Class WebSocketWorkflowAction
java.lang.Object
de.uplanet.lucy.server.workflow.action.AbstractWorkflowAction
de.uplanet.lucy.server.websocket.workflow.action.WebSocketWorkflowAction
- All Implemented Interfaces:
IActivatableWorkflowObject
,INamedWorkflowObject
,INeedWorkflow
,INeedWorkflowDirectory
,IWorkflowAction
,IWorkflowObject
,Serializable
public final class WebSocketWorkflowAction
extends AbstractWorkflowAction
implements INeedWorkflowDirectory
- See Also:
-
Nested Class Summary
Nested Classes -
Field Summary
Fields inherited from interface de.uplanet.lucy.server.workflow.IWorkflowObject
GUID_COMPARATOR
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptiongetData()
Get the message data configuration.Get the topic GUID.Get the workflow directory.boolean
If this property istrue
the message created will only be sent after the current transaction has been committed.boolean
Determine if this action uses transacted Websocket sessions.process
(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
setData
(WebSocketWorkflowAction.DataCfg p_dataCfg) Set the message data configuration.void
setSendMessageAfterCommit
(boolean p_bSendMessageAfterCommit) If this property istrue
the message created will only be sent after the current transaction has been committed.void
setTopicGuid
(String p_strTopicGuid) Set the topic GUID.void
setUseTransactedSession
(boolean p_bUseTransactedSession) Determine if this action uses transacted Websocket sessions.void
setWorkflowDirectory
(Path p_dir) Set the workflow directory.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
-
WebSocketWorkflowAction
-
-
Method Details
-
getWorkflowDirectory
Description copied from interface:INeedWorkflowDirectory
Get the workflow directory.- Specified by:
getWorkflowDirectory
in interfaceINeedWorkflowDirectory
- Returns:
- The workflow directory.
-
setWorkflowDirectory
Description copied from interface:INeedWorkflowDirectory
Set the workflow directory.- Specified by:
setWorkflowDirectory
in interfaceINeedWorkflowDirectory
- Parameters:
p_dir
- The workflow directory.
-
getData
Get the message data configuration.- Returns:
- The message data configuration.
-
setData
Set the message data configuration.- Parameters:
p_dataCfg
- The message data configuration.
-
isSendMessageAfterCommit
public boolean isSendMessageAfterCommit()If this property istrue
the message created will only be sent after the current transaction has been committed.Default is
false
.- Returns:
true
if the message created will only be sent after the current transaction has been committed, orfalse
otherwise.
-
setSendMessageAfterCommit
public void setSendMessageAfterCommit(boolean p_bSendMessageAfterCommit) If this property istrue
the message created will only be sent after the current transaction has been committed.Default is
false
.- Parameters:
p_bSendMessageAfterCommit
-true
if the message created should only be sent after the current transaction has been committed, orfalse
otherwise.
-
isUseTransactedSession
public boolean isUseTransactedSession()Determine if this action uses transacted Websocket sessions.Default is
true
.- Returns:
true
if this action uses transacted Websocket sessions, orfalse
otherwise.
-
setUseTransactedSession
public void setUseTransactedSession(boolean p_bUseTransactedSession) Determine if this action uses transacted Websocket sessions.Default is
true
.- Parameters:
p_bUseTransactedSession
-true
if this action should use transacted Websocket sessions, orfalse
otherwise.
-
setTopicGuid
Set the topic GUID.- Parameters:
p_strTopicGuid
- The topic GUID to be set.
-
getTopicGuid
Get the topic GUID.- Returns:
- The topic GUID.
-
process
public WorkflowTransition process(IWorkflowEvent p_evt, de.uplanet.lucy.server.workflow.IWorkflowProcessingContext p_wfCtx, de.uplanet.lucy.server.IProcessingContext p_ctx) throws Exception 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.- Specified by:
process
in interfaceIWorkflowAction
- 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:
Exception
- If an error occurred.
-