info.magnolia.cms.security

Class MgnlGroupManager

java.lang.Object

info.magnolia.cms.security.RepositoryBackedSecurityManager

info.magnolia.cms.security.MgnlGroupManager

All Implemented Interfaces:

GroupManager

public class MgnlGroupManager
extends RepositoryBackedSecurityManager
implements GroupManager

Group manager working directly with JCR API and returning simple groups (no JCR node aware).

Field Summary

Fields inherited from class info.magnolia.cms.security.RepositoryBackedSecurityManager

nodeNameHelper

Constructor Summary

Constructors

Constructor and Description
MgnlGroupManager() Deprecated. since 5.5.3, use MgnlGroupManager(NodeNameHelper) instead.
MgnlGroupManager(NodeNameHelper nodeNameHelper)

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.
Group	createGroup(String path, String name) Creates a new group in a specific folder.
protected void	findAllGroupsInFolder(javax.jcr.Node node, Collection<Group> addTo) Finds all groups located in the provided node or in sub-folders within it and adds them to the given collection.
protected javax.jcr.Node	findPrincipalNode(String principalName, javax.jcr.Session session) Helper method to find a group.
Collection<Group>	getAllGroups() Get all groups defined in the system.
Collection<String>	getAllGroups(String name) Returns all super-groups of the given group, i.e.
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) Returns sub-groups directly assigned to the given group.
Collection<String>	getGroupsWithRole(String roleName) Returns all groups having assigned the provided role.
protected String	getRepositoryName()
protected Group	newGroupInstance(javax.jcr.Node node)
Group	removeGroup(Group group, String groupName) Removes group from a group.
Group	removeRole(Group group, String roleName) Removes role from a group.
protected void	validateGroupName(String name)

Methods inherited from class info.magnolia.cms.security.RepositoryBackedSecurityManager

add, findPrincipalNode, findPrincipalNode, findPrincipalNodes, findUsersOrGroupsHavingAssignedGroupOrRoleWithUid, getACLs, getACLs, getResourceName, hasAny, remove

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface info.magnolia.cms.security.GroupManager

getACLs

Constructor Detail

MgnlGroupManager

@Inject
public MgnlGroupManager(NodeNameHelper nodeNameHelper)

MgnlGroupManager

@Deprecated
public MgnlGroupManager()

Deprecated. since 5.5.3, use MgnlGroupManager(NodeNameHelper) instead.

Method Detail

createGroup

public Group createGroup(String name)
                  throws AccessDeniedException

Description copied from interface: GroupManager

Creates a new group in the root folder.

Specified by:

createGroup in interface GroupManager

Throws:

AccessDeniedException

createGroup

public Group createGroup(String path,
                         String name)
                  throws AccessDeniedException

Creates a new group in a specific folder. The folder must exist.

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

public Group getGroup(String name)
               throws AccessDeniedException

Description copied from interface: GroupManager

Get a group by name.

Specified by:

getGroup in interface GroupManager

Throws:

AccessDeniedException

getAllGroups

public Collection<Group> getAllGroups()

Description copied from interface: GroupManager

Get all groups defined in the system.

Specified by:

getAllGroups in interface GroupManager

getAllGroups

public Collection<String> getAllGroups(String name)

Description copied from interface: GroupManager

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

Specified by:

getAllGroups in interface GroupManager

See Also:

GroupManager.getAllSuperGroups(String)

newGroupInstance

protected Group newGroupInstance(javax.jcr.Node node)
                          throws javax.jcr.RepositoryException

Throws:

javax.jcr.RepositoryException

findPrincipalNode

protected javax.jcr.Node findPrincipalNode(String principalName,
                                           javax.jcr.Session session)
                                    throws javax.jcr.RepositoryException

Helper method to find a group. Uses JCR Query. This will return null if group doesn't exist.

Specified by:

findPrincipalNode in class RepositoryBackedSecurityManager

Throws:

javax.jcr.RepositoryException

getRepositoryName

protected String getRepositoryName()

Specified by:

getRepositoryName in class RepositoryBackedSecurityManager

addRole

public Group addRole(Group group,
                     String roleName)
              throws AccessDeniedException

Description copied from interface: GroupManager

Grants a role to a group.

Specified by:

addRole in interface GroupManager

Returns:

Group object with the role already granted.

Throws:

AccessDeniedException

addGroup

public Group addGroup(Group group,
                      String groupName)
               throws AccessDeniedException

Description copied from interface: GroupManager

Adds a group to a group.

Specified by:

addGroup in interface GroupManager

Returns:

group object with the group already assigned.

Throws:

AccessDeniedException

findAllGroupsInFolder

protected void findAllGroupsInFolder(javax.jcr.Node node,
                                     Collection<Group> addTo)
                              throws javax.jcr.RepositoryException

Finds all groups located in the provided node or in sub-folders within it and adds them to the given collection. As this method bases on a method using jcr queries to find nodes, it might not see nodes that have been created but not saved yet (i.e. during installation of a module).

Throws:

javax.jcr.RepositoryException

validateGroupName

protected void validateGroupName(String name)
                          throws AccessDeniedException

Throws:

AccessDeniedException

getGroupsWithGroup

public Collection<String> getGroupsWithGroup(String groupName)

Description copied from interface: GroupManager

Returns sub-groups directly assigned to the given group.

Specified by:

getGroupsWithGroup in interface GroupManager

See Also:

GroupManager.getDirectSubGroups(String)

getDirectSubGroups

public Collection<String> getDirectSubGroups(String groupName)

Description copied from interface: GroupManager

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")  = []
 

Specified by:

getDirectSubGroups in interface GroupManager

getDirectSuperGroups

public Collection<String> getDirectSuperGroups(String groupName)

Description copied from interface: GroupManager

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"]
 

Specified by:

getDirectSuperGroups in interface GroupManager

getGroupsWithRole

public Collection<String> getGroupsWithRole(String roleName)

Description copied from interface: GroupManager

Returns all groups having assigned the provided role.

Specified by:

getGroupsWithRole in interface GroupManager

removeGroup

public Group removeGroup(Group group,
                         String groupName)
                  throws AccessDeniedException

Description copied from interface: GroupManager

Removes group from a group.

Specified by:

removeGroup in interface GroupManager

Returns:

group object with the group assignment removed.

Throws:

AccessDeniedException

removeRole

public Group removeRole(Group group,
                        String roleName)
                 throws AccessDeniedException

Description copied from interface: GroupManager

Removes role from a group.

Specified by:

removeRole in interface GroupManager

Returns:

group object without removed role.

Throws:

AccessDeniedException

getAllSuperGroups

public Collection<String> getAllSuperGroups(String groupName)
                                     throws UnsupportedOperationException

Description copied from interface: GroupManager

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"]
 

Specified by:

getAllSuperGroups in interface GroupManager

Throws:

UnsupportedOperationException

getAllSubGroups

public Collection<String> getAllSubGroups(String groupName)
                                   throws UnsupportedOperationException

Description copied from interface: GroupManager

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")  = []
 

Specified by:

getAllSubGroups in interface GroupManager

Throws:

UnsupportedOperationException