org.apache.jackrabbit.core.security
Class AbstractAccessControlManager

java.lang.Object
  org.apache.jackrabbit.core.security.AbstractAccessControlManager

All Implemented Interfaces:

AccessControlManager, JackrabbitAccessControlManager

Direct Known Subclasses:

DefaultAccessManager, SimpleAccessManager

public abstract class AbstractAccessControlManager
extends java.lang.Object
implements JackrabbitAccessControlManager

AbstractAccessControlManager...

Constructor Summary

AbstractAccessControlManager()

Method Summary

protected abstract void	checkInitialized() Check if this manager has been properly initialized.
protected abstract void	checkPrivileges(java.lang.String absPath, int privileges) Check if the specified privileges are granted at absPath.
protected abstract void	checkValidNodePath(java.lang.String absPath) Build a qualified path from the specified absPath and test if it is really absolute and points to an existing node.
AccessControlPolicy[]	getApplicablePolicies(java.security.Principal principal) Returns the editable policies for the specified principal.
AccessControlPolicyIterator	getApplicablePolicies(java.lang.String absPath) Returns an empty iterator.
AccessControlPolicy[]	getPolicies(java.lang.String absPath) Returns null.
protected abstract PrivilegeRegistry	getPrivilegeRegistry()
Privilege[]	getSupportedPrivileges(java.lang.String absPath) Always returns all registered Privileges.
Privilege	privilegeFromName(java.lang.String privilegeName) Returns the privilege with the specified privilegeName.
void	removePolicy(java.lang.String absPath, AccessControlPolicy policy) Always throws AccessControlException
void	setPolicy(java.lang.String absPath, AccessControlPolicy policy) Always throws AccessControlException

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.api.jsr283.security.AccessControlManager

getEffectivePolicies, getPrivileges, hasPrivileges

Constructor Detail

AbstractAccessControlManager

public AbstractAccessControlManager()

Method Detail

getSupportedPrivileges

public Privilege[] getSupportedPrivileges(java.lang.String absPath)
                                   throws javax.jcr.PathNotFoundException,
                                          javax.jcr.RepositoryException

Always returns all registered Privileges.

Specified by:

getSupportedPrivileges in interface AccessControlManager

Parameters:

absPath -

Returns:

Always returns all registered Privileges.

Throws:

javax.jcr.PathNotFoundException - if no node at absPath exists or the session does not have privilege to retrieve the node.

javax.jcr.RepositoryException - if another error occurs.

See Also:

AccessControlManager.getSupportedPrivileges(String)

privilegeFromName

public Privilege privilegeFromName(java.lang.String privilegeName)
                            throws AccessControlException,
                                   javax.jcr.RepositoryException

Description copied from interface: AccessControlManager

Returns the privilege with the specified privilegeName.

A AccessControlException is thrown if no privilege with the specified name exists.

A RepositoryException is thrown if another error occurs.

Specified by:

privilegeFromName in interface AccessControlManager

Parameters:

privilegeName - the name of an existing privilege.

Returns:

the Privilege with the specified privilegeName.

Throws:

AccessControlException - if no privilege with the specified name exists.

javax.jcr.RepositoryException - if another error occurs.

See Also:

AccessControlManager.privilegeFromName(String)

getPolicies

public AccessControlPolicy[] getPolicies(java.lang.String absPath)
                                  throws javax.jcr.PathNotFoundException,
                                         javax.jcr.AccessDeniedException,
                                         javax.jcr.RepositoryException

Returns null.

Specified by:

getPolicies in interface AccessControlManager

Parameters:

absPath -

Returns:

always returns null.

Throws:

javax.jcr.PathNotFoundException - if no node at absPath exists or the session does not have privilege to retrieve the node.

javax.jcr.AccessDeniedException - if the session lacks READ_ACCESS_CONTROL privilege for the absPath node.

javax.jcr.RepositoryException - if another error occurs.

See Also:

AccessControlManager.getApplicablePolicies(String)

getApplicablePolicies

public AccessControlPolicyIterator getApplicablePolicies(java.lang.String absPath)
                                                  throws javax.jcr.PathNotFoundException,
                                                         javax.jcr.AccessDeniedException,
                                                         javax.jcr.RepositoryException

Returns an empty iterator.

Specified by:

getApplicablePolicies in interface AccessControlManager

Parameters:

absPath -

Returns:

always returns an empty iterator.

Throws:

javax.jcr.PathNotFoundException - if no node at absPath exists or the session does not have privilege to retrieve the node.

javax.jcr.AccessDeniedException - if the session lacks READ_ACCESS_CONTROL privilege for the absPath node.

javax.jcr.RepositoryException - if another error occurs.

See Also:

AccessControlManager.getApplicablePolicies(String)

setPolicy

public void setPolicy(java.lang.String absPath,
                      AccessControlPolicy policy)
               throws javax.jcr.PathNotFoundException,
                      AccessControlException,
                      javax.jcr.AccessDeniedException,
                      javax.jcr.RepositoryException

Always throws AccessControlException

Specified by:

setPolicy in interface AccessControlManager

Parameters:

absPath - an absolute path.

policy - the AccessControlPolicy to be applied.

Throws:

javax.jcr.PathNotFoundException - if no node at absPath exists or the session does not have privilege to retrieve the node.

AccessControlException - if the policy is not applicable.

javax.jcr.AccessDeniedException - if the session lacks MODIFY_ACCESS_CONTROL privilege for the absPath node.

javax.jcr.lock.LockException - if a lock applies at the node at absPath and this implementation performs this validation immediately instead of waiting until save.

javax.jcr.version.VersionException - if the node at absPath is versionable and checked-in or is non-versionable but its nearest versionable ancestor is checked-in and this implementation performs this validation immediately instead of waiting until save.

javax.jcr.RepositoryException - if another error occurs.

See Also:

AccessControlManager.setPolicy(String, AccessControlPolicy)

removePolicy

public void removePolicy(java.lang.String absPath,
                         AccessControlPolicy policy)
                  throws javax.jcr.PathNotFoundException,
                         AccessControlException,
                         javax.jcr.AccessDeniedException,
                         javax.jcr.RepositoryException

Always throws AccessControlException

Specified by:

removePolicy in interface AccessControlManager

Parameters:

absPath - an absolute path.

policy - the policy to be removed.

Throws:

javax.jcr.PathNotFoundException - if no node at absPath exists or the session does not have privilege to retrieve the node.

AccessControlException - if no policy exists.

javax.jcr.AccessDeniedException - if the session lacks MODIFY_ACCESS_CONTROL privilege for the absPath node.

javax.jcr.lock.LockException - if a lock applies at the node at absPath and this implementation performs this validation immediately instead of waiting until save.

javax.jcr.version.VersionException - if the node at absPath is versionable and checked-in or is non-versionable but its nearest versionable ancestor is checked-in and this implementation performs this validation immediately instead of waiting until save.

javax.jcr.RepositoryException - if another error occurs.

See Also:

AccessControlManager.removePolicy(String, AccessControlPolicy)

getApplicablePolicies

public AccessControlPolicy[] getApplicablePolicies(java.security.Principal principal)
                                            throws javax.jcr.AccessDeniedException,
                                                   AccessControlException,
                                                   javax.jcr.UnsupportedRepositoryOperationException,
                                                   javax.jcr.RepositoryException

Returns the editable policies for the specified principal.

Specified by:

getApplicablePolicies in interface JackrabbitAccessControlManager

Returns:

array of policies for the specified principal. Note that the policy object returned must reveal the path of the node where they can be applied later on.

Throws:

javax.jcr.AccessDeniedException - if the session lacks MODIFY_ACCESS_CONTROL privilege.

AccessControlException - if the specified principal does not exist or if same other access control related exception occurs.

javax.jcr.UnsupportedRepositoryOperationException - if editing the policy is not supported.

javax.jcr.RepositoryException - if another error occurs.

checkInitialized

protected abstract void checkInitialized()
                                  throws java.lang.IllegalStateException

Check if this manager has been properly initialized.

Throws:

java.lang.IllegalStateException - If this manager has not been properly initialized.

checkPrivileges

protected abstract void checkPrivileges(java.lang.String absPath,
                                        int privileges)
                                 throws javax.jcr.AccessDeniedException,
                                        javax.jcr.PathNotFoundException,
                                        javax.jcr.RepositoryException

Check if the specified privileges are granted at absPath.

Parameters:

absPath -

privileges -

Throws:

javax.jcr.AccessDeniedException - if the session does not have the specified privileges.

javax.jcr.PathNotFoundException - if no node exists at absPath of if the session does not have the privilege to READ it.

javax.jcr.RepositoryException

getPrivilegeRegistry

protected abstract PrivilegeRegistry getPrivilegeRegistry()
                                                   throws javax.jcr.RepositoryException

Returns:

the privilege registry

Throws:

javax.jcr.RepositoryException

checkValidNodePath

protected abstract void checkValidNodePath(java.lang.String absPath)
                                    throws javax.jcr.PathNotFoundException,
                                           javax.jcr.RepositoryException

Build a qualified path from the specified absPath and test if it is really absolute and points to an existing node.

Parameters:

absPath -

Throws:

javax.jcr.PathNotFoundException - if no node at absPath exists or the session does not have privilege to retrieve the node.

javax.jcr.RepositoryException - If the given absPath is not absolute or if some other error occurs.