Class ConversationState

  • All Implemented Interfaces:
    java.io.Serializable

    public final class ConversationState
    extends java.lang.Object
    implements java.io.Serializable
    Class used to save the state of conversations. Can be used for both Conversation and UnitofWork objects.
    Objects of this class can be serialized and deserialized using standard Java serialization.
    Objects can also be re-instantiated using a ticket string. The ticket is obtained with the getTicket() method. The object can be instantiated using the ticket with the restoreFromTicket() method.
    Since:
    7.1.1.10
    See Also:
    BrokerCommunication.saveState(), Conversation(BrokerService, ConversationState), UnitofWork(BrokerService, ConversationState), Serialized Form
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String getTicket()
      Returns the ticket of this ConversationState object.
      static ConversationState restoreFromTicket​(java.lang.String ticket)
      Create a ConversationState object from the specifed ticket.
      java.lang.String toString()
      Return the ticket of this ConversationState object.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
    • Method Detail

      • restoreFromTicket

        public static ConversationState restoreFromTicket​(java.lang.String ticket)
                                                   throws java.lang.IllegalArgumentException
        Create a ConversationState object from the specifed ticket. The ticket has to be obtained by a call to getTicket().
        Parameters:
        ticket - the ticket
        Returns:
        the ConversationState object to the given ticket.
        Throws:
        java.lang.IllegalArgumentException - if ticket is not valid.
        See Also:
        getTicket()
      • toString

        public java.lang.String toString()
        Return the ticket of this ConversationState object.
        Overrides:
        toString in class java.lang.Object
        Returns:
        the ticket
      • getTicket

        public java.lang.String getTicket()
        Returns the ticket of this ConversationState object.
        Returns:
        the ticket