EJB and Java Class Descriptors

Descriptors describe server-side EJBs and Java classes, and are used to pass information to the client. This appendix describes the EJB and Java class descriptor objects and their methods, including the following:

• ClassDescriptor Object

• ClassInvocationDescriptor Object

• EJBDescriptor Object

• EJBInvocationDescriptor Object

• MethodDescriptor Object

For more information about accessing EJB and Java class descriptors, see Configuring Business Operations.

 

---

ClassDescriptor Object

The com.bea.wlpi.common.ClassDescriptor object describes a server-side Java class. The ClassDescriptor is used to pass information to the client about the Java classes deployed on the server.

The following constructor can be used to for create a new ClassDescriptor object:

public ClassDescriptor(java.lang.Class javaClass)

The following table describes the ClassDescriptor object data, and the associated get methods that can be used to access that data after the object is defined.

Table C-1 ClassDescriptor Object Data  

Description	Get Method
Java class method descriptors	public final java.util.List getMethodDescriptors()
Java class constructor descriptors	public final java.lang.Util getConstructorDescriptors()
Java class modifiers	public final int getModifiers()
Boolean flag specifying whether or not the Java class is serializable	public final boolean isSerializable

For more information, see the com.bea.wlpi.common.ClassDescriptor Javadoc.

 

---

ClassInvocationDescriptor Object

The com.bea.wlpi.common.ClassInvocationDescriptor object describes and implements the invocation of a Java class method.

The ClassInvocationDescriptor is used to instantiate and invoke associated methods on a Java class.

The following constructors can be used to create a new ClassInvocationDescriptor object:

public ClassInvocationDescriptor(
  java.lang.String description,
  java.lang.String className,
  com.bea.wlpi.common.MethodDescriptor constructorDescriptor,
  java.lang.String[] constructorParmDescriptions,
  com.bea.wlpi.common.MethodDescriptor methodDescriptor,
  java.lang.String[] methodParmDescriptions
)

public ClassInvocationDescriptor(
  java.lang.String description,
  java.lang.String className,
  com.bea.wlpi.common.MethodDescriptor constructorDescriptor,
  java.lang.String[] constructorParmDescriptions,
  com.bea.wlpi.common.MethodDescriptor methodDescriptor,
  java.lang.String[] methodParmDescriptions,
  boolean published
)

The following table describes the ClassInvocationDescriptor object data, the constructor parameters used to define the data, and the associated get and set methods that can be used to access that data after the object is defined.

Table C-2 ClassInvocationDescriptor Object Data  

Object Data	Parameter	Get Method	Set Method
Class invocation descriptor ID	N/A	public java.lang.String getId()	public void setId()
Class description in human-readable format	description	public java.lang.String getDescription()	public void set(...) (See Note following table)
Fully-qualified class name	className	public java.lang.String getClassName()	public void set(...) (See Note following table)
Class constructor	constructorDescriptor	public com.bea.wlpi.common.MethodDescriptor getConstructor()	public void set(...) (See Note following table)
Class constructor parameter descriptions	constructorParmDescriptions	public java.lang.String[] getConstructorParmsDescriptions()	public void set(...) (See Note following table)
Class method descriptor	methodDescriptor	public com.bea.wlpi.common.MethodDescriptor getMethod()	public void set(...) (See Note following table)
Method parameter descriptions	methodParmDescriptions	public java.lang.String[] getMethodParmsDescriptions()	public void set(...) (See Note following table)
Boolean flag specifying whether or not the information is locked	published	public boolean isPublished()	public void set(...) (See Note following table)

 

Note: The following methods can be used to set specific Java class descriptor information, as specified in the previous table:

public void set(
  java.lang.String description,
  java.lang.String className,
  com.bea.wlpi.common.MethodDescriptor 
    constructorDescriptor,
  java.lang.String[] constructorParmDescriptions,
  com.bea.wlpi.common.MethodDescriptor methodDescriptor,
  java.lang.String[] methodParmDescriptions
)

public void set(
  java.lang.String description,
  java.lang.String className,
  com.bea.wlpi.common.MethodDescriptor 
    constructorDescriptor,
  java.lang.String[] constructorParmDescriptions,
  com.bea.wlpi.common.MethodDescriptor methodDescriptor,
  java.lang.String[] methodParmDescriptions,
  boolean published
)

For more information, see the com.bea.wlpi.common.ClassInvocationDescriptor Javadoc.

 

---

EJBDescriptor Object

The com.bea.wlpi.common.EJBDescriptor object describes an EJB. The EJBDescriptor is used to pass information to the client about EJBs deployed on the server.

The following constructor can be used to create a new EJBDescriptor object:

public EJBDescriptor()

The following table describes the EJBDescriptor object data, and the associated get and set methods that can be used to access that data after the object is defined.

Table C-3 EJBDescriptor Object Data  

Description	Get Method	Set Method
EJB deployment name	public java.lang.String getEJBDeploymentName()	public void setEJBDeploymentName(java.lang.String ejbDeploymentName)
EJB home name	public java.lang.String getEJBHomeName()	public void getEJBHomeName(java.lang.String ejbHomeName)
EJB home interface method descriptors	public java.util.List getEJBHomeMethodDescriptors()	public void setEJBHomeMethodDescriptors(java.util.List methodDescriptors)
EJB primary key name	public java.lang.String getEJBPrimaryKeyName()	public void setEJBPrimaryKeyName()
EJB remote interface method descriptors	public java.lang.Util getEJBRemoteMethodDescriptors()	public void setEJBRemoteMethodDescriptors(java.util.List methodDescriptors)
EJB remote name	public java.lang.String getEJBRemoteName()	public void setEJBRemoteName(java.lang.String ejbRemoteName)
Session or Entity EJB	public boolean isSessionEJB()	public void setSessionEJB()

For more information, see the com.bea.wlpi.common.EJBDescriptor Javadoc.

 

---

EJBInvocationDescriptor Object

The com.bea.wlpi.common.EJBInvocationDescriptor object describes and implements the invocation of an EJB method. The EJBInvocationDescriptor is used to obtain an EJB remote interface and invoke associated methods.

The following constructors can be used to create a new EJBInvocationDescriptor object:

public EJBInvocationDescriptor()

public EJBInvocationDescriptor(
  java.lang.String description,
  com.bea.wlpi.common.EJBDescriptor beanDescriptor,
  com.bea.wlpi.common.MethodDescriptor homeMethodDescriptor,
  java.lang.String[] homeParmDescriptions,
  com.bea.wlpi.common.MethodDescriptor remoteMethodDescriptor,
  java.lang.String[] remoteParmDescriptions
)

public EJBInvocationDescriptor(
  java.lang.String description,
  com.bea.wlpi.common.EJBDescriptor beanDescriptor,
  com.bea.wlpi.common.MethodDescriptor homeMethodDescriptor,
  java.lang.String[] homeParmDescriptions,
  com.bea.wlpi.common.MethodDescriptor remoteMethodDescriptor,
  java.lang.String[] remoteParmDescriptions,
  boolean published
)

The following table describes the EJBInvocationDescriptor object data, the constructor parameters used to define the data, and the associated get and set methods that can be used to access that data after the object is defined.

Table C-4 EJBInvocationDescriptor Object Data  

Object Data	Parameter	Get Method	Set Method
EJB invocation descriptor id	N/A	public java.lang.String getId()	public void setId()
EJB description in human-readable format	description	public java.lang.String getDescription()	public void set(...) (See Note following table)
EJB deployment name	N/A	public java.lang.String getEJBDeploymentName()	public void setEJBDeploymentName(java.lang.String deploymentName)
EJB deployment descriptor	beanDescriptor	public java.lang.String	public void set(...) (See Note following table)
Home interface name	N/A	public java.lang.String getEJBHomeName()	public void setEJBHomeName(java.lang.String ejbHomeName)
Home interface method descriptor	homeMethodDescriptor	public com.bea.wlpi.common.MethodDescriptor getEJBHomeMethod()	public void setEJBHomeMethod( com.bea.wlpi.common.MethodDescriptor ejbHomeMethod)
Home method parameter descriptions	homeParmDescriptions	public java.lang.String[] getHomeParmsDescriptions()	public void set(...) (See Note following table)
Remote interface name	N/A	public java.lang.String getEJBRemoteName()	public void setEJBRemoteName(java.lang.String ejbRemoteName)
Remote interface method descriptor	remoteMethodDescriptor	public com.bea.wlpi.common.MethodDescriptor getEJBRemoteMethod()	public void setEJBRemoteMethod( com.bea.wlpi.common.MethodDescriptor ejbRemoteMethod)
Remote method parameter descriptions	remoteParmDescriptions	public java.lang.String[] getRemoteParmsDescriptions()	public void set(...) (See Note following table)
Boolean flag specifying whether or not the information is locked	published	public boolean isPublished()	public void set(...) (See Note following table)
Primary key class name	N/A	public java.lang.String getEJBPrimaryKeyName()	public void setEJBPrimaryKeyName(java.lang.String ejbPrimaryKeyName)
Return type name	N/A	public java.lang.String getReturnTypeName()	N/A
Boolean flag specifying whether or not debugging messages are displayed when using the invoke() method, as described in Getting EJB Descriptors	N/A	public boolean isVerbose()	public void setVerbose (boolean verbose)
Boolean flag specifying whether or not the desriptor has all required values set	N/A	public boolean isFullyFormed()	N/A
Boolean flag specifying whether a session or entity EJB	N/A	public boolean isSessionEJB()	N/A

 

Note: The following methods can be used to set specific EJB invocation descriptor information, as specified in the previous table:

public void set(
  java.lang.String description,
  com.bea.wlpi.common.EJBDescriptor beanDescriptor,
  com.bea.wlpi.common.MethodDescriptor homeMethodDescriptor,
  java.lang.String[] homeParmDescriptions,
  com.bea.wlpi.common.MethodDescriptor    
    remoteMethodDescriptor,
  java.lang.String[] remoteParmDescriptions
)

public void set(
  java.lang.String description,
  com.bea.wlpi.common.EJBDescriptor beanDescriptor,
  com.bea.wlpi.common.MethodDescriptor homeMethodDescriptor,
  java.lang.String[] homeParmDescriptions,
  com.bea.wlpi.common.MethodDescriptor 
    remoteMethodDescriptor,
  java.lang.String[] remoteParmDescriptions,
  boolean published
)

For more information, see the com.bea.wlpi.common.EJBInvocationDescriptor Javadoc.

 

---

MethodDescriptor Object

The com.bea.wlpi.common.MethodDescriptor object describes a server-side Java class method. The MethodDescriptor is used to pass information to the client about the Java class constructors and/or methods.

The following constructors can be used to create a new MethodDescriptor object:

public MethodDescriptor(java.lang.reflect.Constructor constructor)

public MethodDescriptor(java.lang.reflect.Method method)

The following table describes the MethodDescriptor object data, and the associated get methods that can be used to access that data after the object is defined.

Table C-5 MethodDescriptor Object Data  

Description	Get Method
Method name	public final java.lang.String getMethodName()
Fully-qualified exception class names	public final java.lang.String[] getExceptionTypes()
Fully-qualified parameter class or interface names	public final java.lang.String[] getParameterTypes()
Return type	public final java.lang.String getReturnType()
Boolean flag specifying whether or not the method is abstract	public final boolean isAbstract()
Boolean flag specifying whether or not the method is final	public final boolean isFinal()
Boolean flag specifying whether or not the method is native	public final boolean isNative()
Boolean flag specifying whether or not the method or constructor is private	public final boolean isPrivate()
Boolean flag specifying whether or not the method or constructor is protected	public final boolean isProtected()
Boolean flag specifying whether or not the method is static	public final boolean isStatic()
Boolean flag specifying whether or not the method is strict	public final boolean isStrict()
Boolean flag specifying whether or not the method is synchronized	public final boolean isSynchronized()

For more information, see the com.bea.wlpi.common.MethodDescriptor Javadoc.