org.apache.jackrabbit.core.security.authorization.combined
Class CombinedProvider

java.lang.Object
  org.apache.jackrabbit.core.security.authorization.AbstractAccessControlProvider
      org.apache.jackrabbit.core.security.authorization.combined.CombinedProvider

All Implemented Interfaces:

AccessControlProvider, AccessControlUtils

public class CombinedProvider
extends AbstractAccessControlProvider

CombinedProvider...

Field Summary

Fields inherited from class org.apache.jackrabbit.core.security.authorization.AbstractAccessControlProvider

observationMgr, PARAM_OMIT_DEFAULT_PERMISSIONS, privAll, privRead, resolver, session

Constructor Summary

CombinedProvider()

Method Summary

boolean	canAccessRoot(Set<Principal> principals) Returns true if the given set of principals can access the root node of the workspace this provider has been built for; false otherwise.
void	close() Closes this provider when it is no longer used by the respective workspace and release resources bound by this provider.
CompiledPermissions	compilePermissions(Set<Principal> principals) Compiles the effective policy for the specified set of Principals.
AccessControlEditor	getEditor(Session editingSession) Returns an AccessControlEditor for the given Session object or null if the implementation does not support editing of access control policies.
AccessControlPolicy[]	getEffectivePolicies(Path absPath) Returns the effective policies for the node at the given absPath.
void	init(Session systemSession, Map configuration) Tests if the given systemSession is a SessionImpl and retrieves the observation manager.
boolean	isAcItem(ItemImpl item) Test if the specified path points to an item that defines AC information and consequently should be considered protected.
boolean	isAcItem(Path absPath) Test if the specified path points to an item that defines AC information.

Methods inherited from class org.apache.jackrabbit.core.security.authorization.AbstractAccessControlProvider

checkInitialized, getAdminPermissions, getReadOnlyPermissions, isAdminOrSystem, isLive, isReadOnly

Methods inherited from class java.lang.Object

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

Constructor Detail

CombinedProvider

public CombinedProvider()

Method Detail

isAcItem

public boolean isAcItem(Path absPath)
                 throws RepositoryException

Description copied from interface: AccessControlUtils

Test if the specified path points to an item that defines AC information.

Parameters:

absPath - Path to an item.

Returns:

true if the item at the specified absPath contains access control information.

Throws:

RepositoryException - If an error occurs.

See Also:

AccessControlUtils.isAcItem(Path)

isAcItem

public boolean isAcItem(ItemImpl item)
                 throws RepositoryException

Description copied from interface: AccessControlUtils

Test if the specified path points to an item that defines AC information and consequently should be considered protected.

Parameters:

item - An item.

Returns:

true if the item at the specified item defines access control related information is should therefore be considered protected.

Throws:

RepositoryException - If an error occurs.

See Also:

AccessControlUtils.isAcItem(ItemImpl)

close

public void close()

Description copied from interface: AccessControlProvider

Closes this provider when it is no longer used by the respective workspace and release resources bound by this provider.

Specified by:

close in interface AccessControlProvider

Overrides:

close in class AbstractAccessControlProvider

See Also:

AccessControlProvider.close()

init

public void init(Session systemSession,
                 Map configuration)
          throws RepositoryException

Description copied from class: AbstractAccessControlProvider

Tests if the given systemSession is a SessionImpl and retrieves the observation manager. The it sets the internal 'initialized' field to true.

Specified by:

init in interface AccessControlProvider

Overrides:

init in class AbstractAccessControlProvider

Parameters:

systemSession - System session.

configuration - Configuration used to initialize this provider.

Throws:

RepositoryException - If the specified session is not a SessionImpl or if retrieving the observation manager fails.

See Also:

AccessControlProvider.init(javax.jcr.Session, java.util.Map)

getEffectivePolicies

public AccessControlPolicy[] getEffectivePolicies(Path absPath)
                                           throws ItemNotFoundException,
                                                  RepositoryException

Description copied from interface: AccessControlProvider

Returns the effective policies for the node at the given absPath.

Parameters:

absPath - an absolute path.

Returns:

The effective policies that apply at absPath or an empty array if the implementation cannot determine the effective policy at the given path.

Throws:

ItemNotFoundException - If no Node with the specified absPath exists.

RepositoryException - If another error occurs.

See Also:

AccessControlProvider.getEffectivePolicies(Path)

getEditor

public AccessControlEditor getEditor(Session editingSession)

Description copied from interface: AccessControlProvider

Returns an AccessControlEditor for the given Session object or null if the implementation does not support editing of access control policies.

Parameters:

editingSession - The editing session.

Returns:

the ACL editor or null.

See Also:

AccessControlProvider.getEditor(javax.jcr.Session)

compilePermissions

public CompiledPermissions compilePermissions(Set<Principal> principals)
                                       throws RepositoryException

Description copied from interface: AccessControlProvider

Compiles the effective policy for the specified set of Principals.

Parameters:

principals - Set of principals to compile the permissions for. If the order of evaluating permissions for principals is meaningful, the caller is adviced to pass a Set that respects the order of insertion.

Returns:

The effective, compiled CompiledPolicy that applies for the specified set of principals.

Throws:

RepositoryException - If an error occurs.

See Also:

AccessControlProvider.compilePermissions(Set)

canAccessRoot

public boolean canAccessRoot(Set<Principal> principals)
                      throws RepositoryException

Description copied from interface: AccessControlProvider

Returns true if the given set of principals can access the root node of the workspace this provider has been built for; false otherwise.

Parameters:

principals - Set of principals to be tested for being allowed to access the root node.

Returns:

true if the given set of principals can access the root node of the workspace this provider has been built for; false otherwise.

Throws:

RepositoryException - If an error occurs.

See Also:

AccessControlProvider.canAccessRoot(Set)