com.ibm.bpe.clientmodel
Class BFMConnection

java.lang.Object
  extended bycom.ibm.bpe.clientmodel.BFMConnection

public class BFMConnection
extends java.lang.Object

The BFMConnection provides access to the BusinessFlowManagerService API. The API is rendered through an EJB. Use BFMConnection to initialize and configure the reference to the EJB.

To configure the connection use the following parameters:


Field Summary
static java.lang.String COPYRIGHT
          (C) Copyright IBM Corporation 2005.
 
Constructor Summary
BFMConnection()
          Create a new connection to the BusinessFlowManagerService.
 
Method Summary
 void close()
          Close the connection to the process engine
protected  void finalize()
           
 com.ibm.bpe.api.BusinessFlowManagerService getBusinessFlowManagerService()
          Retrieve the BusinessFlowManagerService bean.
 java.lang.String getJndiName()
          Get the JNDI name for the API EJB.
 java.lang.String getProviderURL()
          Get the URL to the service provider for the Business Process Choreographer API beans.
 java.lang.Object retrieve(com.ibm.bpe.api.OID id)
          Retrieve an application object by its identifier
 void setJndiName(java.lang.String newName)
          Set the JNDI name for the API EJB.
 void setProviderURL(java.lang.String url)
          Set the URL to the service provider of the Business Process Choreographer beans.
 
Methods inherited from class java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

COPYRIGHT

public static final java.lang.String COPYRIGHT
(C) Copyright IBM Corporation 2005.

See Also:
Constant Field Values
Constructor Detail

BFMConnection

public BFMConnection()
Create a new connection to the BusinessFlowManagerService.

Method Detail

getProviderURL

public java.lang.String getProviderURL()
Get the URL to the service provider for the Business Process Choreographer API beans.

Returns:
an URL

setProviderURL

public void setProviderURL(java.lang.String url)
Set the URL to the service provider of the Business Process Choreographer beans.

Parameters:
url - , e.g. "iiop://localhost"

getJndiName

public java.lang.String getJndiName()
Get the JNDI name for the API EJB.

Returns:
the JNDI lookup name

setJndiName

public void setJndiName(java.lang.String newName)
Set the JNDI name for the API EJB.

Parameters:
newName - The new JNDI lookup name

retrieve

public java.lang.Object retrieve(com.ibm.bpe.api.OID id)
                          throws ClientException
Retrieve an application object by its identifier

Parameters:
id - OID for the object
Returns:
the application object, e.g. ProcessTemplateData, ProcessInstanceData, ...
Throws:
ClientException

close

public void close()
Close the connection to the process engine


finalize

protected void finalize()
                 throws java.lang.Throwable
Throws:
java.lang.Throwable

getBusinessFlowManagerService

public com.ibm.bpe.api.BusinessFlowManagerService getBusinessFlowManagerService()
                                                                         throws javax.naming.NamingException,
                                                                                javax.ejb.CreateException,
                                                                                java.rmi.RemoteException
Retrieve the BusinessFlowManagerService bean.

Returns:
the BusinessFlowManagerService bean
Throws:
javax.naming.NamingException
javax.ejb.CreateException
java.rmi.RemoteException