Module com.rabbitmq.jms

Package com.rabbitmq.jms.client.message

Class RMQStreamMessage

java.lang.Object

com.rabbitmq.jms.client.RMQMessage

com.rabbitmq.jms.client.message.RMQStreamMessage

All Implemented Interfaces:

jakarta.jms.Message, jakarta.jms.StreamMessage, java.lang.Cloneable

public class RMQStreamMessage
extends RMQMessage
implements jakarta.jms.StreamMessage

Implements StreamMessage interface.

Field Summary

Fields inherited from class com.rabbitmq.jms.client.RMQMessage

DEFAULT_MESSAGE_BODY_SIZE, logger, MSG_EOF, NOT_READABLE, NOT_WRITEABLE, UNABLE_TO_CAST

Fields inherited from interface jakarta.jms.Message

DEFAULT_DELIVERY_DELAY, DEFAULT_DELIVERY_MODE, DEFAULT_PRIORITY, DEFAULT_TIME_TO_LIVE

Constructor Summary

Constructors

Constructor	Description
RMQStreamMessage()
RMQStreamMessage(java.util.List<java.lang.String> trustedPackages)

Method Summary

Modifier and Type	Method	Description
void	clearBodyInternal()
protected <T> T	doGetBody(java.lang.Class<T> c)
<T> T	getBody(java.lang.Class<T> c)
boolean	isAmqpWritable()
boolean	isBodyAssignableTo(java.lang.Class c)
protected void	readAmqpBody(byte[] barr)	Invoked when an AMQP message is being transformed into a RMQMessage The implementing class should only read its body by this method
protected void	readBody(java.io.ObjectInput inputStream, java.io.ByteArrayInputStream bin)	Invoked when a message is being deserialized to read and decode the message body.
boolean	readBoolean()
byte	readByte()
int	readBytes(byte[] value)
char	readChar()
double	readDouble()
float	readFloat()
int	readInt()
long	readLong()
java.lang.Object	readObject()	reads an object from the stream that was used to serialize this message
short	readShort()
java.lang.String	readString()
static RMQMessage	recreate(jakarta.jms.StreamMessage msg)
void	reset()
protected void	writeAmqpBody(java.io.ByteArrayOutputStream out)	Invoked when RMQMessage.toAmqpByteArray() is called to create a byte[] from a message.
protected void	writeBody(java.io.ObjectOutput out, java.io.ByteArrayOutputStream bout)	Invoked when RMQMessage.toByteArray() is called to create a byte[] from a message.
void	writeBoolean(boolean value)
void	writeByte(byte value)
void	writeBytes(byte[] value)
void	writeBytes(byte[] value, int offset, int length)
void	writeChar(char value)
void	writeDouble(double value)
void	writeFloat(float value)
void	writeInt(int value)
void	writeLong(long value)
void	writeObject(java.lang.Object value)
void	writeShort(short value)
void	writeString(java.lang.String value)

Methods inherited from class com.rabbitmq.jms.client.RMQMessage

acknowledge, clearBody, clearProperties, clone, copyAttributes, doNotDeclareReplyToDestination, equals, getBooleanProperty, getByteProperty, getDoubleProperty, getFloatProperty, getInternalID, getIntProperty, getJMSCorrelationID, getJMSCorrelationIDAsBytes, getJMSDeliveryMode, getJMSDeliveryTime, getJMSDestination, getJMSExpiration, getJMSMessageID, getJMSPriority, getJMSRedelivered, getJMSReplyTo, getJMSTimestamp, getJMSType, getLongProperty, getObjectProperty, getPropertyNames, getRabbitDeliveryTag, getSession, getShortProperty, getStringProperty, hashCode, isReadonlyBody, isReadOnlyProperties, loggerDebugByteArray, propertyExists, readPrimitive, setBooleanProperty, setByteProperty, setDoubleProperty, setFloatProperty, setIntProperty, setJMSCorrelationID, setJMSCorrelationIDAsBytes, setJMSDeliveryMode, setJMSDeliveryTime, setJMSDestination, setJMSExpiration, setJMSMessageID, setJMSPriority, setJMSRedelivered, setJMSReplyTo, setJMSTimestamp, setJMSType, setLongProperty, setObjectProperty, setRabbitDeliveryTag, setReadonly, setReadOnlyBody, setReadOnlyProperties, setSession, setShortProperty, setStringProperty, writePrimitive, writePrimitive

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface jakarta.jms.Message

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

Constructor Detail

RMQStreamMessage

public RMQStreamMessage(java.util.List<java.lang.String> trustedPackages)

RMQStreamMessage

public RMQStreamMessage()

Method Detail

readBoolean

public boolean readBoolean()
                    throws jakarta.jms.JMSException

Specified by:

readBoolean in interface jakarta.jms.StreamMessage

Throws:

jakarta.jms.JMSException

readByte

public byte readByte()
              throws jakarta.jms.JMSException

Specified by:

readByte in interface jakarta.jms.StreamMessage

Throws:

jakarta.jms.JMSException

readShort

public short readShort()
                throws jakarta.jms.JMSException

Specified by:

readShort in interface jakarta.jms.StreamMessage

Throws:

jakarta.jms.JMSException

readChar

public char readChar()
              throws jakarta.jms.JMSException

Specified by:

readChar in interface jakarta.jms.StreamMessage

Throws:

jakarta.jms.JMSException

readInt

public int readInt()
            throws jakarta.jms.JMSException

Specified by:

readInt in interface jakarta.jms.StreamMessage

Throws:

jakarta.jms.JMSException

readLong

public long readLong()
              throws jakarta.jms.JMSException

Specified by:

readLong in interface jakarta.jms.StreamMessage

Throws:

jakarta.jms.JMSException

readFloat

public float readFloat()
                throws jakarta.jms.JMSException

Specified by:

readFloat in interface jakarta.jms.StreamMessage

Throws:

jakarta.jms.JMSException

readDouble

public double readDouble()
                  throws jakarta.jms.JMSException

Specified by:

readDouble in interface jakarta.jms.StreamMessage

Throws:

jakarta.jms.JMSException

readString

public java.lang.String readString()
                            throws jakarta.jms.JMSException

Specified by:

readString in interface jakarta.jms.StreamMessage

Throws:

jakarta.jms.JMSException

readBytes

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

Specified by:

readBytes in interface jakarta.jms.StreamMessage

Throws:

jakarta.jms.JMSException

readObject

public java.lang.Object readObject()
                            throws jakarta.jms.JMSException

reads an object from the stream that was used to serialize this message

Specified by:

readObject in interface jakarta.jms.StreamMessage

Returns:

the object read

Throws:

jakarta.jms.JMSException - if a deserialization exception happens

writeBoolean

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

Specified by:

writeBoolean in interface jakarta.jms.StreamMessage

Throws:

jakarta.jms.JMSException

writeByte

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

Specified by:

writeByte in interface jakarta.jms.StreamMessage

Throws:

jakarta.jms.JMSException

writeShort

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

Specified by:

writeShort in interface jakarta.jms.StreamMessage

Throws:

jakarta.jms.JMSException

writeChar

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

Specified by:

writeChar in interface jakarta.jms.StreamMessage

Throws:

jakarta.jms.JMSException

writeInt

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

Specified by:

writeInt in interface jakarta.jms.StreamMessage

Throws:

jakarta.jms.JMSException

writeLong

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

Specified by:

writeLong in interface jakarta.jms.StreamMessage

Throws:

jakarta.jms.JMSException

writeFloat

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

Specified by:

writeFloat in interface jakarta.jms.StreamMessage

Throws:

jakarta.jms.JMSException

writeDouble

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

Specified by:

writeDouble in interface jakarta.jms.StreamMessage

Throws:

jakarta.jms.JMSException

writeString

public void writeString(java.lang.String value)
                 throws jakarta.jms.JMSException

Specified by:

writeString in interface jakarta.jms.StreamMessage

Throws:

jakarta.jms.JMSException

writeBytes

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

Specified by:

writeBytes in interface jakarta.jms.StreamMessage

Throws:

jakarta.jms.JMSException

writeBytes

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

Specified by:

writeBytes in interface jakarta.jms.StreamMessage

Throws:

jakarta.jms.JMSException

writeObject

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

Specified by:

writeObject in interface jakarta.jms.StreamMessage

Throws:

jakarta.jms.JMSException

reset

public void reset()
           throws jakarta.jms.JMSException

Specified by:

reset in interface jakarta.jms.StreamMessage

Throws:

jakarta.jms.JMSException

clearBodyInternal

public void clearBodyInternal()
                       throws jakarta.jms.JMSException

Specified by:

clearBodyInternal in class RMQMessage

Throws:

jakarta.jms.JMSException

writeBody

protected void writeBody(java.io.ObjectOutput out,
                         java.io.ByteArrayOutputStream bout)
                  throws java.io.IOException

Invoked when RMQMessage.toByteArray() is called to create a byte[] from a message. Each subclass must implement this, but ONLY write its specific body. All the properties defined in Message will be written by the parent class.

Specified by:

writeBody in class RMQMessage

Parameters:

out - - the output stream to which the structured part of message body (scalar types) is written

bout - - the output stream to which the un-structured part of message body (explicit bytes) is written

Throws:

java.io.IOException - if the body can not be written

readBody

protected void readBody(java.io.ObjectInput inputStream,
                        java.io.ByteArrayInputStream bin)
                 throws java.io.IOException,
                        java.lang.ClassNotFoundException

Invoked when a message is being deserialized to read and decode the message body. The implementing class should only read its body from this stream. If any exception is thrown, the message will not have been delivered.

Specified by:

readBody in class RMQMessage

Parameters:

inputStream - - the stream to read its body from

bin - - the underlying byte input stream

Throws:

java.io.IOException - if a read error occurs on the input stream

java.lang.ClassNotFoundException - if the object class cannot be found

readAmqpBody

protected void readAmqpBody(byte[] barr)

Description copied from class: RMQMessage

Invoked when an AMQP message is being transformed into a RMQMessage The implementing class should only read its body by this method

Specified by:

readAmqpBody in class RMQMessage

Parameters:

barr - - the byte array payload of the AMQP message

writeAmqpBody

protected void writeAmqpBody(java.io.ByteArrayOutputStream out)
                      throws java.io.IOException

Description copied from class: RMQMessage

Invoked when RMQMessage.toAmqpByteArray() is called to create a byte[] from a message. Each subclass must implement this, but ONLY write its specific body.

Specified by:

writeAmqpBody in class RMQMessage

Parameters:

out - - the output stream to which the message body is written

Throws:

java.io.IOException - if the body can not be written

recreate

public static final RMQMessage recreate(jakarta.jms.StreamMessage msg)
                                 throws jakarta.jms.JMSException

Throws:

jakarta.jms.JMSException

getBody

public <T> T getBody(java.lang.Class<T> c)
              throws jakarta.jms.JMSException

Specified by:

getBody in interface jakarta.jms.Message

Overrides:

getBody in class RMQMessage

Throws:

jakarta.jms.JMSException

doGetBody

protected <T> T doGetBody(java.lang.Class<T> c)

Specified by:

doGetBody in class RMQMessage

isBodyAssignableTo

public boolean isBodyAssignableTo(java.lang.Class c)

Specified by:

isBodyAssignableTo in interface jakarta.jms.Message

isAmqpWritable

public boolean isAmqpWritable()

Specified by:

isAmqpWritable in class RMQMessage