com.j_spaces.jms

Class GSBytesMessageImpl

java.lang.Object

com.j_spaces.core.client.MetaDataEntry

com.j_spaces.jms.GSMessageImpl

com.j_spaces.jms.GSBytesMessageImpl

All Implemented Interfaces:

IReplicatable, Externalizable, Serializable, javax.jms.BytesMessage, javax.jms.Message, Entry

public class GSBytesMessageImpl
extends GSMessageImpl
implements javax.jms.BytesMessage

Implements the javax.jms.BytesMessage interface for the GigaSpaces JMS API. A BytesMessage object is used to send a message containing a stream of uninterpreted m_body_bytes. It inherits from the Message interface and adds a m_body_bytes message body. The receiver of the message supplies the interpretation of the m_body_bytes.

The BytesMessage methods are based largely on those found in java.io.DataInputStream and java.io.DataOutputStream.

This message type is for client encoding of existing message formats. If possible, one of the other self-defining message types should be used instead.

Although the JMS API allows the use of message properties with byte messages, they are typically not used, since the inclusion of properties may affect the format.

The primitive types can be written explicitly using methods for each type. They may also be written generically as objects. For instance, a call to BytesMessage.writeInt(6) is equivalent to BytesMessage.writeObject(new Integer(6)). Both forms are provided, because the explicit form is convenient for static programming, and the object form is needed when types are not known at compile time.

When the message is first created, and when clearBody is called, the body of the message is in write-only mode. After the first call to reset has been made, the message body is in read-only mode. After a message has been sent, the client that sent it can retain and modify it without affecting the message that has been sent. The same message object can be sent multiple times. When a message has been received, the provider has called reset so that the message body is in read-only mode for the client.

If clearBody is called on a message in read-only mode, the message body is cleared and the message is in write-only mode.

If a client attempts to read a message in write-only mode, a MessageNotReadableException is thrown.

If a client attempts to write a message in read-only mode, a MessageNotWriteableException is thrown.

Version:

4.0 Copyright: Copyright (c) 2004 Company: GigaSpaces Technologies,Ltd.

Author:

Gershon Diner

See Also:

Session.createBytesMessage(), MapMessage, Message, ObjectMessage, StreamMessage, TextMessage, Serialized Form

Field Summary

Fields inherited from class com.j_spaces.jms.GSMessageImpl

Body, BODY_STR_NAME, BYTES, DestinationName, indexedFields, JMS_CORRELATION_ID, JMS_DELIVERY_MODE, JMS_DESTINATION, JMS_EXPIRATION, JMS_GSCONNECTION_KEY_NAME, JMS_GSCONVERTER, JMS_GSPRODUCER_KEY_PROP_NAME, JMS_GSTTL_KEY_PROP_NAME, JMS_MESSAGE_ID, JMS_PRIORITY, JMS_REDELIVERED, JMS_REPLY_TO, JMS_TIMESTAMP, JMS_TYPE, JMSCorrelationID, JMSDeliveryMode, JMSDestination, JMSExpiration, JMSMessageID, JMSPriority, JMSRedelivered, JMSReplyTo, JMSTimestamp, JMSType, JMSX_GROUPID, JMSX_GROUPSEQ, JMSX_USERID, MAP, OBJECT, Properties, PROPERTIES_STR_NAME, session, SIMPLE, STREAM, TEXT

Fields inherited from interface javax.jms.Message

DEFAULT_DELIVERY_MODE, DEFAULT_PRIORITY, DEFAULT_TIME_TO_LIVE

Constructor Summary

Constructors

Constructor and Description
GSBytesMessageImpl() Instantiates a new GSBytesMessageImpl.
GSBytesMessageImpl(GSSessionImpl session) Instantiates a new GSBytesMessageImpl.
GSBytesMessageImpl(GSSessionImpl session, byte[] bytesArray) Instantiates a new GSBytesMessageImpl.

Method Summary

Modifier and Type	Method and Description
void	clearBody() Overide the super class method to reset the streams, and put the message body in write only mode.
protected Object	cloneBody() Returns a clone of the body.
long	getBodyLength() Gets the number of bytes of the message body when the message is in read-only mode.
byte[]	getBytes() Returns the bytes array.
boolean	readBoolean() Reads a boolean from the bytes message stream.
byte	readByte() Reads a signed 8-bit value from the bytes message stream.
int	readBytes(byte[] value) Reads a byte array from the bytes message stream.
int	readBytes(byte[] value, int length) Reads a portion of the bytes message stream.
char	readChar() Reads a Unicode character value from the bytes message stream.
double	readDouble() Reads a double from the bytes message stream.
float	readFloat() Reads a float from the bytes message stream.
int	readInt() Reads a signed 32-bit integer from the bytes message stream.
long	readLong() Reads a signed 64-bit integer from the bytes message stream.
short	readShort() Reads a signed 16-bit number from the bytes message stream.
int	readUnsignedByte() Reads an unsigned 8-bit number from the bytes message stream.
int	readUnsignedShort() Reads an unsigned 16-bit number from the bytes message stream.
String	readUTF() Reads a string that has been encoded using a modified UTF-8 format from the bytes message stream.
void	reset() Puts the message body in read-only mode and repositions the stream of bytes to the beginning.
void	seal()
void	setBytes(byte[] bytesArray) Sets the bytes array.
String	toString()
void	writeBoolean(boolean value) Writes a boolean to the bytes message stream as a 1-byte value.
void	writeByte(byte value) Writes a byte to the bytes message stream as a 1-byte value.
void	writeBytes(byte[] value) Writes a byte array to the bytes message stream.
void	writeBytes(byte[] value, int offset, int length) Writes a portion of a byte array to the bytes message stream.
void	writeChar(char value) Writes a char to the bytes message stream as a 2-byte value, high byte first.
void	writeDouble(double value) Converts the double argument to a long using the doubleToLongBits method in class Double, and then writes that long value to the bytes message stream as an 8-byte quantity, high byte first.
void	writeFloat(float value) Converts the float argument to an int using the floatToIntBits method in class Float, and then writes that int value to the bytes message stream as a 4-byte quantity, high byte first.
void	writeInt(int value) Writes an int to the bytes message stream as four bytes, high byte first.
void	writeLong(long value) Writes a long to the bytes message stream as eight bytes, high byte first.
void	writeObject(Object value) Writes an object to the bytes message stream.
void	writeShort(short value) Writes a short to the bytes message stream as two bytes, high byte first.
void	writeUTF(String value) Writes a string to the bytes message stream using UTF-8 encoding in a machine-independent manner.

Methods inherited from class com.j_spaces.jms.GSMessageImpl

__getSpaceIndexedFields, acknowledge, checkBodyReadOnly, checkBodyWriteOnly, checkPropertiesReadOnly, clearProperties, cloneObject, copyTo, equals, getBooleanProperty, getByteProperty, getDestinationName, getDoubleProperty, getFloatProperty, getIntProperty, getJMSCorrelationID, getJMSCorrelationIDAsBytes, getJMSDeliveryMode, getJMSDestination, getJMSExpiration, getJMSMessageID, getJMSPriority, getJMSRedelivered, getJMSReplyTo, getJMSTimestamp, getJMSType, getLongProperty, getObjectProperty, getPropertyNames, getShortProperty, getStringProperty, hashCode, propertyExists, readExternal, setBooleanProperty, setByteProperty, setDestinationName, setDoubleProperty, setFloatProperty, setIntProperty, setJMSCorrelationID, setJMSCorrelationIDAsBytes, setJMSDeliveryMode, setJMSDestination, setJMSExpiration, setJMSMessageID, setJMSPriority, setJMSRedelivered, setJMSReplyTo, setJMSTimestamp, setJMSType, setLongProperty, setObjectProperty, setProperties, setRoutingIndexes, setShortProperty, setStringProperty, writeExternal

Methods inherited from class com.j_spaces.core.client.MetaDataEntry

__getEntryInfo, __setEntryInfo, _readExternal, _writeExternal, isFifo, isNOWriteLeaseMode, isTransient, makePersistent, makeTransient, setFifo, setNOWriteLeaseMode, setTransient

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface javax.jms.Message

acknowledge, clearProperties, getBooleanProperty, getByteProperty, getDoubleProperty, getFloatProperty, getIntProperty, getJMSCorrelationID, getJMSCorrelationIDAsBytes, getJMSDeliveryMode, getJMSDestination, getJMSExpiration, getJMSMessageID, getJMSPriority, getJMSRedelivered, getJMSReplyTo, getJMSTimestamp, getJMSType, getLongProperty, getObjectProperty, getPropertyNames, getShortProperty, getStringProperty, propertyExists, setBooleanProperty, setByteProperty, setDoubleProperty, setFloatProperty, setIntProperty, setJMSCorrelationID, setJMSCorrelationIDAsBytes, setJMSDeliveryMode, setJMSDestination, setJMSExpiration, setJMSMessageID, setJMSPriority, setJMSRedelivered, setJMSReplyTo, setJMSTimestamp, setJMSType, setLongProperty, setObjectProperty, setShortProperty, setStringProperty

Constructor Detail

GSBytesMessageImpl

public GSBytesMessageImpl()
                   throws javax.jms.JMSException

Instantiates a new GSBytesMessageImpl.

Throws:

javax.jms.JMSException - if falied to create the message

GSBytesMessageImpl

public GSBytesMessageImpl(GSSessionImpl session,
                          byte[] bytesArray)
                   throws javax.jms.JMSException

Instantiates a new GSBytesMessageImpl.

Parameters:

session - the session of the message

bytesArray - the bytes content of the message

Throws:

javax.jms.JMSException - if falied to create the message

GSBytesMessageImpl

public GSBytesMessageImpl(GSSessionImpl session)
                   throws javax.jms.JMSException

Instantiates a new GSBytesMessageImpl.

Parameters:

session - the session of the message

Throws:

javax.jms.JMSException - if falied to create the message

Method Detail

setBytes

public void setBytes(byte[] bytesArray)

Sets the bytes array.

Parameters:

bytesArray - the bytes array

getBytes

public byte[] getBytes()

Returns the bytes array.

Returns:

the bytes array

seal

public void seal()
          throws IOException

Throws:

IOException

getBodyLength

public long getBodyLength()
                   throws javax.jms.JMSException

Gets the number of bytes of the message body when the message is in read-only mode. The value returned can be used to allocate a byte array. The value returned is the entire length of the message body, regardless of where the pointer for reading the message is currently located.

Specified by:

getBodyLength in interface javax.jms.BytesMessage

Returns:

number of bytes in the message

Throws:

javax.jms.JMSException - if the JMS provider fails to read the message due to some internal error.

javax.jms.MessageNotReadableException - if the message is in write-only mode.

Since:

1.1

readBoolean

public boolean readBoolean()
                    throws javax.jms.JMSException

Reads a boolean from the bytes message stream.

Specified by:

readBoolean in interface javax.jms.BytesMessage

Returns:

the boolean value read

Throws:

javax.jms.JMSException - if the JMS provider fails to read the message due to some internal error.

javax.jms.MessageEOFException - if unexpected end of bytes stream has been reached.

javax.jms.MessageNotReadableException - if the message is in write-only mode.

readByte

public byte readByte()
              throws javax.jms.JMSException

Reads a signed 8-bit value from the bytes message stream.

Specified by:

readByte in interface javax.jms.BytesMessage

Returns:

the next byte from the bytes message stream as a signed 8-bit byte

Throws:

javax.jms.JMSException - if the JMS provider fails to read the message due to some internal error.

javax.jms.MessageEOFException - if unexpected end of bytes stream has been reached.

javax.jms.MessageNotReadableException - if the message is in write-only mode.

readUnsignedByte

public int readUnsignedByte()
                     throws javax.jms.JMSException

Reads an unsigned 8-bit number from the bytes message stream.

Specified by:

readUnsignedByte in interface javax.jms.BytesMessage

Returns:

the next byte from the bytes message stream, interpreted as an unsigned 8-bit number

Throws:

javax.jms.JMSException - if the JMS provider fails to read the message due to some internal error.

javax.jms.MessageEOFException - if unexpected end of bytes stream has been reached.

javax.jms.MessageNotReadableException - if the message is in write-only mode.

readShort

public short readShort()
                throws javax.jms.JMSException

Reads a signed 16-bit number from the bytes message stream.

Specified by:

readShort in interface javax.jms.BytesMessage

Returns:

the next two bytes from the bytes message stream, interpreted as a signed 16-bit number

Throws:

javax.jms.JMSException - if the JMS provider fails to read the message due to some internal error.

javax.jms.MessageEOFException - if unexpected end of bytes stream has been reached.

javax.jms.MessageNotReadableException - if the message is in write-only mode.

readUnsignedShort

public int readUnsignedShort()
                      throws javax.jms.JMSException

Reads an unsigned 16-bit number from the bytes message stream.

Specified by:

readUnsignedShort in interface javax.jms.BytesMessage

Returns:

the next two bytes from the bytes message stream, interpreted as an unsigned 16-bit integer

Throws:

javax.jms.JMSException - if the JMS provider fails to read the message due to some internal error.

javax.jms.MessageEOFException - if unexpected end of bytes stream has been reached.

javax.jms.MessageNotReadableException - if the message is in write-only mode.

readChar

public char readChar()
              throws javax.jms.JMSException

Reads a Unicode character value from the bytes message stream.

Specified by:

readChar in interface javax.jms.BytesMessage

Returns:

the next two bytes from the bytes message stream as a Unicode character

Throws:

javax.jms.JMSException - if the JMS provider fails to read the message due to some internal error.

javax.jms.MessageEOFException - if unexpected end of bytes stream has been reached.

javax.jms.MessageNotReadableException - if the message is in write-only mode.

readInt

public int readInt()
            throws javax.jms.JMSException

Reads a signed 32-bit integer from the bytes message stream.

Specified by:

readInt in interface javax.jms.BytesMessage

Returns:

the next four bytes from the bytes message stream, interpreted as an int

Throws:

javax.jms.JMSException - if the JMS provider fails to read the message due to some internal error.

javax.jms.MessageEOFException - if unexpected end of bytes stream has been reached.

javax.jms.MessageNotReadableException - if the message is in write-only mode.

readLong

public long readLong()
              throws javax.jms.JMSException

Reads a signed 64-bit integer from the bytes message stream.

Specified by:

readLong in interface javax.jms.BytesMessage

Returns:

the next eight bytes from the bytes message stream, interpreted as a long

Throws:

javax.jms.JMSException - if the JMS provider fails to read the message due to some internal error.

javax.jms.MessageEOFException - if unexpected end of bytes stream has been reached.

javax.jms.MessageNotReadableException - if the message is in write-only mode.

readFloat

public float readFloat()
                throws javax.jms.JMSException

Reads a float from the bytes message stream.

Specified by:

readFloat in interface javax.jms.BytesMessage

Returns:

the next four bytes from the bytes message stream, interpreted as a float

Throws:

javax.jms.JMSException - if the JMS provider fails to read the message due to some internal error.

javax.jms.MessageEOFException - if unexpected end of bytes stream has been reached.

javax.jms.MessageNotReadableException - if the message is in write-only mode.

readDouble

public double readDouble()
                  throws javax.jms.JMSException

Reads a double from the bytes message stream.

Specified by:

readDouble in interface javax.jms.BytesMessage

Returns:

the next eight bytes from the bytes message stream, interpreted as a double

Throws:

javax.jms.JMSException - if the JMS provider fails to read the message due to some internal error.

javax.jms.MessageEOFException - if unexpected end of bytes stream has been reached.

javax.jms.MessageNotReadableException - if the message is in write-only mode.

readUTF

public String readUTF()
               throws javax.jms.JMSException

Reads a string that has been encoded using a modified UTF-8 format from the bytes message stream.

For more information on the UTF-8 format, see "File System Safe UCS Transformation Format (FSS_UTF)", X/Open Preliminary Specification, X/Open Company Ltd., Document Number: P316. This information also appears in ISO/IEC 10646, Annex P.

Specified by:

readUTF in interface javax.jms.BytesMessage

Returns:

a Unicode string from the bytes message stream

Throws:

javax.jms.JMSException - if the JMS provider fails to read the message due to some internal error.

javax.jms.MessageEOFException - if unexpected end of bytes stream has been reached.

javax.jms.MessageNotReadableException - if the message is in write-only mode.

readBytes

public int readBytes(byte[] value)
              throws javax.jms.JMSException

Reads a byte array from the bytes message stream.

If the length of array value is less than the number of bytes remaining to be read from the stream, the array should be filled. A subsequent call reads the next increment, and so on.

If the number of bytes remaining in the stream is less than the length of array value, the bytes should be read into the array. The return value of the total number of bytes read will be less than the length of the array, indicating that there are no more bytes left to be read from the stream. The next read of the stream returns -1.

Specified by:

readBytes in interface javax.jms.BytesMessage

Parameters:

value - the buffer into which the data is read

Returns:

the total number of bytes read into the buffer, or -1 if there is no more data because the end of the stream has been reached

Throws:

javax.jms.JMSException - if the JMS provider fails to read the message due to some internal error.

javax.jms.MessageNotReadableException - if the message is in write-only mode.

readBytes

public int readBytes(byte[] value,
                     int length)
              throws javax.jms.JMSException

Reads a portion of the bytes message stream.

If the length of array value is less than the number of bytes remaining to be read from the stream, the array should be filled. A subsequent call reads the next increment, and so on.

If the number of bytes remaining in the stream is less than the length of array value, the bytes should be read into the array. The return value of the total number of bytes read will be less than the length of the array, indicating that there are no more bytes left to be read from the stream. The next read of the stream returns -1.

If length is negative, or length is greater than the length of the array value, then an IndexOutOfBoundsException is thrown. No bytes will be read from the stream for this exception case.

Specified by:

readBytes in interface javax.jms.BytesMessage

Parameters:

value - the buffer into which the data is read

length - the number of bytes to read; must be less than or equal to value.length

Returns:

the total number of bytes read into the buffer, or -1 if there is no more data because the end of the stream has been reached

Throws:

javax.jms.JMSException - if the JMS provider fails to read the message due to some internal error.

javax.jms.MessageNotReadableException - if the message is in write-only mode.

writeBoolean

public void writeBoolean(boolean value)
                  throws javax.jms.JMSException

Writes a boolean to the bytes message stream as a 1-byte value. The value true is written as the value (byte)1; the value false is written as the value (byte)0.

Specified by:

writeBoolean in interface javax.jms.BytesMessage

Parameters:

value - the boolean value to be written

Throws:

javax.jms.JMSException - if the JMS provider fails to write the message due to some internal error.

javax.jms.MessageNotWriteableException - if the message is in read-only mode.

writeByte

public void writeByte(byte value)
               throws javax.jms.JMSException

Writes a byte to the bytes message stream as a 1-byte value.

Specified by:

writeByte in interface javax.jms.BytesMessage

Parameters:

value - the byte value to be written

Throws:

javax.jms.JMSException - if the JMS provider fails to write the message due to some internal error.

javax.jms.MessageNotWriteableException - if the message is in read-only mode.

writeShort

public void writeShort(short value)
                throws javax.jms.JMSException

Writes a short to the bytes message stream as two bytes, high byte first.

Specified by:

writeShort in interface javax.jms.BytesMessage

Parameters:

value - the short to be written

Throws:

javax.jms.JMSException - if the JMS provider fails to write the message due to some internal error.

javax.jms.MessageNotWriteableException - if the message is in read-only mode.

writeChar

public void writeChar(char value)
               throws javax.jms.JMSException

Writes a char to the bytes message stream as a 2-byte value, high byte first.

Specified by:

writeChar in interface javax.jms.BytesMessage

Parameters:

value - the char value to be written

Throws:

javax.jms.JMSException - if the JMS provider fails to write the message due to some internal error.

javax.jms.MessageNotWriteableException - if the message is in read-only mode.

writeInt

public void writeInt(int value)
              throws javax.jms.JMSException

Writes an int to the bytes message stream as four bytes, high byte first.

Specified by:

writeInt in interface javax.jms.BytesMessage

Parameters:

value - the int to be written

Throws:

javax.jms.JMSException - if the JMS provider fails to write the message due to some internal error.

javax.jms.MessageNotWriteableException - if the message is in read-only mode.

writeLong

public void writeLong(long value)
               throws javax.jms.JMSException

Writes a long to the bytes message stream as eight bytes, high byte first.

Specified by:

writeLong in interface javax.jms.BytesMessage

Parameters:

value - the long to be written

Throws:

javax.jms.JMSException - if the JMS provider fails to write the message due to some internal error.

javax.jms.MessageNotWriteableException - if the message is in read-only mode.

writeFloat

public void writeFloat(float value)
                throws javax.jms.JMSException

Converts the float argument to an int using the floatToIntBits method in class Float, and then writes that int value to the bytes message stream as a 4-byte quantity, high byte first.

Specified by:

writeFloat in interface javax.jms.BytesMessage

Parameters:

value - the float value to be written

Throws:

javax.jms.JMSException - if the JMS provider fails to write the message due to some internal error.

javax.jms.MessageNotWriteableException - if the message is in read-only mode.

writeDouble

public void writeDouble(double value)
                 throws javax.jms.JMSException

Converts the double argument to a long using the doubleToLongBits method in class Double, and then writes that long value to the bytes message stream as an 8-byte quantity, high byte first.

Specified by:

writeDouble in interface javax.jms.BytesMessage

Parameters:

value - the double value to be written

Throws:

javax.jms.JMSException - if the JMS provider fails to write the message due to some internal error.

javax.jms.MessageNotWriteableException - if the message is in read-only mode.

writeUTF

public void writeUTF(String value)
              throws javax.jms.JMSException

Writes a string to the bytes message stream using UTF-8 encoding in a machine-independent manner.

For more information on the UTF-8 format, see "File System Safe UCS Transformation Format (FSS_UTF)", X/Open Preliminary Specification, X/Open Company Ltd., Document Number: P316. This information also appears in ISO/IEC 10646, Annex P.

Specified by:

writeUTF in interface javax.jms.BytesMessage

Parameters:

value - the String value to be written

Throws:

javax.jms.JMSException - if the JMS provider fails to write the message due to some internal error.

javax.jms.MessageNotWriteableException - if the message is in read-only mode.

writeBytes

public void writeBytes(byte[] value)
                throws javax.jms.JMSException

Writes a byte array to the bytes message stream.

Specified by:

writeBytes in interface javax.jms.BytesMessage

Parameters:

value - the byte array to be written

Throws:

javax.jms.JMSException - if the JMS provider fails to write the message due to some internal error.

javax.jms.MessageNotWriteableException - if the message is in read-only mode.

writeBytes

public void writeBytes(byte[] value,
                       int offset,
                       int length)
                throws javax.jms.JMSException

Writes a portion of a byte array to the bytes message stream.

Specified by:

writeBytes in interface javax.jms.BytesMessage

Parameters:

value - the byte array value to be written

offset - the initial offset within the byte array

length - the number of bytes to use

Throws:

javax.jms.JMSException - if the JMS provider fails to write the message due to some internal error.

javax.jms.MessageNotWriteableException - if the message is in read-only mode.

writeObject

public void writeObject(Object value)
                 throws javax.jms.JMSException

Writes an object to the bytes message stream.

This method works only for the objectified primitive object types (Integer,Double, Long ...), String objects, and byte arrays.

Specified by:

writeObject in interface javax.jms.BytesMessage

Parameters:

value - the object in the Java programming language ("Java object") to be written; it must not be null

Throws:

javax.jms.JMSException - if the JMS provider fails to write the message due to some internal error.

javax.jms.MessageFormatException - if the object is of an invalid type.

javax.jms.MessageNotWriteableException - if the message is in read-only mode.

NullPointerException - if the parameter value is null.

reset

public void reset()
           throws javax.jms.JMSException

Puts the message body in read-only mode and repositions the stream of bytes to the beginning.

Specified by:

reset in interface javax.jms.BytesMessage

Throws:

javax.jms.JMSException - if an internal error occurs

clearBody

public void clearBody()
               throws javax.jms.JMSException

Overide the super class method to reset the streams, and put the message body in write only mode.

If clearBody is called on a message in read-only mode, the message body is cleared and the message is in write-only mode. bytes to the beginning.

If clearBody is called on a message already in write-only mode, the spec does not define the outcome, so do nothing. Client must then call reset, followed by clearBody to reset the stream at the beginning for a new write.

Specified by:

clearBody in interface javax.jms.Message

Overrides:

clearBody in class GSMessageImpl

Throws:

javax.jms.JMSException - if JMS fails to reset the message due to some internal JMS error

See Also:

Message.clearBody()

toString

public String toString()

Overrides:

toString in class GSMessageImpl

See Also:

Object.toString()

cloneBody

protected Object cloneBody()

Returns a clone of the body.

Overrides:

cloneBody in class GSMessageImpl

Returns:

a clone of the body.