com.ibm.bpe.clientmodel

Class BFMConnection

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

  1. public class BFMConnection
  2. extends java.lang.Object

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

Use the following parameters to configure the connection:

For example, the BFMConnection can be used as context for a Command.


Field Summary

Modifier and Type Field and Description
  1. static
  2. java.lang.String
COPYRIGHT
(C) Copyright IBM Corporation 2005, 2012.

Constructor Summary

Constructor and Description
BFMConnection()
Creates a new connection to the BusinessFlowManagerService.

Method Summary

Modifier and Type Method and Description
  1. void
close()
Closes the connection to the process engine.
  1. protected
  2. void
finalize()
  1. BusinessFlowManagerService
getBusinessFlowManagerService()
Retrieves the BusinessFlowManagerService bean.
  1. java.lang.String
getJndiName()
Gets the JNDI name for the API EJB.
  1. java.lang.Boolean
getObserver()
Deprecated. As of version 8.0.1, the reporting feature is no longer supported. This method always returns false.
  1. java.lang.String
getProviderURL()
Gets the URL to the service provider for the Business Process Choreographer API beans.
  1. java.lang.String
getRemote()
Whether the connection is through a remote or local EJB interface.
  1. java.lang.Object
retrieve(OID id)
Retrieves a ProcessTemplateData, ProcessInstanceData or ActivityInstanceData object by its identifier
  1. void
setJndiName(java.lang.String newName)
Set the JNDI name for the API EJB.
  1. void
setObserver(java.lang.Boolean booleanValue)
Deprecated. As of version 8.0.1, the reporting feature is no longer supported. This value is ignored.
  1. void
setProviderURL(java.lang.String url)
Sets the URL to the service provider of the Business Process Choreographer beans.
  1. void
setRemote(java.lang.String booleanString)
Sets whether the connection is to be made through a remote or local EJB interface.
Methods inherited from class java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

  1. public static final java.lang.String COPYRIGHT
(C) Copyright IBM Corporation 2005, 2012.
See Also:

Constructor Detail

BFMConnection

  1. public BFMConnection()
Creates a new connection to the BusinessFlowManagerService.

Method Detail

getProviderURL

  1. public java.lang.String getProviderURL( )
Gets the URL to the service provider for the Business Process Choreographer API beans.
Returns:
a URL

setProviderURL

  1. public void setProviderURL(java.lang.String url)
Sets the URL to the service provider of the Business Process Choreographer beans.
Parameters:
url - For example, "iiop://localhost".

getJndiName

  1. public java.lang.String getJndiName( )
Gets the JNDI name for the API EJB.
Returns:
the JNDI lookup name

setJndiName

  1. public void setJndiName(java.lang.String newName)
Set the JNDI name for the API EJB.
Parameters:
newName - The new JNDI lookup name

setRemote

  1. public void setRemote(java.lang.String booleanString)
Sets whether the connection is to be made through a remote or local EJB interface.
Parameters:
booleanString - 'TRUE' and 'FALSE' are valid values.

getRemote

  1. public java.lang.String getRemote( )
Whether the connection is through a remote or local EJB interface.
Returns:
'TRUE' or 'FALSE'.

getObserver

  1. public java.lang.Boolean getObserver( )
Deprecated. As of version 8.0.1, the reporting feature is no longer supported. This method always returns false.
Gets whether the observer EJB is configured within BPCExplorer.
Returns:
'FALSE'.

setObserver

  1. public void setObserver(java.lang.Boolean booleanValue)
Deprecated. As of version 8.0.1, the reporting feature is no longer supported. This value is ignored.
Sets whether the observer EJB is configured within BPCExplorer.
Parameters:
booleanValue - 'TRUE' and 'FALSE' are valid values.

retrieve

  1. public java.lang.Object retrieve( OID id)
  2. throws ClientException
Retrieves a ProcessTemplateData, ProcessInstanceData or ActivityInstanceData object by its identifier
Parameters:
id - OID of the object
Returns:
the application object
Throws:

close

  1. public void close()
Closes the connection to the process engine.

finalize

  1. protected void finalize()
  2. throws java.lang.Throwable
Overrides:
finalize in class java.lang.Object
Throws:
java.lang.Throwable

getBusinessFlowManagerService

  1. public BusinessFlowManagerService getBusinessFlowManagerService( )
  2. throws javax.naming.NamingException
  3. javax.ejb.CreateException
  4. java.rmi.RemoteException
Retrieves the BusinessFlowManagerService bean.
Returns:
the BusinessFlowManagerService bean
Throws:
javax.naming.NamingException
javax.ejb.CreateException
java.rmi.RemoteException