Class AbstractJMSMessageProducerWorkflowAction
java.lang.Object
de.uplanet.lucy.server.workflow.action.AbstractWorkflowAction
de.uplanet.lucy.server.jms.workflow.action.AbstractJMSMessageProducerWorkflowAction
- All Implemented Interfaces:
IActivatableWorkflowObject
,INamedWorkflowObject
,de.uplanet.lucy.server.workflow.INeedWorkflow
,IWorkflowAction
,IWorkflowObject
,Serializable
- Direct Known Subclasses:
JMSQueueMessageProducerWorkflowAction
,JMSTopicMessageProducerWorkflowAction
- See Also:
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic final class
-
Field Summary
Fields inherited from interface de.uplanet.lucy.server.workflow.IWorkflowObject
GUID_COMPARATOR
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionGet the broker URL.Get the client identifier for the JMS connection.getData()
Get the message data configuration.Get the delivery mode.Get the password that is used when creating the JMS connection.long
Get the time-to-live of messages generated by this action.Get the user identity that used when creating the JMS connection.boolean
This property determines if it is an error when no data are available at runtime.boolean
Determine if this action uses transacted JMS sessions.de.uplanet.lucy.server.workflow.WorkflowTransition
process
(de.uplanet.lucy.server.workflow.event.IWorkflowEvent p_evt, de.uplanet.lucy.server.workflow.IWorkflowProcessingContext p_wfCtx, de.uplanet.lucy.server.IProcessingContext p_ctx) Process a workflow event in the given context.void
setBrokerUrl
(String p_strBrokerURL) Set the broker URL.void
setClientId
(String p_strClientId) Set the client identifier for the JMS connection.void
Set the message data configuration.void
setDeliveryMode
(String p_strDeliveryMode) Set the delivery mode.void
setNoMessageDataIsError
(boolean p_bNoMessageDataIsError) This property determines if it is an error when no data are available at runtime.void
setPassword
(String p_strPassword) Set the password that is used when creating the JMS connection.void
setTimeToLive
(long p_timeToLive) Set time-to-live of messages generated by this action.void
setUserName
(String p_strUserName) Set the user identity that used when creating the JMS connection.void
setUseTransactedSession
(boolean p_bUseTransactedSession) Determine if this action uses transacted JMS sessions.Methods inherited from class de.uplanet.lucy.server.workflow.action.AbstractWorkflowAction
getAfferentTransition, getEfferentTransition, getGuid, getName, getWorkflow, isActive, setActive, setAfferentTransition, setEfferentTransition, setName, setWorkflow, toString
-
Constructor Details
-
AbstractJMSMessageProducerWorkflowAction
- Parameters:
p_strGuid
- The GUID of the workflow action.- Throws:
IllegalArgumentException
- If the GUID parameter isnull
or if it does not represent a valid GUID.
-
-
Method Details
-
getBrokerUrl
Get the broker URL.- Returns:
- The broker URL.
-
setBrokerUrl
Set the broker URL.- Parameters:
p_strBrokerURL
- The broker URL.
-
getUserName
Get the user identity that used when creating the JMS connection.- Returns:
- The user identity.
-
setUserName
Set the user identity that used when creating the JMS connection.If this property is
null
(default) the default user identity will be used.- Parameters:
p_strUserName
- The user identity.
-
getPassword
Get the password that is used when creating the JMS connection.- Returns:
- The password.
-
setPassword
Set the password that is used when creating the JMS connection.- Parameters:
p_strPassword
- The password.
-
getClientId
Get the client identifier for the JMS connection.Note: If a client identifier has been set, the user must ensure that not multiple instances of this action run in parallel transactions.
- Returns:
- The client identifier for the JMS connection.
-
setClientId
Set the client identifier for the JMS connection.Note: If a client identifier has been set, the user must ensure that not multiple instances of this action run in parallel transactions.
- Parameters:
p_strClientId
- The client identifier for the JMS connection.
-
isUseTransactedSession
public boolean isUseTransactedSession()Determine if this action uses transacted JMS sessions.Default is
true
.- Returns:
true
if this action uses transacted JMS sessions, orfalse
otherwise.
-
setUseTransactedSession
public void setUseTransactedSession(boolean p_bUseTransactedSession) Determine if this action uses transacted JMS sessions.Default is
true
.- Parameters:
p_bUseTransactedSession
-true
if this action should use transacted JMS sessions, orfalse
otherwise.
-
getDeliveryMode
Get the delivery mode.The default value is
NON_PERSISTENT
.- Returns:
- The delivery mode.
-
setDeliveryMode
Set the delivery mode.- Parameters:
p_strDeliveryMode
- EitherNON_PERSISTENT
, orPERSISTENT
.
-
getTimeToLive
public long getTimeToLive()Get the time-to-live of messages generated by this action.- Returns:
- The time-to-live in milliseconds.
-
setTimeToLive
public void setTimeToLive(long p_timeToLive) Set time-to-live of messages generated by this action.- Parameters:
p_timeToLive
- The time-to-live in milliseconds. Zero is unlimited, a negative value means default.
-
getData
Get the message data configuration.- Returns:
- The message data configuration.
-
setData
Set the message data configuration.- Parameters:
p_dataCfg
- The message data configuration.
-
isNoMessageDataIsError
public boolean isNoMessageDataIsError()This property determines if it is an error when no data are available at runtime.If it is an error, an exception is thrown. Otherwise this action does nothing.
- Returns:
true
if it is an error when no data are available, orfalse
otherwise.
-
setNoMessageDataIsError
public void setNoMessageDataIsError(boolean p_bNoMessageDataIsError) This property determines if it is an error when no data are available at runtime.If it is an error, an exception is thrown. Otherwise this action does nothing.
- Parameters:
p_bNoMessageDataIsError
-true
if it is an error when no data are available, orfalse
otherwise.
-
process
public de.uplanet.lucy.server.workflow.WorkflowTransition process(de.uplanet.lucy.server.workflow.event.IWorkflowEvent p_evt, de.uplanet.lucy.server.workflow.IWorkflowProcessingContext p_wfCtx, de.uplanet.lucy.server.IProcessingContext p_ctx) throws de.uplanet.lucy.server.workflow.WorkflowException, jakarta.jms.JMSException, de.uplanet.util.InvalidPropertyException, de.uplanet.lucy.server.businesslogic.BlException, InterruptedException Description copied from interface:IWorkflowAction
Process a workflow event in the given context.Normally, a workflow action should return its efferent transition, regardless whether it is
active
, or not.- Parameters:
p_evt
- The event to be processed.p_wfCtx
- The workflow processing context.p_ctx
- The processing context.- Returns:
- The efferent transition, or
null
. - Throws:
InterruptedException
- If processing of this action has been interrupted.de.uplanet.lucy.server.workflow.WorkflowException
jakarta.jms.JMSException
de.uplanet.util.InvalidPropertyException
de.uplanet.lucy.server.businesslogic.BlException
-