public
interface
AclEntry
implements
Cloneable
| java.security.acl.AclEntry |
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:
Public methods | |
|---|---|
abstract
boolean
|
addPermission(Permission permission)
Adds the specified permission to this ACL entry. |
abstract
boolean
|
checkPermission(Permission permission)
Checks if the specified permission is part of the permission set in this entry. |
abstract
Object
|
clone()
Clones this ACL entry. |
abstract
Principal
|
getPrincipal()
Returns the principal for which permissions are granted or denied by this ACL entry. |
abstract
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. |
abstract
Enumeration<Permission>
|
permissions()
Returns an enumeration of the permissions in this ACL entry. |
abstract
boolean
|
removePermission(Permission permission)
Removes the specified permission from this ACL entry. |
abstract
void
|
setNegativePermissions()
Sets this ACL entry to be a negative one. |
abstract
boolean
|
setPrincipal(Principal user)
Specifies the principal for which permissions are granted or denied by this ACL entry. |
abstract
String
|
toString()
Returns a string representation of the contents of this ACL entry. |
boolean addPermission (Permission permission)
Adds the specified permission to this ACL entry. Note: An entry can have multiple permissions.
| Parameters | |
|---|---|
permission |
Permission:
the permission to be associated with
the principal in this entry. |
| Returns | |
|---|---|
boolean |
true if the permission was added, false if the permission was already part of this entry's permission set. |
boolean checkPermission (Permission permission)
Checks if the specified permission is part of the permission set in this entry.
| Parameters | |
|---|---|
permission |
Permission:
the permission to be checked for. |
| Returns | |
|---|---|
boolean |
true if the permission is part of the permission set in this entry, false otherwise. |
Object clone ()
Clones this ACL entry.
| Returns | |
|---|---|
Object |
a clone of this ACL entry. |
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 | |
|---|---|
Principal |
the principal associated with this entry. |
See also:
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 | |
|---|---|
boolean |
true if this is a negative ACL entry, false if it's not. |
Enumeration<Permission> permissions ()
Returns an enumeration of the permissions in this ACL entry.
| Returns | |
|---|---|
Enumeration<Permission> |
an enumeration of the permissions in this ACL entry. |
boolean removePermission (Permission permission)
Removes the specified permission from this ACL entry.
| Parameters | |
|---|---|
permission |
Permission:
the permission to be removed from this entry. |
| Returns | |
|---|---|
boolean |
true if the permission is removed, false if the permission was not part of this entry's permission set. |
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.
boolean setPrincipal (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 |
Principal:
the principal to be set for this entry. |
| Returns | |
|---|---|
boolean |
true if the principal is set, false if there was already a principal set for this entry. |
See also:
String toString ()
Returns a string representation of the contents of this ACL entry.
| Returns | |
|---|---|
String |
a string representation of the contents. |
Developers