org.apache.jackrabbit.oak.spi.security.authorization.cug

Interface CugPolicy

All Superinterfaces:

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

public interface CugPolicy
extends org.apache.jackrabbit.api.security.JackrabbitAccessControlPolicy

Denies read access for all principals except for the specified principals.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	addPrincipals(Principal... principals) Add Principals that are allowed to access the restricted area.
Set<Principal>	getPrincipals() Returns the set of Principals that are allowed to access the items in the restricted area defined by this policy.
boolean	removePrincipals(Principal... principals) Remove the specified Principals for the set of allowed principals thus revoking their ability to read items in the restricted area defined by this policy.

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

getPath

Method Detail

getPrincipals

@Nonnull
Set<Principal> getPrincipals()

Returns the set of Principals that are allowed to access the items in the restricted area defined by this policy.

Returns:

The set of Principals that are allowed to access the restricted area.

addPrincipals

boolean addPrincipals(@Nonnull
                    Principal... principals)
                      throws AccessControlException

Add Principals that are allowed to access the restricted area.

Parameters:

principals - The Principals that are granted read access.

Returns:

true if this policy was modified; false otherwise.

Throws:

AccessControlException - If any of the specified principals is invalid.

removePrincipals

boolean removePrincipals(@Nonnull
                       Principal... principals)
                         throws AccessControlException

Remove the specified Principals for the set of allowed principals thus revoking their ability to read items in the restricted area defined by this policy.

Parameters:

principals - The Principals for which access should be revoked.

Returns:

true if this policy was modified; false otherwise.

Throws:

AccessControlException - If an error occurs.