Package 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, AggregationAware, RestrictionProvider

Direct Known Subclasses:

RestrictionProviderImpl

public abstract class AbstractRestrictionProvider
extends Object
implements RestrictionProvider, AggregationAware, AccessControlConstants

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_CURRENT, REP_GLOB, REP_GLOBS, REP_ITEM_NAMES, REP_NODE_PATH, REP_NT_NAMES, REP_POLICY, REP_PREFIXES, REP_PRINCIPAL_NAME, REP_PRIVILEGES, REP_REPO_POLICY, REP_RESTRICTIONS, REP_SUBTREES

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

EMPTY

Constructor Summary

Constructors

Constructor	Description
AbstractRestrictionProvider(@NotNull Map<String,? extends RestrictionDefinition> definitions)

Method Summary

Modifier and Type	Method	Description
@NotNull Restriction	createRestriction(@Nullable String oakPath, @NotNull String oakName, @NotNull Value value)	Creates a new single valued restriction for the specified parameters.
@NotNull Restriction	createRestriction(@Nullable String oakPath, @NotNull String oakName, @NotNull Value... values)	Creates a new multi valued restriction for the specified parameters.
protected @NotNull Tree	getRestrictionsTree(@NotNull Tree aceTree)	Returns the tree that contains the restriction of the specified ACE tree.
@NotNull Set<RestrictionDefinition>	getSupportedRestrictions(@Nullable String oakPath)	Returns the restriction definitions supported by this provider implementation at the specified path.
protected boolean	isUnsupportedPath(@Nullable String oakPath)	Returns true if the specified path is null.
@NotNull Set<Restriction>	readRestrictions(@Nullable String oakPath, @NotNull Tree aceTree)	Read the valid restrictions stored in the specified ACE tree.
void	setComposite(@NotNull CompositeRestrictionProvider composite)
void	validateRestrictions(@Nullable String oakPath, @NotNull Tree aceTree)	Validate the restrictions present with the specified ACE tree.
void	writeRestrictions(@Nullable String oakPath, @NotNull Tree aceTree, @NotNull Set<Restriction> restrictions)	Writes the given restrictions to the specified ACE tree.

Methods inherited from class java.lang.Object

clone, equals, finalize, 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(@NotNull
                                   @NotNull Map<String,? extends RestrictionDefinition> definitions)

Method Detail

setComposite

public void setComposite(@NotNull
                         @NotNull CompositeRestrictionProvider composite)

Specified by:

setComposite in interface AggregationAware

getSupportedRestrictions

@NotNull
public @NotNull Set<RestrictionDefinition> getSupportedRestrictions(@Nullable
                                                                    @Nullable 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

@NotNull
public @NotNull Restriction createRestriction(@Nullable
                                              @Nullable String oakPath,
                                              @NotNull
                                              @NotNull String oakName,
                                              @NotNull
                                              @NotNull 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:

AccessControlException - If no matching restriction definition exists for the specified parameters.

RepositoryException - If another error occurs.

createRestriction

@NotNull
public @NotNull Restriction createRestriction(@Nullable
                                              @Nullable String oakPath,
                                              @NotNull
                                              @NotNull String oakName,
                                              @NotNull
                                              @NotNull Value... values)
                                       throws RepositoryException

Description copied from interface: RestrictionProvider

Creates a new multi 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 values of the restriction.

Returns:

A new restriction instance.

Throws:

AccessControlException - If no matching restriction definition exists for the specified parameters.

RepositoryException - If another error occurs.

readRestrictions

@NotNull
public @NotNull Set<Restriction> readRestrictions(@Nullable
                                                  @Nullable String oakPath,
                                                  @NotNull
                                                  @NotNull 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(@Nullable
                              @Nullable String oakPath,
                              @NotNull
                              @NotNull Tree aceTree,
                              @NotNull
                              @NotNull 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(@Nullable
                                 @Nullable String oakPath,
                                 @NotNull
                                 @NotNull 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.

isUnsupportedPath

protected boolean isUnsupportedPath(@Nullable
                                    @Nullable String oakPath)

Returns true if the specified path is null. Subclasses may change the default behavior.

Parameters:

oakPath - The path for which a restriction is being created.

Returns:

true if this implementation can create restrictions for the specified oakPath; false otherwise.

getRestrictionsTree

@NotNull
protected @NotNull Tree getRestrictionsTree(@NotNull
                                            @NotNull Tree aceTree)

Returns the tree that contains the restriction of the specified ACE tree.

Parameters:

aceTree - The ACE tree for which the restrictions are being read.

Returns:

The tree storing the restriction information.