|
ABLE 2.0.0 07/02/2003 10:25:01 | ||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--com.ibm.able.conversation.ConversationSetupForm
This is a MessageForm for messages that contain data for setting up a conversation: i.e., the name, locator, and conversationID of a participant. Used during the ConversationSetup handshake, it offers some predefined strings for the two phases of the handshake (the "request" and "accept" phases).
OLD VERSION -- TO BE DELETED Replaced by com.ibm.able.conversation.JasConversationSetupTransform.
The ConversationSetupForm is used in the setup_cp.xml provided in the examples/datafiles directory
Field Summary | |
---|---|
static java.lang.String |
ACCEPT
|
static java.lang.String |
REQUEST
|
Constructor Summary | |
---|---|
ConversationSetupForm()
Constructor |
|
ConversationSetupForm(java.lang.String newName)
|
Method Summary | |
---|---|
void |
clearData()
Reset the constituent data to null or default values. |
javax.agent.Payload |
formMessagePayload()
Creates a message, using constituent data that was stored inside this MessageForm object. |
javax.agent.AgentName |
getAgentName()
|
java.lang.String |
getConversationID()
|
java.lang.String |
getCounterpartAgentName()
|
java.lang.Object[] |
getData()
Returns the constituent data as an array of objects. |
javax.agent.Locator |
getLocator()
|
java.lang.String |
getMessageName()
|
protected javax.agent.Payload |
makePayload(javax.agent.AgentName localAgentName,
javax.agent.Locator localLocator,
java.lang.String localConversationID)
Internal method that constructs the payload for the constituent data |
boolean |
parseMessagePayload(javax.agent.Payload payload)
Parses the message into its constituent data, which is (supposed to be) stored inside this message-form object in a type-specific way. |
javax.agent.Payload |
sampleMessagePayload()
Return a "sample message" showing the format, but with dummy data values. |
void |
setAgentName(javax.agent.AgentName newName)
|
void |
setConversationID(java.lang.String newID)
|
void |
setCounterpartAgentName(java.lang.String name)
|
void |
setData(java.lang.Object[] newData)
Sets the constituent data from an array of objects. |
void |
setLocator(javax.agent.Locator newLocator)
|
void |
setMessageName(java.lang.String newName)
|
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
public static final java.lang.String REQUEST
public static final java.lang.String ACCEPT
Constructor Detail |
public ConversationSetupForm()
public ConversationSetupForm(java.lang.String newName)
Method Detail |
public void setMessageName(java.lang.String newName)
public java.lang.String getMessageName()
public void setAgentName(javax.agent.AgentName newName)
public javax.agent.AgentName getAgentName()
public void setLocator(javax.agent.Locator newLocator)
public javax.agent.Locator getLocator()
public void setConversationID(java.lang.String newID)
public java.lang.String getConversationID()
public void setCounterpartAgentName(java.lang.String name)
public java.lang.String getCounterpartAgentName()
protected javax.agent.Payload makePayload(javax.agent.AgentName localAgentName, javax.agent.Locator localLocator, java.lang.String localConversationID)
public javax.agent.Payload formMessagePayload() throws java.lang.IllegalStateException
MessageForm
formMessagePayload
in interface MessageForm
MessageForm.formMessagePayload()
public boolean parseMessagePayload(javax.agent.Payload payload)
MessageForm
parseMessagePayload
in interface MessageForm
MessageForm.parseMessagePayload(Payload)
public javax.agent.Payload sampleMessagePayload()
MessageForm
sampleMessagePayload
in interface MessageForm
MessageForm.sampleMessagePayload()
public void clearData()
MessageForm
clearData
in interface MessageForm
MessageForm.clearData()
public java.lang.Object[] getData()
Contents of the array are as follows:
data[0] = (AgentName) agentName
data[1] = (Locator) locator
data[2] = (String) conversationID
getData
in interface MessageForm
public void setData(java.lang.Object[] newData) throws java.lang.IllegalArgumentException
Expects the contents of the array to be the same as described in
setData
in interface MessageForm
getData().
|
ABLE 2.0.0 07/02/2003 10:25:01 | ||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |