com.opensymphony.workflow.util
Class JMSMessage
java.lang.Object
com.opensymphony.workflow.util.JMSMessage
- All Implemented Interfaces:
- FunctionProvider
public class JMSMessage
- extends Object
- implements FunctionProvider
Sends out a JMS TextMessage to a specified Queue or Topic. The following arguments
are expected:
- queue-factory-location - the location to be passed to InitialContext.lookup
- queue-location - the location to be passed to InitialContext.lookup
- topic-factory-location - the location to be passed to InitialContext.lookup
- topic-location - the location to be passed to InitialContext.lookup
- text - the text message to be included in this JMS message
Also, please note that the entire set of properties will be passed through to the
constructor for InitialContext, meaning that if you need to use an
InintialContextFactory other than the default one, you are free to include arguments
that will do so.
Also note that all arguments are also passed to the TextMessage using
setObjectProperty(), except for "text" which is set using setText(). An extra
property is always added to denote the workflow entry for this message. This is
stored as a long property, with the name 'workflowEntry'.
- Author:
- Hani Suleiman
|
Method Summary |
void |
execute(Map transientVars,
Map args,
com.opensymphony.module.propertyset.PropertySet ps)
Execute this function |
| Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
JMSMessage
public JMSMessage()
execute
public void execute(Map transientVars,
Map args,
com.opensymphony.module.propertyset.PropertySet ps)
- Description copied from interface:
FunctionProvider
- Execute this function
- Specified by:
execute in interface FunctionProvider
- Parameters:
transientVars - Variables that will not be persisted. These include inputs
given in the Workflow.initialize(java.lang.String, int, java.util.Map) and Workflow.doAction(long, int, java.util.Map) method calls.
There are a number of special variable names:
entry: (object type: WorkflowEntry)
The workflow instance
context:
(object type: WorkflowContext). The workflow context.
actionId: The Integer ID of the current action that was take (if applicable).
currentSteps: A Collection of the current steps in the workflow instance.
store: The WorkflowStore.
descriptor: The WorkflowDescriptor.
Also, any variable set as a Register), will also be
available in the transient map, no matter what. These transient variables only last through
the method call that they were invoked in, such as Workflow.initialize(java.lang.String, int, java.util.Map)
and Workflow.doAction(long, int, java.util.Map).args - The properties for this function invocation. Properties are created
from arg nested elements within the xml, an arg element takes in a name attribute
which is the properties key, and the CDATA text contents of the element map to
the property value.ps - The persistent variables that are associated with the current
instance of the workflow. Any change made to the propertyset are persisted to
the propertyset implementation's persistent store.