org.jboss.mq.il.uil2.msgs
Class BaseMsg

java.lang.Object
  org.jboss.mq.il.uil2.msgs.BaseMsg

All Implemented Interfaces:

java.lang.Runnable

Direct Known Subclasses:

AcknowledgementRequestMsg (src) , AddMsg (src) , BrowseMsg (src) , CheckIDMsg (src) , CheckUserMsg (src) , CloseMsg (src) , ConnectionTokenMsg (src) , CreateDestMsg (src) , DeleteSubscriptionMsg (src) , DeleteTemporaryDestMsg (src) , EnableConnectionMsg (src) , GetIDMsg (src) , PingMsg (src) , ReceiveMsg (src) , ReceiveRequestMsg (src) , SubscribeMsg (src) , TemporaryDestMsg (src) , TransactMsg (src) , UnsubscribeMsg (src)

public class BaseMsg

extends java.lang.Object

implements java.lang.Runnable

The base msg class for all msgs used by the UIL2 invoker. Msgs consist of a msg type, id and exception and can operate as two way items that are sent with the request content and received with the reply content for the request. Such round-trip behavior is based on matching the request msgID with the reply msgID. The msgID parameter is segmented into value 1 to 2147483647 for client originated msgs and -1 to -2147483647 for server originated msgs.

The message is a Runnable to avoid constructing a Runnable object when asynchronously handling the message from the ReadTask.

msgType

public int msgType

The MsgTypes constant representing the type of the msg

msgID

public int msgID

A msg id used to associated a reply with its request

error

public java.lang.Exception error

Any error thrown by the remote side

BaseMsg

public BaseMsg(int msgType)

BaseMsg

public BaseMsg(int msgType,
               int msgID)

setUseJMSServerMsgIDs

public static void setUseJMSServerMsgIDs(boolean flag)

Set the msgID parameter range. If false, the msgID is segmented into the range 1 to 2147483647 and if true, the rangs is -1 to -2147483647. The JMS server sets this to true and clients default to false.

Parameters:

flag -

createMsg

public static BaseMsg (src)  createMsg(int msgType)
                         throws java.lang.IllegalArgumentException

Create a BaseMsg subclass based on the msgType.

Parameters:

msgType - A MsgTypes.m_xxx constant

Returns:

the derived BaseMsg

Throws:

java.lang.IllegalArgumentException - thrown for a msgType that does not match any MsgTypes.m_xxx constant

toString

public static java.lang.String toString(int msgType)

Translate a msgType into its string menmonic.

Parameters:

msgType - A MsgTypes.m_xxx constant

Returns:

the string form of the MsgTypes.m_xxx constant

getMsgType

public int getMsgType()

getMsgID

public int getMsgID()

Access the msgID, initializing it if it has not been set yet. This is used by the SocketManager.internalSendMessage to setup the unique msgID for a request msg.

Returns:

the msgID value

setMsgID

public void setMsgID(int msgID)

Set the msgID. This is used by the SocketManager read task to populate a msg with its request ID.

Parameters:

msgID - the msgID read off the socket

getError

public java.lang.Exception getError()

Access any exception associated with the msg

Returns:

setError

public void setError(java.lang.Throwable e)

Set an exception that should be used as the msg return value.

Parameters:

e -

equals

public boolean equals(java.lang.Object o)

Equality is based on BaseMsg.msgID

Parameters:

o - a BaseMsg

Returns:

true if o.msgID == msgID

hashCode

public int hashCode()

Hash code is simply the msgID

Returns:

toString

public java.lang.String toString()

trimReply

public void trimReply()

Trim the message when replying

write

public void write(java.io.ObjectOutputStream out)
           throws java.io.IOException

Write the msgType, msgID, hasError flag and optionally the error

Parameters:

out -

Throws:

java.io.IOException

read

public void read(java.io.ObjectInputStream in)
          throws java.io.IOException,
                 java.lang.ClassNotFoundException

Read the hasError flag and optionally the error. This method is not a complete analog of write because the SocketManager read task reads the msgType and msgID off of the socket.

Parameters:

in -

Throws:

java.io.IOException

java.lang.ClassNotFoundException

setHandler

public void setHandler(SocketManager.ReadTask (src)  handler)

run

public void run()

Specified by:

run in interface java.lang.Runnable