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:

javax.jcr.security.AccessControlManager, org.apache.jackrabbit.api.security.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(@NotNull Root root, @NotNull NamePathMapper namePathMapper, @NotNull SecurityProvider securityProvider)

Method Summary

Modifier and Type	Method and Description
boolean	defines(String absPath, @NotNull javax.jcr.security.AccessControlPolicy accessControlPolicy) Determines if the implementing AccessManager defines the specified accessControlPolicy at the given absPath.
@NotNull org.apache.jackrabbit.api.security.JackrabbitAccessControlPolicy[]	getApplicablePolicies(@NotNull Principal principal)
@NotNull javax.jcr.security.AccessControlPolicyIterator	getApplicablePolicies(@Nullable String absPath)
@NotNull javax.jcr.security.AccessControlPolicy[]	getEffectivePolicies(@NotNull Set<Principal> principals)
@NotNull javax.jcr.security.AccessControlPolicy[]	getEffectivePolicies(@Nullable String absPath)
@NotNull org.apache.jackrabbit.api.security.JackrabbitAccessControlPolicy[]	getPolicies(@NotNull Principal principal)
@NotNull javax.jcr.security.AccessControlPolicy[]	getPolicies(@Nullable String absPath)
void	removePolicy(@Nullable String absPath, @NotNull javax.jcr.security.AccessControlPolicy policy)
void	setPolicy(@Nullable String absPath, @NotNull javax.jcr.security.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(@NotNull
                                @NotNull Root root,
                                @NotNull
                                @NotNull NamePathMapper namePathMapper,
                                @NotNull
                                @NotNull SecurityProvider securityProvider)

Method Detail

getPolicies

@NotNull
public @NotNull javax.jcr.security.AccessControlPolicy[] getPolicies(@Nullable
                                                                              @Nullable String absPath)
                                                                       throws javax.jcr.RepositoryException

Specified by:

getPolicies in interface javax.jcr.security.AccessControlManager

Throws:

javax.jcr.RepositoryException

getEffectivePolicies

@NotNull
public @NotNull javax.jcr.security.AccessControlPolicy[] getEffectivePolicies(@Nullable
                                                                                       @Nullable String absPath)
                                                                                throws javax.jcr.RepositoryException

Specified by:

getEffectivePolicies in interface javax.jcr.security.AccessControlManager

Throws:

javax.jcr.RepositoryException

getApplicablePolicies

@NotNull
public @NotNull javax.jcr.security.AccessControlPolicyIterator getApplicablePolicies(@Nullable
                                                                                              @Nullable String absPath)
                                                                                       throws javax.jcr.RepositoryException

Specified by:

getApplicablePolicies in interface javax.jcr.security.AccessControlManager

Throws:

javax.jcr.RepositoryException

setPolicy

public void setPolicy(@Nullable
                      @Nullable String absPath,
                      @NotNull
                      @NotNull javax.jcr.security.AccessControlPolicy policy)
               throws javax.jcr.RepositoryException

Specified by:

setPolicy in interface javax.jcr.security.AccessControlManager

Throws:

javax.jcr.RepositoryException

removePolicy

public void removePolicy(@Nullable
                         @Nullable String absPath,
                         @NotNull
                         @NotNull javax.jcr.security.AccessControlPolicy policy)
                  throws javax.jcr.RepositoryException

Specified by:

removePolicy in interface javax.jcr.security.AccessControlManager

Throws:

javax.jcr.RepositoryException

getApplicablePolicies

@NotNull
public @NotNull org.apache.jackrabbit.api.security.JackrabbitAccessControlPolicy[] getApplicablePolicies(@NotNull
                                                                                                                  @NotNull Principal principal)
                                                                                                           throws javax.jcr.RepositoryException

Specified by:

getApplicablePolicies in interface org.apache.jackrabbit.api.security.JackrabbitAccessControlManager

Throws:

javax.jcr.RepositoryException

getPolicies

@NotNull
public @NotNull org.apache.jackrabbit.api.security.JackrabbitAccessControlPolicy[] getPolicies(@NotNull
                                                                                                        @NotNull Principal principal)
                                                                                                 throws javax.jcr.RepositoryException

Specified by:

getPolicies in interface org.apache.jackrabbit.api.security.JackrabbitAccessControlManager

Throws:

javax.jcr.RepositoryException

getEffectivePolicies

@NotNull
public @NotNull javax.jcr.security.AccessControlPolicy[] getEffectivePolicies(@NotNull
                                                                                       @NotNull Set<Principal> principals)
                                                                                throws javax.jcr.RepositoryException

Specified by:

getEffectivePolicies in interface org.apache.jackrabbit.api.security.JackrabbitAccessControlManager

Throws:

javax.jcr.RepositoryException

defines

public boolean defines(String absPath,
                       @NotNull
                       @NotNull javax.jcr.security.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.