Package com.adaptris.core

Class MleMarker

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

    Records information about activities (generally Service implementations) performed on a AdaptrisMessage during a workflow.

    See Also:
    MessageLifecycleEvent, Serialized Form

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

    • Constructor Summary

      Constructors 
      Constructor Description
      MleMarker()
      Creates a new instance.
      MleMarker​(MessageEventGenerator meg, boolean success, long seq, java.lang.String uniqueId)  
      MleMarker​(java.lang.String s, boolean b, long seq, java.lang.String id)
      Creates a new instance.

    • Constructor Detail

      • MleMarker

        public MleMarker()

        Creates a new instance.

      • MleMarker

        public MleMarker​(MessageEventGenerator meg,
                 boolean success,
                 long seq,
                 java.lang.String uniqueId)

      • MleMarker

        public MleMarker​(java.lang.String s,
                 boolean b,
                 long seq,
                 java.lang.String id)

        Creates a new instance.

        Parameters:
        s - the name of the 'event'
        b - true if successful
        seq - the sequence number
        id - the Unique id

    • Method Detail

      • setCreationTime

        public void setCreationTime​(long l)
        Set the creation time for this marker.
        Parameters:
        l - the creation time.

      • getCreationTime

        public long getCreationTime()
        Get the creation time.
        Returns:
        the creation time.

      • setName

        public void setName​(java.lang.String s)
        Set the name of this marker.
        Parameters:
        s - the name of the marker, may not be null
        See Also:
        MessageEventGenerator.createName()

      • setSequenceNumber

        public void setSequenceNumber​(long i)
        Set the sequence number for this event.
        Parameters:
        i - the sequence number

      • getSequenceNumber

        public long getSequenceNumber()
        Get the sequence number for this marker.
        Returns:
        the sequence number.

      • getName

        public java.lang.String getName()

        Returns the name of the 'event'.

        Returns:
        the name of the 'event'

      • setWasSuccessful

        public void setWasSuccessful​(boolean b)

        Set whether the 'event' was successful or not.

        Parameters:
        b - true if the 'event' was successful.

      • getWasSuccessful

        public boolean getWasSuccessful()

        Return true if the named 'event' was successful, otherwise false.

        Returns:
        true if the named 'event' was successful, otherwise false

      • setUniqueId

        public void setUniqueId​(java.lang.String id)
        Set the unique id for this marker.
        Parameters:
        id - the unique id.

      • getUniqueId

        public java.lang.String getUniqueId()
        Get the unique id.
        Returns:
        the uniqueid.

      • clone

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

      • toString

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

      • equals

        public boolean equals​(java.lang.Object o)
        Overrides:
        equals in class java.lang.Object
        See Also:
        Object.equals(java.lang.Object)

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object

      • getConfirmationId

        @Deprecated
public java.lang.String getConfirmationId()
        Deprecated.
        since 3.6.2 since MessageEventGenerator#isConfirmation() is deprecated

        Returns the optional confirmation ID. If set this is used to set up a confirmation in tracking.

        Returns:
        the optional confirmation ID

      • setConfirmationId

        @Deprecated
public void setConfirmationId​(java.lang.String s)
        Deprecated.
        since 3.6.2 since MessageEventGenerator#isConfirmation() is deprecated

        Sets the optional confirmation ID. If set this is used to set up a confirmation in tracking.

        Parameters:
        s - the optional confirmation ID

      • getIsConfirmation

        @Deprecated
public boolean getIsConfirmation()
        Deprecated.
        since 3.6.2 since MessageEventGenerator#isConfirmation() is deprecated

        Returns true if this is a confirmation otherwise false.

        Returns:
        true if this is a confirmation otherwise false.

      • setIsConfirmation

        @Deprecated
public void setIsConfirmation​(boolean b)
        Deprecated.
        since 3.6.2 since MessageEventGenerator#isConfirmation() is deprecated

        Sets whether this is a confirmation (for the given confirmation id).

        Parameters:
        b - this is a confirmation (for the given confirmation id)

      • getQualifier

        public java.lang.String getQualifier()
        The qualifier for the event in question

        In most cases, the qualifier is the unique-id of the MessageEventGenerator that created this marker

        Returns:
        the qualifier

      • setQualifier

        public void setQualifier​(java.lang.String qualifier)