info.magnolia.cms.security

Interface GroupManager

All Known Implementing Classes:

MgnlGroupManager

public interface GroupManager

Manages groups, groups are identified by name and can be organized in folders. The name is globally unique regardless of their organisation in folders.

See Also:

Group

Method Summary

Modifier and Type	Method and Description
Group	addGroup(Group group, String groupName) Adds a group to a group.
Group	addRole(Group group, String roleName) Grants a role to a group.
Group	createGroup(String name) Creates a new group in the root folder.
Map<String,ACL>	getACLs(String group)
Collection<Group>	getAllGroups() Get all groups defined in the system.
Collection<String>	getAllGroups(String groupName) Deprecated. since 5.5, use getAllSuperGroups(String) instead.
Collection<String>	getAllSubGroups(String groupName) Returns all sub-groups of the given group.
Collection<String>	getAllSuperGroups(String groupName) Returns all super-groups of the given group, i.e.
Collection<String>	getDirectSubGroups(String groupName) Returns sub-groups directly assigned to the given group.
Collection<String>	getDirectSuperGroups(String groupName) Returns direct super-groups of the given group.
Group	getGroup(String name) Get a group by name.
Collection<String>	getGroupsWithGroup(String groupName) Deprecated. since 5.5, use getDirectSubGroups(String) instead.
Collection<String>	getGroupsWithRole(String roleName) Returns all groups having assigned the provided role.
Group	removeGroup(Group group, String groupName) Removes group from a group.
Group	removeRole(Group group, String roleName) Removes role from a group.

Method Detail

createGroup

Group createGroup(String name)
           throws UnsupportedOperationException,
                  AccessDeniedException

Creates a new group in the root folder.

Throws:

IllegalArgumentException - if the name is not valid or if a group with this name already exists

UnsupportedOperationException - if the implementation does not support writing

AccessDeniedException

getGroup

Group getGroup(String name)
        throws UnsupportedOperationException,
               AccessDeniedException

Get a group by name.

Throws:

UnsupportedOperationException - if the implementation does not support writing

AccessDeniedException

getAllGroups

Collection<Group> getAllGroups()
                        throws UnsupportedOperationException

Get all groups defined in the system.

Throws:

UnsupportedOperationException

getAllGroups

@Deprecated
Collection<String> getAllGroups(String groupName)
                                     throws UnsupportedOperationException

Deprecated. since 5.5, use getAllSuperGroups(String) instead.

Returns all super-groups of the given group, i.e. both directly assigned and transitively assigned super-groups.

Throws:

UnsupportedOperationException

See Also:

getAllSuperGroups(String)

getAllSuperGroups

Collection<String> getAllSuperGroups(String groupName)
                              throws UnsupportedOperationException

Returns all super-groups of the given group, i.e. both directly assigned and transitively assigned super-groups.

Given the following groups:

 /
 ├── people
 │   └──employees ("employees" is directly assigned to the "people" super-group)
 │      └──developers ("developers" is directly assigned to the "employees" super-group; and is thus transitively assigned to the "people" super-group)

 #getAllSuperGroups("people")  = []
 #getAllSuperGroups("employees")  = ["people"]
 #getAllSuperGroups("developers")  = ["employees","people"]
 

Throws:

UnsupportedOperationException

getAllSubGroups

Collection<String> getAllSubGroups(String groupName)
                            throws UnsupportedOperationException

Returns all sub-groups of the given group.

Given the following groups:

 /
 ├── people
 │   └──employees ("employees" is directly assigned to the "people" super-group)
 │      └──developers ("developers" is directly assigned to the "employees" super-group; and is thus transitively assigned to the "people" super-group)

 #getAllSubGroups("people")  = ["employees","developers"]
 #getAllSubGroups("employees")  = ["developers"]
 #getAllSubGroups("developers")  = []
 

Throws:

UnsupportedOperationException

getACLs

Map<String,ACL> getACLs(String group)

addRole

Group addRole(Group group,
              String roleName)
       throws AccessDeniedException

Grants a role to a group.

Returns:

Group object with the role already granted.

Throws:

AccessDeniedException

addGroup

Group addGroup(Group group,
               String groupName)
        throws AccessDeniedException

Adds a group to a group.

Returns:

group object with the group already assigned.

Throws:

AccessDeniedException

getGroupsWithGroup

@Deprecated
Collection<String> getGroupsWithGroup(String groupName)

Deprecated. since 5.5, use getDirectSubGroups(String) instead.

Returns sub-groups directly assigned to the given group.

See Also:

getDirectSubGroups(String)

getDirectSubGroups

Collection<String> getDirectSubGroups(String groupName)

Returns sub-groups directly assigned to the given group.

Given the following groups:

 /
 ├── people
 │   └──employees ("employees" is directly assigned to the "people" super-group)
 │      └──developers ("developers" is directly assigned to the "employees" super-group; and is thus transitively assigned to the "people" super-group)

 #getDirectSubGroups("people")  = ["employees"]
 #getDirectSubGroups("employees")  = ["developers"]
 #getDirectSubGroups("developers")  = []
 

getDirectSuperGroups

Collection<String> getDirectSuperGroups(String groupName)

Returns direct super-groups of the given group.

Given the following groups:

 /
 ├── people
 │   └──employees ("employees" is directly assigned to the "people" super-group)
 │      └──developers ("developers" is directly assigned to the "employees" super-group; and is thus transitively assigned to the "people" super-group)

 #getDirectSuperGroups("people")  = []
 #getDirectSuperGroups("employees")  = ["people"]
 #getDirectSuperGroups("developers")  = ["employees"]
 

getGroupsWithRole

Collection<String> getGroupsWithRole(String roleName)

Returns all groups having assigned the provided role.

removeGroup

Group removeGroup(Group group,
                  String groupName)
           throws AccessDeniedException

Removes group from a group.

Returns:

group object with the group assignment removed.

Throws:

AccessDeniedException

removeRole

Group removeRole(Group group,
                 String roleName)
          throws AccessDeniedException

Removes role from a group.

Returns:

group object without removed role.

Throws:

AccessDeniedException