org.jboss.mq
Class SpyMessage

java.lang.Object
  org.jboss.mq.SpyMessage

All Implemented Interfaces:

java.lang.Cloneable, java.lang.Comparable, java.io.Externalizable, Message (src) , java.io.Serializable

Direct Known Subclasses:

SpyBytesMessage (src) , SpyMapMessage (src) , SpyObjectMessage (src) , SpyStreamMessage (src) , SpyTextMessage (src)

public class SpyMessage

extends java.lang.Object

implements java.io.Serializable, Message (src) , java.lang.Comparable, java.lang.Cloneable, java.io.Externalizable

This class implements javax.jms.Message

See Also:

Serialized Form

PROPERTY_SCHEDULED_DELIVERY

public static final java.lang.String PROPERTY_SCHEDULED_DELIVERY

JBoss-vendor specific property for scheduling a JMS message. In milliseconds since January 1, 1970.

See Also:

Constant Field Values (src)

PROPERTY_REDELIVERY_DELAY

public static final java.lang.String PROPERTY_REDELIVERY_DELAY

JBoss-vendor specific property specifying redelivery delay of a message. The message will be rescheduled for delivery from the time at which it was unacknowledged, plus the given period.

See Also:

Constant Field Values (src)

PROPERTY_REDELIVERY_COUNT

public static final java.lang.String PROPERTY_REDELIVERY_COUNT

JBoss-vendor specific property for getting the count of redelivery attempts of a message.

See Also:

Constant Field Values (src)

PROPERTY_REDELIVERY_LIMIT

public static final java.lang.String PROPERTY_REDELIVERY_LIMIT

JBoss-vendor specific property specifying the limit of redelivery attempts of a message. The message will be redelivered a given number of times. If not set, the container default is used.

See Also:

Constant Field Values (src)

OBJECT_MESS

protected static final byte OBJECT_MESS

An object message

See Also:

Constant Field Values (src)

BYTES_MESS

protected static final byte BYTES_MESS

An bytes message

See Also:

Constant Field Values (src)

MAP_MESS

protected static final byte MAP_MESS

A map message

See Also:

Constant Field Values (src)

TEXT_MESS

protected static final byte TEXT_MESS

A text message

See Also:

Constant Field Values (src)

STREAM_MESS

protected static final byte STREAM_MESS

A stream message

See Also:

Constant Field Values (src)

ENCAP_MESS

protected static final byte ENCAP_MESS

An encapsulated message

See Also:

Constant Field Values (src)

SPY_MESS

protected static final byte SPY_MESS

A plain message

See Also:

Constant Field Values (src)

BYTE

protected static final int BYTE

A byte property

See Also:

Constant Field Values (src)

SHORT

protected static final int SHORT

A short property

See Also:

Constant Field Values (src)

INT

protected static final int INT

An integer property

See Also:

Constant Field Values (src)

LONG

protected static final int LONG

A long property

See Also:

Constant Field Values (src)

FLOAT

protected static final int FLOAT

A float property

See Also:

Constant Field Values (src)

DOUBLE

protected static final int DOUBLE

A double property

See Also:

Constant Field Values (src)

BOOLEAN

protected static final int BOOLEAN

A boolean property

See Also:

Constant Field Values (src)

STRING

protected static final int STRING

A string property

See Also:

Constant Field Values (src)

OBJECT

protected static final int OBJECT

An object property

See Also:

Constant Field Values (src)

NULL

protected static final int NULL

A null property

See Also:

Constant Field Values (src)

header

public SpyMessage.Header (src)  header

The message header

ack

public transient AcknowledgementRequest (src)  ack

The acknowledgement request for this message

session

public transient SpySession (src)  session

The session for this message

SpyMessage

public SpyMessage()

writeMessage

public static void writeMessage(SpyMessage (src)  message,
                                java.io.ObjectOutput out)
                         throws java.io.IOException

Write a message

Parameters:

message - the message

out - the output

Throws:

java.io.IOException - for any error

readMessage

public static SpyMessage (src)  readMessage(java.io.ObjectInput in)
                              throws java.io.IOException

Read a message

Parameters:

in - the input

Returns:

the message

Throws:

java.io.IOException - for any error

clearBody

public void clearBody()
               throws JMSException (src) 

Clear the message body

Specified by:

clearBody in interface Message (src)

Throws:

JMSException (src) - for any error

acknowledge

public void acknowledge()
                 throws JMSException (src) 

Acknowledge a message

Specified by:

acknowledge in interface Message (src)

Throws:

JMSException (src) - for any error

See Also:

Session.CLIENT_ACKNOWLEDGE

setReadOnlyMode

public void setReadOnlyMode()

Set the message to read only

myClone

public SpyMessage (src)  myClone()
                   throws JMSException (src) 

Clone the message

Returns:

the cloned message

Throws:

JMSException (src) - for any error

copyProps

public void copyProps(SpyMessage (src)  original)
               throws JMSException (src) 

Copy the properties

Parameters:

original - the message with original properties

Throws:

JMSException (src) - for any error

isOutdated

public boolean isOutdated()

Test whether a message has expired

Returns:

true when expired false otherwise

doAcknowledge

public void doAcknowledge()
                   throws JMSException (src) 

Actually acknowledge a message

Throws:

JMSException (src) - for any error

doNegAcknowledge

public void doNegAcknowledge()
                      throws JMSException (src) 

Actually nack a message

Throws:

JMSException (src) - for any error

createAcknowledgementRequest

public void createAcknowledgementRequest(int subscriptionId)

Create an acknowledgement request for the message

getAcknowledgementRequest

public AcknowledgementRequest (src)  getAcknowledgementRequest(boolean isAck)
                                                 throws JMSException (src) 

Get an acknowledgement request for the message

Parameters:

isAck - true for an ack, false for a nack

Throws:

JMSException (src) - for any error

compareTo

public int compareTo(java.lang.Object o)

Specified by:

compareTo in interface java.lang.Comparable

getJMSMessageID

public java.lang.String getJMSMessageID()

Description copied from interface: Message (src)

Gets the message ID.

The JMSMessageID header field contains a value that uniquely identifies each message sent by a provider.

When a message is sent, JMSMessageID can be ignored. When the send or publish method returns, it contains a provider-assigned value.

A JMSMessageID is a String value that should function as a unique key for identifying messages in a historical repository. The exact scope of uniqueness is provider-defined. It should at least cover all messages for a specific installation of a provider, where an installation is some connected set of message routers.

All JMSMessageID values must start with the prefix 'ID:'. Uniqueness of message ID values across different providers is not required.

Since message IDs take some effort to create and increase a message's size, some JMS providers may be able to optimize message overhead if they are given a hint that the message ID is not used by an application. By calling the MessageProducer.setDisableMessageID method, a JMS client enables this potential optimization for all messages sent by that message producer. If the JMS provider accepts this hint, these messages must have the message ID set to null; if the provider ignores the hint, the message ID must be set to its normal unique value.

Specified by:

getJMSMessageID in interface Message (src)

Returns:

the message ID

See Also:

Message.setJMSMessageID(String), MessageProducer.setDisableMessageID(boolean)

setJMSMessageID

public void setJMSMessageID(java.lang.String id)
                     throws JMSException (src) 

Description copied from interface: Message (src)

Sets the message ID.

JMS providers set this field when a message is sent. This method can be used to change the value for a message that has been received.

Specified by:

setJMSMessageID in interface Message (src)

Parameters:

id - the ID of the message

Throws:

JMSException (src) - if the JMS provider fails to set the message ID due to some internal error.

See Also:

Message.getJMSMessageID()

getJMSTimestamp

public long getJMSTimestamp()

Description copied from interface: Message (src)

Gets the message timestamp.

The JMSTimestamp header field contains the time a message was handed off to a provider to be sent. It is not the time the message was actually transmitted, because the actual send may occur later due to transactions or other client-side queueing of messages.

When a message is sent, JMSTimestamp is ignored. When the send or publish method returns, it contains a time value somewhere in the interval between the call and the return. The value is in the format of a normal millis time value in the Java programming language.

Since timestamps take some effort to create and increase a message's size, some JMS providers may be able to optimize message overhead if they are given a hint that the timestamp is not used by an application. By calling the MessageProducer.setDisableMessageTimestamp method, a JMS client enables this potential optimization for all messages sent by that message producer. If the JMS provider accepts this hint, these messages must have the timestamp set to zero; if the provider ignores the hint, the timestamp must be set to its normal value.

Specified by:

getJMSTimestamp in interface Message (src)

Returns:

the message timestamp

See Also:

Message.setJMSTimestamp(long), MessageProducer.setDisableMessageTimestamp(boolean)

setJMSTimestamp

public void setJMSTimestamp(long timestamp)
                     throws JMSException (src) 

Description copied from interface: Message (src)

Sets the message timestamp.

JMS providers set this field when a message is sent. This method can be used to change the value for a message that has been received.

Specified by:

setJMSTimestamp in interface Message (src)

Parameters:

timestamp - the timestamp for this message

Throws:

JMSException (src) - if the JMS provider fails to set the timestamp due to some internal error.

See Also:

Message.getJMSTimestamp()

getJMSCorrelationIDAsBytes

public byte[] getJMSCorrelationIDAsBytes()
                                  throws JMSException (src) 

Description copied from interface: Message (src)

Gets the correlation ID as an array of bytes for the message.

The use of a byte[] value for JMSCorrelationID is non-portable.

Specified by:

getJMSCorrelationIDAsBytes in interface Message (src)

Returns:

the correlation ID of a message as an array of bytes

Throws:

JMSException (src) - if the JMS provider fails to get the correlation ID due to some internal error.

See Also:

Message.setJMSCorrelationID(String), Message.getJMSCorrelationID(), Message.setJMSCorrelationIDAsBytes(byte[])

setJMSCorrelationIDAsBytes

public void setJMSCorrelationIDAsBytes(byte[] correlationID)
                                throws JMSException (src) 

Description copied from interface: Message (src)

Sets the correlation ID as an array of bytes for the message.

The array is copied before the method returns, so future modifications to the array will not alter this message header.

If a provider supports the native concept of correlation ID, a JMS client may need to assign specific JMSCorrelationID values to match those expected by native messaging clients. JMS providers without native correlation ID values are not required to support this method and its corresponding get method; their implementation may throw a java.lang.UnsupportedOperationException.

The use of a byte[] value for JMSCorrelationID is non-portable.

Specified by:

setJMSCorrelationIDAsBytes in interface Message (src)

Parameters:

correlationID - the correlation ID value as an array of bytes

Throws:

JMSException (src) - if the JMS provider fails to set the correlation ID due to some internal error.

See Also:

Message.setJMSCorrelationID(String), Message.getJMSCorrelationID(), Message.getJMSCorrelationIDAsBytes()

setJMSCorrelationID

public void setJMSCorrelationID(java.lang.String correlationID)
                         throws JMSException (src) 

Description copied from interface: Message (src)

Sets the correlation ID for the message.

A client can use the JMSCorrelationID header field to link one message with another. A typical use is to link a response message with its request message.

JMSCorrelationID can hold one of the following:

• A provider-specific message ID
• An application-specific String
• A provider-native byte[] value

Since each message sent by a JMS provider is assigned a message ID value, it is convenient to link messages via message ID. All message ID values must start with the 'ID:' prefix.

In some cases, an application (made up of several clients) needs to use an application-specific value for linking messages. For instance, an application may use JMSCorrelationID to hold a value referencing some external information. Application-specified values must not start with the 'ID:' prefix; this is reserved for provider-generated message ID values.

If a provider supports the native concept of correlation ID, a JMS client may need to assign specific JMSCorrelationID values to match those expected by clients that do not use the JMS API. A byte[] value is used for this purpose. JMS providers without native correlation ID values are not required to support byte[] values. The use of a byte[] value for JMSCorrelationID is non-portable.

Specified by:

setJMSCorrelationID in interface Message (src)

Parameters:

correlationID - the message ID of a message being referred to

Throws:

JMSException (src) - if the JMS provider fails to set the correlation ID due to some internal error.

See Also:

Message.getJMSCorrelationID(), Message.getJMSCorrelationIDAsBytes(), Message.setJMSCorrelationIDAsBytes(byte[])

getJMSCorrelationID

public java.lang.String getJMSCorrelationID()
                                     throws JMSException (src) 

Description copied from interface: Message (src)

Gets the correlation ID for the message.

This method is used to return correlation ID values that are either provider-specific message IDs or application-specific String values.

Specified by:

getJMSCorrelationID in interface Message (src)

Returns:

the correlation ID of a message as a String

Throws:

JMSException (src) - if the JMS provider fails to get the correlation ID due to some internal error.

See Also:

Message.setJMSCorrelationID(String), Message.getJMSCorrelationIDAsBytes(), Message.setJMSCorrelationIDAsBytes(byte[])

getJMSReplyTo

public Destination (src)  getJMSReplyTo()

Description copied from interface: Message (src)

Gets the Destination object to which a reply to this message should be sent.

Specified by:

getJMSReplyTo in interface Message (src)

Returns:

Destination to which to send a response to this message

See Also:

Message.setJMSReplyTo(Destination)

setJMSReplyTo

public void setJMSReplyTo(Destination (src)  replyTo)
                   throws JMSException (src) 

Description copied from interface: Message (src)

Sets the Destination object to which a reply to this message should be sent.

The JMSReplyTo header field contains the destination where a reply to the current message should be sent. If it is null, no reply is expected. The destination may be either a Queue object or a Topic object.

Messages sent with a null JMSReplyTo value may be a notification of some event, or they may just be some data the sender thinks is of interest.

Messages with a JMSReplyTo value typically expect a response. A response is optional; it is up to the client to decide. These messages are called requests. A message sent in response to a request is called a reply.

In some cases a client may wish to match a request it sent earlier with a reply it has just received. The client can use the JMSCorrelationID header field for this purpose.

Specified by:

setJMSReplyTo in interface Message (src)

Parameters:

replyTo - Destination to which to send a response to this message

Throws:

JMSException (src) - if the JMS provider fails to set the JMSReplyTo destination due to some internal error.

See Also:

Message.getJMSReplyTo()

getJMSDestination

public Destination (src)  getJMSDestination()

Description copied from interface: Message (src)

Gets the Destination object for this message.

The JMSDestination header field contains the destination to which the message is being sent.

When a message is sent, this field is ignored. After completion of the send or publish method, the field holds the destination specified by the method.

When a message is received, its JMSDestination value must be equivalent to the value assigned when it was sent.

Specified by:

getJMSDestination in interface Message (src)

Returns:

the destination of this message

See Also:

Message.setJMSDestination(Destination)

setJMSDestination

public void setJMSDestination(Destination (src)  destination)
                       throws JMSException (src) 

Description copied from interface: Message (src)

Sets the Destination object for this message.

JMS providers set this field when a message is sent. This method can be used to change the value for a message that has been received.

Specified by:

setJMSDestination in interface Message (src)

Parameters:

destination - the destination for this message

Throws:

JMSException (src) - if the JMS provider fails to set the destination due to some internal error.

See Also:

Message.getJMSDestination()

getJMSDeliveryMode

public int getJMSDeliveryMode()

Description copied from interface: Message (src)

Gets the DeliveryMode value specified for this message.

Specified by:

getJMSDeliveryMode in interface Message (src)

Returns:

the delivery mode for this message

See Also:

Message.setJMSDeliveryMode(int), DeliveryMode (src)

setJMSDeliveryMode

public void setJMSDeliveryMode(int deliveryMode)
                        throws JMSException (src) 

Description copied from interface: Message (src)

Sets the DeliveryMode value for this message.

JMS providers set this field when a message is sent. This method can be used to change the value for a message that has been received.

Specified by:

setJMSDeliveryMode in interface Message (src)

Parameters:

deliveryMode - the delivery mode for this message

Throws:

JMSException (src) - if the JMS provider fails to set the delivery mode due to some internal error.

See Also:

Message.getJMSDeliveryMode(), DeliveryMode (src)

getJMSRedelivered

public boolean getJMSRedelivered()

Description copied from interface: Message (src)

Gets an indication of whether this message is being redelivered.

If a client receives a message with the JMSRedelivered field set, it is likely, but not guaranteed, that this message was delivered earlier but that its receipt was not acknowledged at that time.

Specified by:

getJMSRedelivered in interface Message (src)

Returns:

true if this message is being redelivered

See Also:

Message.setJMSRedelivered(boolean)

setJMSRedelivered

public void setJMSRedelivered(boolean redelivered)
                       throws JMSException (src) 

Description copied from interface: Message (src)

Specifies whether this message is being redelivered.

This field is set at the time the message is delivered. This method can be used to change the value for a message that has been received.

Specified by:

setJMSRedelivered in interface Message (src)

Parameters:

redelivered - an indication of whether this message is being redelivered

Throws:

JMSException (src) - if the JMS provider fails to set the redelivered state due to some internal error.

See Also:

Message.getJMSRedelivered()

getJMSType

public java.lang.String getJMSType()

Description copied from interface: Message (src)

Gets the message type identifier supplied by the client when the message was sent.

Specified by:

getJMSType in interface Message (src)

Returns:

the message type

See Also:

Message.setJMSType(String)

setJMSType

public void setJMSType(java.lang.String type)
                throws JMSException (src) 

Description copied from interface: Message (src)

Sets the message type.

Some JMS providers use a message repository that contains the definitions of messages sent by applications. The JMSType header field may reference a message's definition in the provider's repository.

The JMS API does not define a standard message definition repository, nor does it define a naming policy for the definitions it contains.

Some messaging systems require that a message type definition for each application message be created and that each message specify its type. In order to work with such JMS providers, JMS clients should assign a value to JMSType, whether the application makes use of it or not. This ensures that the field is properly set for those providers that require it.

To ensure portability, JMS clients should use symbolic values for JMSType that can be configured at installation time to the values defined in the current provider's message repository. If string literals are used, they may not be valid type names for some JMS providers.

Specified by:

setJMSType in interface Message (src)

Parameters:

type - the message type

Throws:

JMSException (src) - if the JMS provider fails to set the message type due to some internal error.

See Also:

Message.getJMSType()

getJMSExpiration

public long getJMSExpiration()

Description copied from interface: Message (src)

Gets the message's expiration value.

When a message is sent, the JMSExpiration header field is left unassigned. After completion of the send or publish method, it holds the expiration time of the message. This is the sum of the time-to-live value specified by the client and the GMT at the time of the send or publish.

If the time-to-live is specified as zero, JMSExpiration is set to zero to indicate that the message does not expire.

When a message's expiration time is reached, a provider should discard it. The JMS API does not define any form of notification of message expiration.

Clients should not receive messages that have expired; however, the JMS API does not guarantee that this will not happen.

Specified by:

getJMSExpiration in interface Message (src)

Returns:

the time the message expires, which is the sum of the time-to-live value specified by the client and the GMT at the time of the send

See Also:

Message.setJMSExpiration(long)

setJMSExpiration

public void setJMSExpiration(long expiration)
                      throws JMSException (src) 

Description copied from interface: Message (src)

Sets the message's expiration value.

JMS providers set this field when a message is sent. This method can be used to change the value for a message that has been received.

Specified by:

setJMSExpiration in interface Message (src)

Parameters:

expiration - the message's expiration time

Throws:

JMSException (src) - if the JMS provider fails to set the message expiration due to some internal error.

See Also:

Message.getJMSExpiration()

getJMSPriority

public int getJMSPriority()

Description copied from interface: Message (src)

Gets the message priority level.

The JMS API defines ten levels of priority value, with 0 as the lowest priority and 9 as the highest. In addition, clients should consider priorities 0-4 as gradations of normal priority and priorities 5-9 as gradations of expedited priority.

The JMS API does not require that a provider strictly implement priority ordering of messages; however, it should do its best to deliver expedited messages ahead of normal messages.

Specified by:

getJMSPriority in interface Message (src)

Returns:

the default message priority

See Also:

Message.setJMSPriority(int)

setJMSPriority

public void setJMSPriority(int priority)
                    throws JMSException (src) 

Description copied from interface: Message (src)

Sets the priority level for this message.

JMS providers set this field when a message is sent. This method can be used to change the value for a message that has been received.

Specified by:

setJMSPriority in interface Message (src)

Parameters:

priority - the priority of this message

Throws:

JMSException (src) - if the JMS provider fails to set the message priority due to some internal error.

See Also:

Message.getJMSPriority()

clearProperties

public void clearProperties()
                     throws JMSException (src) 

Description copied from interface: Message (src)

Clears a message's properties.

The message's header fields and body are not cleared.

Specified by:

clearProperties in interface Message (src)

Throws:

JMSException (src) - if the JMS provider fails to clear the message properties due to some internal error.

propertyExists

public boolean propertyExists(java.lang.String name)
                       throws JMSException (src) 

Description copied from interface: Message (src)

Indicates whether a property value exists.

Specified by:

propertyExists in interface Message (src)

Parameters:

name - the name of the property to test

Returns:

true if the property exists

Throws:

JMSException (src) - if the JMS provider fails to determine if the property exists due to some internal error.

getBooleanProperty

public boolean getBooleanProperty(java.lang.String name)
                           throws JMSException (src) 

Description copied from interface: Message (src)

Returns the value of the boolean property with the specified name.

Specified by:

getBooleanProperty in interface Message (src)

Parameters:

name - the name of the boolean property

Returns:

the boolean property value for the specified name

Throws:

JMSException (src) - if the JMS provider fails to get the property value due to some internal error.

getByteProperty

public byte getByteProperty(java.lang.String name)
                     throws JMSException (src) 

Description copied from interface: Message (src)

Returns the value of the byte property with the specified name.

Specified by:

getByteProperty in interface Message (src)

Parameters:

name - the name of the byte property

Returns:

the byte property value for the specified name

Throws:

JMSException (src) - if the JMS provider fails to get the property value due to some internal error.

getShortProperty

public short getShortProperty(java.lang.String name)
                       throws JMSException (src) 

Description copied from interface: Message (src)

Returns the value of the short property with the specified name.

Specified by:

getShortProperty in interface Message (src)

Parameters:

name - the name of the short property

Returns:

the short property value for the specified name

Throws:

JMSException (src) - if the JMS provider fails to get the property value due to some internal error.

getIntProperty

public int getIntProperty(java.lang.String name)
                   throws JMSException (src) 

Description copied from interface: Message (src)

Returns the value of the int property with the specified name.

Specified by:

getIntProperty in interface Message (src)

Parameters:

name - the name of the int property

Returns:

the int property value for the specified name

Throws:

JMSException (src) - if the JMS provider fails to get the property value due to some internal error.

getLongProperty

public long getLongProperty(java.lang.String name)
                     throws JMSException (src) 

Description copied from interface: Message (src)

Returns the value of the long property with the specified name.

Specified by:

getLongProperty in interface Message (src)

Parameters:

name - the name of the long property

Returns:

the long property value for the specified name

Throws:

JMSException (src) - if the JMS provider fails to get the property value due to some internal error.

getFloatProperty

public float getFloatProperty(java.lang.String name)
                       throws JMSException (src) 

Description copied from interface: Message (src)

Returns the value of the float property with the specified name.

Specified by:

getFloatProperty in interface Message (src)

Parameters:

name - the name of the float property

Returns:

the float property value for the specified name

Throws:

JMSException (src) - if the JMS provider fails to get the property value due to some internal error.

getDoubleProperty

public double getDoubleProperty(java.lang.String name)
                         throws JMSException (src) 

Description copied from interface: Message (src)

Returns the value of the double property with the specified name.

Specified by:

getDoubleProperty in interface Message (src)

Parameters:

name - the name of the double property

Returns:

the double property value for the specified name

Throws:

JMSException (src) - if the JMS provider fails to get the property value due to some internal error.

getStringProperty

public java.lang.String getStringProperty(java.lang.String name)
                                   throws JMSException (src) 

Description copied from interface: Message (src)

Returns the value of the String property with the specified name.

Specified by:

getStringProperty in interface Message (src)

Parameters:

name - the name of the String property

Returns:

the String property value for the specified name; if there is no property by this name, a null value is returned

Throws:

JMSException (src) - if the JMS provider fails to get the property value due to some internal error.

getObjectProperty

public java.lang.Object getObjectProperty(java.lang.String name)
                                   throws JMSException (src) 

Description copied from interface: Message (src)

Returns the value of the Java object property with the specified name.

This method can be used to return, in objectified format, an object that has been stored as a property in the message with the equivalent setObjectProperty method call, or its equivalent primitive settypeProperty method.

Specified by:

getObjectProperty in interface Message (src)

Parameters:

name - the name of the Java object property

Returns:

the Java object property value with the specified name, in objectified format (for example, if the property was set as an int, an Integer is returned); if there is no property by this name, a null value is returned

Throws:

JMSException (src) - if the JMS provider fails to get the property value due to some internal error.

getPropertyNames

public java.util.Enumeration getPropertyNames()
                                       throws JMSException (src) 

Description copied from interface: Message (src)

Returns an Enumeration of all the property names.

Note that JMS standard header fields are not considered properties and are not returned in this enumeration.

Specified by:

getPropertyNames in interface Message (src)

Returns:

an enumeration of all the names of property values

Throws:

JMSException (src) - if the JMS provider fails to get the property names due to some internal error.

setBooleanProperty

public void setBooleanProperty(java.lang.String name,
                               boolean value)
                        throws JMSException (src) 

Description copied from interface: Message (src)

Sets a boolean property value with the specified name into the message.

Specified by:

setBooleanProperty in interface Message (src)

Parameters:

name - the name of the boolean property

value - the boolean property value to set

Throws:

JMSException (src) - if the JMS provider fails to set the property due to some internal error.

setByteProperty

public void setByteProperty(java.lang.String name,
                            byte value)
                     throws JMSException (src) 

Description copied from interface: Message (src)

Sets a byte property value with the specified name into the message.

Specified by:

setByteProperty in interface Message (src)

Parameters:

name - the name of the byte property

value - the byte property value to set

Throws:

JMSException (src) - if the JMS provider fails to set the property due to some internal error.

setShortProperty

public void setShortProperty(java.lang.String name,
                             short value)
                      throws JMSException (src) 

Description copied from interface: Message (src)

Sets a short property value with the specified name into the message.

Specified by:

setShortProperty in interface Message (src)

Parameters:

name - the name of the short property

value - the short property value to set

Throws:

JMSException (src) - if the JMS provider fails to set the property due to some internal error.

setIntProperty

public void setIntProperty(java.lang.String name,
                           int value)
                    throws JMSException (src) 

Description copied from interface: Message (src)

Sets an int property value with the specified name into the message.

Specified by:

setIntProperty in interface Message (src)

Parameters:

name - the name of the int property

value - the int property value to set

Throws:

JMSException (src) - if the JMS provider fails to set the property due to some internal error.

setLongProperty

public void setLongProperty(java.lang.String name,
                            long value)
                     throws JMSException (src) 

Description copied from interface: Message (src)

Sets a long property value with the specified name into the message.

Specified by:

setLongProperty in interface Message (src)

Parameters:

name - the name of the long property

value - the long property value to set

Throws:

JMSException (src) - if the JMS provider fails to set the property due to some internal error.

setFloatProperty

public void setFloatProperty(java.lang.String name,
                             float value)
                      throws JMSException (src) 

Description copied from interface: Message (src)

Sets a float property value with the specified name into the message.

Specified by:

setFloatProperty in interface Message (src)

Parameters:

name - the name of the float property

value - the float property value to set

Throws:

JMSException (src) - if the JMS provider fails to set the property due to some internal error.

setDoubleProperty

public void setDoubleProperty(java.lang.String name,
                              double value)
                       throws JMSException (src) 

Description copied from interface: Message (src)

Sets a double property value with the specified name into the message.

Specified by:

setDoubleProperty in interface Message (src)

Parameters:

name - the name of the double property

value - the double property value to set

Throws:

JMSException (src) - if the JMS provider fails to set the property due to some internal error.

setStringProperty

public void setStringProperty(java.lang.String name,
                              java.lang.String value)
                       throws JMSException (src) 

Description copied from interface: Message (src)

Sets a String property value with the specified name into the message.

Specified by:

setStringProperty in interface Message (src)

Parameters:

name - the name of the String property

value - the String property value to set

Throws:

JMSException (src) - if the JMS provider fails to set the property due to some internal error.

setObjectProperty

public void setObjectProperty(java.lang.String name,
                              java.lang.Object value)
                       throws JMSException (src) 

Description copied from interface: Message (src)

Sets a Java object property value with the specified name into the message.

Note that this method works only for the objectified primitive object types (Integer, Double, Long ...) and String objects.

Specified by:

setObjectProperty in interface Message (src)

Parameters:

name - the name of the Java object property

value - the Java object property value to set

Throws:

JMSException (src) - if the JMS provider fails to set the property due to some internal error.

writeExternal

public void writeExternal(java.io.ObjectOutput out)
                   throws java.io.IOException

Specified by:

writeExternal in interface java.io.Externalizable

Throws:

java.io.IOException

readExternal

public void readExternal(java.io.ObjectInput in)
                  throws java.io.IOException,
                         java.lang.ClassNotFoundException

Specified by:

readExternal in interface java.io.Externalizable

Throws:

java.io.IOException

java.lang.ClassNotFoundException

toString

public java.lang.String toString()