1 /**
2 * This file Copyright (c) 2003-2010 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 * @author Sameer Charles $Id:Group.java 9391 2007-05-11 15:48:02Z scharles $
42 */
43 public interface Group extends Serializable {
44
45 public String getName();
46
47 public void addRole(String roleName) throws UnsupportedOperationException, AccessDeniedException;
48
49 /**
50 * Add a subgroup to this group.
51 * @param groupName
52 * @throws UnsupportedOperationException if the implementation does not support writing
53 * @throws AccessDeniedException if loggen in repository user does not sufficient rights
54 */
55 public void addGroup(String groupName) throws UnsupportedOperationException, AccessDeniedException;
56
57 public void removeRole(String roleName) throws UnsupportedOperationException, AccessDeniedException;
58
59 public void removeGroup(String groupName) throws UnsupportedOperationException, AccessDeniedException;
60
61 public boolean hasRole(String roleName) throws UnsupportedOperationException, AccessDeniedException;
62
63 /**
64 * Gets an arbitrary property from this group.
65 */
66 String getProperty(String propertyName);
67
68 /**
69 * Sets an arbitrary property for this group.
70 */
71 void setProperty(String propertyName, String value);
72
73 /**
74 * Get groups that are directly assigned to group.
75 */
76 public Collection<String> getGroups();
77
78 /**
79 * Get all groups assigned to this group, collected recursively from subgroups.
80 * */
81 public Collection<String> getAllGroups();
82
83 /**
84 * Get roles that are directly assigned to group.
85 */
86 public Collection<String> getRoles();
87
88 }