org.skyscreamer.nevado.jms.message
Class AbstractMessage<T>

java.lang.Object
  org.skyscreamer.nevado.jms.message.AbstractMessage<T>

All Implemented Interfaces:

Serializable, javax.jms.Message

Direct Known Subclasses:

NevadoMessage

public abstract class AbstractMessage<T>
extends Object
implements javax.jms.Message, Serializable

Generic non-Nevado-specific abstract message. Designed specific to the generic specification. Could theoretically be used for other implementations. This abstraction was created to breakout specification-specific logic from Nevado's provider-specific logic.

Author:

Carter Page

See Also:

NevadoMessage, Serialized Form

Field Summary

static String[]	RESERVED_PROPERTY_NAMES
static String	WHITESPACE_CHARS

Fields inherited from interface javax.jms.Message

DEFAULT_DELIVERY_MODE, DEFAULT_PRIORITY, DEFAULT_TIME_TO_LIVE

Constructor Summary

AbstractMessage()

Method Summary

abstract void	acknowledge()
protected void	checkReadOnlyBody()
protected void	checkWriteOnlyBody()
void	clearBody()
void	clearProperties()
T	copyOf()
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	getPropertyNames()
short	getShortProperty(String name)
String	getStringProperty(String name)
abstract void	internalClearBody()
protected void	internalSetObjectProperty(String name, Object value)
void	onSend()
boolean	propertyExists(String propertyName)
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	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 messageID)
void	setJMSPriority(int priority)
void	setJMSRedelivered(boolean redelivered)
void	setJMSReplyTo(javax.jms.Destination jmsReplyTo)
void	setJMSTimestamp(long timestamp)
void	setJMSType(String type)
void	setLongProperty(String name, long value)
void	setObjectProperty(String name, Object value)
void	setShortProperty(String name, short value)
void	setStringProperty(String name, String value)

Methods inherited from class java.lang.Object

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

Field Detail

WHITESPACE_CHARS

public static final String WHITESPACE_CHARS

See Also:

Constant Field Values

RESERVED_PROPERTY_NAMES

public static final String[] RESERVED_PROPERTY_NAMES

Constructor Detail

AbstractMessage

public AbstractMessage()

Method Detail

getJMSMessageID

public String getJMSMessageID()
                       throws javax.jms.JMSException

Specified by:

getJMSMessageID in interface javax.jms.Message

Throws:

javax.jms.JMSException

setJMSMessageID

public void setJMSMessageID(String messageID)
                     throws javax.jms.JMSException

Specified by:

setJMSMessageID in interface javax.jms.Message

Throws:

javax.jms.JMSException

getJMSTimestamp

public long getJMSTimestamp()
                     throws javax.jms.JMSException

Specified by:

getJMSTimestamp in interface javax.jms.Message

Throws:

javax.jms.JMSException

setJMSTimestamp

public void setJMSTimestamp(long timestamp)
                     throws javax.jms.JMSException

Specified by:

setJMSTimestamp in interface javax.jms.Message

Throws:

javax.jms.JMSException

getJMSCorrelationIDAsBytes

public byte[] getJMSCorrelationIDAsBytes()
                                  throws javax.jms.JMSException

Specified by:

getJMSCorrelationIDAsBytes in interface javax.jms.Message

Throws:

javax.jms.JMSException

setJMSCorrelationIDAsBytes

public void setJMSCorrelationIDAsBytes(byte[] correlationID)
                                throws javax.jms.JMSException

Specified by:

setJMSCorrelationIDAsBytes in interface javax.jms.Message

Throws:

javax.jms.JMSException

setJMSCorrelationID

public void setJMSCorrelationID(String correlationID)
                         throws javax.jms.JMSException

Specified by:

setJMSCorrelationID in interface javax.jms.Message

Throws:

javax.jms.JMSException

getJMSCorrelationID

public String getJMSCorrelationID()
                           throws javax.jms.JMSException

Specified by:

getJMSCorrelationID in interface javax.jms.Message

Throws:

javax.jms.JMSException

getJMSReplyTo

public javax.jms.Destination getJMSReplyTo()
                                    throws javax.jms.JMSException

Specified by:

getJMSReplyTo in interface javax.jms.Message

Throws:

javax.jms.JMSException

setJMSReplyTo

public void setJMSReplyTo(javax.jms.Destination jmsReplyTo)
                   throws javax.jms.JMSException

Specified by:

setJMSReplyTo in interface javax.jms.Message

Throws:

javax.jms.JMSException

getJMSDestination

public javax.jms.Destination getJMSDestination()
                                        throws javax.jms.JMSException

Specified by:

getJMSDestination in interface javax.jms.Message

Throws:

javax.jms.JMSException

setJMSDestination

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

Specified by:

setJMSDestination in interface javax.jms.Message

Throws:

javax.jms.JMSException

getJMSDeliveryMode

public int getJMSDeliveryMode()
                       throws javax.jms.JMSException

Specified by:

getJMSDeliveryMode in interface javax.jms.Message

Throws:

javax.jms.JMSException

setJMSDeliveryMode

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

Specified by:

setJMSDeliveryMode in interface javax.jms.Message

Throws:

javax.jms.JMSException

getJMSRedelivered

public boolean getJMSRedelivered()
                          throws javax.jms.JMSException

Specified by:

getJMSRedelivered in interface javax.jms.Message

Throws:

javax.jms.JMSException

setJMSRedelivered

public void setJMSRedelivered(boolean redelivered)
                       throws javax.jms.JMSException

Specified by:

setJMSRedelivered in interface javax.jms.Message

Throws:

javax.jms.JMSException

getJMSType

public String getJMSType()
                  throws javax.jms.JMSException

Specified by:

getJMSType in interface javax.jms.Message

Throws:

javax.jms.JMSException

setJMSType

public void setJMSType(String type)
                throws javax.jms.JMSException

Specified by:

setJMSType in interface javax.jms.Message

Throws:

javax.jms.JMSException

getJMSExpiration

public long getJMSExpiration()
                      throws javax.jms.JMSException

Specified by:

getJMSExpiration in interface javax.jms.Message

Throws:

javax.jms.JMSException

setJMSExpiration

public void setJMSExpiration(long expiration)
                      throws javax.jms.JMSException

Specified by:

setJMSExpiration in interface javax.jms.Message

Throws:

javax.jms.JMSException

getJMSPriority

public int getJMSPriority()
                   throws javax.jms.JMSException

Specified by:

getJMSPriority in interface javax.jms.Message

Throws:

javax.jms.JMSException

setJMSPriority

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

Specified by:

setJMSPriority in interface javax.jms.Message

Throws:

javax.jms.JMSException

clearProperties

public void clearProperties()
                     throws javax.jms.JMSException

Specified by:

clearProperties in interface javax.jms.Message

Throws:

javax.jms.JMSException

internalClearBody

public abstract void internalClearBody()
                                throws javax.jms.JMSException

Throws:

javax.jms.JMSException

clearBody

public void clearBody()
               throws javax.jms.JMSException

Specified by:

clearBody in interface javax.jms.Message

Throws:

javax.jms.JMSException

propertyExists

public boolean propertyExists(String propertyName)
                       throws javax.jms.JMSException

Specified by:

propertyExists in interface javax.jms.Message

Throws:

javax.jms.JMSException

getBooleanProperty

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

Specified by:

getBooleanProperty in interface javax.jms.Message

Throws:

javax.jms.JMSException

getByteProperty

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

Specified by:

getByteProperty in interface javax.jms.Message

Throws:

javax.jms.JMSException

getShortProperty

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

Specified by:

getShortProperty in interface javax.jms.Message

Throws:

javax.jms.JMSException

getIntProperty

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

Specified by:

getIntProperty in interface javax.jms.Message

Throws:

javax.jms.JMSException

getLongProperty

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

Specified by:

getLongProperty in interface javax.jms.Message

Throws:

javax.jms.JMSException

getFloatProperty

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

Specified by:

getFloatProperty in interface javax.jms.Message

Throws:

javax.jms.JMSException

getDoubleProperty

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

Specified by:

getDoubleProperty in interface javax.jms.Message

Throws:

javax.jms.JMSException

getStringProperty

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

Specified by:

getStringProperty in interface javax.jms.Message

Throws:

javax.jms.JMSException

getObjectProperty

public Object getObjectProperty(String name)
                         throws javax.jms.JMSException

Specified by:

getObjectProperty in interface javax.jms.Message

Throws:

javax.jms.JMSException

getPropertyNames

public Enumeration getPropertyNames()
                             throws javax.jms.JMSException

Specified by:

getPropertyNames in interface javax.jms.Message

Throws:

javax.jms.JMSException

setBooleanProperty

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

Specified by:

setBooleanProperty in interface javax.jms.Message

Throws:

javax.jms.JMSException

setByteProperty

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

Specified by:

setByteProperty in interface javax.jms.Message

Throws:

javax.jms.JMSException

setShortProperty

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

Specified by:

setShortProperty in interface javax.jms.Message

Throws:

javax.jms.JMSException

setIntProperty

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

Specified by:

setIntProperty in interface javax.jms.Message

Throws:

javax.jms.JMSException

setLongProperty

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

Specified by:

setLongProperty in interface javax.jms.Message

Throws:

javax.jms.JMSException

setFloatProperty

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

Specified by:

setFloatProperty in interface javax.jms.Message

Throws:

javax.jms.JMSException

setDoubleProperty

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

Specified by:

setDoubleProperty in interface javax.jms.Message

Throws:

javax.jms.JMSException

setStringProperty

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

Specified by:

setStringProperty in interface javax.jms.Message

Throws:

javax.jms.JMSException

setObjectProperty

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

Specified by:

setObjectProperty in interface javax.jms.Message

Throws:

javax.jms.JMSException

internalSetObjectProperty

protected void internalSetObjectProperty(String name,
                                         Object value)
                                  throws javax.jms.JMSException

Throws:

javax.jms.JMSException

acknowledge

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

Specified by:

acknowledge in interface javax.jms.Message

Throws:

javax.jms.JMSException

checkReadOnlyBody

protected void checkReadOnlyBody()
                          throws javax.jms.MessageNotWriteableException

Throws:

javax.jms.MessageNotWriteableException

checkWriteOnlyBody

protected void checkWriteOnlyBody()
                           throws javax.jms.MessageNotReadableException

Throws:

javax.jms.MessageNotReadableException

onSend

public void onSend()

copyOf

public T copyOf()
         throws javax.jms.JMSException

Throws:

javax.jms.JMSException