org.apache.jackrabbit.oak.security.authorization.accesscontrol

Class AccessControlManagerImpl

java.lang.Object

org.apache.jackrabbit.oak.spi.security.authorization.accesscontrol.AbstractAccessControlManager

org.apache.jackrabbit.oak.security.authorization.accesscontrol.AccessControlManagerImpl

All Implemented Interfaces:

AccessControlManager, JackrabbitAccessControlManager, AccessControlConstants, PolicyOwner

public class AccessControlManagerImpl
extends AbstractAccessControlManager
implements PolicyOwner

Default implementation of the JackrabbitAccessControlManager interface. This implementation covers both editing access control content by path and by Principal resulting both in the same content structure.

Field Summary

Fields inherited from interface org.apache.jackrabbit.oak.spi.security.authorization.accesscontrol.AccessControlConstants

AC_NODETYPE_NAMES, ACE_PROPERTY_NAMES, MIX_REP_ACCESS_CONTROLLABLE, MIX_REP_REPO_ACCESS_CONTROLLABLE, NT_REP_ACE, NT_REP_ACL, NT_REP_DENY_ACE, NT_REP_GRANT_ACE, NT_REP_POLICY, NT_REP_RESTRICTIONS, PARAM_RESTRICTION_PROVIDER, POLICY_NODE_NAMES, REP_GLOB, REP_ITEM_NAMES, REP_NODE_PATH, REP_NT_NAMES, REP_POLICY, REP_PREFIXES, REP_PRINCIPAL_NAME, REP_PRIVILEGES, REP_REPO_POLICY, REP_RESTRICTIONS

Constructor Summary

Constructors

Constructor and Description
AccessControlManagerImpl(Root root, NamePathMapper namePathMapper, SecurityProvider securityProvider)

Method Summary

Modifier and Type	Method and Description
boolean	defines(String absPath, AccessControlPolicy accessControlPolicy) Determines if the implementing AccessManager defines the specified accessControlPolicy at the given absPath.
JackrabbitAccessControlPolicy[]	getApplicablePolicies(Principal principal)
AccessControlPolicyIterator	getApplicablePolicies(String absPath)
AccessControlPolicy[]	getEffectivePolicies(Set<Principal> principals)
AccessControlPolicy[]	getEffectivePolicies(String absPath)
JackrabbitAccessControlPolicy[]	getPolicies(Principal principal)
AccessControlPolicy[]	getPolicies(String absPath)
void	removePolicy(String absPath, AccessControlPolicy policy)
void	setPolicy(String absPath, AccessControlPolicy policy)

Methods inherited from class org.apache.jackrabbit.oak.spi.security.authorization.accesscontrol.AbstractAccessControlManager

getConfig, getLatestRoot, getNamePathMapper, getOakPath, getPermissionProvider, getPrivilegeManager, getPrivileges, getPrivileges, getRoot, getSupportedPrivileges, getTree, hasPrivileges, hasPrivileges, privilegeFromName

Methods inherited from class java.lang.Object

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

Constructor Detail

AccessControlManagerImpl

public AccessControlManagerImpl(@Nonnull
                                Root root,
                                @Nonnull
                                NamePathMapper namePathMapper,
                                @Nonnull
                                SecurityProvider securityProvider)

Method Detail

getPolicies

@Nonnull
public AccessControlPolicy[] getPolicies(@Nullable
                                                   String absPath)
                                            throws RepositoryException

Specified by:

getPolicies in interface AccessControlManager

Throws:

RepositoryException

getEffectivePolicies

@Nonnull
public AccessControlPolicy[] getEffectivePolicies(@Nullable
                                                            String absPath)
                                                     throws RepositoryException

Specified by:

getEffectivePolicies in interface AccessControlManager

Throws:

RepositoryException

getApplicablePolicies

@Nonnull
public AccessControlPolicyIterator getApplicablePolicies(@Nullable
                                                                   String absPath)
                                                            throws RepositoryException

Specified by:

getApplicablePolicies in interface AccessControlManager

Throws:

RepositoryException

setPolicy

public void setPolicy(@Nullable
                      String absPath,
                      @Nonnull
                      AccessControlPolicy policy)
               throws RepositoryException

Specified by:

setPolicy in interface AccessControlManager

Throws:

RepositoryException

removePolicy

public void removePolicy(@Nullable
                         String absPath,
                         @Nonnull
                         AccessControlPolicy policy)
                  throws RepositoryException

Specified by:

removePolicy in interface AccessControlManager

Throws:

RepositoryException

getApplicablePolicies

@Nonnull
public JackrabbitAccessControlPolicy[] getApplicablePolicies(@Nonnull
                                                                       Principal principal)
                                                                throws RepositoryException

Specified by:

getApplicablePolicies in interface JackrabbitAccessControlManager

Throws:

RepositoryException

getPolicies

@Nonnull
public JackrabbitAccessControlPolicy[] getPolicies(@Nonnull
                                                             Principal principal)
                                                      throws RepositoryException

Specified by:

getPolicies in interface JackrabbitAccessControlManager

Throws:

RepositoryException

getEffectivePolicies

@Nonnull
public AccessControlPolicy[] getEffectivePolicies(@Nonnull
                                                            Set<Principal> principals)
                                                     throws RepositoryException

Specified by:

getEffectivePolicies in interface JackrabbitAccessControlManager

Throws:

RepositoryException

defines

public boolean defines(String absPath,
                       @Nonnull
                       AccessControlPolicy accessControlPolicy)

Description copied from interface: PolicyOwner

Determines if the implementing AccessManager defines the specified accessControlPolicy at the given absPath. If this method returns true it is expected that the given policy is valid to be set or removed with the manager.

Specified by:

defines in interface PolicyOwner

Parameters:

absPath - An absolute path.

accessControlPolicy - The access control policy to be tested.

Returns:

true If the AccessControlManager implementing this interface can handle the specified accessControlPolicy at the given path.