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

Class AbstractAccessControlList

java.lang.Object

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

All Implemented Interfaces:

AccessControlList, AccessControlPolicy, JackrabbitAccessControlList, JackrabbitAccessControlPolicy

Direct Known Subclasses:

ImmutableACL

public abstract class AbstractAccessControlList
extends Object
implements JackrabbitAccessControlList

Abstract base implementation of the JackrabbitAccessControlList interface.

Constructor Summary

Constructors

Constructor	Description
AbstractAccessControlList(@Nullable String oakPath, @NotNull NamePathMapper namePathMapper)

Method Summary

Modifier and Type	Method	Description
boolean	addAccessControlEntry(Principal principal, Privilege[] privileges)	Adds an access control entry to this policy consisting of the specified principal and the specified privileges.
boolean	addEntry(@NotNull Principal principal, @NotNull Privilege[] privileges, boolean isAllow)	Same as JackrabbitAccessControlList.addEntry(Principal, Privilege[], boolean, Map) using some implementation specific restrictions.
boolean	addEntry(@NotNull Principal principal, @NotNull Privilege[] privileges, boolean isAllow, @Nullable Map<String,Value> restrictions)	Adds an access control entry to this policy consisting of the specified principal, the specified privileges, the isAllow flag and an optional map containing additional restrictions.
AccessControlEntry[]	getAccessControlEntries()	Returns all access control entries present with this policy.
abstract @NotNull List<? extends JackrabbitAccessControlEntry>	getEntries()
@NotNull NamePathMapper	getNamePathMapper()
@Nullable String	getOakPath()
@Nullable String	getPath()	Returns the path of the node this policy has been created for.
@NotNull String[]	getRestrictionNames()	Returns the names of the supported restrictions or an empty array if no restrictions are respected.
abstract @NotNull RestrictionProvider	getRestrictionProvider()
int	getRestrictionType(@NotNull String restrictionName)	Return the expected property type of the restriction with the specified restrictionName.
boolean	isEmpty()	Returns true if this policy does not yet define any entries.
boolean	isMultiValueRestriction(@NotNull String restrictionName)	Returns true if the restriction is multivalued; false otherwise.
int	size()	Returns the number of entries or 0 if the policy is empty.

Methods inherited from class java.lang.Object

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

Methods inherited from interface javax.jcr.security.AccessControlList

removeAccessControlEntry

Methods inherited from interface org.apache.jackrabbit.api.security.JackrabbitAccessControlList

addEntry, orderBefore

Constructor Details

AbstractAccessControlList

public AbstractAccessControlList(@Nullable
 @Nullable String oakPath,
 @NotNull
 @NotNull NamePathMapper namePathMapper)

Method Details

getOakPath

@Nullable
public @Nullable String getOakPath()

getNamePathMapper

@NotNull
public @NotNull NamePathMapper getNamePathMapper()

getEntries

@NotNull
public abstract @NotNull List<? extends JackrabbitAccessControlEntry> getEntries()

getRestrictionProvider

@NotNull
public abstract @NotNull RestrictionProvider getRestrictionProvider()

getPath

@Nullable
public @Nullable String getPath()

Description copied from interface: JackrabbitAccessControlPolicy

Returns the path of the node this policy has been created for.

Specified by:

getPath in interface JackrabbitAccessControlPolicy

Returns:

the path of the node this policy has been created for.

getAccessControlEntries

public AccessControlEntry[] getAccessControlEntries()

Description copied from interface: AccessControlList

Returns all access control entries present with this policy.

This method is only guaranteed to return an AccessControlEntry if that AccessControlEntry has been assigned through this API.

Specified by:

getAccessControlEntries in interface AccessControlList

Returns:

all access control entries present with this policy.

addAccessControlEntry

public boolean addAccessControlEntry(Principal principal,
 Privilege[] privileges)
                              throws RepositoryException

Description copied from interface: AccessControlList

Adds an access control entry to this policy consisting of the specified principal and the specified privileges.

This method returns true if this policy was modified, false otherwise.

How the entries are grouped within the list is an implementation detail. An implementation may e.g. combine the specified privileges with those added by a previous call to addAccessControlEntry for the same Principal. However, a call to addAccessControlEntry for a given Principal can never remove a Privilege added by a previous call.

The modification does not take effect until this policy has been set to a node by calling AccessControlManager.setPolicy(String, AccessControlPolicy) and save is performed.

Specified by:

addAccessControlEntry in interface AccessControlList

Parameters:

principal - a Principal.

privileges - an array of Privileges.

Returns:

true if this policy was modify; false otherwise.

Throws:

RepositoryException - if another error occurs.

isEmpty

public boolean isEmpty()

Description copied from interface: JackrabbitAccessControlList

Returns true if this policy does not yet define any entries.

Specified by:

isEmpty in interface JackrabbitAccessControlList

Returns:

If no entries are present.

size

public int size()

Description copied from interface: JackrabbitAccessControlList

Returns the number of entries or 0 if the policy is empty.

Specified by:

size in interface JackrabbitAccessControlList

Returns:

The number of entries present or 0 if the policy is empty.

getRestrictionNames

@NotNull
public @NotNull String[] getRestrictionNames()

Description copied from interface: JackrabbitAccessControlList

Returns the names of the supported restrictions or an empty array if no restrictions are respected.

Specified by:

getRestrictionNames in interface JackrabbitAccessControlList

Returns:

the names of the supported restrictions or an empty array.

See Also:

• JackrabbitAccessControlList.addEntry(Principal, Privilege[], boolean, Map)

getRestrictionType

public int getRestrictionType(@NotNull
 @NotNull String restrictionName)

Description copied from interface: JackrabbitAccessControlList

Return the expected property type of the restriction with the specified restrictionName.

Specified by:

getRestrictionType in interface JackrabbitAccessControlList

Parameters:

restrictionName - Any of the restriction names retrieved from JackrabbitAccessControlList.getRestrictionNames().

Returns:

expected property type.

isMultiValueRestriction

public boolean isMultiValueRestriction(@NotNull
 @NotNull String restrictionName)

Description copied from interface: JackrabbitAccessControlList

Returns true if the restriction is multivalued; false otherwise. If an given implementation doesn't support multivalued restrictions, this method always returns false.

Specified by:

isMultiValueRestriction in interface JackrabbitAccessControlList

Parameters:

restrictionName - Any of the restriction names retrieved from JackrabbitAccessControlList.getRestrictionNames().

Returns:

true if the restriction is multivalued; false if the restriction with the given name is single value or if the implementation doesn't support multivalued restrictions, this method always returns false.

See Also:

• JackrabbitAccessControlList.addEntry(Principal, Privilege[], boolean, Map, Map)

addEntry

public boolean addEntry(@NotNull
 @NotNull Principal principal,
 @NotNull
 @NotNull Privilege[] privileges,
 boolean isAllow)
                 throws RepositoryException

Description copied from interface: JackrabbitAccessControlList

Same as JackrabbitAccessControlList.addEntry(Principal, Privilege[], boolean, Map) using some implementation specific restrictions.

Specified by:

addEntry in interface JackrabbitAccessControlList

Parameters:

principal - the principal to add the entry for

privileges - the privileges to add

isAllow - if true if this is a positive (allow) entry

Returns:

true if this policy has changed by incorporating the given entry; false otherwise.

Throws:

RepositoryException - If another error occurs.

See Also:

• AccessControlList.addAccessControlEntry(Principal, Privilege[])

addEntry

public boolean addEntry(@NotNull
 @NotNull Principal principal,
 @NotNull
 @NotNull Privilege[] privileges,
 boolean isAllow,
 @Nullable
 @Nullable Map<String,Value> restrictions)
                 throws RepositoryException

Description copied from interface: JackrabbitAccessControlList

Adds an access control entry to this policy consisting of the specified principal, the specified privileges, the isAllow flag and an optional map containing additional restrictions.

This method returns true if this policy was modified, false otherwise.

An AccessControlException is thrown if any of the specified parameters is invalid or if some other access control related exception occurs.

Specified by:

addEntry in interface JackrabbitAccessControlList

Parameters:

principal - the principal to add the entry for

privileges - the privileges to add

isAllow - if true if this is a positive (allow) entry

restrictions - A map of additional restrictions used to narrow the effect of the entry to be created. The map must map JCR names to a single Value object.

Returns:

true if this policy has changed by incorporating the given entry; false otherwise.

Throws:

RepositoryException - If another error occurs.

See Also:

• AccessControlList.addAccessControlEntry(Principal, Privilege[])