org.apache.jackrabbit.oak.spi.security.authorization.restriction

Class AbstractRestrictionProvider

java.lang.Object

org.apache.jackrabbit.oak.spi.security.authorization.restriction.AbstractRestrictionProvider

All Implemented Interfaces:

AccessControlConstants, RestrictionProvider

public abstract class AbstractRestrictionProvider
extends java.lang.Object
implements RestrictionProvider, AccessControlConstants

Field Summary

Fields inherited from interface org.apache.jackrabbit.oak.spi.security.authorization.restriction.RestrictionProvider

EMPTY

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
AbstractRestrictionProvider(java.util.Map<java.lang.String,? extends RestrictionDefinition> definitions)

Method Summary

Modifier and Type	Method and Description
Restriction	createRestriction(java.lang.String oakPath, java.lang.String oakName, Value... values) Creates a new single valued restriction for the specified parameters.
Restriction	createRestriction(java.lang.String oakPath, java.lang.String oakName, Value value) Creates a new single valued restriction for the specified parameters.
java.util.Set<RestrictionDefinition>	getSupportedRestrictions(java.lang.String oakPath) Returns the restriction definitions supported by this provider implementation at the specified path.
java.util.Set<Restriction>	readRestrictions(java.lang.String oakPath, Tree aceTree) Read the valid restrictions stored in the specified ACE tree.
void	validateRestrictions(java.lang.String oakPath, Tree aceTree) Validate the restrictions present with the specified ACE tree.
void	writeRestrictions(java.lang.String oakPath, Tree aceTree, java.util.Set<Restriction> restrictions) Writes the given restrictions to the specified ACE tree.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.jackrabbit.oak.spi.security.authorization.restriction.RestrictionProvider

getPattern, getPattern

Constructor Detail

AbstractRestrictionProvider

public AbstractRestrictionProvider(java.util.Map<java.lang.String,? extends RestrictionDefinition> definitions)

Method Detail

getSupportedRestrictions

public java.util.Set<RestrictionDefinition> getSupportedRestrictions(java.lang.String oakPath)

Description copied from interface: RestrictionProvider

Returns the restriction definitions supported by this provider implementation at the specified path.

Specified by:

getSupportedRestrictions in interface RestrictionProvider

Parameters:

oakPath - The path of the access controlled tree. A null path indicates that the supported restrictions for repository level policies should be returned.

Returns:

The set of supported restrictions at the given path.

createRestriction

public Restriction createRestriction(java.lang.String oakPath,
                                     java.lang.String oakName,
                                     Value value)
                              throws RepositoryException

Description copied from interface: RestrictionProvider

Creates a new single valued restriction for the specified parameters.

Specified by:

createRestriction in interface RestrictionProvider

Parameters:

oakPath - The path of the access controlled tree or null if the target policies applies to the repository level.

oakName - The name of the restriction.

value - The value of the restriction.

Returns:

A new restriction instance.

Throws:

RepositoryException - If another error occurs.

createRestriction

public Restriction createRestriction(java.lang.String oakPath,
                                     java.lang.String oakName,
                                     Value... values)
                              throws RepositoryException

Description copied from interface: RestrictionProvider

Creates a new single valued restriction for the specified parameters.

Specified by:

createRestriction in interface RestrictionProvider

Parameters:

oakPath - The path of the access controlled tree or null if the target policies applies to the repository level.

oakName - The name of the restriction.

values - The value of the restriction.

Returns:

A new restriction instance.

Throws:

RepositoryException - If another error occurs.

readRestrictions

public java.util.Set<Restriction> readRestrictions(java.lang.String oakPath,
                                                   Tree aceTree)

Description copied from interface: RestrictionProvider

Read the valid restrictions stored in the specified ACE tree.

Specified by:

readRestrictions in interface RestrictionProvider

Parameters:

oakPath - The path of the access controlled tree or null if the target policies applies to the repository level.

aceTree - The tree corresponding to an ACE that may contain restrictions.

Returns:

The valid restrictions stored with the specified tree or an empty set.

writeRestrictions

public void writeRestrictions(java.lang.String oakPath,
                              Tree aceTree,
                              java.util.Set<Restriction> restrictions)
                       throws RepositoryException

Description copied from interface: RestrictionProvider

Writes the given restrictions to the specified ACE tree. Note, that this method does not need to validate the specified restrictions (see also RestrictionProvider.validateRestrictions(String, org.apache.jackrabbit.oak.api.Tree)).

Specified by:

writeRestrictions in interface RestrictionProvider

Parameters:

oakPath - The path of the access controlled tree or null if the target policies applies to the repository level.

aceTree - The tree corresponding to an ACE that will have the specified restrictions added.

restrictions - The set of restrictions to be written to the specified tree.

Throws:

RepositoryException - If an error occurs while writing the restrictions.

validateRestrictions

public void validateRestrictions(java.lang.String oakPath,
                                 Tree aceTree)
                          throws AccessControlException

Description copied from interface: RestrictionProvider

Validate the restrictions present with the specified ACE tree.

Specified by:

validateRestrictions in interface RestrictionProvider

Parameters:

oakPath - The path of the access controlled tree or null if the target policies applies to the repository level.

aceTree - The tree corresponding to an ACE.

Throws:

AccessControlException - If any invalid restrictions are detected.