1 /** 2 * This file Copyright (c) 2003-2016 Magnolia International 3 * Ltd. (http://www.magnolia-cms.com). All rights reserved. 4 * 5 * 6 * This file is dual-licensed under both the Magnolia 7 * Network Agreement and the GNU General Public License. 8 * You may elect to use one or the other of these licenses. 9 * 10 * This file is distributed in the hope that it will be 11 * useful, but AS-IS and WITHOUT ANY WARRANTY; without even the 12 * implied warranty of MERCHANTABILITY or FITNESS FOR A 13 * PARTICULAR PURPOSE, TITLE, or NONINFRINGEMENT. 14 * Redistribution, except as permitted by whichever of the GPL 15 * or MNA you select, is prohibited. 16 * 17 * 1. For the GPL license (GPL), you can redistribute and/or 18 * modify this file under the terms of the GNU General 19 * Public License, Version 3, as published by the Free Software 20 * Foundation. You should have received a copy of the GNU 21 * General Public License, Version 3 along with this program; 22 * if not, write to the Free Software Foundation, Inc., 51 23 * Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. 24 * 25 * 2. For the Magnolia Network Agreement (MNA), this file 26 * and the accompanying materials are made available under the 27 * terms of the MNA which accompanies this distribution, and 28 * is available at http://www.magnolia-cms.com/mna.html 29 * 30 * Any modifications to this file must keep this entire header 31 * intact. 32 * 33 */ 34 package info.magnolia.cms.security; 35 36 import java.io.Serializable; 37 import java.util.Collection; 38 39 /** 40 * A user group. Groups are assigned to {@link User users} and can have sub groups. 41 */ 42 public interface Group extends Serializable { 43 44 public String getName(); 45 46 /** 47 * @deprecated since 5.3.3 use manager instead 48 */ 49 @Deprecated 50 public void addRole(String roleName) throws UnsupportedOperationException, AccessDeniedException; 51 52 /** 53 * @deprecated since 5.3.3 use manager instead 54 */ 55 @Deprecated 56 public void addGroup(String groupName) throws UnsupportedOperationException, AccessDeniedException; 57 58 /** 59 * @deprecated since 5.3.3 use manager instead 60 */ 61 @Deprecated 62 public void removeRole(String roleName) throws UnsupportedOperationException, AccessDeniedException; 63 64 /** 65 * @deprecated since 5.3.3 use manager instead 66 */ 67 @Deprecated 68 public void removeGroup(String groupName) throws UnsupportedOperationException, AccessDeniedException; 69 70 public boolean hasRole(String roleName) throws UnsupportedOperationException, AccessDeniedException; 71 72 /** 73 * Gets an arbitrary property from this group. 74 */ 75 String getProperty(String propertyName); 76 77 /** 78 * Sets an arbitrary property for this group. 79 */ 80 void setProperty(String propertyName, String value); 81 82 /** 83 * Get groups that are directly assigned to group. 84 */ 85 public Collection<String> getGroups(); 86 87 /** 88 * Get all groups assigned to this group, collected recursively from subgroups. 89 * */ 90 public Collection<String> getAllGroups(); 91 92 /** 93 * Get roles that are directly assigned to group. 94 */ 95 public Collection<String> getRoles(); 96 97 /** 98 * Gets identifier of the group. 99 */ 100 public String getId(); 101 102 }