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

com.ibm.able.conversation
Class MessageEvent

java.lang.Object
  |
  +--java.util.EventObject
        |
        +--com.ibm.able.conversation.ConversationEvent
              |
              +--com.ibm.able.conversation.MessageEvent
All Implemented Interfaces:
java.io.Serializable

public class MessageEvent
extends ConversationEvent

Event for use with both inbound and outbound messages.

OLD VERSION -- TO BE DELETED

Instead of a complete TransportMessage, MessageEvents only contain the message's payload. The ConversationManager is in charge of creating the TransportMessage and initializing its Envelope. The ConversationPolicyHandler only concerns itself with the message content--i.e., the Payload.

See Also:
Serialized Form

Field Summary
static int INBOUND
           
static int OUTBOUND
           
 
Fields inherited from class java.util.EventObject
source
 
Constructor Summary
MessageEvent(java.lang.Object source)
           
MessageEvent(java.lang.Object source, int newType, javax.agent.Payload newPayload)
           
 
Method Summary
 javax.agent.Payload getMessagePayload()
           
 int getType()
           
static java.lang.String getTypeString(int testType)
           
static boolean isValidType(int testType)
           
 void setMessagePayload(javax.agent.Payload newPayload)
          Stores the arg as a ref: does not clone it.
 void setType(int newType)
           
 java.lang.String summary()
          Returns a descriptive summary of the event, intended for ordinary humans.
 java.lang.String toString()
          Returns a text summary of this object, intended for human eyes.
 
Methods inherited from class java.util.EventObject
getSource
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

INBOUND

public static final int INBOUND

OUTBOUND

public static final int OUTBOUND
Constructor Detail

MessageEvent

public MessageEvent(java.lang.Object source)

MessageEvent

public MessageEvent(java.lang.Object source,
                    int newType,
                    javax.agent.Payload newPayload)
Method Detail

getType

public int getType()

setType

public void setType(int newType)

isValidType

public static boolean isValidType(int testType)

getTypeString

public static java.lang.String getTypeString(int testType)

getMessagePayload

public javax.agent.Payload getMessagePayload()

setMessagePayload

public void setMessagePayload(javax.agent.Payload newPayload)
Stores the arg as a ref: does not clone it.

toString

public java.lang.String toString()
Returns a text summary of this object, intended for human eyes.
Overrides:
toString in class java.util.EventObject

summary

public java.lang.String summary()
Description copied from class: ConversationEvent
Returns a descriptive summary of the event, intended for ordinary humans.
Unless overridden, this is identical to toString().
Overrides:
summary in class ConversationEvent

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

(C) Copyright IBM Corporation 1999, 2003