com.anabas.gxo
Class GMS_Message

java.lang.Object
  |
  +--com.anabas.gxo.GMS_Message
Direct Known Subclasses:
GMS_BytesMessage, GMS_MessageIBusWrapper, GMS_ObjectMessage, GMS_TextMessage

public abstract class GMS_Message
extends java.lang.Object

Application creatable message types. Some internal messages such as clock, network, ... message types are not available to the application developer.


Field Summary
static short BODYTYPE_BYTES
           
static short BODYTYPE_MAP
           
static short BODYTYPE_OBJECT
           
static short BODYTYPE_TEXT
           
static short BODYTYPE_XML
           
static short MSGTYPE_ACK
           
static short MSGTYPE_ADMINISTRATION
           
static short MSGTYPE_MAJOR
           
static short MSGTYPE_MINOR
           
static short PRIORITY_LOW
           
static short PRIORITY_NORMAL
           
static short PRIORITY_REALTIME
           
 
Constructor Summary
GMS_Message()
           
 
Method Summary
abstract  void clearBody()
           
abstract  void clearProperties()
           
abstract  long getBodyType()
           
abstract  GMS_MessageID getID()
          Uniquely identifies it from other messages within the system.
abstract  long getMessageType()
          One of ADMINSTRATION, NORMAL, or ACK.
abstract  long getPriority()
           
abstract  java.lang.Object getProperty(java.lang.String name)
          Message property definition.
abstract  java.util.Enumeration getPropertyNames()
           
abstract  com.anabas.concepts.Time getTimeStamp()
           
abstract  void setProperty(java.lang.String name, java.lang.Object property)
          Sets a message property.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

MSGTYPE_ADMINISTRATION

public static final short MSGTYPE_ADMINISTRATION

MSGTYPE_MINOR

public static final short MSGTYPE_MINOR

MSGTYPE_MAJOR

public static final short MSGTYPE_MAJOR

MSGTYPE_ACK

public static final short MSGTYPE_ACK

BODYTYPE_TEXT

public static final short BODYTYPE_TEXT

BODYTYPE_MAP

public static final short BODYTYPE_MAP

BODYTYPE_OBJECT

public static final short BODYTYPE_OBJECT

BODYTYPE_BYTES

public static final short BODYTYPE_BYTES

BODYTYPE_XML

public static final short BODYTYPE_XML

PRIORITY_REALTIME

public static final short PRIORITY_REALTIME

PRIORITY_NORMAL

public static final short PRIORITY_NORMAL

PRIORITY_LOW

public static final short PRIORITY_LOW
Constructor Detail

GMS_Message

public GMS_Message()
Method Detail

getBodyType

public abstract long getBodyType()
Returns:
One of the types defined as BODYTYPE_XXX

getProperty

public abstract java.lang.Object getProperty(java.lang.String name)
                                      throws GXO_Exception
Message property definition.

setProperty

public abstract void setProperty(java.lang.String name,
                                 java.lang.Object property)
                          throws GXO_Exception
Sets a message property.
Throws:
InvalidPropertyException - The property type or content is unsupported or incorrect.

getPropertyNames

public abstract java.util.Enumeration getPropertyNames()
                                                throws GXO_Exception

clearBody

public abstract void clearBody()
                        throws GXO_Exception

clearProperties

public abstract void clearProperties()
                              throws GXO_Exception

getTimeStamp

public abstract com.anabas.concepts.Time getTimeStamp()
                                               throws GXO_Exception
Returns:
The time stamp of when the message was sent within the global time system.

getID

public abstract GMS_MessageID getID()
                             throws GXO_Exception
Uniquely identifies it from other messages within the system. ?? Should it be unique within the system?

getPriority

public abstract long getPriority()
                          throws GXO_Exception
Returns:
The priority of the message

getMessageType

public abstract long getMessageType()
                             throws GXO_Exception
One of ADMINSTRATION, NORMAL, or ACK.