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

Class ImmutableACL

java.lang.Object

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

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

All Implemented Interfaces:

AccessControlList, AccessControlPolicy, org.apache.jackrabbit.api.security.JackrabbitAccessControlList, org.apache.jackrabbit.api.security.JackrabbitAccessControlPolicy

public class ImmutableACL
extends AbstractAccessControlList

An implementation of the JackrabbitAccessControlList interface that only allows for reading. The write methods throw an AccessControlException.

Constructor Summary

Constructors

Constructor	Description
ImmutableACL(@NotNull AbstractAccessControlList accessControlList)	Construct a new ImmutableACL from the given AbstractAccessControlList.
ImmutableACL(@Nullable String oakPath, @NotNull List<? extends org.apache.jackrabbit.api.security.JackrabbitAccessControlEntry> entries, @NotNull RestrictionProvider restrictionProvider, @NotNull org.apache.jackrabbit.oak.namepath.NamePathMapper namePathMapper)	Construct a new ImmutableACL

Method Summary

Modifier and Type	Method	Description
boolean	addEntry(@NotNull Principal principal, @NotNull Privilege[] privileges, boolean isAllow, @Nullable Map<String,Value> restrictions)
boolean	addEntry(@NotNull Principal principal, @NotNull Privilege[] privileges, boolean isAllow, @Nullable Map<String,Value> restrictions, @Nullable Map<String,Value[]> mvRestrictions)
boolean	equals(Object obj)
@NotNull List<org.apache.jackrabbit.api.security.JackrabbitAccessControlEntry>	getEntries()
@NotNull RestrictionProvider	getRestrictionProvider()
int	hashCode()
void	orderBefore(@NotNull AccessControlEntry srcEntry, @Nullable AccessControlEntry destEntry)
void	removeAccessControlEntry(AccessControlEntry ace)

Methods inherited from class org.apache.jackrabbit.oak.spi.security.authorization.accesscontrol.AbstractAccessControlList

addAccessControlEntry, addEntry, getAccessControlEntries, getNamePathMapper, getOakPath, getPath, getRestrictionNames, getRestrictionType, isEmpty, isMultiValueRestriction, size

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ImmutableACL

public ImmutableACL(@Nullable
                    @Nullable String oakPath,
                    @NotNull
                    @NotNull List<? extends org.apache.jackrabbit.api.security.JackrabbitAccessControlEntry> entries,
                    @NotNull
                    @NotNull RestrictionProvider restrictionProvider,
                    @NotNull
                    @NotNull org.apache.jackrabbit.oak.namepath.NamePathMapper namePathMapper)

Construct a new ImmutableACL

Parameters:

oakPath - The Oak path of this policy or null.

entries - The access control entries contained in this policy.

restrictionProvider - The restriction provider.

namePathMapper - The NamePathMapper used for conversion.

ImmutableACL

public ImmutableACL(@NotNull
                    @NotNull AbstractAccessControlList accessControlList)

Construct a new ImmutableACL from the given AbstractAccessControlList.

Parameters:

accessControlList - The base list

Method Detail

removeAccessControlEntry

public void removeAccessControlEntry(AccessControlEntry ace)
                              throws AccessControlException

Throws:

AccessControlException

addEntry

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

Specified by:

addEntry in interface org.apache.jackrabbit.api.security.JackrabbitAccessControlList

Overrides:

addEntry in class AbstractAccessControlList

Throws:

AccessControlException

addEntry

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

Throws:

AccessControlException

orderBefore

public void orderBefore(@NotNull
                        @NotNull AccessControlEntry srcEntry,
                        @Nullable
                        @Nullable AccessControlEntry destEntry)
                 throws AccessControlException

Throws:

AccessControlException

getEntries

@NotNull
public @NotNull List<org.apache.jackrabbit.api.security.JackrabbitAccessControlEntry> getEntries()

Specified by:

getEntries in class AbstractAccessControlList

getRestrictionProvider

@NotNull
public @NotNull RestrictionProvider getRestrictionProvider()

Specified by:

getRestrictionProvider in class AbstractAccessControlList

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object