FileDocCategorySizeDatePackage
BytesMessage.javaAPI DocGlassfish v2 API24021Fri May 04 22:36:16 BST 2007javax.jms

BytesMessage

public interface BytesMessage implements Message
A BytesMessage object is used to send a message containing a stream of uninterpreted bytes. It inherits from the Message interface and adds a bytes message body. The receiver of the message supplies the interpretation of the 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
1.1 April 2, 2002
author
Mark Hapner
author
Rich Burridge
author
Kate Stout
see
javax.jms.Session#createBytesMessage()
see
javax.jms.MapMessage
see
javax.jms.Message
see
javax.jms.ObjectMessage
see
javax.jms.StreamMessage
see
javax.jms.TextMessage

Fields Summary
Constructors Summary
Methods Summary
public longgetBodyLength()
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.

return
number of bytes in the message
exception
JMSException if the JMS provider fails to read the message due to some internal error.
exception
MessageNotReadableException if the message is in write-only mode.
since
1.1

public booleanreadBoolean()
Reads a boolean from the bytes message stream.

return
the boolean value read
exception
JMSException if the JMS provider fails to read the message due to some internal error.
exception
MessageEOFException if unexpected end of bytes stream has been reached.
exception
MessageNotReadableException if the message is in write-only mode.

public bytereadByte()
Reads a signed 8-bit value from the bytes message stream.

return
the next byte from the bytes message stream as a signed 8-bit byte
exception
JMSException if the JMS provider fails to read the message due to some internal error.
exception
MessageEOFException if unexpected end of bytes stream has been reached.
exception
MessageNotReadableException if the message is in write-only mode.

public intreadBytes(byte[] value)
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.

param
value the buffer into which the data is read
return
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
exception
JMSException if the JMS provider fails to read the message due to some internal error.
exception
MessageNotReadableException if the message is in write-only mode.

public intreadBytes(byte[] value, int length)
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.

param
value the buffer into which the data is read
param
length the number of bytes to read; must be less than or equal to value.length
return
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
exception
JMSException if the JMS provider fails to read the message due to some internal error.
exception
MessageNotReadableException if the message is in write-only mode.

public charreadChar()
Reads a Unicode character value from the bytes message stream.

return
the next two bytes from the bytes message stream as a Unicode character
exception
JMSException if the JMS provider fails to read the message due to some internal error.
exception
MessageEOFException if unexpected end of bytes stream has been reached.
exception
MessageNotReadableException if the message is in write-only mode.

public doublereadDouble()
Reads a double from the bytes message stream.

return
the next eight bytes from the bytes message stream, interpreted as a double
exception
JMSException if the JMS provider fails to read the message due to some internal error.
exception
MessageEOFException if unexpected end of bytes stream has been reached.
exception
MessageNotReadableException if the message is in write-only mode.

public floatreadFloat()
Reads a float from the bytes message stream.

return
the next four bytes from the bytes message stream, interpreted as a float
exception
JMSException if the JMS provider fails to read the message due to some internal error.
exception
MessageEOFException if unexpected end of bytes stream has been reached.
exception
MessageNotReadableException if the message is in write-only mode.

public intreadInt()
Reads a signed 32-bit integer from the bytes message stream.

return
the next four bytes from the bytes message stream, interpreted as an int
exception
JMSException if the JMS provider fails to read the message due to some internal error.
exception
MessageEOFException if unexpected end of bytes stream has been reached.
exception
MessageNotReadableException if the message is in write-only mode.

public longreadLong()
Reads a signed 64-bit integer from the bytes message stream.

return
the next eight bytes from the bytes message stream, interpreted as a long
exception
JMSException if the JMS provider fails to read the message due to some internal error.
exception
MessageEOFException if unexpected end of bytes stream has been reached.
exception
MessageNotReadableException if the message is in write-only mode.

public shortreadShort()
Reads a signed 16-bit number from the bytes message stream.

return
the next two bytes from the bytes message stream, interpreted as a signed 16-bit number
exception
JMSException if the JMS provider fails to read the message due to some internal error.
exception
MessageEOFException if unexpected end of bytes stream has been reached.
exception
MessageNotReadableException if the message is in write-only mode.

public java.lang.StringreadUTF()
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.

return
a Unicode string from the bytes message stream
exception
JMSException if the JMS provider fails to read the message due to some internal error.
exception
MessageEOFException if unexpected end of bytes stream has been reached.
exception
MessageNotReadableException if the message is in write-only mode.

public intreadUnsignedByte()
Reads an unsigned 8-bit number from the bytes message stream.

return
the next byte from the bytes message stream, interpreted as an unsigned 8-bit number
exception
JMSException if the JMS provider fails to read the message due to some internal error.
exception
MessageEOFException if unexpected end of bytes stream has been reached.
exception
MessageNotReadableException if the message is in write-only mode.

public intreadUnsignedShort()
Reads an unsigned 16-bit number from the bytes message stream.

return
the next two bytes from the bytes message stream, interpreted as an unsigned 16-bit integer
exception
JMSException if the JMS provider fails to read the message due to some internal error.
exception
MessageEOFException if unexpected end of bytes stream has been reached.
exception
MessageNotReadableException if the message is in write-only mode.

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

exception
JMSException if the JMS provider fails to reset the message due to some internal error.
exception
MessageFormatException if the message has an invalid format.

public voidwriteBoolean(boolean value)
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.

param
value the boolean value to be written
exception
JMSException if the JMS provider fails to write the message due to some internal error.
exception
MessageNotWriteableException if the message is in read-only mode.

public voidwriteByte(byte value)
Writes a byte to the bytes message stream as a 1-byte value.

param
value the byte value to be written
exception
JMSException if the JMS provider fails to write the message due to some internal error.
exception
MessageNotWriteableException if the message is in read-only mode.

public voidwriteBytes(byte[] value)
Writes a byte array to the bytes message stream.

param
value the byte array to be written
exception
JMSException if the JMS provider fails to write the message due to some internal error.
exception
MessageNotWriteableException if the message is in read-only mode.

public voidwriteBytes(byte[] value, int offset, int length)
Writes a portion of a byte array to the bytes message stream.

param
value the byte array value to be written
param
offset the initial offset within the byte array
param
length the number of bytes to use
exception
JMSException if the JMS provider fails to write the message due to some internal error.
exception
MessageNotWriteableException if the message is in read-only mode.

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

param
value the char value to be written
exception
JMSException if the JMS provider fails to write the message due to some internal error.
exception
MessageNotWriteableException if the message is in read-only mode.

public voidwriteDouble(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.

param
value the double value to be written
exception
JMSException if the JMS provider fails to write the message due to some internal error.
exception
MessageNotWriteableException if the message is in read-only mode.

public voidwriteFloat(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.

param
value the float value to be written
exception
JMSException if the JMS provider fails to write the message due to some internal error.
exception
MessageNotWriteableException if the message is in read-only mode.

public voidwriteInt(int value)
Writes an int to the bytes message stream as four bytes, high byte first.

param
value the int to be written
exception
JMSException if the JMS provider fails to write the message due to some internal error.
exception
MessageNotWriteableException if the message is in read-only mode.

public voidwriteLong(long value)
Writes a long to the bytes message stream as eight bytes, high byte first.

param
value the long to be written
exception
JMSException if the JMS provider fails to write the message due to some internal error.
exception
MessageNotWriteableException if the message is in read-only mode.

public voidwriteObject(java.lang.Object value)
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.

param
value the object in the Java programming language ("Java object") to be written; it must not be null
exception
JMSException if the JMS provider fails to write the message due to some internal error.
exception
MessageFormatException if the object is of an invalid type.
exception
MessageNotWriteableException if the message is in read-only mode.
exception
java.lang.NullPointerException if the parameter value is null.

public voidwriteShort(short value)
Writes a short to the bytes message stream as two bytes, high byte first.

param
value the short to be written
exception
JMSException if the JMS provider fails to write the message due to some internal error.
exception
MessageNotWriteableException if the message is in read-only mode.

public voidwriteUTF(java.lang.String value)
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.

param
value the String value to be written
exception
JMSException if the JMS provider fails to write the message due to some internal error.
exception
MessageNotWriteableException if the message is in read-only mode.