org.fusesource.stompjms.message.StompJmsBytesMessage Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of stompjms-client Show documentation
Show all versions of stompjms-client Show documentation
STOMP-JMS is a JMS implementation using STOMP as the wire protocol
/**
* Copyright (C) 2010-2011, FuseSource Corp. All rights reserved.
*
* http://fusesource.com
*
* The software in this package is published under the terms of the
* CDDL license a copy of which has been included with this distribution
* in the license.txt file.
*/
package org.fusesource.stompjms.message;
import org.fusesource.hawtbuf.Buffer;
import org.fusesource.hawtbuf.DataByteArrayInputStream;
import org.fusesource.hawtbuf.DataByteArrayOutputStream;
import org.fusesource.stompjms.StompJmsExceptionSupport;
import javax.jms.*;
import java.io.IOException;
/**
* 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.
*
* @openwire:marshaller code=24
* @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
*/
public class StompJmsBytesMessage extends StompJmsMessage implements BytesMessage {
protected transient DataByteArrayOutputStream bytesOut;
protected transient DataByteArrayInputStream dataIn;
protected transient int length;
public JmsMsgType getMsgType() {
return JmsMsgType.BYTES;
}
public StompJmsMessage copy() throws JMSException {
StompJmsBytesMessage copy = new StompJmsBytesMessage();
copy(copy);
return copy;
}
private void copy(StompJmsBytesMessage copy) throws JMSException {
storeContent();
super.copy(copy);
copy.bytesOut = null;
copy.dataIn = null;
}
public void storeContent() throws JMSException {
try {
if (bytesOut != null) {
bytesOut.close();
Buffer bs = bytesOut.toBuffer();
setContent(bs);
bytesOut = null;
}
} catch (IOException ioe) {
throw StompJmsExceptionSupport.create(ioe);
}
}
/**
* Clears out the message body. Clearing a message's body does not clear its
* header values or property entries.
*
* If this message body was read-only, calling this method leaves the
* message body in the same state as an empty body in a newly created
* message.
*
* @throws JMSException if the JMS provider fails to clear the message body
* due to some internal error.
*/
public void clearBody() throws JMSException {
super.clearBody();
this.dataIn = null;
this.bytesOut = null;
}
/**
* 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
* @throws JMSException if the JMS provider fails to read the message due to
* some internal error.
* @throws MessageNotReadableException if the message is in write-only mode.
* @since 1.1
*/
public long getBodyLength() throws JMSException {
initializeReading();
return length;
}
/**
* Reads a boolean from the bytes message stream.
*
* @return the boolean value read
* @throws JMSException if the JMS provider fails to read the message due to
* some internal error.
* @throws MessageNotReadableException if the message is in write-only mode.
*/
public boolean readBoolean() throws JMSException {
initializeReading();
try {
return this.dataIn.readBoolean();
} catch (ArrayIndexOutOfBoundsException e) {
throw StompJmsExceptionSupport.createMessageEOFException(e);
} catch (Throwable e) {
throw StompJmsExceptionSupport.createMessageFormatException(e);
}
}
/**
* 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
* @throws JMSException if the JMS provider fails to read the message due to
* some internal error.
* @throws MessageNotReadableException if the message is in write-only mode.
*/
public byte readByte() throws JMSException {
initializeReading();
return this.dataIn.readByte();
}
/**
* 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
* @throws JMSException if the JMS provider fails to read the message due to
* some internal error.
* @throws javax.jms.MessageEOFException if unexpected end of bytes stream has been
* reached.
* @throws MessageNotReadableException if the message is in write-only mode.
*/
public int readUnsignedByte() throws JMSException {
initializeReading();
try {
return this.dataIn.readUnsignedByte();
} catch (ArrayIndexOutOfBoundsException e) {
throw StompJmsExceptionSupport.createMessageEOFException(e);
} catch (Throwable e) {
throw StompJmsExceptionSupport.createMessageFormatException(e);
}
}
/**
* 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
* @throws JMSException if the JMS provider fails to read the message due to
* some internal error.
* @throws MessageEOFException if unexpected end of bytes stream has been
* reached.
* @throws MessageNotReadableException if the message is in write-only mode.
*/
public short readShort() throws JMSException {
initializeReading();
try {
return this.dataIn.readShort();
} catch (ArrayIndexOutOfBoundsException e) {
throw StompJmsExceptionSupport.createMessageEOFException(e);
} catch (Throwable e) {
throw StompJmsExceptionSupport.createMessageFormatException(e);
}
}
/**
* 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
* @throws JMSException if the JMS provider fails to read the message due to
* some internal error.
* @throws MessageEOFException if unexpected end of bytes stream has been
* reached.
* @throws MessageNotReadableException if the message is in write-only mode.
*/
public int readUnsignedShort() throws JMSException {
initializeReading();
try {
return this.dataIn.readUnsignedShort();
} catch (ArrayIndexOutOfBoundsException e) {
throw StompJmsExceptionSupport.createMessageEOFException(e);
} catch (Throwable e) {
throw StompJmsExceptionSupport.createMessageFormatException(e);
}
}
/**
* Reads a Unicode character value from the bytes message stream.
*
* @return the next two bytes from the bytes message stream as a Unicode
* character
* @throws JMSException if the JMS provider fails to read the message due to
* some internal error.
* @throws MessageEOFException if unexpected end of bytes stream has been
* reached.
* @throws MessageNotReadableException if the message is in write-only mode.
*/
public char readChar() throws JMSException {
initializeReading();
try {
return this.dataIn.readChar();
} catch (ArrayIndexOutOfBoundsException e) {
throw StompJmsExceptionSupport.createMessageEOFException(e);
} catch (Throwable e) {
throw StompJmsExceptionSupport.createMessageFormatException(e);
}
}
/**
* 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
* @throws JMSException if the JMS provider fails to read the message due to
* some internal error.
* @throws MessageEOFException if unexpected end of bytes stream has been
* reached.
* @throws MessageNotReadableException if the message is in write-only mode.
*/
public int readInt() throws JMSException {
initializeReading();
try {
return this.dataIn.readInt();
} catch (ArrayIndexOutOfBoundsException e) {
throw StompJmsExceptionSupport.createMessageEOFException(e);
} catch (Throwable e) {
throw StompJmsExceptionSupport.createMessageFormatException(e);
}
}
/**
* 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
* @throws JMSException if the JMS provider fails to read the message due to
* some internal error.
* @throws MessageEOFException if unexpected end of bytes stream has been
* reached.
* @throws MessageNotReadableException if the message is in write-only mode.
*/
public long readLong() throws JMSException {
initializeReading();
try {
return this.dataIn.readLong();
} catch (ArrayIndexOutOfBoundsException e) {
throw StompJmsExceptionSupport.createMessageEOFException(e);
} catch (Throwable e) {
throw StompJmsExceptionSupport.createMessageFormatException(e);
}
}
/**
* Reads a float from the bytes message stream.
*
* @return the next four bytes from the bytes message stream, interpreted as
* a float
* @throws JMSException if the JMS provider fails to read the message due to
* some internal error.
* @throws MessageEOFException if unexpected end of bytes stream has been
* reached.
* @throws MessageNotReadableException if the message is in write-only mode.
*/
public float readFloat() throws JMSException {
initializeReading();
try {
return this.dataIn.readFloat();
} catch (ArrayIndexOutOfBoundsException e) {
throw StompJmsExceptionSupport.createMessageEOFException(e);
} catch (Throwable e) {
throw StompJmsExceptionSupport.createMessageFormatException(e);
}
}
/**
* Reads a double from the bytes message stream.
*
* @return the next eight bytes from the bytes message stream, interpreted
* as a double
* @throws JMSException if the JMS provider fails to read the message due to
* some internal error.
* @throws MessageEOFException if unexpected end of bytes stream has been
* reached.
* @throws MessageNotReadableException if the message is in write-only mode.
*/
public double readDouble() throws JMSException {
initializeReading();
try {
return this.dataIn.readDouble();
} catch (ArrayIndexOutOfBoundsException e) {
throw StompJmsExceptionSupport.createMessageEOFException(e);
} catch (Throwable e) {
throw StompJmsExceptionSupport.createMessageFormatException(e);
}
}
/**
* 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
* @throws JMSException if the JMS provider fails to read the message due to
* some internal error.
* @throws MessageEOFException if unexpected end of bytes stream has been
* reached.
* @throws MessageNotReadableException if the message is in write-only mode.
*/
public String readUTF() throws JMSException {
initializeReading();
try {
return this.dataIn.readUTF();
} catch (ArrayIndexOutOfBoundsException e) {
throw StompJmsExceptionSupport.createMessageEOFException(e);
} catch (Throwable e) {
throw StompJmsExceptionSupport.createMessageFormatException(e);
}
}
/**
* 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
* @throws JMSException if the JMS provider fails to read the message due to
* some internal error.
* @throws MessageNotReadableException if the message is in write-only mode.
*/
public int readBytes(byte[] value) throws JMSException {
return readBytes(value, value.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
* @throws JMSException if the JMS provider fails to read the message due to
* some internal error.
* @throws MessageNotReadableException if the message is in write-only mode.
*/
public int readBytes(byte[] value, int length) throws JMSException {
initializeReading();
try {
int n = 0;
while (n < length) {
int count = this.dataIn.read(value, n, length - n);
if (count < 0) {
break;
}
n += count;
}
if (n == 0 && length > 0) {
n = -1;
}
return n;
} catch (ArrayIndexOutOfBoundsException e) {
throw StompJmsExceptionSupport.createMessageEOFException(e);
} catch (Throwable e) {
throw StompJmsExceptionSupport.createMessageFormatException(e);
}
}
/**
* 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
* @throws JMSException if the JMS provider fails to write the message due
* to some internal error.
* @throws MessageNotWriteableException if the message is in read-only mode.
*/
public void writeBoolean(boolean value) throws JMSException {
initializeWriting();
try {
this.bytesOut.writeBoolean(value);
} catch (IOException e) {
throw StompJmsExceptionSupport.createMessageFormatException(e);
}
}
/**
* Writes a byte to the bytes message stream as a 1-byte
* value.
*
* @param value the byte value to be written
* @throws JMSException if the JMS provider fails to write the message due
* to some internal error.
* @throws MessageNotWriteableException if the message is in read-only mode.
*/
public void writeByte(byte value) throws JMSException {
initializeWriting();
try {
this.bytesOut.writeByte(value);
} catch (IOException e) {
throw StompJmsExceptionSupport.createMessageFormatException(e);
}
}
/**
* Writes a short to the bytes message stream as two bytes,
* high byte first.
*
* @param value the short to be written
* @throws JMSException if the JMS provider fails to write the message due
* to some internal error.
* @throws MessageNotWriteableException if the message is in read-only mode.
*/
public void writeShort(short value) throws JMSException {
initializeWriting();
try {
this.bytesOut.writeShort(value);
} catch (IOException e) {
throw StompJmsExceptionSupport.createMessageFormatException(e);
}
}
/**
* Writes a char to the bytes message stream as a 2-byte
* value, high byte first.
*
* @param value the char value to be written
* @throws JMSException if the JMS provider fails to write the message due
* to some internal error.
* @throws MessageNotWriteableException if the message is in read-only mode.
*/
public void writeChar(char value) throws JMSException {
initializeWriting();
try {
this.bytesOut.writeChar(value);
} catch (IOException e) {
throw StompJmsExceptionSupport.createMessageFormatException(e);
}
}
/**
* Writes an int to the bytes message stream as four bytes,
* high byte first.
*
* @param value the int to be written
* @throws JMSException if the JMS provider fails to write the message due
* to some internal error.
* @throws MessageNotWriteableException if the message is in read-only mode.
*/
public void writeInt(int value) throws JMSException {
initializeWriting();
try {
this.bytesOut.writeInt(value);
} catch (IOException e) {
throw StompJmsExceptionSupport.createMessageFormatException(e);
}
}
/**
* Writes a long to the bytes message stream as eight bytes,
* high byte first.
*
* @param value the long to be written
* @throws JMSException if the JMS provider fails to write the message due
* to some internal error.
* @throws MessageNotWriteableException if the message is in read-only mode.
*/
public void writeLong(long value) throws JMSException {
initializeWriting();
try {
this.bytesOut.writeLong(value);
} catch (IOException e) {
throw StompJmsExceptionSupport.createMessageFormatException(e);
}
}
/**
* 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
* @throws JMSException if the JMS provider fails to write the message due
* to some internal error.
* @throws MessageNotWriteableException if the message is in read-only mode.
*/
public void writeFloat(float value) throws JMSException {
initializeWriting();
try {
this.bytesOut.writeFloat(value);
} catch (IOException e) {
throw StompJmsExceptionSupport.createMessageFormatException(e);
}
}
/**
* 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
* @throws JMSException if the JMS provider fails to write the message due
* to some internal error.
* @throws MessageNotWriteableException if the message is in read-only mode.
*/
public void writeDouble(double value) throws JMSException {
initializeWriting();
try {
this.bytesOut.writeDouble(value);
} catch (IOException e) {
throw StompJmsExceptionSupport.createMessageFormatException(e);
}
}
/**
* 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
* @throws JMSException if the JMS provider fails to write the message due
* to some internal error.
* @throws MessageNotWriteableException if the message is in read-only mode.
*/
public void writeUTF(String value) throws JMSException {
initializeWriting();
try {
this.bytesOut.writeUTF(value);
} catch (IOException ioe) {
throw StompJmsExceptionSupport.create(ioe);
}
}
/**
* Writes a byte array to the bytes message stream.
*
* @param value the byte array to be written
* @throws JMSException if the JMS provider fails to write the message due
* to some internal error.
* @throws MessageNotWriteableException if the message is in read-only mode.
*/
public void writeBytes(byte[] value) throws JMSException {
initializeWriting();
try {
this.bytesOut.write(value);
} catch (IOException e) {
throw StompJmsExceptionSupport.createMessageFormatException(e);
}
}
/**
* 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
* @throws JMSException if the JMS provider fails to write the message due
* to some internal error.
* @throws MessageNotWriteableException if the message is in read-only mode.
*/
public void writeBytes(byte[] value, int offset, int length) throws JMSException {
initializeWriting();
try {
this.bytesOut.write(value, offset, length);
} catch (IOException e) {
throw StompJmsExceptionSupport.createMessageFormatException(e);
}
}
/**
* 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
* @throws JMSException if the JMS provider fails to write the message due
* to some internal error.
* @throws MessageFormatException if the object is of an invalid type.
* @throws MessageNotWriteableException if the message is in read-only mode.
* @throws java.lang.NullPointerException if the parameter
* value is null.
*/
public void writeObject(Object value) throws JMSException {
if (value == null) {
throw new NullPointerException();
}
initializeWriting();
if (value instanceof Boolean) {
writeBoolean(((Boolean) value).booleanValue());
} else if (value instanceof Character) {
writeChar(((Character) value).charValue());
} else if (value instanceof Byte) {
writeByte(((Byte) value).byteValue());
} else if (value instanceof Short) {
writeShort(((Short) value).shortValue());
} else if (value instanceof Integer) {
writeInt(((Integer) value).intValue());
} else if (value instanceof Long) {
writeLong(((Long) value).longValue());
} else if (value instanceof Float) {
writeFloat(((Float) value).floatValue());
} else if (value instanceof Double) {
writeDouble(((Double) value).doubleValue());
} else if (value instanceof String) {
writeUTF(value.toString());
} else if (value instanceof byte[]) {
writeBytes((byte[]) value);
} else {
throw new MessageFormatException("Cannot write non-primitive type:" + value.getClass());
}
}
/**
* Puts the message body in read-only mode and repositions the stream of
* bytes to the beginning.
*
* @throws JMSException if an internal error occurs
*/
public void reset() throws JMSException {
storeContent();
this.bytesOut = null;
this.dataIn = null;
setReadOnlyBody(true);
}
private void initializeWriting() throws JMSException {
checkReadOnlyBody();
if (this.bytesOut == null) {
this.bytesOut = new DataByteArrayOutputStream();
}
}
protected void checkWriteOnlyBody() throws MessageNotReadableException {
if (!readOnlyBody) {
throw new MessageNotReadableException("Message body is write-only");
}
}
private void initializeReading() throws JMSException {
checkWriteOnlyBody();
Buffer buffer = getContent();
if (dataIn == null && buffer != null) {
dataIn = new DataByteArrayInputStream(buffer);
this.length = buffer.getLength();
}
}
public void setObjectProperty(String name, Object value) throws JMSException {
initializeWriting();
super.setObjectProperty(name, value);
}
public String toString() {
return super.toString() + " StompJmsBytesMessage{ " + "bytesOut = " + bytesOut + ", dataIn = " + dataIn + " }";
}
}