All Packages  Class Hierarchy  This Package  Previous  Next  Index

Interface java.security.acl.AclEntry

public interface AclEntry
extends Cloneable
This is the interface used for representing one entry in an Access Control List (ACL).

An ACL can be thought of as a data structure with multiple ACL entry objects. Each ACL entry object 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. Each principal can have at most one positive ACL entry and one negative entry; that is, multiple positive or negative ACL entries are not allowed for any principal. Note: ACL entries are by default positive. An entry becomes a negative entry only if the setNegativePermissions method is called on it.

See Also:
Acl

Method Index

o addPermission(Permission)
Adds the specified permission to this ACL entry.
o checkPermission(Permission)
Checks if the specified permission is part of the permission set in this entry.
o clone()
Clones this ACL entry.
o getPrincipal()
Returns the principal for which permissions are granted or denied by this ACL entry.
o isNegative()
Returns true if this is a negative ACL entry (one denying the associated principal the set of permissions in the entry), false otherwise.
o permissions()
Returns an enumeration of the permissions in this ACL entry.
o removePermission(Permission)
Removes the specified permission from this ACL entry.
o setNegativePermissions()
Sets this ACL entry to be a negative one.
o setPrincipal(Principal)
Specifies the principal for which permissions are granted or denied by this ACL entry.
o toString()
Returns a string representation of the contents of this ACL entry.

Methods

o setPrincipal 
    method setPrincipal(user=Principal) returns boolean public abstract
Specifies the principal for which permissions are granted or denied by this ACL entry. If a principal was already set for this ACL entry, false is returned, otherwise true is returned.

Parameters:
user - the principal to be set for this entry.
Returns:
true if the principal is set, false if there was already a principal set for this entry.
o getPrincipal 
    method getPrincipal() returns Principal public abstract
Returns the principal for which permissions are granted or denied by this ACL entry. Returns null if there is no principal set for this entry yet.

Returns:
the principal associated with this entry.
o setNegativePermissions 
    method setNegativePermissions()  public abstract
Sets this ACL entry to be a negative one. That is, the associated principal (e.g., a user or a group) will be denied the permission set specified in the entry. Note: ACL entries are by default positive. An entry becomes a negative entry only if this setNegativePermissions method is called on it.

o isNegative 
    method isNegative() returns boolean public abstract
Returns true if this is a negative ACL entry (one denying the associated principal the set of permissions in the entry), false otherwise.

Returns:
true if this is a negative ACL entry, false if it's not.
o addPermission 
    method addPermission(permission=Permission) returns boolean public abstract
Adds the specified permission to this ACL entry. Note: An entry can have multiple permissions.

Parameters:
permission - the permission to be associated with the principal in this entry.
Returns:
true if the permission was added, false if the permission was already part of this entry's permission set.
o removePermission 
    method removePermission(permission=Permission) returns boolean public abstract
Removes the specified permission from this ACL entry.

Parameters:
permission - the permission to be removed from this entry.
Returns:
true if the permission is removed, false if the permission was not part of this entry's permission set.
o checkPermission 
    method checkPermission(permission=Permission) returns boolean public abstract
Checks if the specified permission is part of the permission set in this entry.

Parameters:
permission - the permission to be checked for.
Returns:
true if the permission is part of the permission set in this entry, false otherwise.
o permissions 
    method permissions() returns Enumeration public abstract
Returns an enumeration of the permissions in this ACL entry.

Returns:
an enumeration of the permissions in this ACL entry.
o toString 
    method toString() returns String public abstract
Returns a string representation of the contents of this ACL entry.

Returns:
a string representation of the contents.
Overrides:
toString in class Object
o clone 
    method clone() returns Object public abstract
Clones this ACL entry.

Returns:
a clone of this ACL entry.
Overrides:
clone in class Object 
All Packages  Class Hierarchy  This Package  Previous  Next  Index