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

Class AbstractJMSWorkflowEventSource

java.lang.Object
de.uplanet.lucy.server.workflow.eventsource.AbstractWorkflowEventSource
de.uplanet.lucy.server.workflow.eventsource.AbstractSingleThreadedWorkflowEventSource
de.uplanet.lucy.server.jms.workflow.eventsource.AbstractJMSWorkflowEventSource
All Implemented Interfaces:
de.uplanet.lucy.server.workflow.authentication.INeedCredentialSupplier, de.uplanet.lucy.server.workflow.authentication.INeedPasswordSupplier, IActivatableWorkflowObject, de.uplanet.lucy.server.workflow.IImpersonateUser, ILogLevelAware, INamedWorkflowObject, de.uplanet.lucy.server.workflow.INeedClusterInfo, INeedWorkflow, IRunnableWorkflowObject, IStartableWorkflowObject, ISupportAfterStopEvent, ISupportBeforeStartEvent, ISupportGlobalSharedState, IWorkflowEventSource, IWorkflowObject, Serializable
Direct Known Subclasses:
JMSQueueWorkflowEventSource, JMSTopicWorkflowEventSource
public abstract class AbstractJMSWorkflowEventSource extends AbstractSingleThreadedWorkflowEventSource implements de.uplanet.lucy.server.workflow.INeedClusterInfo, de.uplanet.lucy.server.workflow.authentication.INeedPasswordSupplier, ISupportGlobalSharedState, ISupportBeforeStartEvent, ISupportAfterStopEvent
Since:
Intrexx 7.0.
See Also:

  • Constructor Details

    • AbstractJMSWorkflowEventSource

      public AbstractJMSWorkflowEventSource(String p_strGuid)

  • Method Details

    • getClusterInfo

      public de.uplanet.lucy.server.workflow.IClusterInfo getClusterInfo()
      Specified by:
      getClusterInfo in interface de.uplanet.lucy.server.workflow.INeedClusterInfo

    • setClusterInfo

      public void setClusterInfo(de.uplanet.lucy.server.workflow.IClusterInfo p_clusterInfo)
      Specified by:
      setClusterInfo in interface de.uplanet.lucy.server.workflow.INeedClusterInfo

    • getOnErrorRestartWaitTimeout

      public long getOnErrorRestartWaitTimeout()
      Get the time in milliseconds the event source will wait before it tries to restart after an error occurred that prevented it to running the source loop.

      The default value is 60000 milliseconds (one minute).

      Returns:
      The timeout in milliseconds.

    • setOnErrorRestartWaitTimeout

      public void setOnErrorRestartWaitTimeout(long p_lOnErrorRestartWaitTimeout)
      Set the time in milliseconds the event source will wait before it tries to restart after an error occurred that prevented it to running the source loop.
      Parameters:
      p_lOnErrorRestartWaitTimeout - The timeout in milliseconds.

    • isGlobalSharedState

      public boolean isGlobalSharedState()
      Description copied from interface: ISupportGlobalSharedState
      This property determines if a global shared state should be used for all events created by this event source.
      Specified by:
      isGlobalSharedState in interface ISupportGlobalSharedState
      Returns:
      true if a global shared state should be used, or false otherwise.

    • isSendBeforeStartEvent

      public boolean isSendBeforeStartEvent()
      Description copied from interface: ISupportBeforeStartEvent
      This property determines if an before-start event should be sent.
      Specified by:
      isSendBeforeStartEvent in interface ISupportBeforeStartEvent
      Returns:
      true if an event should be sent before the workflow object's activity is about to being started, or false otherwise.

    • setGlobalSharedState

      public void setGlobalSharedState(boolean p_bGlobalSharedState)
      Description copied from interface: ISupportGlobalSharedState
      This property determines if a global shared state should be used for all events created by this event source.
      Specified by:
      setGlobalSharedState in interface ISupportGlobalSharedState
      Parameters:
      p_bGlobalSharedState - true if a global shared state should be used, or false otherwise.

    • setSendBeforeStartEvent

      public void setSendBeforeStartEvent(boolean p_bSendBeforeStartEvent)
      Description copied from interface: ISupportBeforeStartEvent
      This property determines if an before-start event should be sent.
      Specified by:
      setSendBeforeStartEvent in interface ISupportBeforeStartEvent
      Parameters:
      p_bSendBeforeStartEvent - true if an event should be sent before the workflow object's activity is about to being started, or false otherwise.

    • isSendAfterStopEvent

      public boolean isSendAfterStopEvent()
      Description copied from interface: ISupportAfterStopEvent
      This property determines if an after-stop event should be sent.
      Specified by:
      isSendAfterStopEvent in interface ISupportAfterStopEvent
      Returns:
      true if an event should be sent after the workflow object's activity has been stopped, or false otherwise.

    • setSendAfterStopEvent

      public void setSendAfterStopEvent(boolean p_bSendAfterStopEvent)
      Description copied from interface: ISupportAfterStopEvent
      This property determines if an after-stop event should be sent.
      Specified by:
      setSendAfterStopEvent in interface ISupportAfterStopEvent
      Parameters:
      p_bSendAfterStopEvent - true if an event should be sent after the workflow object's activity has been stopped, or false otherwise.

    • 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.
      Returns:
      The client identifier for the JMS connection.

    • setClientId

      public void setClientId(String p_strClientId)
      Set the client identifier for the JMS connection.
      Parameters:
      p_strClientId - The client identifier for the JMS connection.

    • isUseTransactedSession

      public boolean isUseTransactedSession()
      Determine if this event source uses transacted JMS sessions.

      Default is true.

      Returns:
      true if this event source uses transacted JMS sessions, or false otherwise.

    • setUseTransactedSession

      public void setUseTransactedSession(boolean p_bUseTransactedSession)
      Determine if this event source uses transacted JMS sessions.

      Default is true.

      Parameters:
      p_bUseTransactedSession - true if this event source should use transacted JMS sessions, or false otherwise.

    • getMessageSelector

      public String getMessageSelector()
      Get the message selector.
      Returns:
      The message selector.

    • setMessageSelector

      public void setMessageSelector(String p_strMessageSelector)
      Set the message selector.
      Parameters:
      p_strMessageSelector - The message selector.

    • stop

      public void stop()
      Description copied from interface: IStartableWorkflowObject
      Stop the workflow object.

      A call to this method must not throw an exception if the object is already stopped.

      Specified by:
      stop in interface IStartableWorkflowObject
      Overrides:
      stop in class AbstractSingleThreadedWorkflowEventSource