Java Authorization Contract for Containers API 1.6 · javax.security.jacc.EJBMethodPermission

Modifier and Type	Field and Description
private transient String	actions
private transient int	hashCodeValue
private static HashMap<K, V>	interfaceHash
private static final String[]	interfaceKeys
private transient int	methodInterface
private transient String	methodName
private transient String	methodParams
private transient String	otherMethodInterface
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

Access	Constructor and Description
public	EJBMethodPermission(String of the EJB to which the permission pertains. name, String identifies the methods of the EJB to which the permission pertains. actions) Creates a new EJBMethodPermission with the specified name and actions.
public	EJBMethodPermission(String The string representation of the name of the EJB as it appears in the corresponding ejb-name element in the deployment descriptor. EJBName, String A string that may be used to indicate the method of the EJB to which the permission pertains. A value of null or "" indicates that the permission pertains to all methods that match the other parameters of the permission specification without consideration of method name. methodName, String A string that may be used to specify the EJB interface to which the permission pertains. A value of null or "", indicates that the permission pertains to all methods that match the other parameters of the permission specification without consideration of the interface they occur on. methodInterface, String[] An array of strings that may be used to specify (by typeNames) the parameter signature of the target methods. The order of the typeNames in methodParams array must match the order of occurence of the corresponding parameters in the method signature of the target method(s). Each typeName in the methodParams array must contain the canonical form of the corresponding parameter's typeName as defined by the getActions method. An empty methodParams array is used to represent a method signature with no arguments. A value of null indicates that the permission pertains to all methods that match the other parameters of the permission specification without consideration of method signature. methodParams) Creates a new EJBMethodPermission with name corresponding to the EJBName and actions composed from methodName, methodInterface, and methodParams.
public	EJBMethodPermission(String The string representation of the name of the EJB as it appears in the corresponding ejb-name element in the deployment descriptor. EJBName, String A string that may be used to specify the EJB interface to which the permission pertains. A value of null or "", indicates that the permission pertains to all methods that match the other parameters of the permission specification without consideration of the interface they occur on. methodInterface, Method an instance of the Java.lang.reflect.Method class corresponding to the method that the container is trying to determine whether the caller has permission to access. This value must not be null. method) Creates a new EJBMethodPermission with name corresponding to the EJBName and actions composed from methodInterface, and the Method object.

Method Summary

Modifier and Type	Method and Description
public boolean	Returns: true if the argument EJBMethodPermission object is equivalent to this EJBMethodPermission. equals(Object the EJBMethodPermission object being tested for equality with this EJBMethodPermission o) Implements abstract java.security.Permission.equals. Checks two EJBMethodPermission objects for equality.
public String	Returns: a String containing the canonicalized actions of this EJBMethodPermission. getActions() Implements abstract java.security.Permission.getActions. Returns a String containing a canonical representation of the actions of this EJBMethodPermission.
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 EJBMethodPermission.
public boolean	Returns: true if the specified permission is implied by this object, false if not. implies(Permission "this" EJBMethodPermission 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 EJBMethodPermission.
private void	readObject(ObjectInputStream s) readObject reads the serialized fields from the input stream and uses them to restore the permission.
private void	setMethodSpec(String actions)
private void	setMethodSpec(String methodName, String mInterface, String[] methodParams)
private void	setMethodSpec(String mInterface, Method method)
private static int	validateInterface(String methodInterface)
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:: checkGuard getName newPermissionCollection toString

Field Detail

actions	back to summary
private transient String actions

hashCodeValue	back to summary
private transient int hashCodeValue

interfaceHash	back to summary
private static HashMap<K, V> interfaceHash

interfaceKeys	back to summary
private static final String[] interfaceKeys

methodInterface	back to summary
private transient int methodInterface

methodName	back to summary
private transient String methodName

methodParams	back to summary
private transient String methodParams

otherMethodInterface	back to summary
private transient String otherMethodInterface

serialPersistentFields	back 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).

serialVersionUID	back to summary
private static final long serialVersionUID Hides java.security.Permission.serialVersionUID.

Constructor Detail

EJBMethodPermission	back to summary
public EJBMethodPermission(String name, String actions) Creates a new EJBMethodPermission with the specified name and actions. The name contains the value of the ejb-name element corresponding to an EJB in the application's deployment descriptor. The actions contains a methodSpec. The syntax of the actions parameter is defined as follows: methodNameSpec ::= methodName \| emptyString methodInterfaceName ::= String methodInterfaceSpec ::= methodInterfaceName \| emptyString typeName ::= typeName \| typeName [] methodParams ::= typeName \| methodParams comma typeName methodParamsSpec ::= emptyString \| methodParams methodSpec ::= null \| methodNameSpec \| methodNameSpec comma methodInterfaceName \| methodNameSpec comma methodInterfaceSpec comma methodParamsSpec A MethodInterfaceName is a non-empty String and should contain a method-intf value as defined for use in EJB deployment descriptors. An implementation must be flexible such that it supports additional interface names especially if they are standardized by the EJB Specification. The EJB Specification currently defines the following method-intf values: { "Home", "LocalHome", "Remote", "Local", "ServiceEndpoint" } A null or empty string methodSpec indicates that the permission applies to all methods of the EJB. A methodSpec with a methodNameSpec of the empty string matches all methods of the EJB that match the methodInterface and methodParams elements of the methodSpec. A methodSpec with a methodInterfaceSpec of the empty string matches all methods of the EJB that match the methodNameSpec and methodParamsSpec elements of the methodSpec. A methodSpec without a methodParamsSpec matches all methods of the EJB that match the methodNameSpec and methodInterface elements of the methodSpec. The order of the typeNames in methodParams array must match the order of occurence of the corresponding parameters in the method signature of the target method(s). Each typeName in the methodParams must contain the canonical form of the corresponding parameter's typeName as defined by the getActions method. A methodSpec with an empty methodParamsSpec matches all 0 argument methods of the EJB that match the methodNameSpec and methodInterfaceSpec elements of the methodSpec. Parameters name:String of the EJB to which the permission pertains. actions:String identifies the methods of the EJB to which the permission pertains.

EJBMethodPermission

back to summary

public EJBMethodPermission(String name, String actions)

Creates a new EJBMethodPermission with the specified name and actions.

The name contains the value of the ejb-name element corresponding to an EJB in the application's deployment descriptor.

The actions contains a methodSpec. The syntax of the actions parameter is defined as follows:

     methodNameSpec ::= methodName | emptyString

     methodInterfaceName ::= String

     methodInterfaceSpec ::= methodInterfaceName | emptyString

     typeName ::= typeName | typeName []

     methodParams ::= typeName | methodParams comma typeName

     methodParamsSpec ::= emptyString | methodParams

     methodSpec ::= null |
          methodNameSpec |
          methodNameSpec comma methodInterfaceName |
          methodNameSpec comma methodInterfaceSpec comma methodParamsSpec

A MethodInterfaceName is a non-empty String and should contain a method-intf value as defined for use in EJB deployment descriptors. An implementation must be flexible such that it supports additional interface names especially if they are standardized by the EJB Specification. The EJB Specification currently defines the following method-intf values:

      { "Home", "LocalHome", "Remote", "Local", "ServiceEndpoint" }

A null or empty string methodSpec indicates that the permission applies to all methods of the EJB. A methodSpec with a methodNameSpec of the empty string matches all methods of the EJB that match the methodInterface and methodParams elements of the methodSpec.

A methodSpec with a methodInterfaceSpec of the empty string matches all methods of the EJB that match the methodNameSpec and methodParamsSpec elements of the methodSpec.

A methodSpec without a methodParamsSpec matches all methods of the EJB that match the methodNameSpec and methodInterface elements of the methodSpec.

The order of the typeNames in methodParams array must match the order of occurence of the corresponding parameters in the method signature of the target method(s). Each typeName in the methodParams must contain the canonical form of the corresponding parameter's typeName as defined by the getActions method. A methodSpec with an empty methodParamsSpec matches all 0 argument methods of the EJB that match the methodNameSpec and methodInterfaceSpec elements of the methodSpec.

Parameters

name:String

of the EJB to which the permission pertains.

actions:String

identifies the methods of the EJB to which the permission pertains.

EJBMethodPermission	back to summary
public EJBMethodPermission(String EJBName, String methodName, String methodInterface, String[] methodParams) Creates a new EJBMethodPermission with name corresponding to the EJBName and actions composed from methodName, methodInterface, and methodParams. Parameters EJBName:String The string representation of the name of the EJB as it appears in the corresponding ejb-name element in the deployment descriptor. methodName:String A string that may be used to indicate the method of the EJB to which the permission pertains. A value of null or "" indicates that the permission pertains to all methods that match the other parameters of the permission specification without consideration of method name. methodInterface:String A string that may be used to specify the EJB interface to which the permission pertains. A value of null or "", indicates that the permission pertains to all methods that match the other parameters of the permission specification without consideration of the interface they occur on. methodParams:String[] An array of strings that may be used to specify (by typeNames) the parameter signature of the target methods. The order of the typeNames in methodParams array must match the order of occurence of the corresponding parameters in the method signature of the target method(s). Each typeName in the methodParams array must contain the canonical form of the corresponding parameter's typeName as defined by the getActions method. An empty methodParams array is used to represent a method signature with no arguments. A value of null indicates that the permission pertains to all methods that match the other parameters of the permission specification without consideration of method signature.

EJBMethodPermission

back to summary

public EJBMethodPermission(String EJBName, String methodName, String methodInterface, String[] methodParams)

Creates a new EJBMethodPermission with name corresponding to the EJBName and actions composed from methodName, methodInterface, and methodParams.

Parameters

EJBName:String

The string representation of the name of the EJB as it appears in the corresponding ejb-name element in the deployment descriptor.

methodName:String

A string that may be used to indicate the method of the EJB to which the permission pertains. A value of null or "" indicates that the permission pertains to all methods that match the other parameters of the permission specification without consideration of method name.

methodInterface:String

A string that may be used to specify the EJB interface to which the permission pertains. A value of null or "", indicates that the permission pertains to all methods that match the other parameters of the permission specification without consideration of the interface they occur on.

methodParams:String[]

An array of strings that may be used to specify (by typeNames) the parameter signature of the target methods. The order of the typeNames in methodParams array must match the order of occurence of the corresponding parameters in the method signature of the target method(s). Each typeName in the methodParams array must contain the canonical form of the corresponding parameter's typeName as defined by the getActions method. An empty methodParams array is used to represent a method signature with no arguments. A value of null indicates that the permission pertains to all methods that match the other parameters of the permission specification without consideration of method signature.

EJBMethodPermission	back to summary
public EJBMethodPermission(String EJBName, String methodInterface, Method method) Creates a new EJBMethodPermission with name corresponding to the EJBName and actions composed from methodInterface, and the Method object. A container uses this constructor prior to checking if a caller has permission to call the method of an EJB. Parameters EJBName:String The string representation of the name of the EJB as it appears in the corresponding ejb-name element in the deployment descriptor. methodInterface:String A string that may be used to specify the EJB interface to which the permission pertains. A value of null or "", indicates that the permission pertains to all methods that match the other parameters of the permission specification without consideration of the interface they occur on. method:Method an instance of the Java.lang.reflect.Method class corresponding to the method that the container is trying to determine whether the caller has permission to access. This value must not be null.

EJBMethodPermission

back to summary

public EJBMethodPermission(String EJBName, String methodInterface, Method method)

Creates a new EJBMethodPermission with name corresponding to the EJBName and actions composed from methodInterface, and the Method object.

A container uses this constructor prior to checking if a caller has permission to call the method of an EJB.

Parameters

EJBName:String

The string representation of the name of the EJB as it appears in the corresponding ejb-name element in the deployment descriptor.

methodInterface:String

method:Method

an instance of the Java.lang.reflect.Method class corresponding to the method that the container is trying to determine whether the caller has permission to access. This value must not be null.

Method Detail

equals	back to summary
public boolean equals(Object o) Implements abstract java.security.Permission.equals. Checks two EJBMethodPermission objects for equality. EJBMethodPermission objects are equivalent if they have case sensitive equivalent name and actions values. Two Permission objects, P1 and P2, are equivalent if and only if P1.implies(P2) && P2.implies(P1). Parameters o:Object the EJBMethodPermission object being tested for equality with this EJBMethodPermission Returns:boolean true if the argument EJBMethodPermission object is equivalent to this EJBMethodPermission.

equals

back to summary

public boolean equals(Object o)

Implements abstract java.security.Permission.equals.

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

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

Parameters

o:Object

the EJBMethodPermission object being tested for equality with this EJBMethodPermission

Returns:boolean

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

getActions	back to summary
public String getActions() Implements abstract java.security.Permission.getActions. Returns a String containing a canonical representation of the actions of this EJBMethodPermission. The Canonical form of the actions of an EJBMethodPermission is described by the following syntax description. methodNameSpec ::= methodName \| emptyString methodInterfaceName ::= String methodInterfaceSpec ::= methodInterfaceName \| emptyString typeName ::= typeName \| typeName [] methodParams ::= typeName \| methodParams comma typeName methodParamsSpec ::= emptyString \| methodParams methodSpec ::= null \| methodName \| methodNameSpec comma methodInterfaceName \| methodNameSpec comma methodInterfaceSpec comma methodParamsSpec The canonical form of each typeName must begin with the fully qualified Java name of the corresponding parameter's type. The canonical form of a typeName for an array parameter is the fully qualified Java name of the array's component type followed by as many instances of the string "[]" as there are dimensions to the array. No additional characters (e.g. blanks) may occur in the canonical form. A MethodInterfaceName is a non-empty String and should contain a method-intf value as defined for use in EJB deployment descriptors. An implementation must be flexible such that it supports additional interface names especially if they are standardized by the EJB Specification. The EJB Specification currently defines the following method-intf values: { "Home", "LocalHome", "Remote", "Local", "ServiceEndpoint" } Returns:String a String containing the canonicalized actions of this EJBMethodPermission.

getActions

back to summary

public String getActions()

Implements abstract java.security.Permission.getActions.

Returns a String containing a canonical representation of the actions of this EJBMethodPermission. The Canonical form of the actions of an EJBMethodPermission is described by the following syntax description.

     methodNameSpec ::= methodName | emptyString

     methodInterfaceName ::= String

     methodInterfaceSpec ::= methodInterfaceName | emptyString

     typeName ::= typeName | typeName []

     methodParams ::= typeName | methodParams comma typeName

     methodParamsSpec ::= emptyString | methodParams

     methodSpec ::= null |
          methodName |
          methodNameSpec comma methodInterfaceName |
          methodNameSpec comma methodInterfaceSpec comma methodParamsSpec

The canonical form of each typeName must begin with the fully qualified Java name of the corresponding parameter's type. The canonical form of a typeName for an array parameter is the fully qualified Java name of the array's component type followed by as many instances of the string "[]" as there are dimensions to the array. No additional characters (e.g. blanks) may occur in the canonical form.

      { "Home", "LocalHome", "Remote", "Local", "ServiceEndpoint" }

Returns:String: a String containing the canonicalized actions of this EJBMethodPermission.

hashCode	back to summary
public int hashCode() Implements abstract java.security.Permission.hashCode. Returns the hash code value for this EJBMethodPermission. 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 EJBMethodPermission object. The value returned by hashCode for a particular EJBMethodPermission need not remain consistent from one execution of an application to another. If two EJBMethodPermission 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.

hashCode

back to summary

public int hashCode()

Implements abstract java.security.Permission.hashCode.

Returns the hash code value for this EJBMethodPermission. 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 EJBMethodPermission object. The value returned by hashCode for a particular EJBMethodPermission need not remain consistent from one execution of an application to another.
If two EJBMethodPermission 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.

implies	back to summary
public boolean implies(Permission permission) Implements abstract java.security.Permission.implies. Determines if the argument Permission is "implied by" this EJBMethodPermission. For this to be the case, The argument must be an instanceof EJBMethodPermission with name equivalent to that of this EJBMethodPermission, and the methods to which the argument permission applies (as defined in its actions) must be a subset of the methods to which this EJBMethodPermission applies (as defined in its actions). The argument permission applies to a subset of the methods to which this permission applies if all of the following conditions are met. the method name component of the methodNameSpec of this permission is null, the empty string, or equivalent to the method name of the argument permission, and the method interface component of the methodNameSpec of this permission is null, the empty string, or equivalent to the method interface of the argument permission, and the method parameter list component of the methodNameSpec of this permission is null, the empty string, or equivalent to the method parameter list of the argument permission. The name and actions comparisons described above are case sensitive. Parameters permission:Permission "this" EJBMethodPermission 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.

implies

back to summary

public boolean implies(Permission permission)

Implements abstract java.security.Permission.implies.

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

The argument must be an instanceof EJBMethodPermission
with name equivalent to that of this EJBMethodPermission, and
the methods to which the argument permission applies (as defined in its actions) must be a subset of the methods to which this EJBMethodPermission applies (as defined in its actions).

The argument permission applies to a subset of the methods to which this permission applies if all of the following conditions are met.

the method name component of the methodNameSpec of this permission is null, the empty string, or equivalent to the method name of the argument permission, and
the method interface component of the methodNameSpec of this permission is null, the empty string, or equivalent to the method interface of the argument permission, and
the method parameter list component of the methodNameSpec of this permission is null, the empty string, or equivalent to the method parameter list of the argument permission.

The name and actions comparisons described above are case sensitive.

Parameters

permission:Permission

"this" EJBMethodPermission 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.

readObject	back to summary
private 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.

setMethodSpec	back to summary
private void setMethodSpec(String actions)

setMethodSpec	back to summary
private void setMethodSpec(String methodName, String mInterface, String[] methodParams)

setMethodSpec	back to summary
private void setMethodSpec(String mInterface, Method method)

validateInterface	back to summary
private static int validateInterface(String methodInterface)

writeObject	back 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.

writeObject

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

public final Class EJBMethodPermission

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail