Package com.adaptris.core

Class MessageLifecycleEvent

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Cloneable
    public class MessageLifecycleEvent
extends Event
implements java.lang.Cloneable, java.io.Serializable

    Container for message lifecycle events (MleMarkers) for implementations of AdaptrisMessage.

    In the adapter configuration file this class is aliased as message-lifecycle-event which is the preferred alternative to the fully qualified classname when building your configuration.

    See Also:
    Serialized Form

    • Constructor Detail

      • MessageLifecycleEvent

        public MessageLifecycleEvent()

        Creates a new instance.

    • Method Detail

      • getNameSpace

        public java.lang.String getNameSpace()

        Returns the immutable name space of this Event. Over-rides implementation in Event and adds .fail or .success to the end of the original name space, based on calling getWasSuccessful on all MleMarkers.

        Overrides:
        getNameSpace in class Event
        Returns:
        the namespace of this Event

      • addMleMarker

        public void addMleMarker​(MleMarker event)

        Adds a MleMarker to the end of the ordered internal store.

        Parameters:
        event - the MleMarker to add, may not be null

      • getMleMarkers

        public java.util.List<MleMarker> getMleMarkers()

        Returns the List of MleMarkers.

        Returns:
        the List of MleMarkers

      • setMleMarkers

        public void setMleMarkers​(java.util.List<MleMarker> l)

        Sets the List of MleMarkers.

        Parameters:
        l - the List of MleMarkers

      • setMessageUniqueId

        public void setMessageUniqueId​(java.lang.String uniqueId)

        Sets the unique ID of the message to which these MleMarkers are related.

        Parameters:
        uniqueId - the unique ID of the message to which these MleMarkers are related

      • getMessageUniqueId

        public java.lang.String getMessageUniqueId()

        Returns the unique ID of the message to which these MleMarkers are related.

        Returns:
        the unique ID of the message to which these MleMarkers are related.

      • getChannelId

        public java.lang.String getChannelId()
        Get the id of the channel that started processing this message.
        Returns:
        the channel id.

      • setChannelId

        public void setChannelId​(java.lang.String s)
        Set the id of the channel that is processing this message.
        Parameters:
        s - the channel id

      • setWorkflowId

        public void setWorkflowId​(java.lang.String s)
        Set the id of workflow that is processing this message.
        Parameters:
        s - the workflow id.

      • getWorkflowId

        public java.lang.String getWorkflowId()
        Get the id of the workflow that is processing this message.
        Returns:
        the workflow id.

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object

      • clone

        public MessageLifecycleEvent clone()
                            throws java.lang.CloneNotSupportedException
        Overrides:
        clone in class java.lang.Object
        Throws:
        java.lang.CloneNotSupportedException