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:
  • Constructor Details

    • WebSocketWorkflowAction

      public WebSocketWorkflowAction(String p_strGuid)
  • Method Details

    • getWorkflowDirectory

      public Path getWorkflowDirectory()
      Description copied from interface: INeedWorkflowDirectory
      Get the workflow directory.
      Specified by:
      getWorkflowDirectory in interface INeedWorkflowDirectory
      Returns:
      The workflow directory.
    • setWorkflowDirectory

      public void setWorkflowDirectory(Path p_dir)
      Description copied from interface: INeedWorkflowDirectory
      Set the workflow directory.
      Specified by:
      setWorkflowDirectory in interface INeedWorkflowDirectory
      Parameters:
      p_dir - The workflow directory.
    • 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, or false 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, or false 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 interface IWorkflowAction
      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.