1 /**
2 * This file Copyright (c) 2003-2014 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 info.magnolia.cms.security.auth.ACL;
37
38 import java.util.Collection;
39 import java.util.Map;
40
41 /**
42 * Manages the groups.
43 * @author Sameer Charles $Id$
44 */
45 public interface GroupManager {
46
47 /**
48 * @throws UnsupportedOperationException if the implementation does not support writing
49 */
50 public Group createGroup(String name) throws UnsupportedOperationException, AccessDeniedException;
51
52 /**
53 * @throws UnsupportedOperationException if the implementation does not support writing
54 */
55 public Group getGroup(String name) throws UnsupportedOperationException, AccessDeniedException;
56
57 /**
58 * Get all groups defined in the system.
59 */
60 public Collection<Group> getAllGroups() throws UnsupportedOperationException;
61
62 /**
63 * Get all groups related to one concrete group.
64 */
65 public Collection<String> getAllGroups(String groupName) throws UnsupportedOperationException;
66
67 public Map<String, ACL> getACLs(String group);
68
69 /**
70 * Grants to the group a role.
71 * @return Group object with the role already granted.
72 */
73 public Group addRole(Group group, String roleName) throws AccessDeniedException;
74
75 /**
76 * Adds to the group to a group.
77 * @return group object with the group already assigned.
78 */
79 public Group addGroup(Group group, String groupName) throws AccessDeniedException;
80
81 }