Package org.apache.jackrabbit.api.security

Interface JackrabbitAccessControlEntry

All Superinterfaces:

AccessControlEntry

All Known Subinterfaces:

PrincipalAccessControlList.Entry

All Known Implementing Classes:

ACE

@ProviderType
public interface JackrabbitAccessControlEntry
extends AccessControlEntry

JackrabbitAccessControlEntry is a Jackrabbit specific extension of the AccessControlEntry interface. It represents an single entry of a JackrabbitAccessControlList.

Method Summary

Modifier and Type	Method	Description
@NotNull PrivilegeCollection	getPrivilegeCollection()	Returns a PrivilegeCollection representing the privileges associated with this entry.
@Nullable Value	getRestriction(@NotNull String restrictionName)	Return the value of the restriction with the specified name or null if no such restriction exists.
@NotNull String[]	getRestrictionNames()	Return the names of the restrictions present with this access control entry.
@Nullable Value[]	getRestrictions(@NotNull String restrictionName)	Return the values of the restriction with the specified name or null if no such restriction exists.
boolean	isAllow()

Methods inherited from interface javax.jcr.security.AccessControlEntry

getPrincipal, getPrivileges

Method Detail

isAllow

boolean isAllow()

Returns:

true if this entry adds Privileges for the principal; false otherwise.

getRestrictionNames

@NotNull
@NotNull String[] getRestrictionNames()
                               throws RepositoryException

Return the names of the restrictions present with this access control entry.

Returns:

the names of the restrictions

Throws:

RepositoryException - if an error occurs.

getRestriction

@Nullable
@Nullable Value getRestriction(@NotNull
                               @NotNull String restrictionName)
                        throws ValueFormatException,
                               RepositoryException

Return the value of the restriction with the specified name or null if no such restriction exists. In case the restriction with the specified name contains multiple value this method will call ValueFormatException.

Parameters:

restrictionName - The of the restriction as obtained through getRestrictionNames().

Returns:

value of the restriction with the specified name or null if no such restriction exists.

Throws:

ValueFormatException - If the restriction with the specified name contains multiple values.

RepositoryException - if an error occurs.

See Also:

getRestrictions(String)

getRestrictions

@Nullable
@Nullable Value[] getRestrictions(@NotNull
                                  @NotNull String restrictionName)
                           throws RepositoryException

Return the values of the restriction with the specified name or null if no such restriction exists. For restrictions that contain just a single value this method is expected to return an array with a single element even if the underlying implementation stored the restriction in single-value JCR property.

Parameters:

restrictionName - The of the restriction as obtained through getRestrictionNames().

Returns:

the values of the restriction with the specified name as an array or null if no such restriction exists. The array may contain zero, one or multiple values.

Throws:

RepositoryException - if an error occurs.

See Also:

getRestriction(String)

getPrivilegeCollection

@NotNull
@NotNull PrivilegeCollection getPrivilegeCollection()
                                             throws RepositoryException

Returns a PrivilegeCollection representing the privileges associated with this entry.

Returns:

A PrivilegeCollection wrapping around the privileges defined for this instance of JackrabbitAccessControlEntry.

Throws:

RepositoryException - If an error occurs.

Since:

Oak 1.42.0

See Also:

AccessControlEntry.getPrivileges()