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
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 Details

addPermission

public 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

checkPermission

public 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

clone

public Object clone()
This method returns a clone of this ACL entry
Overrides:
clone in interface Object
Returns:
A clone of this ACL entry

getPrincipal

public Principal getPrincipal()
This method returns the Principal associated with this ACL entry.
Returns:
The Principal for this ACL entry

isNegative

public 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

permissions

public Enumeration 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

removePermission

public 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

setNegativePermissions

public 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.

setPrincipal

public 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.

toString

public String toString()
This method returns this object as a String.
Overrides:
toString in interface Object
Returns:
A String representation of this object

AclEntry.java -- An entry in an ACL list. Copyright (C) 1998 Free Software Foundation, Inc. This file is part of GNU Classpath. GNU Classpath is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2, or (at your option) any later version. GNU Classpath is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with GNU Classpath; see the file COPYING. If not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. Linking this library statically or dynamically with other modules is making a combined work based on this library. Thus, the terms and conditions of the GNU General Public License cover the whole combination. As a special exception, the copyright holders of this library give you permission to link this library with independent modules to produce an executable, regardless of the license terms of these independent modules, and to copy and distribute the resulting executable under terms of your choice, provided that you also meet, for each linked independent module, the terms and conditions of the license of that module. An independent module is a module which is not derived from or based on this library. If you modify this library, you may extend this exception to your version of the library, but you are not obligated to do so. If you do not wish to do so, delete this exception statement from your version.