Class MessageBase

java.lang.Object

com.sun.corba.ee.impl.protocol.giopmsgheaders.MessageBase

All Implemented Interfaces:

Message

Direct Known Subclasses:

Message_1_0, Message_1_1

public abstract class MessageBase
extends Object
implements Message

This class acts as the base class for the various GIOP message types. This also serves as a factory to create various message types. We currently support GIOP 1.0, 1.1 and 1.2 message types.

Version:

1.0

Author:

Ram Jeyaraman 05/14/2000

Field Summary

Fields inherited from interface Message

defaultBufferSize, FLAG_NO_FRAG_BIG_ENDIAN, GIOPBigMagic, GIOPCancelRequest, GIOPCloseConnection, GIOPFragment, GIOPLocateReply, GIOPLocateRequest, GIOPMessageError, GIOPMessageHeaderLength, GIOPReply, GIOPRequest, LITTLE_ENDIAN_BIT, MORE_FRAGMENTS_BIT, THREAD_POOL_TO_USE_MASK, TRAILING_TWO_BIT_BYTE_MASK

Constructor Summary

Constructors

Constructor	Description
MessageBase()

Method Summary

Modifier and Type	Method	Description
void	callback(MessageHandler handler)
static CancelRequestMessage	createCancelRequest(GIOPVersion gv, int request_id)
static Message	createCloseConnection(GIOPVersion gv)
static LocateReplyMessage	createLocateReply(ORB orb, GIOPVersion gv, byte encodingVersion, int request_id, int locate_status, IOR ior)
static LocateRequestMessage	createLocateRequest(ORB orb, GIOPVersion gv, byte encodingVersion, int request_id, byte[] object_key)
static Message	createMessageError(GIOPVersion gv)
static ReplyMessage	createReply(ORB orb, GIOPVersion gv, byte encodingVersion, int request_id, int reply_status, ServiceContexts service_contexts, IOR ior)
static RequestMessage	createRequest(ORB orb, GIOPVersion gv, byte encodingVersion, int request_id, boolean response_expected, IOR ior, short addrDisp, String operation, ServiceContexts service_contexts, Principal requesting_principal)
RequestId	getCorbaRequestId()	Return a Message's CorbaRequestId.
byte	getEncodingVersion()
static RequestId	getRequestIdFromMessageBytes(Message message, ByteBuffer byteBuffer)	Get the request id from the 4 bytes following the 12 byte GIOP request header if the request header exists.
int	getThreadPoolToUse()
static MessageBase	parseGiopHeader(ORB orb, Connection connection, ByteBuffer buf, int startPosition)
void	setEncodingVersion(byte version)
static void	setFlag(ByteBuffer byteBuffer, int flag)	Set a flag in the given buffer (fragment bit, byte order bit, etc)
boolean	supportsFragments()	Returns true if this message could be followed by a fragment.
static String	typeToString(byte type)

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface Message

createFragmentMessage, getGIOPVersion, getSize, getType, isLittleEndian, moreFragmentsToFollow, read, setSize, write

Constructor Details

MessageBase

public MessageBase()

Method Details

typeToString

public static String typeToString(byte type)

parseGiopHeader

public static MessageBase parseGiopHeader(ORB orb,
 Connection connection,
 ByteBuffer buf,
 int startPosition)

createRequest

public static RequestMessage createRequest(ORB orb,
 GIOPVersion gv,
 byte encodingVersion,
 int request_id,
 boolean response_expected,
 IOR ior,
 short addrDisp,
 String operation,
 ServiceContexts service_contexts,
 Principal requesting_principal)

createReply

public static ReplyMessage createReply(ORB orb,
 GIOPVersion gv,
 byte encodingVersion,
 int request_id,
 int reply_status,
 ServiceContexts service_contexts,
 IOR ior)

createLocateRequest

public static LocateRequestMessage createLocateRequest(ORB orb,
 GIOPVersion gv,
 byte encodingVersion,
 int request_id,
 byte[] object_key)

createLocateReply

public static LocateReplyMessage createLocateReply(ORB orb,
 GIOPVersion gv,
 byte encodingVersion,
 int request_id,
 int locate_status,
 IOR ior)

createCancelRequest

public static CancelRequestMessage createCancelRequest(GIOPVersion gv,
 int request_id)

createCloseConnection

public static Message createCloseConnection(GIOPVersion gv)

createMessageError

public static Message createMessageError(GIOPVersion gv)

setFlag

public static void setFlag(ByteBuffer byteBuffer,
 int flag)

Set a flag in the given buffer (fragment bit, byte order bit, etc)

Parameters:

byteBuffer - buffer to set flag in

flag - flag to set

callback

public void callback(MessageHandler handler)
              throws IOException

Specified by:

callback in interface Message

Throws:

IOException

getThreadPoolToUse

public int getThreadPoolToUse()

Specified by:

getThreadPoolToUse in interface Message

getEncodingVersion

public byte getEncodingVersion()

Specified by:

getEncodingVersion in interface Message

setEncodingVersion

public void setEncodingVersion(byte version)

Specified by:

setEncodingVersion in interface Message

getCorbaRequestId

public RequestId getCorbaRequestId()

Return a Message's CorbaRequestId. NOTE: This method should be overridden for messages that support a 4 byte request id following the 12 byte GIOP message header.

Specified by:

getCorbaRequestId in interface Message

Returns:

a Message's CorbaRequestId.

supportsFragments

public boolean supportsFragments()

Returns true if this message could be followed by a fragment.

Specified by:

supportsFragments in interface Message

Returns:

true if Message supports fragmenting or is a message fragment. Otherwise false it does not support message fragments.

getRequestIdFromMessageBytes

public static RequestId getRequestIdFromMessageBytes(Message message,
 ByteBuffer byteBuffer)

Get the request id from the 4 bytes following the 12 byte GIOP request header if the request header exists. Otherwise, return 0.

NOTE: Assumes Message already been filtered by MessageBase.messageSupportsFragments(Message)

Parameters:

message - message to set ID of

byteBuffer - buffer containing the request ID

Returns:

CorbaRequestIdif Message supports a 12 + 4 byte GIOP header. Otherwise returns a CorbaRequestId with an undefined request id.