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 * @author Sameer Charles $Id:Group.java 9391 2007-05-11 15:48:02Z scharles $
41 */
42 public interface Group extends Serializable {
43
44 /**
45 * get name of this node
46 * @return group name
47 */
48 public String getName();
49
50 /**
51 * add role to this group
52 * @param roleName
53 * @throws UnsupportedOperationException if the implementation does not support writing
54 * @throws AccessDeniedException if loggen in repository user does not sufficient rights
55 */
56 public void addRole(String roleName) throws UnsupportedOperationException, AccessDeniedException;
57
58 /**
59 * add subgroup to this group
60 * @param groupName
61 * @throws UnsupportedOperationException if the implementation does not support writing
62 * @throws AccessDeniedException if loggen in repository user does not sufficient rights
63 */
64 public void addGroup(String groupName) throws UnsupportedOperationException, AccessDeniedException;
65
66 /**
67 * remove role from this group
68 * @param roleName
69 * @throws UnsupportedOperationException if the implementation does not support writing
70 * @throws AccessDeniedException if loggen in repository user does not sufficient rights
71 */
72 public void removeRole(String roleName) throws UnsupportedOperationException, AccessDeniedException;
73
74 /**
75 * remove subgroup from this group
76 * @param groupName
77 * @throws UnsupportedOperationException if the implementation does not support writing
78 * @throws AccessDeniedException if loggen in repository user does not sufficient rights
79 */
80 public void removeGroup(String groupName) throws UnsupportedOperationException, AccessDeniedException;
81
82 /**
83 * returns true if role exist in this group
84 * @param roleName
85 * @throws UnsupportedOperationException if the implementation does not exist
86 * @throws AccessDeniedException if loggen in repository user does not sufficient rights
87 */
88 public boolean hasRole(String roleName) throws UnsupportedOperationException, AccessDeniedException;
89
90 /**
91 * Gets an arbitrary property from this group.
92 */
93 String getProperty(String propertyName);
94
95 /**
96 * Sets an arbitrary property for this group.
97 */
98 void setProperty(String propertyName, String value);
99
100 /**
101 * get groups that are directly assigned to group
102 */
103 public Collection<String> getGroups();
104
105 /**
106 * get all groups assigned to this group, collected recursively from subgroups
107 * */
108 public Collection<String> getAllGroups();
109
110 /**
111 * get roles that are directly assigned to group
112 */
113 public Collection<String> getRoles();
114
115 }