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

Class AbstractJMSMessageProducerWorkflowAction

    • Constructor Detail

      • 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 Detail

      • 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.

      • 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.

      • 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.

      • 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.

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