net.timewalker.ffmq4.common.message

Class AbstractMessage

java.lang.Object

net.timewalker.ffmq4.common.message.AbstractMessage

All Implemented Interfaces:

javax.jms.Message

Direct Known Subclasses:

BytesMessageImpl, EmptyMessageImpl, MapMessageImpl, ObjectMessageImpl, StreamMessageImpl, TextMessageImpl

public abstract class AbstractMessage
extends Object
implements javax.jms.Message

Base implementation for a JMS message

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	bodyIsReadOnly

Fields inherited from interface javax.jms.Message

DEFAULT_DELIVERY_MODE, DEFAULT_PRIORITY, DEFAULT_TIME_TO_LIVE

Constructor Summary

Constructors

Constructor and Description
AbstractMessage() Constructor

Method Summary

Modifier and Type	Method and Description
void	acknowledge()
protected void	assertDeserializationLevel(int targetLevel)
void	clearProperties()
abstract AbstractMessage	copy() Create an independant copy of this message
protected void	copyCommonFields(AbstractMessage clone) Create an independant copy of this message
void	ensureDeserializationLevel(int targetLevel)
boolean	getBooleanProperty(String name)
byte	getByteProperty(String name)
double	getDoubleProperty(String name)
float	getFloatProperty(String name)
int	getIntProperty(String name)
String	getJMSCorrelationID()
byte[]	getJMSCorrelationIDAsBytes()
int	getJMSDeliveryMode()
javax.jms.Destination	getJMSDestination()
long	getJMSExpiration()
String	getJMSMessageID()
int	getJMSPriority()
boolean	getJMSRedelivered()
javax.jms.Destination	getJMSReplyTo()
long	getJMSTimestamp()
String	getJMSType()
long	getLongProperty(String name)
Object	getObjectProperty(String name)
Enumeration<String>	getPropertyNames()
RawDataBuffer	getRawMessage() Get the raw message form if available
protected AbstractSession	getSession() Get the parent session
short	getShortProperty(String name)
String	getStringProperty(String name)
protected abstract byte	getType() Get the type value for this message
protected void	initializeFromRaw(RawDataBuffer rawMessage) Initialize the message from the given raw data
boolean	isInternalCopy() Test if this message is an internal copy
void	markAsReadOnly()
boolean	propertyExists(String name)
protected Map<String,Object>	readMapFrom(RawDataBuffer in) Write a map to the given output stream
protected abstract void	serializeBodyTo(RawDataBuffer out)
protected void	serializeTo(RawDataBuffer out) Write the message content to the given output stream
void	setBooleanProperty(String name, boolean value)
void	setByteProperty(String name, byte value)
void	setDoubleProperty(String name, double value)
void	setFloatProperty(String name, float value)
void	setInternalCopy(boolean copy) Set if this message is an internal copy
void	setIntProperty(String name, int value)
void	setJMSCorrelationID(String correlationID)
void	setJMSCorrelationIDAsBytes(byte[] correlationID)
void	setJMSDeliveryMode(int deliveryMode)
void	setJMSDestination(javax.jms.Destination destination)
void	setJMSExpiration(long expiration)
void	setJMSMessageID(String id)
void	setJMSPriority(int priority)
void	setJMSRedelivered(boolean redelivered)
void	setJMSReplyTo(javax.jms.Destination replyTo)
void	setJMSTimestamp(long timestamp)
void	setJMSType(String type)
void	setLongProperty(String name, long value)
void	setObjectProperty(String name, Object value)
void	setSession(AbstractSession session) Set the message session
void	setShortProperty(String name, short value)
void	setStringProperty(String name, String value)
String	toString()
protected abstract void	unserializeBodyFrom(RawDataBuffer in)
protected void	writeMapTo(Map<String,Object> map, RawDataBuffer out) Write a map to the given output stream

Methods inherited from class java.lang.Object

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

Methods inherited from interface javax.jms.Message

clearBody

Field Detail

bodyIsReadOnly

protected boolean bodyIsReadOnly

Constructor Detail

AbstractMessage

public AbstractMessage()

Constructor

Method Detail

getRawMessage

public final RawDataBuffer getRawMessage()

Get the raw message form if available

Returns:

the raw message form if available

copy

public abstract AbstractMessage copy()

Create an independant copy of this message

copyCommonFields

protected final void copyCommonFields(AbstractMessage clone)

Create an independant copy of this message

setSession

public final void setSession(AbstractSession session)
                      throws javax.jms.JMSException

Set the message session

Throws:

javax.jms.JMSException

getSession

protected final AbstractSession getSession()
                                    throws javax.jms.JMSException

Get the parent session

Throws:

javax.jms.JMSException

acknowledge

public final void acknowledge()
                       throws javax.jms.JMSException

Specified by:

acknowledge in interface javax.jms.Message

Throws:

javax.jms.JMSException

clearProperties

public final void clearProperties()

Specified by:

clearProperties in interface javax.jms.Message

getBooleanProperty

public final boolean getBooleanProperty(String name)
                                 throws javax.jms.JMSException

Specified by:

getBooleanProperty in interface javax.jms.Message

Throws:

javax.jms.JMSException

getByteProperty

public final byte getByteProperty(String name)
                           throws javax.jms.JMSException

Specified by:

getByteProperty in interface javax.jms.Message

Throws:

javax.jms.JMSException

getDoubleProperty

public final double getDoubleProperty(String name)
                               throws javax.jms.JMSException

Specified by:

getDoubleProperty in interface javax.jms.Message

Throws:

javax.jms.JMSException

getFloatProperty

public final float getFloatProperty(String name)
                             throws javax.jms.JMSException

Specified by:

getFloatProperty in interface javax.jms.Message

Throws:

javax.jms.JMSException

getIntProperty

public final int getIntProperty(String name)
                         throws javax.jms.JMSException

Specified by:

getIntProperty in interface javax.jms.Message

Throws:

javax.jms.JMSException

getJMSCorrelationID

public final String getJMSCorrelationID()

Specified by:

getJMSCorrelationID in interface javax.jms.Message

getJMSCorrelationIDAsBytes

public final byte[] getJMSCorrelationIDAsBytes()

Specified by:

getJMSCorrelationIDAsBytes in interface javax.jms.Message

getJMSDeliveryMode

public final int getJMSDeliveryMode()

Specified by:

getJMSDeliveryMode in interface javax.jms.Message

getJMSDestination

public final javax.jms.Destination getJMSDestination()

Specified by:

getJMSDestination in interface javax.jms.Message

getJMSExpiration

public final long getJMSExpiration()

Specified by:

getJMSExpiration in interface javax.jms.Message

getJMSMessageID

public final String getJMSMessageID()

Specified by:

getJMSMessageID in interface javax.jms.Message

getJMSPriority

public final int getJMSPriority()

Specified by:

getJMSPriority in interface javax.jms.Message

getJMSRedelivered

public final boolean getJMSRedelivered()

Specified by:

getJMSRedelivered in interface javax.jms.Message

getJMSReplyTo

public final javax.jms.Destination getJMSReplyTo()

Specified by:

getJMSReplyTo in interface javax.jms.Message

getJMSTimestamp

public final long getJMSTimestamp()

Specified by:

getJMSTimestamp in interface javax.jms.Message

getJMSType

public final String getJMSType()

Specified by:

getJMSType in interface javax.jms.Message

getLongProperty

public final long getLongProperty(String name)
                           throws javax.jms.JMSException

Specified by:

getLongProperty in interface javax.jms.Message

Throws:

javax.jms.JMSException

getObjectProperty

public final Object getObjectProperty(String name)

Specified by:

getObjectProperty in interface javax.jms.Message

getShortProperty

public final short getShortProperty(String name)
                             throws javax.jms.JMSException

Specified by:

getShortProperty in interface javax.jms.Message

Throws:

javax.jms.JMSException

getStringProperty

public final String getStringProperty(String name)
                               throws javax.jms.JMSException

Specified by:

getStringProperty in interface javax.jms.Message

Throws:

javax.jms.JMSException

propertyExists

public final boolean propertyExists(String name)

Specified by:

propertyExists in interface javax.jms.Message

setBooleanProperty

public final void setBooleanProperty(String name,
                                     boolean value)
                              throws javax.jms.JMSException

Specified by:

setBooleanProperty in interface javax.jms.Message

Throws:

javax.jms.JMSException

setByteProperty

public final void setByteProperty(String name,
                                  byte value)
                           throws javax.jms.JMSException

Specified by:

setByteProperty in interface javax.jms.Message

Throws:

javax.jms.JMSException

setDoubleProperty

public final void setDoubleProperty(String name,
                                    double value)
                             throws javax.jms.JMSException

Specified by:

setDoubleProperty in interface javax.jms.Message

Throws:

javax.jms.JMSException

setFloatProperty

public final void setFloatProperty(String name,
                                   float value)
                            throws javax.jms.JMSException

Specified by:

setFloatProperty in interface javax.jms.Message

Throws:

javax.jms.JMSException

setIntProperty

public final void setIntProperty(String name,
                                 int value)
                          throws javax.jms.JMSException

Specified by:

setIntProperty in interface javax.jms.Message

Throws:

javax.jms.JMSException

setJMSCorrelationID

public final void setJMSCorrelationID(String correlationID)

Specified by:

setJMSCorrelationID in interface javax.jms.Message

setJMSCorrelationIDAsBytes

public final void setJMSCorrelationIDAsBytes(byte[] correlationID)

Specified by:

setJMSCorrelationIDAsBytes in interface javax.jms.Message

setJMSDeliveryMode

public final void setJMSDeliveryMode(int deliveryMode)
                              throws javax.jms.JMSException

Specified by:

setJMSDeliveryMode in interface javax.jms.Message

Throws:

javax.jms.JMSException

setJMSDestination

public final void setJMSDestination(javax.jms.Destination destination)
                             throws javax.jms.JMSException

Specified by:

setJMSDestination in interface javax.jms.Message

Throws:

javax.jms.JMSException

setJMSExpiration

public final void setJMSExpiration(long expiration)

Specified by:

setJMSExpiration in interface javax.jms.Message

setJMSMessageID

public final void setJMSMessageID(String id)
                           throws javax.jms.JMSException

Specified by:

setJMSMessageID in interface javax.jms.Message

Throws:

javax.jms.JMSException

setJMSPriority

public final void setJMSPriority(int priority)
                          throws javax.jms.JMSException

Specified by:

setJMSPriority in interface javax.jms.Message

Throws:

javax.jms.JMSException

setJMSRedelivered

public final void setJMSRedelivered(boolean redelivered)

Specified by:

setJMSRedelivered in interface javax.jms.Message

setJMSReplyTo

public final void setJMSReplyTo(javax.jms.Destination replyTo)

Specified by:

setJMSReplyTo in interface javax.jms.Message

setJMSTimestamp

public final void setJMSTimestamp(long timestamp)

Specified by:

setJMSTimestamp in interface javax.jms.Message

setJMSType

public final void setJMSType(String type)

Specified by:

setJMSType in interface javax.jms.Message

setLongProperty

public final void setLongProperty(String name,
                                  long value)
                           throws javax.jms.JMSException

Specified by:

setLongProperty in interface javax.jms.Message

Throws:

javax.jms.JMSException

setObjectProperty

public final void setObjectProperty(String name,
                                    Object value)
                             throws javax.jms.JMSException

Specified by:

setObjectProperty in interface javax.jms.Message

Throws:

javax.jms.JMSException

setShortProperty

public final void setShortProperty(String name,
                                   short value)
                            throws javax.jms.JMSException

Specified by:

setShortProperty in interface javax.jms.Message

Throws:

javax.jms.JMSException

setStringProperty

public final void setStringProperty(String name,
                                    String value)
                             throws javax.jms.JMSException

Specified by:

setStringProperty in interface javax.jms.Message

Throws:

javax.jms.JMSException

getPropertyNames

public final Enumeration<String> getPropertyNames()

Specified by:

getPropertyNames in interface javax.jms.Message

isInternalCopy

public final boolean isInternalCopy()

Test if this message is an internal copy

setInternalCopy

public final void setInternalCopy(boolean copy)

Set if this message is an internal copy

getType

protected abstract byte getType()

Get the type value for this message

serializeTo

protected final void serializeTo(RawDataBuffer out)

Write the message content to the given output stream

initializeFromRaw

protected final void initializeFromRaw(RawDataBuffer rawMessage)

Initialize the message from the given raw data

ensureDeserializationLevel

public final void ensureDeserializationLevel(int targetLevel)

assertDeserializationLevel

protected final void assertDeserializationLevel(int targetLevel)

markAsReadOnly

public final void markAsReadOnly()

serializeBodyTo

protected abstract void serializeBodyTo(RawDataBuffer out)

unserializeBodyFrom

protected abstract void unserializeBodyFrom(RawDataBuffer in)

writeMapTo

protected final void writeMapTo(Map<String,Object> map,
                                RawDataBuffer out)

Write a map to the given output stream

readMapFrom

protected final Map<String,Object> readMapFrom(RawDataBuffer in)

Write a map to the given output stream

toString

public String toString()

Overrides:

toString in class Object