Added in API level 1

AclEntry

interface AclEntry : 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.

Summary

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 Any	`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 Unit	`setNegativePermissions()` Sets this ACL entry to be a negative one.
abstract Boolean	`setPrincipal(user: Principal!)` Specifies the principal for which permissions are granted or denied by this ACL entry.

Public methods

addPermission

Added in API level 1

abstract fun addPermission(permission: Permission!): Boolean

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.

Return
`Boolean`	true if the permission was added, false if the permission was already part of this entry's permission set.

checkPermission

Added in API level 1

abstract fun checkPermission(permission: Permission!): Boolean

Checks if the specified permission is part of the permission set in this entry.

Parameters
`permission`	Permission!: the permission to be checked for.

Return
`Boolean`	true if the permission is part of the permission set in this entry, false otherwise.

clone

Added in API level 1

abstract fun clone(): Any

Clones this ACL entry.

Return
`Any`	a clone of this ACL entry.

Exceptions
`java.lang.CloneNotSupportedException`	if the object's class does not support the `Cloneable` interface. Subclasses that override the `clone` method can also throw this exception to indicate that an instance cannot be cloned.

getPrincipal

Added in API level 1

abstract fun getPrincipal(): Principal!

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.

Return
`Principal!`	the principal associated with this entry.

See Also

#setPrincipal

isNegative

Added in API level 1

abstract fun isNegative(): Boolean

Returns true if this is a negative ACL entry (one denying the associated principal the set of permissions in the entry), false otherwise.

Return
`Boolean`	true if this is a negative ACL entry, false if it's not.

permissions

Added in API level 1

abstract fun permissions(): Enumeration<Permission!>!

Returns an enumeration of the permissions in this ACL entry.

Return
`Enumeration<Permission!>!`	an enumeration of the permissions in this ACL entry.

removePermission

Added in API level 1

abstract fun removePermission(permission: Permission!): Boolean

Removes the specified permission from this ACL entry.

Parameters
`permission`	Permission!: the permission to be removed from this entry.

Return
`Boolean`	true if the permission is removed, false if the permission was not part of this entry's permission set.

setNegativePermissions

Added in API level 1

abstract fun setNegativePermissions(): Unit

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.

setPrincipal

Added in API level 1

abstract fun setPrincipal(user: Principal!): Boolean

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.

Return
`Boolean`	true if the principal is set, false if there was already a principal set for this entry.

See Also

#getPrincipal