com.amazon.sqs.javamessaging.message

Class SQSBytesMessage

java.lang.Object

com.amazon.sqs.javamessaging.message.SQSMessage

com.amazon.sqs.javamessaging.message.SQSBytesMessage

public class SQSBytesMessage
extends SQSMessage

This class borrows from ActiveMQStreamMessage, which is also licensed under Apache2.0. Its methods are based largely on those found in java.io.DataInputStream and java.io.DataOutputStream.

See Also:

org.apache.activemq.command.ActiveMQStreamMessage

Nested Class Summary

Nested classes/interfaces inherited from class com.amazon.sqs.javamessaging.message.SQSMessage

SQSMessage.JMSMessagePropertyValue, SQSMessage.TypeConversionSupport

Field Summary

Fields inherited from class com.amazon.sqs.javamessaging.message.SQSMessage

BYTE_MESSAGE_TYPE, JMS_SQS_MESSAGE_TYPE, JMS_SQS_REPLY_TO_QUEUE_NAME, JMS_SQS_REPLY_TO_QUEUE_URL, OBJECT_MESSAGE_TYPE, TEXT_MESSAGE_TYPE

Constructor Summary

Constructors

Constructor and Description
SQSBytesMessage() Create new empty BytesMessage to send.
SQSBytesMessage(Acknowledger acknowledger, java.lang.String queueUrl, Message sqsMessage) Convert received SQSMessage into BytesMessage.

Method Summary

Methods

Modifier and Type	Method and Description
void	clearBody() When the message is first created, and when clearBody is called, the body of the message is in write-only mode.
byte[]	getBodyAsBytes() Reads the body of message, which can be either the body returned from the the receives message as bytes or the bytes put in bytesOut if it is a sent message.
long	getBodyLength() Gets the number of bytes of the message body when the message is in read-only mode.
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 32-bit integer from the bytes message stream.
long	readLong() Reads a 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 value from the bytes message stream.
int	readUnsignedShort() Reads an unsigned 16-bit number from the bytes message stream.
java.lang.String	readUTF() Reads a string that has been encoded using a 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	writeBoolean(boolean value) Writes a boolean to the bytes message stream
void	writeByte(byte value) Writes a byte to the bytes message stream
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
void	writeDouble(double value) Writes a double to the bytes message stream
void	writeFloat(float value) Writes a float to the bytes message stream
void	writeInt(int value) Writes a int to the bytes message stream
void	writeLong(long value) Writes a long to the bytes message stream
void	writeObject(java.lang.Object value) Writes an object to the bytes message stream.
void	writeShort(short value) Writes a short to the bytes message stream
void	writeUTF(java.lang.String value) Writes a string that has been encoded using a UTF-8 format to the bytes message stream

Methods inherited from class com.amazon.sqs.javamessaging.message.SQSMessage

acknowledge, checkBodyWritePermissions, checkPropertyWritePermissions, clearProperties, convertExceptionToJMSException, convertExceptionToMessageFormatException, getBooleanProperty, getByteProperty, getDoubleProperty, getFloatProperty, getIntProperty, getJMSCorrelationID, getJMSCorrelationIDAsBytes, getJMSDeliveryMode, getJMSDestination, getJMSExpiration, getJMSMessageID, getJMSMessagePropertyValue, getJMSPriority, getJMSRedelivered, getJMSReplyTo, getJMSTimestamp, getJMSType, getLongProperty, getObjectProperty, getPropertyNames, getQueueUrl, getReceiptHandle, getShortProperty, getSQSMessageDeduplicationId, getSQSMessageGroupId, getSQSMessageId, getSQSMessageSequenceNumber, getStringProperty, propertyExists, setBodyWritePermissions, setBooleanProperty, setByteProperty, setDoubleProperty, setFloatProperty, setIntProperty, setJMSCorrelationID, setJMSCorrelationIDAsBytes, setJMSDeliveryMode, setJMSDestination, setJMSExpiration, setJMSMessageID, setJMSPriority, setJMSRedelivered, setJMSReplyTo, setJMSTimestamp, setJMSType, setLongProperty, setObjectProperty, setSequenceNumber, setShortProperty, setSQSMessageId, setStringProperty

Methods inherited from class java.lang.Object

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

Constructor Detail

SQSBytesMessage

public SQSBytesMessage(Acknowledger acknowledger,
               java.lang.String queueUrl,
               Message sqsMessage)
                throws JMSException

Convert received SQSMessage into BytesMessage.

Throws:

JMSException

SQSBytesMessage

public SQSBytesMessage()
                throws JMSException

Create new empty BytesMessage to send.

Throws:

JMSException

Method Detail

getBodyLength

public long getBodyLength()
                   throws 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.

Returns:

number of bytes in the message

Throws:

MessageNotReadableException - If the message is in write-only mode.

JMSException

readBoolean

public boolean readBoolean()
                    throws JMSException

Reads a boolean from the bytes message stream.

Returns:

the boolean value

Throws:

JMSException - If the JMS provider fails to read the message due to some internal error.

MessageEOFException - If unexpected end of bytes stream has been reached.

MessageNotReadableException - If the message is in write-only mode.

readByte

public byte readByte()
              throws JMSException

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

Returns:

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

Throws:

JMSException - If the JMS provider fails to read the message due to some internal error.

MessageEOFException - If unexpected end of bytes stream has been reached.

MessageNotReadableException - If the message is in write-only mode.

readUnsignedByte

public int readUnsignedByte()
                     throws JMSException

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

Returns:

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

Throws:

JMSException - If the JMS provider fails to read the message due to some internal error.

MessageEOFException - If unexpected end of bytes stream has been reached.

MessageNotReadableException - If the message is in write-only mode.

readShort

public short readShort()
                throws JMSException

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

Returns:

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

Throws:

JMSException - If the JMS provider fails to read the message due to some internal error.

MessageEOFException - If unexpected end of bytes stream has been reached.

MessageNotReadableException - If the message is in write-only mode.

readUnsignedShort

public int readUnsignedShort()
                      throws JMSException

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

Returns:

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

Throws:

JMSException - If the JMS provider fails to read the message due to some internal error.

MessageEOFException - If unexpected end of bytes stream has been reached.

MessageNotReadableException - If the message is in write-only mode.

readChar

public char readChar()
              throws JMSException

Reads a Unicode character value from the bytes message stream.

Returns:

a Unicode character from the bytes message stream

Throws:

JMSException - If the JMS provider fails to read the message due to some internal error.

MessageEOFException - If unexpected end of bytes stream has been reached.

MessageNotReadableException - If the message is in write-only mode.

readInt

public int readInt()
            throws JMSException

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

Returns:

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

Throws:

JMSException - If the JMS provider fails to read the message due to some internal error.

MessageEOFException - If unexpected end of bytes stream has been reached.

MessageNotReadableException - If the message is in write-only mode.

readLong

public long readLong()
              throws JMSException

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

Returns:

a 64-bit integer value from the bytes message stream, interpreted as a long

Throws:

JMSException - If the JMS provider fails to read the message due to some internal error.

MessageEOFException - If unexpected end of bytes stream has been reached.

MessageNotReadableException - If the message is in write-only mode.

readFloat

public float readFloat()
                throws JMSException

Reads a float from the bytes message stream.

Returns:

a float value from the bytes message stream

Throws:

JMSException - If the JMS provider fails to read the message due to some internal error.

MessageEOFException - If unexpected end of bytes stream has been reached.

MessageNotReadableException - If the message is in write-only mode.

readDouble

public double readDouble()
                  throws JMSException

Reads a double from the bytes message stream.

Returns:

a double value from the bytes message stream

Throws:

JMSException - If the JMS provider fails to read the message due to some internal error.

MessageEOFException - If unexpected end of bytes stream has been reached.

MessageNotReadableException - If the message is in write-only mode.

readUTF

public java.lang.String readUTF()
                         throws JMSException

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

Returns:

a Unicode string from the bytes message stream

Throws:

JMSException - If the JMS provider fails to read the message due to some internal error.

MessageEOFException - If unexpected end of bytes stream has been reached.

MessageNotReadableException - If the message is in write-only mode.

readBytes

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

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:

JMSException - If the JMS provider fails to read the message due to some internal error.

MessageNotReadableException - If the message is in write-only mode.

readBytes

public int readBytes(byte[] value,
            int length)
              throws 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, then an IndexOutOfBoundsException is thrown. No bytes will be read from the stream for this exception case.

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:

JMSException - If the JMS provider fails to read the message due to some internal error.

MessageNotReadableException - If the message is in write-only mode.

writeBoolean

public void writeBoolean(boolean value)
                  throws JMSException

Writes a boolean to the bytes message stream

Parameters:

value - The boolean value to be written

Throws:

JMSException - If the JMS provider fails to write the message due to some internal error.

MessageNotWriteableException - If the message is in read-only mode.

writeByte

public void writeByte(byte value)
               throws JMSException

Writes a byte to the bytes message stream

Parameters:

value - The byte value to be written

Throws:

JMSException - If the JMS provider fails to write the message due to some internal error.

MessageNotWriteableException - If the message is in read-only mode.

writeShort

public void writeShort(short value)
                throws JMSException

Writes a short to the bytes message stream

Parameters:

value - The short value to be written

Throws:

JMSException - If the JMS provider fails to write the message due to some internal error.

MessageNotWriteableException - If the message is in read-only mode.

writeChar

public void writeChar(char value)
               throws JMSException

Writes a char to the bytes message stream

Parameters:

value - The char value to be written

Throws:

JMSException - If the JMS provider fails to write the message due to some internal error.

MessageNotWriteableException - If the message is in read-only mode.

writeInt

public void writeInt(int value)
              throws JMSException

Writes a int to the bytes message stream

Parameters:

value - The int value to be written

Throws:

JMSException - If the JMS provider fails to write the message due to some internal error.

MessageNotWriteableException - If the message is in read-only mode.

writeLong

public void writeLong(long value)
               throws JMSException

Writes a long to the bytes message stream

Parameters:

value - The long value to be written

Throws:

JMSException - If the JMS provider fails to write the message due to some internal error.

MessageNotWriteableException - If the message is in read-only mode.

writeFloat

public void writeFloat(float value)
                throws JMSException

Writes a float to the bytes message stream

Parameters:

value - The float value to be written

Throws:

JMSException - If the JMS provider fails to write the message due to some internal error.

MessageNotWriteableException - If the message is in read-only mode.

writeDouble

public void writeDouble(double value)
                 throws JMSException

Writes a double to the bytes message stream

Parameters:

value - The double value to be written

Throws:

JMSException - If the JMS provider fails to write the message due to some internal error.

MessageNotWriteableException - If the message is in read-only mode.

writeUTF

public void writeUTF(java.lang.String value)
              throws JMSException

Writes a string that has been encoded using a UTF-8 format to the bytes message stream

Parameters:

value - The String value to be written

Throws:

JMSException - If the JMS provider fails to write the message due to some internal error.

MessageNotWriteableException - If the message is in read-only mode.

writeBytes

public void writeBytes(byte[] value)
                throws JMSException

Writes a byte array to the bytes message stream

Parameters:

value - The byte array value to be written

Throws:

JMSException - If the JMS provider fails to write the message due to some internal error.

MessageNotWriteableException - If the message is in read-only mode.

writeBytes

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

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

Parameters:

value - The portion of byte array value to be written

offset - The initial offset within the byte array

length - The number of bytes to use

Throws:

JMSException - If the JMS provider fails to write the message due to some internal error.

MessageNotWriteableException - If the message is in read-only mode.

writeObject

public void writeObject(java.lang.Object value)
                 throws JMSException

Writes an object to the bytes message stream.

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

Parameters:

value - The Java object to be written

Throws:

JMSException - If the JMS provider fails to write the message due to some internal error.

MessageNotWriteableException - If the message is in read-only mode.

MessageFormatException - If the object is of an invalid type.

java.lang.NullPointerException - If the object is null.

reset

public void reset()
           throws JMSException

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

Throws:

JMSException

clearBody

public void clearBody()
               throws JMSException

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 is made, the message body goes to read-only mode. when the message is sent, the sender can retain and modify it without affecting the sent message. If clearBody is called on a message, when it is in read-only mode, the message body is cleared and the message goes to write-only mode.

Overrides:

clearBody in class SQSMessage

Throws:

JMSException - If directly called

getBodyAsBytes

public byte[] getBodyAsBytes()
                      throws JMSException

Reads the body of message, which can be either the body returned from the the receives message as bytes or the bytes put in bytesOut if it is a sent message.

Returns:

value The body returned as byte array

Throws:

JMSException