public interface Acl extends Owner
Interface representing an Access Control List (ACL). 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 permissions associated with a particular principal. (A principal represents an entity such as an individual user or a group). Additionally, each ACL entry is specified as being either positive or negative. If positive, the permissions are to be granted to the associated principal. If negative, the permissions are to be denied.
The ACL Entries in each ACL observe the following rules:
java.security.acl
package provides the interfaces to the ACL and related data structures (ACL entries, groups, permissions, etc.), and the sun.security.acl
classes provide a default implementation of the interfaces. For example, java.security.acl.Acl
provides the interface to an ACL and the sun.security.acl.AclImpl
class provides the default implementation of the interface. The java.security.acl.Acl
interface extends the java.security.acl.Owner
interface. The Owner interface is used to maintain a list of owners for each ACL. Only owners are allowed to modify an ACL. For example, only an owner can call the ACL's addEntry
method to add a new ACL entry to the ACL.
AclEntry
, Owner
, getPermissions(java.security.Principal)
void setName(Principal caller, String name) throws NotOwnerException
Sets the name of this ACL.
caller
- the principal invoking this method. It must be an owner of this ACL.name
- the name to be given to this ACL.NotOwnerException
- if the caller principal is not an owner of this ACL.getName()
String getName()
Returns the name of this ACL.
setName(java.security.Principal, java.lang.String)
boolean addEntry(Principal caller, AclEntry entry) throws NotOwnerException
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) and one negative ACL entry (specifying permissions to be denied). If there is already an ACL entry of the same type (negative or positive) already in the ACL, false is returned.
caller
- the principal invoking this method. It must be an owner of this ACL.entry
- the ACL entry to be added to this ACL.NotOwnerException
- if the caller principal is not an owner of this ACL.boolean removeEntry(Principal caller, AclEntry entry) throws NotOwnerException
Removes an ACL entry from this ACL.
caller
- the principal invoking this method. It must be an owner of this ACL.entry
- the ACL entry to be removed from this ACL.NotOwnerException
- if the caller principal is not an owner of this Acl.Enumeration<Permission> getPermissions(Principal user)
The individual positive and negative permission sets are also determined. The positive permission set contains the permissions specified in the positive ACL entry (if any) for the principal. Similarly, the negative permission set contains the permissions specified in the negative ACL entry (if any) for the principal. The individual positive (or negative) permission set is considered to be null if there is not a positive (negative) ACL entry for the principal in this ACL.
The set of permissions granted to the principal is then calculated using the simple rule that individual permissions always override the group permissions. That is, the principal's individual negative permission set (specific denial of permissions) overrides the group positive permission set, and the principal's individual positive permission set overrides the group negative permission set.
user
- the principal whose permission set is to be returned.Enumeration<AclEntry> entries()
Returns an enumeration of the entries in this ACL. Each element in the enumeration is of type AclEntry.
boolean checkPermission(Principal principal, Permission permission)
Checks whether or not the specified principal has the specified permission. If it does, true is returned, otherwise false is returned. More specifically, this method checks whether the passed permission is a member of the allowed permission set of the specified principal. The allowed permission set is determined by the same algorithm as is used by the getPermissions
method.
principal
- the principal, assumed to be a valid authenticated Principal.permission
- the permission to be checked for.getPermissions(java.security.Principal)
String toString()
Returns a string representation of the ACL contents.
© 1993–2017, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.