ABLE 2.0.0 07/02/2003 10:25:01

com.ibm.able.conversation
Class ConversationContext

java.lang.Object
  |
  +--com.ibm.able.conversation.ConversationContext
All Implemented Interfaces:
java.io.Serializable

public class ConversationContext
extends java.lang.Object
implements java.io.Serializable

This is a storage area for contextual information relevant to a conversation: conversation IDs, participant names & locators, whether conversation is in-progress, done, or derailed by a protocol error, etc.

OLD VERSION -- TO BE DELETED Replaced by com.ibm.conversation.ConversationMetaData

It's also the thing that "addresses" the envelopes of TransportMessages.

See Also:
Serialized Form

Field Summary
static int DONE
           
static int ERROR
           
static int IN_PROGRESS
           
static int NOT_STARTED
           
static java.lang.String RECEIVER_CONVERSATION_ID_KEY
           
static java.lang.String SENDER_CONVERSATION_ID_KEY
           
protected static long serialVersionUID
          Serialized version identifier in form YYYYMMDDVerRelModxx
 
Constructor Summary
ConversationContext()
           
 
Method Summary
 javax.agent.TransportMessage createTransportMessage()
           
 javax.agent.AgentName getCounterpartAgentName()
           
 java.lang.String getCounterpartConversationID()
           
 javax.agent.Locator getCounterpartLocator()
           
 javax.agent.AgentName getMyAgentName()
           
 java.lang.String getMyConversationID()
           
 javax.agent.Locator getMyLocator()
           
 int getStatus()
           
static java.lang.String getStatusString(int testStatus)
           
 void initEnvelope(javax.agent.Envelope envelope)
          Fills in a message's envelope.
 void initMessage(org.jagent.acr.AclMessage message)
           
static boolean isValidStatus(int testStatus)
           
 void setCounterpartAgentInfo(java.lang.String newName, javax.agent.AgentName newAgentName, javax.agent.Locator newLocator)
           
 void setCounterpartConversationID(java.lang.String newID)
           
 void setMyAgentInfo(java.lang.String newName, javax.agent.AgentName newAgentName, javax.agent.Locator newLocator, javax.agent.service.transport.MessageTransportService newJasMessageTransportService)
           
 void setMyConversationID(java.lang.String newID)
           
 void setStatus(int newStatus)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

serialVersionUID

protected static final long serialVersionUID
Serialized version identifier in form YYYYMMDDVerRelModxx

SENDER_CONVERSATION_ID_KEY

public static final java.lang.String SENDER_CONVERSATION_ID_KEY

RECEIVER_CONVERSATION_ID_KEY

public static final java.lang.String RECEIVER_CONVERSATION_ID_KEY

NOT_STARTED

public static final int NOT_STARTED

IN_PROGRESS

public static final int IN_PROGRESS

DONE

public static final int DONE

ERROR

public static final int ERROR
Constructor Detail

ConversationContext

public ConversationContext()
Method Detail

setMyAgentInfo

public void setMyAgentInfo(java.lang.String newName,
                           javax.agent.AgentName newAgentName,
                           javax.agent.Locator newLocator,
                           javax.agent.service.transport.MessageTransportService newJasMessageTransportService)

getMyConversationID

public java.lang.String getMyConversationID()

getMyAgentName

public javax.agent.AgentName getMyAgentName()

getMyLocator

public javax.agent.Locator getMyLocator()

setMyConversationID

public void setMyConversationID(java.lang.String newID)

setCounterpartAgentInfo

public void setCounterpartAgentInfo(java.lang.String newName,
                                    javax.agent.AgentName newAgentName,
                                    javax.agent.Locator newLocator)

getCounterpartConversationID

public java.lang.String getCounterpartConversationID()

setCounterpartConversationID

public void setCounterpartConversationID(java.lang.String newID)

getStatus

public int getStatus()

setStatus

public void setStatus(int newStatus)

isValidStatus

public static boolean isValidStatus(int testStatus)

getStatusString

public static java.lang.String getStatusString(int testStatus)

initEnvelope

public void initEnvelope(javax.agent.Envelope envelope)
Fills in a message's envelope. Adds sender & recipient locators, conversation IDs.

initMessage

public void initMessage(org.jagent.acr.AclMessage message)

createTransportMessage

public javax.agent.TransportMessage createTransportMessage()

getCounterpartAgentName

public javax.agent.AgentName getCounterpartAgentName()

getCounterpartLocator

public javax.agent.Locator getCounterpartLocator()

ABLE 2.0.0 07/02/2003 10:25:01

(C) Copyright IBM Corporation 1999, 2003