Main Page | Packages | Class Hierarchy | Class List | File List | Class Members | Related Pages | Search for 

org.objectweb.jonas_ejb.deployment.api.MethodDesc Class Reference

Inherited by org.objectweb.jonas_ejb.deployment.api.MethodCmp2Desc, and org.objectweb.jonas_ejb.deployment.api.MethodJdbcCmp1Desc.

Inheritance diagram for org.objectweb.jonas_ejb.deployment.api.MethodDesc:

Inheritance graph
[legend]
Collaboration diagram for org.objectweb.jonas_ejb.deployment.api.MethodDesc:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 MethodDesc (BeanDesc beanDesc, Method meth, int index)
int getIndex ()
boolean isFinder ()
boolean isFindByPrimaryKey ()
boolean isEjbSelect ()
int matchPattern (Class pclass, String mName, MethodParams patternMethodParams)
int getTxAttribute ()
int getTxAttributeStatus ()
String getTxAttributeName ()
String[] getRoleName ()
Method getMethod ()
BeanDesc getBeanDesc ()
String toString ()
boolean isExcluded ()
void setExcluded (boolean excluded)

Static Public Member Functions

int matchPattern (java.lang.reflect.Method meth, Class pclass, String mName, MethodParams patternMethodParams)
String getTxAttributeName (int value)
String methodElementToString (org.objectweb.jonas_ejb.deployment.xml.Method m)
String toString (Method m)
boolean isFinder (Method meth)
boolean isFindByPrimaryKey (Method meth)
boolean isEjbSelect (Method meth)

Static Public Attributes

final int TX_NULL = -1

Static Protected Member Functions

String methodElementToString (String intf, String name, MethodParams params)

Static Protected Attributes

final String TX_STR_DEFAULT_VALUE = "Supports"
final String TX_STR_DEFAULT_VALUE_4_MDB = "NotSupported"

Package Functions

void overwriteTxAttribute (String transAttribute, int status) throws DeploymentDescException
void setTxAttribute (String transAttribute) throws DeploymentDescException
void addRoleName (String rn)

Detailed Description

Class to hold meta-information related to bean and home methods.
Author:
Christophe Ney [cney@batisseurs.com] : Initial developer

Helene Joanin: fix a bug about select method select method is a bean's method which name begins with ejbSelect, (and not home interface method as finder method).

Definition at line 44 of file MethodDesc.java.

Constructor & Destructor Documentation

org.objectweb.jonas_ejb.deployment.api.MethodDesc.MethodDesc (  BeanDesc  beanDesc,
Method  meth,
int  index
) 
 

constructor to be used by parent node

Definition at line 123 of file MethodDesc.java.

Member Function Documentation

void org.objectweb.jonas_ejb.deployment.api.MethodDesc.addRoleName (  String  rn  )  [package]
 

Add a role name to the role names which can execute the method

Parameters:
rn role name to add

Definition at line 209 of file MethodDesc.java.

BeanDesc org.objectweb.jonas_ejb.deployment.api.MethodDesc.getBeanDesc (   ) 
 

get the parent node

Definition at line 399 of file MethodDesc.java.

int org.objectweb.jonas_ejb.deployment.api.MethodDesc.getIndex (   ) 
 

get a unique index of the method for the bean

Definition at line 135 of file MethodDesc.java.

Referenced by org.objectweb.jonas_ejb.genic.VcMethod.VcMethod().

Method org.objectweb.jonas_ejb.deployment.api.MethodDesc.getMethod (   ) 
 

return the method to which the meta-information applies

Definition at line 392 of file MethodDesc.java.

Referenced by org.objectweb.jonas_ejb.deployment.api.BeanDesc.BeanDesc(), org.objectweb.jonas_ejb.deployment.api.MessageDrivenDesc.checkTxAttribute(), org.objectweb.jonas_ejb.deployment.api.EntityDesc.checkTxAttribute(), org.objectweb.jonas_ejb.deployment.api.EntityCmp2Desc.EntityCmp2Desc(), org.objectweb.jonas_ejb.deployment.api.EntityDesc.EntityDesc(), org.objectweb.jonas_ejb.container.jorm.MedorFactory.evaluate(), org.objectweb.jonas_ejb.deployment.api.MessageDrivenDesc.MessageDrivenDesc(), and org.objectweb.jonas_ejb.deployment.api.SessionStatelessDesc.SessionStatelessDesc().

String [] org.objectweb.jonas_ejb.deployment.api.MethodDesc.getRoleName (   ) 
 

String representation of the roles which can execute the method

Returns:
Array of String representing the roles which can execute the method

Definition at line 325 of file MethodDesc.java.

Referenced by org.objectweb.jonas_ejb.genic.VcMethod.VcMethod(), and org.objectweb.jonas_ejb.deployment.api.BeanDesc.verifyRoleName().

int org.objectweb.jonas_ejb.deployment.api.MethodDesc.getTxAttribute (   ) 
 

Get the container transaction attribute that match the method

Returns:
Constant value within list : TX_NOT_SUPPORTED,TX_REQUIRED,TX_SUPPORTS,TX_REQUIRES_NEW,TX_MANDATORY,TX_NEVER,TX_NOT_SET

Definition at line 288 of file MethodDesc.java.

Referenced by org.objectweb.jonas_ejb.deployment.api.EntityDesc.EntityDesc(), org.objectweb.jonas_ejb.container.JMdbEndpointFactory.isDeliveryTransacted(), org.objectweb.jonas_ejb.deployment.api.MessageDrivenDesc.MessageDrivenDesc(), org.objectweb.jonas_ejb.deployment.api.SessionStatelessDesc.SessionStatelessDesc(), and org.objectweb.jonas_ejb.genic.VcMethod.VcMethod().

String org.objectweb.jonas_ejb.deployment.api.MethodDesc.getTxAttributeName (   ) 
 

String representation of the transactionnal attribute

Returns:
String representation of this transactionnal attribute

Definition at line 317 of file MethodDesc.java.

String org.objectweb.jonas_ejb.deployment.api.MethodDesc.getTxAttributeName (  int  value  )  [static]
 

String representation of the transactionnal attribute

Returns:
String representation of this transactionnal attribute

Definition at line 306 of file MethodDesc.java.

int org.objectweb.jonas_ejb.deployment.api.MethodDesc.getTxAttributeStatus (   ) 
 

Get the container transaction attribute that match the method

Returns:
Constant value within list : APPLY_TO_NOTHING, APPLY_TO_BEAN, APPLY_TO_CLASS, APPLY_TO_BEAN_METHOD_NAME, APPLY_TO_CLASS_METHOD_NAME, APPLY_TO_BEAN_METHOD, APPLY_TO_CLASS_METHOD

Definition at line 298 of file MethodDesc.java.

boolean org.objectweb.jonas_ejb.deployment.api.MethodDesc.isEjbSelect (  Method  meth  )  [static]
 

access if a method is a select

Definition at line 424 of file MethodDesc.java.

boolean org.objectweb.jonas_ejb.deployment.api.MethodDesc.isEjbSelect (   ) 
 

access if the method is a select

Returns:
true for select methods

Definition at line 164 of file MethodDesc.java.

boolean org.objectweb.jonas_ejb.deployment.api.MethodDesc.isExcluded (   ) 
 

Returns:
true if this method is excluded (in DD), else false

Definition at line 457 of file MethodDesc.java.

Referenced by org.objectweb.jonas_ejb.genic.VcMethod.VcMethod().

boolean org.objectweb.jonas_ejb.deployment.api.MethodDesc.isFindByPrimaryKey (  Method  meth  )  [static]
 

access if a method is findByPrimaryKey

Definition at line 415 of file MethodDesc.java.

boolean org.objectweb.jonas_ejb.deployment.api.MethodDesc.isFindByPrimaryKey (   ) 
 

access if the method is findByPrimaryKey

Returns:
true for the findByPrimaryKey method

Definition at line 155 of file MethodDesc.java.

boolean org.objectweb.jonas_ejb.deployment.api.MethodDesc.isFinder (  Method  meth  )  [static]
 

access if a method is a finder

Definition at line 406 of file MethodDesc.java.

boolean org.objectweb.jonas_ejb.deployment.api.MethodDesc.isFinder (   ) 
 

access if the method is a finder

Returns:
true for finder methods

Definition at line 147 of file MethodDesc.java.

int org.objectweb.jonas_ejb.deployment.api.MethodDesc.matchPattern (  java.lang.reflect.Method  meth,
Class  pclass,
String  mName,
MethodParams  patternMethodParams
)  [static]
 

Get the status of applicability for a given pattern to a method

Returns:
status of applicability APPLY_TO_NOTHING,APPLY_TO_BEAN,APPLY_TO_CLASS,APPLY_TO_METHOD_NAME,APPLY_TO_METHOD

Definition at line 225 of file MethodDesc.java.

References org.objectweb.jonas_ejb.deployment.xml.MethodParams.getMethodParamList().

Here is the call graph for this function:

int org.objectweb.jonas_ejb.deployment.api.MethodDesc.matchPattern (  Class  pclass,
String  mName,
MethodParams  patternMethodParams
) 
 

Evaluate method pattern maching as defined in the EJB specifications

Returns:
one of the APPLY_TO_* values.

Definition at line 217 of file MethodDesc.java.

Referenced by org.objectweb.jonas_ejb.deployment.api.EntityCmp2Desc.EntityCmp2Desc(), and org.objectweb.jonas_ejb.deployment.api.EntityJdbcCmp1Desc.EntityJdbcCmp1Desc().

String org.objectweb.jonas_ejb.deployment.api.MethodDesc.methodElementToString (  String  intf,
String  name,
MethodParams  params
)  [static, protected]
 

get a String representation of a method from it's XML representation

Definition at line 349 of file MethodDesc.java.

References org.objectweb.jonas_ejb.deployment.xml.MethodParams.getMethodParamList().

Here is the call graph for this function:

String org.objectweb.jonas_ejb.deployment.api.MethodDesc.methodElementToString (  org.objectweb.jonas_ejb.deployment.xml.Method  m  )  [static]
 

String representation of the given element <method>

Parameters:
m an element <method>
Returns:
String representation of the given element method

Definition at line 342 of file MethodDesc.java.

Referenced by org.objectweb.jonas_ejb.deployment.api.MethodCmp2Desc.queryMethodElementToString().

void org.objectweb.jonas_ejb.deployment.api.MethodDesc.overwriteTxAttribute (  String  transAttribute,
int  status
)  throws DeploymentDescException [package]
 

Overwrite TxAttribute

Parameters:
transAttribute new value for txAttribute
status applicability of given transAttribute parameter

Definition at line 174 of file MethodDesc.java.

void org.objectweb.jonas_ejb.deployment.api.MethodDesc.setExcluded (  boolean  excluded  ) 
 

Sets the excluded attribute.

Parameters:
excluded true of false

Definition at line 464 of file MethodDesc.java.

void org.objectweb.jonas_ejb.deployment.api.MethodDesc.setTxAttribute (  String  transAttribute  )  throws DeploymentDescException [package]
 

Set TxAttribute with given value

Definition at line 186 of file MethodDesc.java.

String org.objectweb.jonas_ejb.deployment.api.MethodDesc.toString (   ) 
 

String representation of the object for test purpose

Returns:
String representation of this object

Reimplemented in org.objectweb.jonas_ejb.deployment.api.MethodCmp2Desc, and org.objectweb.jonas_ejb.deployment.api.MethodJdbcCmp1Desc.

Definition at line 433 of file MethodDesc.java.

References org.objectweb.jonas_ejb.deployment.api.BeanDesc.toString().

Here is the call graph for this function:

String org.objectweb.jonas_ejb.deployment.api.MethodDesc.toString (  Method  m  )  [static]
 

get a String representation of a method from the reflection object

Definition at line 371 of file MethodDesc.java.

Referenced by org.objectweb.jonas_ejb.deployment.api.BeanDesc.getHashCodeForIdentifier(), org.objectweb.jonas_ejb.deployment.api.EntityJdbcCmp1Desc.toString(), org.objectweb.jonas_ejb.deployment.api.EntityCmp2Desc.toString(), and org.objectweb.jonas_ejb.deployment.api.BeanDesc.toString().

Member Data Documentation

final int org.objectweb.jonas_ejb.deployment.api.MethodDesc.TX_NULL = -1 [static]
 

Set of constants for method transaction attribute

Definition at line 49 of file MethodDesc.java.

final String org.objectweb.jonas_ejb.deployment.api.MethodDesc.TX_STR_DEFAULT_VALUE = "Supports" [static, protected]
 

default value for undefined transaction attribute for sessions and entities

Definition at line 72 of file MethodDesc.java.

final String org.objectweb.jonas_ejb.deployment.api.MethodDesc.TX_STR_DEFAULT_VALUE_4_MDB = "NotSupported" [static, protected]
 

default value for undefined transaction attribute for message driven beans

Definition at line 77 of file MethodDesc.java.

The documentation for this class was generated from the following file:
Generated on Tue Feb 15 15:11:24 2005 for JOnAS by  doxygen 1.3.9.1