|
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.JasMessageTransform | +--com.ibm.able.conversation.JasConversationSetupTransform
The JasConversationSetupTransform class deals with messages that contain data for setting up a conversation over Java Agent Services (JAS) messaging.
The setup messages contain the name, locator, and conversationID of the participants. Used during the Conversation setup handshake.
Field Summary | |
---|---|
static java.lang.String |
ACCEPT
Keyword for MessageDescription data. |
static java.lang.String |
AGENT_NAME_KEY
Keyword for use in forming & parsing JAS payloads. |
static java.lang.String |
CONVERSATION_ID_KEY
Keyword for use in forming & parsing JAS payloads. |
static java.lang.String |
JAS_CONVERSATION_SETUP
Keyword for MessageDescription data. |
static java.lang.String |
LOCATOR_KEY
Keyword for use in forming & parsing JAS payloads. |
static java.lang.String |
MESSAGE_NAME_KEY
Keyword for use in forming & parsing JAS payloads. |
static java.lang.String |
REQUEST
Keyword for MessageDescription data. |
Fields inherited from class com.ibm.able.conversation.JasMessageTransform |
---|
messagePayload |
Constructor Summary | |
---|---|
JasConversationSetupTransform()
|
Method Summary | |
---|---|
boolean |
configureFor(MessageDescription desc)
Attempts to configure this MessageTransform to fit the given message description. |
boolean |
formAndValidate()
Converts message name & data into a deliverable message object that conforms to this transform's message description. |
java.lang.String[] |
getDecisionArgNames()
Returns the names of the decision-data parameters stored in this MessageTransform. |
java.lang.Object[] |
getDecisionArgs()
Returns the decision-data parameters stored in this MessageTransform. |
java.lang.Class[] |
getDecisionArgTypes()
Returns the class types of the decision-data parameters this MessageTransform is able to transform. |
boolean |
parseAndValidate()
Converts message object into name & data, assuming the message conforms to this transform's message description. |
protected boolean |
parseMessagePayload(javax.agent.Payload payload)
|
void |
setDecisionArgs(java.lang.Object[] args)
Sets the decision-data parameters stored in this MessageTransform. |
void |
setMessagePayload(javax.agent.Payload newPayload)
|
Methods inherited from class com.ibm.able.conversation.JasMessageTransform |
---|
getMessage, getMessagePayload, getMessageType, setMessage |
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 JAS_CONVERSATION_SETUP
public static final java.lang.String REQUEST
public static final java.lang.String ACCEPT
public static final java.lang.String MESSAGE_NAME_KEY
public static final java.lang.String AGENT_NAME_KEY
public static final java.lang.String LOCATOR_KEY
public static final java.lang.String CONVERSATION_ID_KEY
Constructor Detail |
public JasConversationSetupTransform()
Method Detail |
public java.lang.String[] getDecisionArgNames()
MessageTransform
These are meant to be hints about what sort of information is in each object, in the same way that variable names are hints about what the variables contain. This becomes especially useful when the decision data class types are uninformative on their own (e.g., because they're all the same, or because they're very general-purpose classes).
com.ibm.conversation.MessageTransform
public java.lang.Class[] getDecisionArgTypes()
MessageTransform
Note: this implies that, for any particular MessageTransform instance at any particular
time, there is only one such array of class types. However, it is still possible that
the class types may depend on the MessageDescription for which this MessageTransform is
configured. I.e., in the following fragment, the elements of a1
and
a2
are not necessarily equal:
Class[] a1 = someTransform.getDecisionArgTypes(); someTransform.configureFor(someDescription); Class[] a2 = someTransform.getDecisionArgTypes();
com.ibm.conversation.MessageTransform
public boolean configureFor(MessageDescription desc)
MessageTransform
If the configuration is successful, this MessageTransform will be able to validate, form, and parse messages matching the given description.
MessageTransforms are not required to be configurable for arbitrary message descriptions, or even configurable at all. Therefore, the return value must always be checked to determine whether the transform object involved could in fact be configured to fit the given description.
com.ibm.conversation.MessageTransform
desc
- The MessageDescription to configure this MessageTransform for.public void setMessagePayload(javax.agent.Payload newPayload)
setMessagePayload
in class JasMessageTransform
public java.lang.Object[] getDecisionArgs()
MessageTransform
These were either set directly--in anticipation of being transformed--via a call to
setDecisionArgs()
, or else generated from the stored message via a call
to parseAndValidate()
.
com.ibm.conversation.MessageTransform
public void setDecisionArgs(java.lang.Object[] args)
MessageTransform
This prepares this MessageTransform for a call to formAndValidate()
.
com.ibm.conversation.MessageTransform
args
- The new decision-data parameters.public boolean formAndValidate()
com.ibm.conversation.MessageTransform
public boolean parseAndValidate()
com.ibm.conversation.MessageTransform
protected boolean parseMessagePayload(javax.agent.Payload payload)
|
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 |