| com.ecyrd.jspwiki.auth.acl.Acl
All known Subclasses: com.ecyrd.jspwiki.auth.acl.AclImpl,
| Acl | | public interface Acl (Code) | |
Defines an access control list (ACL) for wiki pages. An Access Control List
is a data structure used to guard access to resources. An ACL can be thought
of as a data structure with multiple ACL entries. Each ACL entry, of
interface type AclEntry, contains a set of positive permissions associated
with a particular principal. (A principal represents an entity such as an
individual user or a group). The ACL Entries in each ACL observe the
following rules:
- Each principal can have at most one ACL entry; that is, multiple ACL
entries are not allowed for any principal. Each entry specifies the set of
permissions that are to be granted
- If there is no entry for a particular principal, then the principal is
considered to have a null (empty) permission set
This interface is a highly stripped-down derivation of the
java.security.acl.Acl interface. In particular, the notion of an Acl "owner"
has been eliminated, since JWPWiki pages do not have owners. An additional
simplification compared to the standard Java package is that negative
permissions have been eliminated. Instead, JSPWiki assumes a "default-deny"
security stance: principals are granted no permissions by default, and
posesses only those that have been explicitly granted to them. And finally,
the getPermissions() and checkPermission() methods have been eliminated due
to the complexities associated with resolving Role principal membership.
author:
Janne Jalkanen
author:
Andrew Jaquith
since:
2.3 |
| Method Summary | |
| public boolean | addEntry(AclEntry entry)
Adds an ACL entry to this ACL. | | public Enumeration | entries()
Returns an enumeration of the entries in this ACL. | | public Principal[] | findPrincipals(Permission permission)
Returns all Principal objects assigned a given Permission in the access
control list. | | public AclEntry | getEntry(Principal principal)
Returns an AclEntry for a supplied Principal, or null if
the Principal does not have a matching AclEntry. | | public boolean | isEmpty()
Returns true, if this Acl is empty. | | public boolean | removeEntry(AclEntry entry)
Removes an ACL entry from this ACL. | | public String | toString()
Returns a string representation of the contents of this Acl. |
| addEntry | | public boolean addEntry(AclEntry entry)(Code) | | Adds an ACL entry to this ACL. An entry associates a principal (e.g., an
individual or a group) with a set of permissions. Each principal can have
at most one positive ACL entry, specifying permissions to be granted to
the principal. If there is already an ACL entry already in the ACL, false
is returned.
Parameters:
entry - - the ACL entry to be added to this ACL true on success, false if an entry of the same type (positive ornegative) for the same principal is already present in this ACL |
| entries | | public Enumeration entries()(Code) | | Returns an enumeration of the entries in this ACL. Each element in the
enumeration is of type AclEntry.
an enumeration of the entries in this ACL. |
| findPrincipals | | public Principal[] findPrincipals(Permission permission)(Code) | | Returns all Principal objects assigned a given Permission in the access
control list. The Princiapls returned are those that have been granted
either the supplied permission, or a permission implied by the supplied
permission. Principals are not "expanded" if they are a role or group.
Parameters:
permission - the permission to search for an array of Principals posessing the permission |
| getEntry | | public AclEntry getEntry(Principal principal)(Code) | | Returns an AclEntry for a supplied Principal, or null if
the Principal does not have a matching AclEntry.
Parameters:
principal - the principal to search for the AclEntry associated with the principal, or null |
| isEmpty | | public boolean isEmpty()(Code) | | Returns true, if this Acl is empty.
the result
since:
2.4.68 |
| removeEntry | | public boolean removeEntry(AclEntry entry)(Code) | | Removes an ACL entry from this ACL.
Parameters:
entry - the ACL entry to be removed from this ACL true on success, false if the entry is not part of this ACL |
| toString | | public String toString()(Code) | | Returns a string representation of the contents of this Acl.
the string representation |
|
|