--- ProcessConnector.java 2007-09-16 10:41:00.000000000 +0200
+++ ProcessConnector.java.new 2007-12-23 02:31:17.000000000 +0100
@@ -23,257 +23,207 @@
import java.util.Map;
/**
- * 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.
+ * 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.
*/
-public class ProcessConnector extends AbstractConnector implements MessageService
-{
- /** The underlying BPMS */
- protected BPMS bpms;
-
- /**
- * If the BPMS instance itself is not provided, it will be instantiated from this class
- * (using the default constructor).
- */
- protected String bpmsClass;
-
- /** This field will be used to correlate messages with processes. */
- protected String processIdField;
-
- /**
- * The global receiver allows an endpoint of type "bpm://*" to receive any
- * incoming message to the BPMS, regardless of the process. If this is false, the
- * process name must be specified for each endpoint, e.g. "bpm://MyProcess" will
- * only receive messages for the process "MyProcess".
- */
- protected boolean allowGlobalReceiver = false;
-
- /**
- * If false, any message generated by the process is routed from the component on
- * which it is received. If true, a process can send messages to any endpoint
- * on any component.
- */
- protected boolean allowGlobalDispatcher = false;
-
- public static final String PROPERTY_ENDPOINT = "endpoint";
- public static final String PROPERTY_PROCESS_TYPE = "processType";
- public static final String PROPERTY_PROCESS_ID = "processId";
- public static final String PROPERTY_ACTION = "action";
- public static final String PROPERTY_TRANSITION = "transition";
- public static final String PROPERTY_PROCESS_STARTED = "started";
- public static final String ACTION_START = "start";
- public static final String ACTION_ADVANCE = "advance";
- public static final String ACTION_UPDATE = "update";
- public static final String ACTION_ABORT = "abort";
- public static final String PROCESS_VARIABLE_INCOMING = "incoming";
- public static final String PROCESS_VARIABLE_INCOMING_SOURCE = "incomingSource";
- public static final String PROCESS_VARIABLE_DATA = "data";
-
- public static final String PROTOCOL = "bpm";
- public static final String GLOBAL_RECEIVER = PROTOCOL + "://*";
-
- private MuleClient muleClient = null;
-
- public String getProtocol()
- {
- return PROTOCOL;
- }
-
- protected void doInitialise() throws InitialisationException
- {
- try
- {
- if (bpms == null)
- {
- if (bpmsClass != null)
- {
- logger.info("Instantiating BPMS from the default constructor for " + bpmsClass);
- bpms = (BPMS) ClassUtils.instanciateClass(bpmsClass, new Object[0]);
- }
- else
- {
- throw new ConfigurationException(
- MessageFactory.createStaticMessage("Either the bpms or bpmsClass property must be set for this connector."));
+public class ProcessConnector extends AbstractConnector implements MessageService {
+ /** The underlying BPMS */
+ protected BPMS bpms;
+
+ /**
+ * If the BPMS instance itself is not provided, it will be instantiated from this class
+ * (using the default constructor).
+ */
+ protected String bpmsClass;
+
+ /** This field will be used to correlate messages with processes. */
+ protected String processIdField;
+
+ /**
+ * The global receiver allows an endpoint of type "bpm://*" to receive any incoming message
+ * to the BPMS, regardless of the process. If this is false, the process name must be
+ * specified for each endpoint, e.g. "bpm://MyProcess" will only receive messages for the
+ * process "MyProcess".
+ */
+ protected boolean allowGlobalReceiver = false;
+
+ /**
+ * If false, any message generated by the process is routed from the component on which it
+ * is received. If true, a process can send messages to any endpoint on any component.
+ */
+ protected boolean allowGlobalDispatcher = false;
+
+ public static final String PROPERTY_PREFIX = "BPM_";
+ public static final String PROPERTY_ENDPOINT = MuleProperties.PROPERTY_PREFIX + PROPERTY_PREFIX + "ENDPOINT";
+ public static final String PROPERTY_PROCESS_TYPE = MuleProperties.PROPERTY_PREFIX + PROPERTY_PREFIX + "PROCESS_TYPE";
+ public static final String PROPERTY_PROCESS_ID = MuleProperties.PROPERTY_PREFIX + PROPERTY_PREFIX + "PROCESS_ID";
+ public static final String PROPERTY_ACTION = MuleProperties.PROPERTY_PREFIX + PROPERTY_PREFIX + "ACTION";
+ public static final String PROPERTY_TRANSITION = MuleProperties.PROPERTY_PREFIX + PROPERTY_PREFIX + "TRANSITION";
+ public static final String PROPERTY_PROCESS_STARTED = MuleProperties.PROPERTY_PREFIX + PROPERTY_PREFIX + "STARTED";
+ public static final String ACTION_START = "start";
+ public static final String ACTION_ADVANCE = "advance";
+ public static final String ACTION_UPDATE = "update";
+ public static final String ACTION_ABORT = "abort";
+ public static final String PROCESS_VARIABLE_INCOMING = "incoming";
+ public static final String PROCESS_VARIABLE_INCOMING_SOURCE = "incomingSource";
+ public static final String PROCESS_VARIABLE_DATA = "data";
+
+ public static final String PROTOCOL = "bpm";
+ public static final String GLOBAL_RECEIVER = PROTOCOL + "://*";
+
+ private MuleClient muleClient = null;
+
+ public String getProtocol() {
+ return PROTOCOL;
+ }
+
+ protected void doInitialise() throws InitialisationException {
+ try {
+ if (bpms == null) {
+ if (bpmsClass != null) {
+ logger.info("Instantiating BPMS from the default constructor for " + bpmsClass);
+ bpms = (BPMS) ClassUtils.instanciateClass(bpmsClass, new Object[0]);
+ } else {
+ throw new ConfigurationException(MessageFactory.createStaticMessage("Either the bpms or bpmsClass property must be set for this connector."));
+ }
+ }
+
+ // Set a callback so that the BPMS may generate messages within Mule.
+ bpms.setMessageService(this);
+
+ // The MuleClient is used as a global dispatcher.
+ // TODO MULE-1221 It would be cleaner to use something like the dynamic://
+ // transport
+ if ((allowGlobalDispatcher == true) && (muleClient == null)) {
+ muleClient = new MuleClient(false);
+ }
+ } catch (Exception e) {
+ throw new InitialisationException(e, this);
}
- }
-
- // Set a callback so that the BPMS may generate messages within Mule.
- bpms.setMessageService(this);
-
- // The MuleClient is used as a global dispatcher.
- // TODO MULE-1221 It would be cleaner to use something like the dynamic:// transport
- if ((allowGlobalDispatcher == true) && (muleClient == null))
- {
- muleClient = new MuleClient(false);
- }
- }
- catch (Exception e)
- {
- throw new InitialisationException(e, this);
}
- }
-
- protected void doDispose()
- {
- // template method
- }
-
- protected void doConnect() throws Exception
- {
- // template method
- }
-
- protected void doDisconnect() throws Exception
- {
- // template method
- }
-
- protected void doStart() throws UMOException
- {
- // template method
- }
-
- protected void doStop() throws UMOException
- {
- // template method
- }
-
- /**
- * This method looks for a receiver based on the process name and ID. It searches
- * iteratively from the narrowest scope (match process name and ID) to the widest
- * scope (match neither - global receiver) possible.
- *
- * @return ProcessMessageReceiver or null if no match is found
- */
- public ProcessMessageReceiver lookupReceiver(String processName, Object processId)
- {
- ProcessMessageReceiver receiver = (ProcessMessageReceiver)lookupReceiver(toUrl(processName, processId));
- if (receiver == null)
- {
- receiver = (ProcessMessageReceiver)lookupReceiver(toUrl(processName, null));
- }
- if (receiver == null)
- {
- receiver = (ProcessMessageReceiver)lookupReceiver(toUrl(null, null));
+
+ protected void doDispose() {
+ // template method
+ }
+
+ protected void doConnect() throws Exception {
+ // template method
+ }
+
+ protected void doDisconnect() throws Exception {
+ // template method
+ }
+
+ protected void doStart() throws UMOException {
+ // template method
+ }
+
+ protected void doStop() throws UMOException {
+ // template method
+ }
+
+ /**
+ * This method looks for a receiver based on the process name and ID. It searches
+ * iteratively from the narrowest scope (match process name and ID) to the widest scope
+ * (match neither - global receiver) possible.
+ *
+ * @return ProcessMessageReceiver or null if no match is found
+ */
+ public ProcessMessageReceiver lookupReceiver(String processName, Object processId) {
+ ProcessMessageReceiver receiver = (ProcessMessageReceiver) lookupReceiver(toUrl(processName, processId));
+ if (receiver == null) {
+ receiver = (ProcessMessageReceiver) lookupReceiver(toUrl(processName, null));
+ }
+ if (receiver == null) {
+ receiver = (ProcessMessageReceiver) lookupReceiver(toUrl(null, null));
+ }
+ return receiver;
}
- return receiver;
- }
-
- /**
- * 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.
- */
- public String toUrl(String processName, Object processId)
- {
- String url = getProtocol() + "://";
- if (StringUtils.isNotEmpty(processName))
- {
- url += processName;
- if (processId != null)
- {
- url += "/" + processId;
- }
- }
- else if (isAllowGlobalReceiver())
- {
- return GLOBAL_RECEIVER;
- }
- else
- {
- throw new IllegalArgumentException(
- "No valid URL could be created for the given process name and ID: processName = " + processName + ", processId = " + 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.
+ */
+ public String toUrl(String processName, Object processId) {
+ String url = getProtocol() + "://";
+ if (StringUtils.isNotEmpty(processName)) {
+ url += processName;
+ if (processId != null) {
+ url += "/" + processId;
+ }
+ } else if (isAllowGlobalReceiver()) {
+ return GLOBAL_RECEIVER;
+ } else {
+ throw new IllegalArgumentException("No valid URL could be created for the given process name and ID: processName = " + processName + ", processId = " + processId);
+ }
+ return url;
}
- return url;
- }
-
- public UMOMessage generateMessage(String endpoint,
- Object payloadObject,
- Map messageProperties,
- boolean synchronous) throws Exception
- {
- String processName = (String)messageProperties.get(ProcessConnector.PROPERTY_PROCESS_TYPE);
- Object processId = messageProperties.get(ProcessConnector.PROPERTY_PROCESS_ID);
-
- // Look up a receiver for this process.
- ProcessMessageReceiver receiver = lookupReceiver(processName, processId);
- if (receiver == null)
- {
- throw new ConfigurationException(MessageFactory
- .createStaticMessage("No corresponding receiver found for processName = " + processName
- + ", processId = " + processId));
+
+ public UMOMessage generateMessage(String endpoint, Object payloadObject, Map messageProperties, boolean synchronous) throws Exception {
+ String processName = (String) messageProperties.get(ProcessConnector.PROPERTY_PROCESS_TYPE);
+ Object processId = messageProperties.get(ProcessConnector.PROPERTY_PROCESS_ID);
+
+ // Look up a receiver for this process.
+ ProcessMessageReceiver receiver = lookupReceiver(processName, processId);
+ if (receiver == null) { throw new ConfigurationException(MessageFactory.createStaticMessage("No corresponding receiver found for processName = " + processName + ", processId = " + processId)); }
+
+ if (synchronous) {
+ // Send the process-generated Mule message synchronously.
+ return receiver.generateSynchronousEvent(endpoint, payloadObject, messageProperties);
+ } else {
+ // Dispatch the process-generated Mule message asynchronously.
+ receiver.generateAsynchronousEvent(endpoint, payloadObject, messageProperties);
+ return null;
+ }
}
-
- if (synchronous)
- {
- // Send the process-generated Mule message synchronously.
- return receiver.generateSynchronousEvent(endpoint, payloadObject, messageProperties);
- }
- else
- {
- // Dispatch the process-generated Mule message asynchronously.
- receiver.generateAsynchronousEvent(endpoint, payloadObject, messageProperties);
- return null;
+
+ // //////////////////////////////////////////////////////////////////////////
+ // Getters and Setters
+ // //////////////////////////////////////////////////////////////////////////
+
+ public BPMS getBpms() {
+ return bpms;
+ }
+
+ public void setBpms(BPMS bpms) {
+ this.bpms = bpms;
+ }
+
+ public String getBpmsClass() {
+ return bpmsClass;
+ }
+
+ public void setBpmsClass(String bpmsClass) {
+ this.bpmsClass = bpmsClass;
+ }
+
+ public MuleClient getMuleClient() {
+ return muleClient;
+ }
+
+ public boolean isAllowGlobalDispatcher() {
+ return allowGlobalDispatcher;
+ }
+
+ public void setAllowGlobalDispatcher(boolean allowGlobalDispatcher) {
+ this.allowGlobalDispatcher = allowGlobalDispatcher;
+ }
+
+ public boolean isAllowGlobalReceiver() {
+ return allowGlobalReceiver;
+ }
+
+ public void setAllowGlobalReceiver(boolean allowGlobalReceiver) {
+ this.allowGlobalReceiver = allowGlobalReceiver;
+ }
+
+ public String getProcessIdField() {
+ return processIdField;
+ }
+
+ public void setProcessIdField(String processIdField) {
+ this.processIdField = processIdField;
}
- }
-
- // //////////////////////////////////////////////////////////////////////////
- // Getters and Setters
- // //////////////////////////////////////////////////////////////////////////
-
- public BPMS getBpms()
- {
- return bpms;
- }
-
- public void setBpms(BPMS bpms)
- {
- this.bpms = bpms;
- }
-
- public String getBpmsClass()
- {
- return bpmsClass;
- }
-
- public void setBpmsClass(String bpmsClass)
- {
- this.bpmsClass = bpmsClass;
- }
-
- public MuleClient getMuleClient()
- {
- return muleClient;
- }
-
- public boolean isAllowGlobalDispatcher()
- {
- return allowGlobalDispatcher;
- }
-
- public void setAllowGlobalDispatcher(boolean allowGlobalDispatcher)
- {
- this.allowGlobalDispatcher = allowGlobalDispatcher;
- }
-
- public boolean isAllowGlobalReceiver()
- {
- return allowGlobalReceiver;
- }
-
- public void setAllowGlobalReceiver(boolean allowGlobalReceiver)
- {
- this.allowGlobalReceiver = allowGlobalReceiver;
- }
-
- public String getProcessIdField()
- {
- return processIdField;
- }
-
- public void setProcessIdField(String processIdField)
- {
- this.processIdField = processIdField;
- }
}