Package de.uplanet.lucy.server.jms.workflow.action

Class AbstractJMSMessageProducerWorkflowAction

java.lang.Object
de.uplanet.lucy.server.workflow.action.AbstractWorkflowAction
de.uplanet.lucy.server.jms.workflow.action.AbstractJMSMessageProducerWorkflowAction
All Implemented Interfaces:
de.uplanet.lucy.server.workflow.authentication.INeedCredentialSupplier, de.uplanet.lucy.server.workflow.authentication.INeedPasswordSupplier, IActivatableWorkflowObject, INamedWorkflowObject, de.uplanet.lucy.server.workflow.INeedParameterProvider, INeedWorkflow, IWorkflowAction, IWorkflowObject, Serializable
Direct Known Subclasses:
JMSQueueMessageProducerWorkflowAction, JMSTopicMessageProducerWorkflowAction
public abstract class AbstractJMSMessageProducerWorkflowAction extends AbstractWorkflowAction implements de.uplanet.lucy.server.workflow.authentication.INeedPasswordSupplier, de.uplanet.lucy.server.workflow.INeedParameterProvider
See Also:

  • Constructor Details

    • AbstractJMSMessageProducerWorkflowAction

      public AbstractJMSMessageProducerWorkflowAction(String p_strGuid)
      Parameters:
      p_strGuid - The GUID of the workflow action.
      Throws:
      IllegalArgumentException - If the GUID parameter is null or if it does not represent a valid GUID.

  • Method Details

    • internalSetParameterProvider

      public void internalSetParameterProvider(de.uplanet.lucy.server.parameterstore.IParameterProvider p_pp)
      Specified by:
      internalSetParameterProvider in interface de.uplanet.lucy.server.workflow.INeedParameterProvider

    • internalGetParameterProvider

      public de.uplanet.lucy.server.parameterstore.IParameterProvider internalGetParameterProvider()
      Specified by:
      internalGetParameterProvider in interface de.uplanet.lucy.server.workflow.INeedParameterProvider

    • getBrokerUrl

      public String getBrokerUrl()
      Get the broker URL.
      Returns:
      The broker URL.

    • setBrokerUrl

      public void setBrokerUrl(String p_strBrokerUrl)
      Set the broker URL.
      Parameters:
      p_strBrokerUrl - The broker URL.

    • getBrokerUrlParamRef

      public String getBrokerUrlParamRef()

    • setBrokerUrlParamRef

      public void setBrokerUrlParamRef(String p_strParamRef)

    • getUserName

      public String getUserName()
      Get the user identity that used when creating the JMS connection.
      Returns:
      The user identity.

    • setUserName

      public void setUserName(String p_strUserName)
      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.

    • getUserNameParamRef

      public String getUserNameParamRef()

    • setUserNameParamRef

      public void setUserNameParamRef(String p_strParamRef)

    • getPassword

      public String getPassword()
      Get the password that is used when creating the JMS connection.
      Returns:
      The password.

    • setPassword

      public void setPassword(String p_strPassword)
      Set the password that is used when creating the JMS connection.
      Parameters:
      p_strPassword - The password.

    • internalSetPasswordSupplier

      public void internalSetPasswordSupplier(de.uplanet.lucy.server.workflow.authentication.IPasswordSupplier p_passwordSupplier)
      Specified by:
      internalSetPasswordSupplier in interface de.uplanet.lucy.server.workflow.authentication.INeedPasswordSupplier

    • internalGetPassword

      public String internalGetPassword()
      Specified by:
      internalGetPassword in interface de.uplanet.lucy.server.workflow.authentication.INeedPasswordSupplier

    • getClientId

      public String 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

      public void setClientId(String p_strClientId)
      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, or false 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, or false otherwise.

    • getDeliveryMode

      public String getDeliveryMode()
      Get the delivery mode.

      The default value is NON_PERSISTENT.

      Returns:
      The delivery mode.

    • setDeliveryMode

      public void setDeliveryMode(String p_strDeliveryMode)
      Set the delivery mode.
      Parameters:
      p_strDeliveryMode - Either NON_PERSISTENT, or PERSISTENT.

    • 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

      public AbstractJMSMessageProducerWorkflowAction.DataCfg getData()
      Get the message data configuration.
      Returns:
      The message data configuration.

    • setData

      public void setData(AbstractJMSMessageProducerWorkflowAction.DataCfg p_dataCfg)
      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, or false 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, or false otherwise.

    • process

      public WorkflowTransition process(IWorkflowEvent p_evt, de.uplanet.lucy.server.workflow.IWorkflowProcessingContext p_wfCtx, de.uplanet.lucy.server.IProcessingContext p_ctx) throws 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.

      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.
      WorkflowException
      jakarta.jms.JMSException
      de.uplanet.util.InvalidPropertyException
      de.uplanet.lucy.server.businesslogic.BlException