java.security

Class Permission

java.lang.Object

java.security.Permission

All Implemented Interfaces:

Serializable, Guard

Direct Known Subclasses:

ApplicationPermission, BasicPermission, FilePermission, PropertyPermission, ServicePermission

public abstract class Permission
extends Object
implements Guard, Serializable

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Permission(String name) Constructs a permission with the specified name.

Method Summary

Modifier and Type	Method and Description
abstract boolean	equals(Object obj) Checks two Permission objects for equality.
abstract String	getActions() Returns the actions as a String.
String	getName() Returns the name of this Permission.
abstract int	hashCode() Returns the hash code value for this Permission object.
abstract boolean	implies(Permission permission) Checks if the specified permission's actions are "implied by" this object's actions.
String	toString() Returns a string describing this Permission.

Methods inherited from class java.lang.Object

clone, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Permission

public Permission(String name)

Constructs a permission with the specified name.

Parameters:

name - name of the Permission object being created.

Method Detail

equals

public abstract boolean equals(@Nullable
                               Object obj)

Checks two Permission objects for equality.

Do not use the equals method for making access control decisions; use the implies method.

Overrides:

equals in class Object

Parameters:

obj - the object we are testing for equality with this object.

Returns:

true if both Permission objects are equivalent.

See Also:

Object.hashCode(), HashMap

getActions

public abstract String getActions()

Returns the actions as a String. This is abstract so subclasses can defer creating a String representation until one is needed. Subclasses should always return actions in what they consider to be their canonical form. For example, two FilePermission objects created via the following:

 perm1 = new FilePermission(p1, "read,write");
 perm2 = new FilePermission(p2, "write,read");
 

both return "read,write" when the getActions method is invoked.

Returns:

the actions of this Permission.

getName

public final String getName()

Returns the name of this Permission. For example, in the case of a java.io.FilePermission, the name will be a pathname.

Returns:

the name of this Permission.

hashCode

public abstract int hashCode()

Returns the hash code value for this Permission object.

The required hashCode behavior for Permission Objects is the following:

• Whenever it is invoked on the same Permission object more than once during an execution of a Java application, the hashCode method must consistently return the same integer. This integer need not remain consistent from one execution of an application to another execution of the same application.
• If two Permission objects are equal according to the equals method, then calling the hashCode method on each of the two Permission objects must produce the same integer result.

Overrides:

hashCode in class Object

Returns:

a hash code value for this object.

See Also:

Object.equals(java.lang.Object), System.identityHashCode(java.lang.Object)

implies

public abstract boolean implies(Permission permission)

Checks if the specified permission's actions are "implied by" this object's actions.

This must be implemented by subclasses of Permission, as they are the only ones that can impose semantics on a Permission object.

Parameters:

permission - the permission to check against.

Returns:

true if the specified permission is implied by this object, false if not.

toString

public String toString()

Returns a string describing this Permission. The convention is to specify the class name, the permission name, and the actions in the following format: '("ClassName" "name" "actions")', or '("ClassName" "name")' if actions list is null or empty.

Overrides:

toString in class Object

Returns:

information about this Permission.