com.bea.wlpi.server.catalog
Interface EJBCatalog

public interface EJBCatalog

extends javax.ejb.EJBObject

Provides a catalog of EJBs installed on the application server.

See Also:

EJBCatalogHome

Method Summary

java.util.List	getEJBDescriptors() List the EJBs installed in the previously specified JNDI context.
java.util.List	getEJBNames() List the JNDI names of EJBs installed in the previously specified JNDI context.
boolean	inspectAlways() Return whether the JNDI names and EJBMetaData are regenerated on every call.
void	ping() A "dummy" method for the client to ping.
void	setCatalogRoot(java.lang.String root) Set the JNDI context to use when looking up installed EJBs.
void	setInspectAlways(boolean inspectAlways) Specify whether to regenerate the JNDI names and EJBMetaData on every call to getEJBNames() and getEJBDescriptors().

Methods inherited from interface javax.ejb.EJBObject

getEJBHome, getHandle, getPrimaryKey, isIdentical, remove

Method Detail

ping

public void ping()
          throws java.rmi.RemoteException

A "dummy" method for the client to ping. This is to avoid a WLS "feature" that dereferences a remote object that has not been referenced for a certain amound of time. This causes the client to die.

Throws:

java.rmi.RemoteException - if a communications error occurred.

setCatalogRoot

public void setCatalogRoot(java.lang.String root)
                    throws java.rmi.RemoteException

Set the JNDI context to use when looking up installed EJBs.

Parameters:

root - JNDI name of context containing EJB bindings.

Throws:

java.rmi.RemoteException - if a communication error occurs.

getEJBNames

public java.util.List getEJBNames()
                           throws WorkflowException,
                                  java.rmi.RemoteException

List the JNDI names of EJBs installed in the previously specified JNDI context. The default implementation recursively iterates through all JNDI bindings within this context and builds a list containing the JNDI name of all EJBHome objects encountered.

Returns:

A list of JNDI names for installed EJB home interfaces.

Throws:

java.rmi.RemoteException - if a communication error occurs.

WorkflowException -

See Also:

setCatalogRoot(java.lang.String), getEJBDescriptors()

getEJBDescriptors

public java.util.List getEJBDescriptors()
                                 throws WorkflowException,
                                        java.rmi.RemoteException

List the EJBs installed in the previously specified JNDI context. The default implementation recursively iterates through all JNDI bindings within this context and builds a list containing an EJBMetaData object for each EJBHome object encountered.

Returns:

A list of javax.ejb.EJBMetaData objects.

Throws:

java.rmi.RemoteException - if a communication error occurs.

WorkflowException -

See Also:

setCatalogRoot(java.lang.String), getEJBNames()

inspectAlways

public boolean inspectAlways()
                      throws java.rmi.RemoteException

Return whether the JNDI names and EJBMetaData are regenerated on every call.

Returns:

true - if the JNDI names and EJBMetaData are regenerated on every call to getEJBNames() and getEJBDescriptors().

Throws:

java.rmi.RemoteException - if a communication error occurs.

See Also:

setInspectAlways(boolean)

setInspectAlways

public void setInspectAlways(boolean inspectAlways)
                      throws java.rmi.RemoteException

Specify whether to regenerate the JNDI names and EJBMetaData on every call to getEJBNames() and getEJBDescriptors().

Parameters:

inspectAlways - true to disable server-side caching of JNDI names and EJBMetaData.

Throws:

java.rmi.RemoteException - if a communication error occurs.

See Also:

inspectAlways()