java.security.acl
Interface AclEntry

All Superinterfaces:
Cloneable sample code for java.lang.Cloneable definition code for java.lang.Cloneable

public interface AclEntry
extends Cloneable sample code for java.lang.Cloneable definition code for java.lang.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 sample code for java.security.acl.AclEntry.setNegativePermissions() definition code for java.security.acl.AclEntry.setNegativePermissions() method is called on it.

See Also:
Acl sample code for java.security.acl.Acl definition code for java.security.acl.Acl

Method Summary
 boolean addPermission sample code for java.security.acl.AclEntry.addPermission(java.security.acl.Permission) definition code for java.security.acl.AclEntry.addPermission(java.security.acl.Permission) (Permission sample code for java.security.acl.Permission definition code for java.security.acl.Permission  permission)
          Adds the specified permission to this ACL entry.
 boolean checkPermission sample code for java.security.acl.AclEntry.checkPermission(java.security.acl.Permission) definition code for java.security.acl.AclEntry.checkPermission(java.security.acl.Permission) (Permission sample code for java.security.acl.Permission definition code for java.security.acl.Permission  permission)
          Checks if the specified permission is part of the permission set in this entry.
 Object sample code for java.lang.Object definition code for java.lang.Object clone sample code for java.security.acl.AclEntry.clone() definition code for java.security.acl.AclEntry.clone() ()
          Clones this ACL entry.
 Principal sample code for java.security.Principal definition code for java.security.Principal getPrincipal sample code for java.security.acl.AclEntry.getPrincipal() definition code for java.security.acl.AclEntry.getPrincipal() ()
          Returns the principal for which permissions are granted or denied by this ACL entry.
 boolean isNegative sample code for java.security.acl.AclEntry.isNegative() definition code for java.security.acl.AclEntry.isNegative() ()
          Returns true if this is a negative ACL entry (one denying the associated principal the set of permissions in the entry), false otherwise.
 Enumeration sample code for java.util.Enumeration definition code for java.util.Enumeration <Permission sample code for java.security.acl.Permission definition code for java.security.acl.Permission > permissions sample code for java.security.acl.AclEntry.permissions() definition code for java.security.acl.AclEntry.permissions() ()
          Returns an enumeration of the permissions in this ACL entry.
 boolean removePermission sample code for java.security.acl.AclEntry.removePermission(java.security.acl.Permission) definition code for java.security.acl.AclEntry.removePermission(java.security.acl.Permission) (Permission sample code for java.security.acl.Permission definition code for java.security.acl.Permission  permission)
          Removes the specified permission from this ACL entry.
 void setNegativePermissions sample code for java.security.acl.AclEntry.setNegativePermissions() definition code for java.security.acl.AclEntry.setNegativePermissions() ()
          Sets this ACL entry to be a negative one.
 boolean setPrincipal sample code for java.security.acl.AclEntry.setPrincipal(java.security.Principal) definition code for java.security.acl.AclEntry.setPrincipal(java.security.Principal) (Principal sample code for java.security.Principal definition code for java.security.Principal  user)
          Specifies the principal for which permissions are granted or denied by this ACL entry.
 String sample code for java.lang.String definition code for java.lang.String toString sample code for java.security.acl.AclEntry.toString() definition code for java.security.acl.AclEntry.toString() ()
          Returns a string representation of the contents of this ACL entry.
 

Method Detail

setPrincipal sample code for java.security.acl.AclEntry.setPrincipal(java.security.Principal) definition code for java.security.acl.AclEntry.setPrincipal(java.security.Principal)

boolean setPrincipal(Principal sample code for java.security.Principal definition code for java.security.Principal  user)
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.
See Also:
getPrincipal() sample code for java.security.acl.AclEntry.getPrincipal() definition code for java.security.acl.AclEntry.getPrincipal()

getPrincipal sample code for java.security.acl.AclEntry.getPrincipal() definition code for java.security.acl.AclEntry.getPrincipal()

Principal sample code for java.security.Principal definition code for java.security.Principal  getPrincipal()
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.
See Also:
setPrincipal(java.security.Principal) sample code for java.security.acl.AclEntry.setPrincipal(java.security.Principal) definition code for java.security.acl.AclEntry.setPrincipal(java.security.Principal)

setNegativePermissions sample code for java.security.acl.AclEntry.setNegativePermissions() definition code for java.security.acl.AclEntry.setNegativePermissions()

void setNegativePermissions()
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.


isNegative sample code for java.security.acl.AclEntry.isNegative() definition code for java.security.acl.AclEntry.isNegative()

boolean isNegative()
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.

addPermission sample code for java.security.acl.AclEntry.addPermission(java.security.acl.Permission) definition code for java.security.acl.AclEntry.addPermission(java.security.acl.Permission)

boolean addPermission(Permission sample code for java.security.acl.Permission definition code for java.security.acl.Permission  permission)
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.

removePermission sample code for java.security.acl.AclEntry.removePermission(java.security.acl.Permission) definition code for java.security.acl.AclEntry.removePermission(java.security.acl.Permission)

boolean removePermission(Permission sample code for java.security.acl.Permission definition code for java.security.acl.Permission  permission)
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.

checkPermission sample code for java.security.acl.AclEntry.checkPermission(java.security.acl.Permission) definition code for java.security.acl.AclEntry.checkPermission(java.security.acl.Permission)

boolean checkPermission(Permission sample code for java.security.acl.Permission definition code for java.security.acl.Permission  permission)
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.

permissions sample code for java.security.acl.AclEntry.permissions() definition code for java.security.acl.AclEntry.permissions()

Enumeration sample code for java.util.Enumeration definition code for java.util.Enumeration <Permission sample code for java.security.acl.Permission definition code for java.security.acl.Permission > permissions()
Returns an enumeration of the permissions in this ACL entry.

Returns:
an enumeration of the permissions in this ACL entry.

toString sample code for java.security.acl.AclEntry.toString() definition code for java.security.acl.AclEntry.toString()

String sample code for java.lang.String definition code for java.lang.String  toString()
Returns a string representation of the contents of this ACL entry.

Overrides:
toString sample code for java.lang.Object.toString() definition code for java.lang.Object.toString() in class Object sample code for java.lang.Object definition code for java.lang.Object
Returns:
a string representation of the contents.

clone sample code for java.security.acl.AclEntry.clone() definition code for java.security.acl.AclEntry.clone()

Object sample code for java.lang.Object definition code for java.lang.Object  clone()
Clones this ACL entry.

Returns:
a clone of this ACL entry.