|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface AccessControlEditor
AccessControlEditor
is used to edit the access control policy
and entry objects provided by the respective service.
Method Summary | |
---|---|
AccessControlPolicy[] |
editAccessControlPolicies(Principal principal)
Returns an array of editable policies for the given principal . |
AccessControlPolicy[] |
editAccessControlPolicies(String nodePath)
Retrieves the editable policies for the Node identified by the given nodePath . |
AccessControlPolicy[] |
getPolicies(String nodePath)
Retrieves the policies for the Node identified by the given nodePath . |
void |
removePolicy(String nodePath,
AccessControlPolicy policy)
Removes the specified policy from the node at nodePath . |
void |
setPolicy(String nodePath,
AccessControlPolicy policy)
Stores the policy template to the respective node. |
Method Detail |
---|
AccessControlPolicy[] getPolicies(String nodePath) throws AccessControlException, PathNotFoundException, RepositoryException
nodePath
. In contrast to editAccessControlPolicies(java.lang.String)
this method
returns an empty array if no policy has been applied before by calling
setPolicy(java.lang.String, org.apache.jackrabbit.api.jsr283.security.AccessControlPolicy)
). Still the returned policies are detached from
the AccessControlProvider
and are only an external representation.
Modification will therefore not take effect, until they are written back to
the editor and persisted.
Compared to the policy returned by AccessControlProvider.getEffectivePolicies(org.apache.jackrabbit.spi.Path)
,
the scope of the policies it limited to the Node itself and does
not take inherited elements into account.
nodePath
- Absolute path to an existing node object.
AccessControlException
- If the Node identified by the given
nodePath
does not allow access control modifications (e.g.
the node itself stores the access control information for its parent).
PathNotFoundException
- if no node exists for the given
nodePath
.
RepositoryException
- if an error occursAccessControlPolicy[] editAccessControlPolicies(String nodePath) throws AccessControlException, PathNotFoundException, RepositoryException
nodePath
. If the node does not yet have any policy set an
new (empty) 'template' is created (see also getPolicies(String)
.AccessControlProvider
and is only an external
representation. Modification will therefore not take effect, until a
modified policy is written back to the editor and persisted.
Compared to the policies returned by AccessControlProvider.getEffectivePolicies(org.apache.jackrabbit.spi.Path)
,
the scope of the policies returned by this methods it limited to the Node
itself and does never not take inherited elements into account.
nodePath
- Absolute path to an existing node object.
AccessControlException
- If the Node identified by the given
nodePath
does not allow access control modifications.
PathNotFoundException
- if no node exists for the given
nodePath
.
RepositoryException
- if an error occursAccessControlPolicy[] editAccessControlPolicies(Principal principal) throws AccessDeniedException, AccessControlException, RepositoryException
principal
.
principal
.
AccessControlException
- if the specified principal does not exist,
if this implementation cannot provide policies for individual principals or
if same other access control related exception occurs.
RepositoryException
- if another error occurs.
AccessDeniedException
void setPolicy(String nodePath, AccessControlPolicy policy) throws AccessControlException, PathNotFoundException, RepositoryException
nodePath
- Absolute path to an existing node object.policy
- the AccessControlPolicy
to store.
AccessControlException
- If the policy is null
or
if it is not applicable to the Node identified by the given
nodePath
.
PathNotFoundException
- if no node exists for the given
nodePath
.
RepositoryException
- if an other error occurs.void removePolicy(String nodePath, AccessControlPolicy policy) throws AccessControlException, PathNotFoundException, RepositoryException
nodePath
.
nodePath
- Absolute path to an existing node object.policy
- The policy to be removed at nodePath
.
AccessControlException
- If the Node identified by the given
nodePath
does not allow policy modifications or does not have
the specified policy attached.
PathNotFoundException
- if no node exists for the given
nodePath
.
RepositoryException
- if an other error occurs
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |