java.security.acl
Interface AclEntry

All Superinterfaces:
Cloneable

public interface AclEntry
extends Cloneable

This interface models an entry in an access control list (ACL). Java ACL's consist of a list of entries, where each consists of a Principal and a list of Permission's which have been granted to that Principal. An ACL can also be negative, which indicates that the list of Permission's is a list of permissions that are not granted to the Principal. A Principal can have at most one regular (or positive) ACL entry and one negative ACL entry.


Method Summary
 boolean addPermission(Permission permission)
          This method adds the specified permission to this ACL entry.
 boolean checkPermission(Permission permission)
          This method tests whether or not the specified permission is associated with this ACL entry.
 Object clone()
          This method returns a clone of this ACL entry
 Principal getPrincipal()
          This method returns the Principal associated with this ACL entry.
 boolean isNegative()
          This method tests whether or not this ACL entry is a negative entry or not.
 Enumeration<Permission> permissions()
          This method returns a list of all Permission objects associated with this ACL entry as an Enumeration.
 boolean removePermission(Permission perm)
          This method deletes the specified permission to this ACL entry.
 void setNegativePermissions()
          This method sets this ACL entry to be a negative entry, indicating that it contains a list of permissions that are not granted to the entry's Principal.
 boolean setPrincipal(Principal user)
          This method sets ths Principal associated with this ACL entry.
 String toString()
          This method returns this object as a String.
 

Method Detail

getPrincipal

Principal getPrincipal()
This method returns the Principal associated with this ACL entry.

Returns:
The Principal for this ACL entry

setPrincipal

boolean setPrincipal(Principal user)
This method sets ths Principal associated with this ACL entry. This operation will only succeed if there is not already a Principal assigned.

Parameters:
user - The Principal for this ACL entry
Returns:
true if the Principal was successfully set or false if this entry already has a Principal.

setNegativePermissions

void setNegativePermissions()
This method sets this ACL entry to be a negative entry, indicating that it contains a list of permissions that are not granted to the entry's Principal. Note that there is no way to undo this operation.


isNegative

boolean isNegative()
This method tests whether or not this ACL entry is a negative entry or not.

Returns:
true if this ACL entry is negative, false otherwise

addPermission

boolean addPermission(Permission permission)
This method adds the specified permission to this ACL entry.

Parameters:
permission - The Permission to add
Returns:
true if the permission was added or false if it was already set for this entry

removePermission

boolean removePermission(Permission perm)
This method deletes the specified permission to this ACL entry.

Parameters:
perm - The Permission to delete from this ACL entry.
Returns:
true if the permission was successfully deleted or false if the permission was not part of this ACL to begin with

checkPermission

boolean checkPermission(Permission permission)
This method tests whether or not the specified permission is associated with this ACL entry.

Parameters:
permission - The Permission to test
Returns:
true if this permission is associated with this entry or false otherwise

permissions

Enumeration<Permission> permissions()
This method returns a list of all Permission objects associated with this ACL entry as an Enumeration.

Returns:
A list of permissions for this ACL entry

toString

String toString()
This method returns this object as a String.

Overrides:
toString in class Object
Returns:
A String representation of this object
See Also:
Object.getClass(), Object.hashCode(), Class.getName(), Integer.toHexString(int)

clone

Object clone()
This method returns a clone of this ACL entry

Returns:
A clone of this ACL entry