Package org.apache.qpid.jms.message

Class JmsStreamMessage

java.lang.Object

org.apache.qpid.jms.message.JmsMessage

org.apache.qpid.jms.message.JmsStreamMessage

All Implemented Interfaces:

jakarta.jms.Message, jakarta.jms.StreamMessage

public class JmsStreamMessage
extends JmsMessage
implements jakarta.jms.StreamMessage

JMS Stream message implementation.

Field Summary

Fields inherited from class org.apache.qpid.jms.message.JmsMessage

acknowledgeCallback, connection, readOnly, readOnlyBody, readOnlyProperties, validatePropertyNames

Fields inherited from interface jakarta.jms.Message

DEFAULT_DELIVERY_DELAY, DEFAULT_DELIVERY_MODE, DEFAULT_PRIORITY, DEFAULT_TIME_TO_LIVE

Constructor Summary

Constructors

Constructor	Description
JmsStreamMessage(JmsStreamMessageFacade facade)

Method Summary

Modifier and Type	Method	Description
void	clearBody()
JmsStreamMessage	copy()
boolean	isBodyAssignableTo(Class target)
void	onSend(long producerTtl)	Used to trigger processing required to place the message in a state where it is ready to be written to the wire.
boolean	readBoolean()
byte	readByte()
int	readBytes(byte[] target)
char	readChar()
double	readDouble()
float	readFloat()
int	readInt()
long	readLong()
Object	readObject()
short	readShort()
String	readString()
void	reset()
String	toString()
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(Object value)
void	writeShort(short value)
void	writeString(String value)

Methods inherited from class org.apache.qpid.jms.message.JmsMessage

acknowledge, checkReadOnly, checkReadOnlyBody, checkReadOnlyProperties, checkWriteOnlyBody, clearProperties, copy, doGetBody, equals, getAcknowledgeCallback, getAllPropertyNames, getBody, getBooleanProperty, getByteProperty, getConnection, getDoubleProperty, getFacade, getFloatProperty, getIntProperty, getJMSCorrelationID, getJMSCorrelationIDAsBytes, getJMSDeliveryMode, getJMSDeliveryTime, getJMSDestination, getJMSExpiration, getJMSMessageID, getJMSPriority, getJMSRedelivered, getJMSReplyTo, getJMSTimestamp, getJMSType, getLongProperty, getObjectProperty, getPropertyNames, getShortProperty, getStringProperty, hashCode, isExpired, isReadOnly, isReadOnlyBody, isReadOnlyProperties, isValidatePropertyNames, onDispatch, onSendComplete, propertyExists, setAcknowledgeCallback, setBooleanProperty, setByteProperty, setConnection, setDoubleProperty, setFloatProperty, setIntProperty, setJMSCorrelationID, setJMSCorrelationIDAsBytes, setJMSDeliveryMode, setJMSDeliveryTime, setJMSDestination, setJMSExpiration, setJMSMessageID, setJMSPriority, setJMSRedelivered, setJMSReplyTo, setJMSTimestamp, setJMSType, setLongProperty, setObjectProperty, setReadOnly, setReadOnlyBody, setReadOnlyProperties, setShortProperty, setStringProperty, setValidatePropertyNames

Methods inherited from class java.lang.Object

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

Methods inherited from interface jakarta.jms.Message

acknowledge, clearProperties, getBody, 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 Details

JmsStreamMessage

public JmsStreamMessage(JmsStreamMessageFacade facade)

Method Details

copy

public JmsStreamMessage copy()
                      throws jakarta.jms.JMSException

Overrides:

copy in class JmsMessage

Throws:

jakarta.jms.JMSException

onSend

public void onSend(long producerTtl)
            throws jakarta.jms.JMSException

Description copied from class: JmsMessage

Used to trigger processing required to place the message in a state where it is ready to be written to the wire. This processing can include such tasks as ensuring that the proper message headers are set or compressing message bodies etc. During this call the message is placed in a read-only mode and will not be returned to a writable state until send completion is triggered.

Overrides:

onSend in class JmsMessage

Parameters:

producerTtl - the time to live value that the producer was configured with at send time.

Throws:

jakarta.jms.JMSException - if an error occurs while preparing the message for send.

clearBody

public void clearBody()
               throws jakarta.jms.JMSException

Specified by:

clearBody in interface jakarta.jms.Message

Overrides:

clearBody in class JmsMessage

Throws:

jakarta.jms.JMSException

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 String readString()
                  throws jakarta.jms.JMSException

Specified by:

readString in interface jakarta.jms.StreamMessage

Throws:

jakarta.jms.JMSException

readBytes

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

Specified by:

readBytes in interface jakarta.jms.StreamMessage

Throws:

jakarta.jms.JMSException

readObject

public Object readObject()
                  throws jakarta.jms.JMSException

Specified by:

readObject in interface jakarta.jms.StreamMessage

Throws:

jakarta.jms.JMSException

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(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(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

toString

public String toString()

Overrides:

toString in class JmsMessage

isBodyAssignableTo

public boolean isBodyAssignableTo(Class target)
                           throws jakarta.jms.JMSException

Specified by:

isBodyAssignableTo in interface jakarta.jms.Message

Overrides:

isBodyAssignableTo in class JmsMessage

Throws:

jakarta.jms.JMSException