org.apache.jackrabbit.core.security.authorization
Class AbstractCompiledPermissions

java.lang.Object
  org.apache.jackrabbit.core.security.authorization.AbstractCompiledPermissions

All Implemented Interfaces:

CompiledPermissions

public abstract class AbstractCompiledPermissions
extends Object
implements CompiledPermissions

AbstractCompiledPermissions...

Nested Class Summary

static class

AbstractCompiledPermissions.Result Result of permission (and optionally privilege) evaluation for a given path.

Field Summary

Fields inherited from interface org.apache.jackrabbit.core.security.authorization.CompiledPermissions

NO_PERMISSION

Constructor Summary

protected

AbstractCompiledPermissions()

Method Summary

protected abstract AbstractCompiledPermissions.Result	buildRepositoryResult() Retrieve the result for repository level operations.
protected abstract AbstractCompiledPermissions.Result	buildResult(org.apache.jackrabbit.spi.Path absPath) Retrieve the result for the specified path.
boolean	canReadAll() Returns true if READ permission is granted everywhere.
protected void	clearCache() Removes all entries from the cache.
void	close() Indicate to this CompiledPermissions object that it is not used any more.
protected abstract PrivilegeManagerImpl	getPrivilegeManagerImpl() Retrieve the privilege manager.
int	getPrivileges(org.apache.jackrabbit.spi.Path absPath) Returns the Privilege bits granted by the underlying policy if the given absPath.
Set<Privilege>	getPrivilegeSet(org.apache.jackrabbit.spi.Path absPath) Returns the Privileges granted by the underlying policy at the given absPath.
AbstractCompiledPermissions.Result	getResult(org.apache.jackrabbit.spi.Path absPath)
boolean	grants(org.apache.jackrabbit.spi.Path absPath, int permissions) Returns true if the specified permissions are granted on the item identified by the given path.
boolean	hasPrivileges(org.apache.jackrabbit.spi.Path absPath, Privilege... privileges) Returns true if the given privileges are granted at the specified absPath.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.jackrabbit.core.security.authorization.CompiledPermissions

canRead

Constructor Detail

AbstractCompiledPermissions

protected AbstractCompiledPermissions()

Method Detail

getResult

public AbstractCompiledPermissions.Result getResult(org.apache.jackrabbit.spi.Path absPath)
                                             throws RepositoryException

Parameters:

absPath - Absolute path to return the result for.

Returns:

the Result for the give absPath.

Throws:

RepositoryException - if an error occurs.

buildResult

protected abstract AbstractCompiledPermissions.Result buildResult(org.apache.jackrabbit.spi.Path absPath)
                                                           throws RepositoryException

Retrieve the result for the specified path.

Parameters:

absPath - Absolute path to build the result for.

Returns:

Result for the specified absPath.

Throws:

RepositoryException - If an error occurs.

buildRepositoryResult

protected abstract AbstractCompiledPermissions.Result buildRepositoryResult()
                                                                     throws RepositoryException

Retrieve the result for repository level operations.

Returns:

The result instance for those permissions and privileges granted for repository level operations.

Throws:

RepositoryException

getPrivilegeManagerImpl

protected abstract PrivilegeManagerImpl getPrivilegeManagerImpl()
                                                         throws RepositoryException

Retrieve the privilege manager.

Returns:

An instance of privilege manager.

Throws:

RepositoryException - If an error occurs.

clearCache

protected void clearCache()

Removes all entries from the cache.

close

public void close()

Description copied from interface: CompiledPermissions

Indicate to this CompiledPermissions object that it is not used any more.

Specified by:

close in interface CompiledPermissions

See Also:

CompiledPermissions.close()

grants

public boolean grants(org.apache.jackrabbit.spi.Path absPath,
                      int permissions)
               throws RepositoryException

Description copied from interface: CompiledPermissions

Returns true if the specified permissions are granted on the item identified by the given path.

Specified by:

grants in interface CompiledPermissions

Parameters:

absPath - Absolute path pointing to an item. If the item does not exist yet (asking for 'add-node' and 'set-property' permission), it's direct ancestor must exist.

permissions - A combination of one or more of permission constants defined by Permission encoded as a bitmask value

Returns:

true if the specified permissions are granted, false otherwise.

Throws:

RepositoryException - if an error occurs.

See Also:

CompiledPermissions.grants(Path, int)

getPrivileges

public int getPrivileges(org.apache.jackrabbit.spi.Path absPath)
                  throws RepositoryException

Description copied from interface: CompiledPermissions

Returns the Privilege bits granted by the underlying policy if the given absPath.

Specified by:

getPrivileges in interface CompiledPermissions

Parameters:

absPath - Absolute path to a Node.

Returns:

the granted privileges at absPath.

Throws:

RepositoryException - if an error occurs

See Also:

CompiledPermissions.getPrivileges(Path)

hasPrivileges

public boolean hasPrivileges(org.apache.jackrabbit.spi.Path absPath,
                             Privilege... privileges)
                      throws RepositoryException

Description copied from interface: CompiledPermissions

Returns true if the given privileges are granted at the specified absPath.

Specified by:

hasPrivileges in interface CompiledPermissions

Returns:

true if the given privileges are granted at the specified absPath.

Throws:

RepositoryException

See Also:

CompiledPermissions.hasPrivileges(org.apache.jackrabbit.spi.Path, javax.jcr.security.Privilege[])

getPrivilegeSet

public Set<Privilege> getPrivilegeSet(org.apache.jackrabbit.spi.Path absPath)
                               throws RepositoryException

Description copied from interface: CompiledPermissions

Returns the Privileges granted by the underlying policy at the given absPath.

Specified by:

getPrivilegeSet in interface CompiledPermissions

Parameters:

absPath - Absolute path to a Node.

Returns:

the granted privileges at absPath.

Throws:

RepositoryException - if an error occurs

See Also:

CompiledPermissions.getPrivilegeSet(Path)

canReadAll

public boolean canReadAll()
                   throws RepositoryException

Description copied from interface: CompiledPermissions

Returns true if READ permission is granted everywhere. This method acts as shortcut for CompiledPermissions.grants(Path, int) where permissions is Permission.READ and allows to shorten the evaluation time given the fact that a check for READ permission is considered to be the most frequent test.

Specified by:

canReadAll in interface CompiledPermissions

Returns:

true if the READ permission is granted everywhere.

Throws:

RepositoryException - if an error occurs

See Also:

CompiledPermissions.canReadAll()