|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.mule.transport.AbstractConnector org.mule.transport.bpm.ProcessConnector
public class ProcessConnector
The BPM provider allows Mule events to initiate and/or advance processes in an external or embedded Business Process Management System (BPMS). It also allows executing processes to generate Mule events.
Field Summary | |
---|---|
static String |
ACTION_ABORT
|
static String |
ACTION_ADVANCE
|
static String |
ACTION_START
|
static String |
ACTION_UPDATE
|
protected boolean |
allowGlobalDispatcher
If false, any message generated by the process is routed from the service on which it is received. |
protected boolean |
allowGlobalReceiver
The global receiver allows an endpoint of type "bpm://*" to receive any incoming message to the BPMS, regardless of the process. |
static String |
BPM_PROPERTY_PREFIX
|
protected BPMS |
bpms
The underlying BPMS |
static String |
GLOBAL_RECEIVER
|
static String |
PROCESS_VARIABLE_DATA
|
static String |
PROCESS_VARIABLE_INCOMING
|
static String |
PROCESS_VARIABLE_INCOMING_SOURCE
|
protected String |
processIdField
This field will be used to correlate messages with processes. |
static String |
PROPERTY_ACTION
|
static String |
PROPERTY_ENDPOINT
|
static String |
PROPERTY_PROCESS_ID
|
static String |
PROPERTY_PROCESS_STARTED
|
static String |
PROPERTY_PROCESS_TYPE
|
static String |
PROPERTY_TRANSITION
|
static String |
PROTOCOL
|
Fields inherited from class org.mule.transport.AbstractConnector |
---|
connected, createMultipleTransactedReceivers, DEFAULT_NUM_CONCURRENT_TX_RECEIVERS, dispatcherFactory, dispatchers, disposed, exceptionListener, initialised, logger, muleContext, name, numberOfConcurrentTransactedReceivers, receivers, requesterFactory, requesters, serviceDescriptor, serviceOverrides, sessionHandler, started, startOnConnect |
Fields inherited from interface org.mule.api.transport.Connector |
---|
INT_VALUE_NOT_SET |
Fields inherited from interface org.mule.api.lifecycle.Initialisable |
---|
PHASE_NAME |
Fields inherited from interface org.mule.api.lifecycle.Startable |
---|
PHASE_NAME |
Fields inherited from interface org.mule.api.lifecycle.Stoppable |
---|
PHASE_NAME |
Fields inherited from interface org.mule.api.lifecycle.Disposable |
---|
PHASE_NAME |
Constructor Summary | |
---|---|
ProcessConnector()
|
Method Summary | |
---|---|
protected void |
doConnect()
Template method where any connections should be made for the connector |
protected void |
doDisconnect()
Template method where any connected resources used by the connector should be disconnected |
protected void |
doDispose()
Template method to perform any work when destroying the connectoe |
protected void |
doInitialise()
|
protected void |
doStart()
Template method to perform any work when starting the connectoe |
protected void |
doStop()
Template method to perform any work when stopping the connectoe |
MuleMessage |
generateMessage(String endpoint,
Object payloadObject,
Map messageProperties,
boolean synchronous)
|
BPMS |
getBpms()
|
MuleClient |
getMuleClient()
|
String |
getProcessIdField()
|
String |
getProtocol()
|
boolean |
isAllowGlobalDispatcher()
|
boolean |
isAllowGlobalReceiver()
|
ProcessMessageReceiver |
lookupReceiver(String processName,
Object processId)
This method looks for a receiver based on the process name and ID. |
void |
setAllowGlobalDispatcher(boolean allowGlobalDispatcher)
|
void |
setAllowGlobalReceiver(boolean allowGlobalReceiver)
|
void |
setBpms(BPMS bpms)
|
void |
setProcessIdField(String processIdField)
|
String |
toUrl(String processName,
Object processId)
Generate a URL based on the process name and ID such as "bpm://myProcess/2342" If the parameters are missing, and allowGlobalReceiver is true,
the GLOBAL_RECEIVER is returned. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
protected BPMS bpms
protected String processIdField
protected boolean allowGlobalReceiver
protected boolean allowGlobalDispatcher
public static final String BPM_PROPERTY_PREFIX
public static final String PROPERTY_ENDPOINT
public static final String PROPERTY_PROCESS_TYPE
public static final String PROPERTY_PROCESS_ID
public static final String PROPERTY_ACTION
public static final String PROPERTY_TRANSITION
public static final String PROPERTY_PROCESS_STARTED
public static final String ACTION_START
public static final String ACTION_ADVANCE
public static final String ACTION_UPDATE
public static final String ACTION_ABORT
public static final String PROCESS_VARIABLE_INCOMING
public static final String PROCESS_VARIABLE_INCOMING_SOURCE
public static final String PROCESS_VARIABLE_DATA
public static final String PROTOCOL
public static final String GLOBAL_RECEIVER
Constructor Detail |
---|
public ProcessConnector()
Method Detail |
---|
public String getProtocol()
getProtocol
in interface Connector
protected void doInitialise() throws InitialisationException
doInitialise
in class AbstractConnector
InitialisationException
protected void doDispose()
AbstractConnector
doDispose
in class AbstractConnector
protected void doConnect() throws Exception
AbstractConnector
doConnect
in class AbstractConnector
Exception
protected void doDisconnect() throws Exception
AbstractConnector
doDisconnect
in class AbstractConnector
Exception
protected void doStart() throws MuleException
AbstractConnector
doStart
in class AbstractConnector
MuleException
- if the method failsprotected void doStop() throws MuleException
AbstractConnector
doStop
in class AbstractConnector
MuleException
- if the method failspublic ProcessMessageReceiver lookupReceiver(String processName, Object processId)
public String toUrl(String processName, Object processId)
allowGlobalReceiver
is true,
the GLOBAL_RECEIVER is returned.
public MuleMessage generateMessage(String endpoint, Object payloadObject, Map messageProperties, boolean synchronous) throws Exception
generateMessage
in interface MessageService
Exception
public BPMS getBpms()
public void setBpms(BPMS bpms)
public MuleClient getMuleClient()
public boolean isAllowGlobalDispatcher()
public void setAllowGlobalDispatcher(boolean allowGlobalDispatcher)
public boolean isAllowGlobalReceiver()
public void setAllowGlobalReceiver(boolean allowGlobalReceiver)
public String getProcessIdField()
public void setProcessIdField(String processIdField)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |