public class BFMConnection
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:
jndiName
(mandatory): JNDI name for the EJB module.remote
(optional): Defines whether the connection is to be made through a remote ('TRUE') or local ('FALSE') EJB interface.
'TRUE' and 'FALSE' are valid values; the default value is 'FALSE'.providerURL
(optional): This parameter is used if the JNDI lookup for the EJB is not to be performed
against the local name serverobserver
(optional): Deprecated - The reporting feature is no longer supported.
This value is ignored and always 'FALSE'.BFMConnection
can be used as context for a Command
.
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
COPYRIGHT
(C) Copyright IBM Corporation 2005, 2012.
|
Constructor and Description |
---|
BFMConnection()
Creates a new connection to the BusinessFlowManagerService.
|
Modifier and Type | Method and Description |
---|---|
void |
close()
Closes the connection to the process engine.
|
protected void |
finalize() |
BusinessFlowManagerService |
getBusinessFlowManagerService()
Retrieves the BusinessFlowManagerService bean.
|
java.lang.String |
getJndiName()
Gets the JNDI name for the API EJB.
|
java.lang.Boolean |
getObserver()
Deprecated.
As of version 8.0.1, the reporting feature is no longer supported. This method always returns false.
|
java.lang.String |
getProviderURL()
Gets the URL to the service provider for the Business Process Choreographer API beans.
|
java.lang.String |
getRemote()
Whether the connection is through a remote or local EJB interface.
|
java.lang.Object |
retrieve(OID id)
Retrieves a ProcessTemplateData, ProcessInstanceData
or ActivityInstanceData object by its identifier
|
void |
setJndiName(java.lang.String newName)
Set the JNDI name for the API EJB.
|
void |
setObserver(java.lang.Boolean booleanValue)
Deprecated.
As of version 8.0.1, the reporting feature is no longer supported. This value is ignored.
|
void |
setProviderURL(java.lang.String url)
Sets the URL to the service provider of the Business Process Choreographer beans.
|
void |
setRemote(java.lang.String booleanString)
Sets whether the connection is to be made through a remote or local EJB interface.
|
public static final java.lang.String COPYRIGHT
public BFMConnection()
public java.lang.String getProviderURL()
public void setProviderURL(java.lang.String url)
url
- For example, "iiop://localhost".public java.lang.String getJndiName()
public void setJndiName(java.lang.String newName)
newName
- The new JNDI lookup namepublic void setRemote(java.lang.String booleanString)
booleanString
- 'TRUE' and 'FALSE' are valid values.public java.lang.String getRemote()
public java.lang.Boolean getObserver()
public void setObserver(java.lang.Boolean booleanValue)
booleanValue
- 'TRUE' and 'FALSE' are valid values.public java.lang.Object retrieve(OID id) throws ClientException
id
- OID
of the objectClientException
public void close()
protected void finalize() throws java.lang.Throwable
finalize
in class java.lang.Object
java.lang.Throwable
public BusinessFlowManagerService getBusinessFlowManagerService() throws javax.naming.NamingException, javax.ejb.CreateException, java.rmi.RemoteException
javax.naming.NamingException
javax.ejb.CreateException
java.rmi.RemoteException