Top Description Fields Constructors Methods
javax.security.jacc

public final Class WebRoleRefPermission

extends Permission
implements Serializable
Class Inheritance
All Implemented Interfaces
java.io.Serializable
Imports
java.io.IOException, .ObjectStreamField, java.security.Permission
Class for Servlet isUserInRole (String reference) permissions. A WebRoleRefPermission is a named permission and has actions.

The name of an WebRoleRefPermission (also referred to as the target name) identifies a Web resource by the servlet name (in the deployment descriptor corresponding to the component from which the call to isUserInRole (String reference) is being made.

The actions of an WebRoleRefPermission identifies the role reference to which the permission applies. A WebRoleRefPermission is checked to determine if the subject is a member of the role identified by the reference.

Implementations of this class MAY implement newPermissionCollection or inherit its implementation from the super class.

Authors
Ron Monzillo, Gary Ellison
See Also
java.security.Permission

Field Summary

Modifier and TypeField and Description
private final String
actions

private transient int
hashCodeValue

private static final ObjectStreamField[]
serialPersistentFields

The serialized fields of this permission are defined below.

private static final long
serialVersionUID

Hides java.security.Permission.serialVersionUID.

Constructor Summary

AccessConstructor and Description
public
WebRoleRefPermission(String
the servlet-name that identifies the application specific web resource in whose context the role references are to be evaluated.

name, String
identifies the role reference to which the permission pertains. The role reference is scoped to the Web resource identified in the name parameter. The value of the role reference must not be null or the empty string.
actions)

Creates a new WebRoleRefPermission with the specified name and actions.

Method Summary

Modifier and TypeMethod and Description
public boolean

Returns:

true if the argument WebRoleRefPermission object is equivalent to this WebRoleRefPermission.
equals(Object
the WebRoleRefPermission object being tested for equality with this WebRoleRefPermission.
o)

Implements abstract java.security.Permission.equals.

Checks two WebRoleRefPermission objects for equality.
public String

Returns:

a String containing the canonicalized actions of this WebRoleRefPermission.
getActions()

Implements abstract java.security.Permission.getActions.

Returns a canonical String representation of the actions of this WebRoleRefPermission.
public int

Returns:

the integer hash code value for this object.
hashCode()

Implements abstract java.security.Permission.hashCode.

Returns the hash code value for this WebRoleRefPermission.
public boolean

Returns:

true if the specified permission is implied by this object, false if not.
implies(Permission
"this" WebRoleRefPermission is checked to see if it implies the argument permission.

permission)

Implements abstract java.security.Permission.implies.

Determines if the argument Permission is "implied by" this WebRoleRefPermission.
private synchronized void
readObject(ObjectInputStream s)

readObject reads the serialized fields from the input stream and uses them to restore the permission.

private synchronized void
writeObject(ObjectOutputStream s)

writeObject is used to establish the values of the serialized fields before they are written to the output stream and need not be implemented if the values of the serialized fields are always available and up to date.

Inherited from java.security.Permission:
checkGuardgetNamenewPermissionCollectiontoString

Field Detail

actionsback to summary
private final String actions
hashCodeValueback to summary
private transient int hashCodeValue
serialPersistentFieldsback to summary
private static final ObjectStreamField[] serialPersistentFields

The serialized fields of this permission are defined below. Whether or not the serialized fields correspond to actual (private) fields is an implementation decision.

Serial Fields:
actions:String
the canonicalized actions string (as returned by getActions).
serialVersionUIDback to summary
private static final long serialVersionUID

Hides java.security.Permission.serialVersionUID.

Constructor Detail

WebRoleRefPermissionback to summary
public WebRoleRefPermission(String name, String actions)

Creates a new WebRoleRefPermission with the specified name and actions.

Parameters
name:String

the servlet-name that identifies the application specific web resource in whose context the role references are to be evaluated.

actions:String

identifies the role reference to which the permission pertains. The role reference is scoped to the Web resource identified in the name parameter. The value of the role reference must not be null or the empty string.

Method Detail

equalsback to summary
public boolean equals(Object o)

Implements abstract java.security.Permission.equals.

Checks two WebRoleRefPermission objects for equality. WebRoleRefPermission objects are equivalent if they have case equivalent name and actions values.

Two Permission objects, P1 and P2, are equivalent if and only if P1.implies(P2) && P2.implies(P1).

The name and actions comparisons described above are case sensitive.

Parameters
o:Object

the WebRoleRefPermission object being tested for equality with this WebRoleRefPermission.

Returns:boolean

true if the argument WebRoleRefPermission object is equivalent to this WebRoleRefPermission.

getActionsback to summary
public String getActions()

Implements abstract java.security.Permission.getActions.

Returns a canonical String representation of the actions of this WebRoleRefPermission.

Returns:String

a String containing the canonicalized actions of this WebRoleRefPermission.

hashCodeback to summary
public int hashCode()

Implements abstract java.security.Permission.hashCode.

Returns the hash code value for this WebRoleRefPermission. The properties of the returned hash code must be as follows:

  • During the lifetime of a Java application, the hashCode method must return the same integer value, every time it is called on a WebRoleRefPermission object. The value returned by hashCode for a particular WebRoleRefPermission need not remain consistent from one execution of an application to another.
  • If two WebRoleRefPermission 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 (within an application).

Returns:int

the integer hash code value for this object.

impliesback to summary
public boolean implies(Permission permission)

Implements abstract java.security.Permission.implies.

Determines if the argument Permission is "implied by" this WebRoleRefPermission. For this to be the case,

  • The argument must be an instanceof WebRoleRefPermission
  • with name equivalent to this WebRoleRefPermission, and
  • with role reference equivalent to this WebRoleRefPermission (as defined in their actions).

The comparisons described above are case sensitive.

Parameters
permission:Permission

"this" WebRoleRefPermission is checked to see if it implies the argument permission.

Returns:boolean

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

readObjectback to summary
private synchronized void readObject(ObjectInputStream s) throws IOException, ClassNotFoundException

readObject reads the serialized fields from the input stream and uses them to restore the permission. This method need not be implemented if establishing the values of the serialized fields (as is done by defaultReadObject) is sufficient to initialize the permission.

writeObjectback to summary
private synchronized void writeObject(ObjectOutputStream s) throws IOException

writeObject is used to establish the values of the serialized fields before they are written to the output stream and need not be implemented if the values of the serialized fields are always available and up to date. The serialized fields are written to the output stream in the same form as they would be written by defaultWriteObject.