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:

JackrabbitAccessControlList, JackrabbitAccessControlPolicy

Direct Known Subclasses:

ImmutableACL

public abstract class AbstractAccessControlList
extends java.lang.Object
implements JackrabbitAccessControlList

Abstract base implementation of the JackrabbitAccessControlList interface.

Constructor Summary

Constructors

Constructor and Description
AbstractAccessControlList(java.lang.String oakPath, NamePathMapper namePathMapper)

Method Summary

Modifier and Type	Method and Description
boolean	addAccessControlEntry(java.security.Principal principal, Privilege[] privileges)
boolean	addEntry(java.security.Principal principal, Privilege[] privileges, boolean isAllow) Same as JackrabbitAccessControlList.addEntry(Principal, Privilege[], boolean, Map) using some implementation specific restrictions.
boolean	addEntry(java.security.Principal principal, Privilege[] privileges, boolean isAllow, java.util.Map<java.lang.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()
abstract java.util.List<? extends JackrabbitAccessControlEntry>	getEntries()
NamePathMapper	getNamePathMapper()
java.lang.String	getOakPath()
java.lang.String	getPath() Returns the path of the node this policy has been created for.
java.lang.String[]	getRestrictionNames() Returns the names of the supported restrictions or an empty array if no restrictions are respected.
abstract RestrictionProvider	getRestrictionProvider()
int	getRestrictionType(java.lang.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.
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 org.apache.jackrabbit.api.security.JackrabbitAccessControlList

addEntry, orderBefore

Constructor Detail

AbstractAccessControlList

public AbstractAccessControlList(java.lang.String oakPath,
                                 NamePathMapper namePathMapper)

Method Detail

getOakPath

public java.lang.String getOakPath()

getNamePathMapper

public NamePathMapper getNamePathMapper()

getEntries

public abstract java.util.List<? extends JackrabbitAccessControlEntry> getEntries()

getRestrictionProvider

public abstract RestrictionProvider getRestrictionProvider()

getPath

public java.lang.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()
                                             throws RepositoryException

Throws:

RepositoryException

addAccessControlEntry

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

Throws:

RepositoryException

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

public java.lang.String[] getRestrictionNames()
                                       throws RepositoryException

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.

Throws:

RepositoryException - If an error occurs.

See Also:

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

getRestrictionType

public int getRestrictionType(java.lang.String restrictionName)
                       throws RepositoryException

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.

Throws:

RepositoryException - If an error occurs.

addEntry

public boolean addEntry(java.security.Principal principal,
                        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(java.security.Principal principal,
                        Privilege[] privileges,
                        boolean isAllow,
                        java.util.Map<java.lang.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 javax.jcr.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[])