info.magnolia.cms.security

Class RepositoryBackedSecurityManager

java.lang.Object

info.magnolia.cms.security.RepositoryBackedSecurityManager

Direct Known Subclasses:

MgnlGroupManager, MgnlRoleManager, MgnlUserManager

public abstract class RepositoryBackedSecurityManager
extends Object

Common parent class for repo based security managers.

Field Summary

Fields

Modifier and Type	Field and Description
protected NodeNameHelper	nodeNameHelper

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
protected void	add(String principalName, String resourceName, String resourceTypeName) Adds link to a resource (group or role) to the principal (user or group).
protected abstract javax.jcr.Node	findPrincipalNode(String principalName, javax.jcr.Session session)
protected javax.jcr.Node	findPrincipalNode(String principalName, javax.jcr.Session session, String primaryNodeType)
protected javax.jcr.Node	findPrincipalNode(String principalName, javax.jcr.Session session, String primaryNodeType, javax.jcr.Node startNode) Find principal nodes of type NodeTypes.User#NAME, NodeTypes.Group#NAME or NodeTypes.Role#NAME.
protected javax.jcr.NodeIterator	findPrincipalNodes(javax.jcr.Node node, String nodeType) Find nodes located in the provided node or in sub-folders within it that have the provided nodeType.
protected Collection<String>	findUsersOrGroupsHavingAssignedGroupOrRoleWithUid(javax.jcr.Session session, javax.jcr.Node groupOrRoleNode, String parentNodeName)
protected Map<String,ACL>	getACLs(javax.jcr.Node node)
Map<String,ACL>	getACLs(String principalName)
protected abstract String	getRepositoryName()
protected String	getResourceName(String resourceId)
boolean	hasAny(String principalName, String resourceName, String resourceTypeName)
protected void	remove(String principalName, String resourceName, String resourceTypeName) This call is lenient and will not throw exception in case principal doesn't exist!

Methods inherited from class java.lang.Object

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

Field Detail

nodeNameHelper

protected final NodeNameHelper nodeNameHelper

Constructor Detail

RepositoryBackedSecurityManager

@Inject
public RepositoryBackedSecurityManager(NodeNameHelper nodeNameHelper)

RepositoryBackedSecurityManager

@Deprecated
public RepositoryBackedSecurityManager()

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

Method Detail

hasAny

public boolean hasAny(String principalName,
                      String resourceName,
                      String resourceTypeName)

add

protected void add(String principalName,
                   String resourceName,
                   String resourceTypeName)
            throws PrincipalNotFoundException

Adds link to a resource (group or role) to the principal (user or group). This call is lenient and will not throw exception in case principal doesn't exist! Instead it will simply return without making any change.

Parameters:

principalName - name of the user or group to be updated

resourceName - name of the group or role to be added

resourceTypeName - type of the added resource (group or role) SecurityConstants.NODE_ROLES, SecurityConstants.NODE_GROUPS

Throws:

PrincipalNotFoundException

getResourceName

protected String getResourceName(String resourceId)

remove

protected void remove(String principalName,
                      String resourceName,
                      String resourceTypeName)
               throws PrincipalNotFoundException

This call is lenient and will not throw exception in case principal doesn't exist! Instead it will simply return without making any change.

Parameters:

principalName - name of the user or group to be updated

resourceName - name of the group or role to be added

resourceTypeName - type of the added resource (group or role) SecurityConstants.NODE_ROLES, SecurityConstants.NODE_GROUPS

Throws:

PrincipalNotFoundException

getRepositoryName

protected abstract String getRepositoryName()

findPrincipalNode

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

Throws:

javax.jcr.RepositoryException

findPrincipalNode

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

Throws:

javax.jcr.RepositoryException

findPrincipalNode

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

Find principal nodes of type NodeTypes.User#NAME, NodeTypes.Group#NAME or NodeTypes.Role#NAME. As we don't save sessions during installation phase the principals that are searched might not be visible to JRC queries so we use traversal then.

Throws:

javax.jcr.RepositoryException

getACLs

public Map<String,ACL> getACLs(String principalName)

getACLs

protected Map<String,ACL> getACLs(javax.jcr.Node node)
                           throws javax.jcr.RepositoryException,
                                  javax.jcr.ValueFormatException,
                                  javax.jcr.PathNotFoundException

Throws:

javax.jcr.RepositoryException

javax.jcr.ValueFormatException

javax.jcr.PathNotFoundException

findPrincipalNodes

protected javax.jcr.NodeIterator findPrincipalNodes(javax.jcr.Node node,
                                                    String nodeType)
                                             throws javax.jcr.RepositoryException

Find nodes located in the provided node or in sub-folders within it that have the provided nodeType. As this method uses 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

findUsersOrGroupsHavingAssignedGroupOrRoleWithUid

protected Collection<String> findUsersOrGroupsHavingAssignedGroupOrRoleWithUid(javax.jcr.Session session,
                                                                               javax.jcr.Node groupOrRoleNode,
                                                                               String parentNodeName)
                                                                        throws javax.jcr.RepositoryException

Throws:

javax.jcr.RepositoryException