|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface AccessControlList
The AccessControlList
is an AccessControlPolicy
representing a list of access control entries
.
It is mutable before being set
to the AccessControlManager and consequently defines methods to read and
mutate the list i.e. to get, add or remove individual entries.
Method Summary | |
---|---|
boolean |
addAccessControlEntry(Principal principal,
Privilege[] privileges)
Adds an access control entry to this policy consisting of the specified principal and the specified privileges . |
AccessControlEntry[] |
getAccessControlEntries()
Returns all access control entries present with this policy. |
void |
removeAccessControlEntry(AccessControlEntry ace)
Removes the specified AccessControlEntry from this policy. |
Method Detail |
---|
AccessControlEntry[] getAccessControlEntries() throws RepositoryException
AccessControlEntry
if that AccessControlEntry
has been assigned through this
API.
A RepositoryException
is thrown if an error occurs.
RepositoryException
- if an error occurs.boolean addAccessControlEntry(Principal principal, Privilege[] privileges) throws AccessControlException, RepositoryException
principal
and the specified privileges
.
This method returns true
if this policy was modified,
false
otherwise.
How the entries are grouped within the list is an implementation detail.
An implementation may e.g. combine the specified privileges with those
added by a previous call to addAccessControlEntry
for the
same Principal
. However, a call to
addAccessControlEntry
for a given Principal
can
never remove a Privilege
added by a previous call.
The modification does not take effect until this policy has been
set to a node by calling AccessControlManager.setPolicy(String, AccessControlPolicy)
and save
is performed.
An AccessControlException
is thrown if the specified principal
or any of the privileges does not exist or if some other access control
related exception occurs.
A RepositoryException
is thrown if another error occurs.
principal
- a Principal
.privileges
- an array of Privilege
s.
true
if this policy was modify; false
otherwise.
AccessControlException
- if the specified principal or any of the
privileges does not existor if some other
access control related exception occurs.
RepositoryException
- if another error occurs.void removeAccessControlEntry(AccessControlEntry ace) throws AccessControlException, RepositoryException
AccessControlEntry
from this policy.
Only exactly those entries obtained through
getAccessControlEntries can be removed. This method does
not take effect until this policy has been re-set to a node by calling
AccessControlManager.setPolicy(String, AccessControlPolicy)
and save
is performed.
An AccessControlException
is thrown if the specified entry
is not present on this policy.
A RepositoryException
is thrown if another error occurs.
- Parameters:
ace
- the access control entry to be removed.
- Throws:
AccessControlException
- if the specified entry is not
present on the specified node.
RepositoryException
- if another error occurs.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |