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:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
WebSocketWorkflowAction.DataCfg
-
Field Summary
-
Fields inherited from interface de.uplanet.lucy.server.workflow.IWorkflowObject
GUID_COMPARATOR
-
-
Constructor Summary
Constructors Constructor Description WebSocketWorkflowAction(String p_strGuid)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description WebSocketWorkflowAction.DataCfg
getData()
Get the message data configuration.String
getTopicGuid()
Get the topic GUID.Path
getWorkflowDirectory()
Get the workflow directory.boolean
isUseTransactedSession()
Determine if this action uses transacted Websocket sessions.WorkflowTransition
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
setTopicGuid(String p_topicGuid)
Set the topic GUID.void
setUseTransactedSession(boolean p_useTransactedSession)
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 Detail
-
WebSocketWorkflowAction
public WebSocketWorkflowAction(String p_strGuid)
-
-
Method Detail
-
getWorkflowDirectory
public Path getWorkflowDirectory()
Description copied from interface:INeedWorkflowDirectory
Get the workflow directory.- Specified by:
getWorkflowDirectory
in interfaceINeedWorkflowDirectory
- Returns:
- The workflow directory.
-
setWorkflowDirectory
public void setWorkflowDirectory(Path p_dir)
Description copied from interface:INeedWorkflowDirectory
Set the workflow directory.- Specified by:
setWorkflowDirectory
in interfaceINeedWorkflowDirectory
- Parameters:
p_dir
- The workflow directory.
-
getData
public WebSocketWorkflowAction.DataCfg getData()
Get the message data configuration.- Returns:
- The message data configuration.
-
setData
public void setData(WebSocketWorkflowAction.DataCfg p_dataCfg)
Set the message data configuration.- Parameters:
p_dataCfg
- The message data configuration.
-
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_useTransactedSession)
Determine if this action uses transacted Websocket sessions.Default is
true
.- Parameters:
p_useTransactedSession
-true
if this action should use transacted Websocket sessions, orfalse
otherwise.
-
setTopicGuid
public void setTopicGuid(String p_topicGuid)
Set the topic GUID.- Parameters:
p_topicGuid
- The topic GUID to be set.- Throws:
IllegalArgumentException
- If {code p_topicGuid} is not a valid GUID.
-
getTopicGuid
public String 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:
InterruptedException
- If processing of this action has been interrupted.Exception
- If an error occurred.
-
-