Summary: Methods
Since: API Level 1
public interface

AclEntry

implements Cloneable
java.security.acl.AclEntry

Class Overview

The Access Control List Entry interface definition.

An AclEntry is a list of the Permissions that are granted (positive) or denied (negative) to a Principal.

Summary

Public Methods
abstract boolean addPermission(Permission permission)
Adds the specified permission to this ACL entry.
abstract boolean checkPermission(Permission permission)
Checks whether the specified permission is in this ACL entry.
abstract Object clone()
Clones this ACL entry instance.
abstract Principal getPrincipal()
Returns the principal of this ACL entry.
abstract boolean isNegative()
Returns whether this ACL entry is negative.
abstract Enumeration<Permission> permissions()
Returns the list of permissions of 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 negative.
abstract boolean setPrincipal(Principal user)
Set the principal for this ACL entry.
abstract String toString()
Returns the string representation of this ACL entry.

Public Methods

public abstract boolean addPermission (Permission permission)

Since: API Level 1

Adds the specified permission to this ACL entry.

Parameters
permission the permission to be added.
Returns
  • true if the specified permission is added, false if the permission was already in this entry.

public abstract boolean checkPermission (Permission permission)

Since: API Level 1

Checks whether the specified permission is in this ACL entry.

Parameters
permission the permission to check.
Returns
  • true if the permission is in this entry, otherwise false.

public abstract Object clone ()

Since: API Level 1

Clones this ACL entry instance.

Returns
  • a copy of this entry.

public abstract Principal getPrincipal ()

Since: API Level 1

Returns the principal of this ACL entry.

Returns
  • the principal of this ACL entry, or null if none is set.

public abstract boolean isNegative ()

Since: API Level 1

Returns whether this ACL entry is negative.

Returns
  • true if this ACL entry is negative, false if it's positive.

public abstract Enumeration<Permission> permissions ()

Since: API Level 1

Returns the list of permissions of this ACL entry.

Returns
  • the list of permissions of this ACL entry,

public abstract boolean removePermission (Permission permission)

Since: API Level 1

Removes the specified permission from this ACL entry.

Parameters
permission the permission to be removed.
Returns
  • true if the permission is removed, false if the permission was not in this entry.

public abstract void setNegativePermissions ()

Since: API Level 1

Sets this ACL entry to be negative.

The permissions in this ACL entry will be denied to the principal associated with this entry.

Note: An ACL entry is positive by default and can only become negative by calling this method.

public abstract boolean setPrincipal (Principal user)

Since: API Level 1

Set the principal for this ACL entry.

The principal for an ACL entry can only be set once.

Parameters
user the principal for this ACL entry.
Returns
  • true on success, false if there is a principal already set for this entry.

public abstract String toString ()

Since: API Level 1

Returns the string representation of this ACL entry.

Returns
  • the string representation of this ACL entry.