public class ActiveMQMessage extends Object implements Message
Modifier and Type | Field and Description |
---|---|
protected ClientMessage |
message |
static SimpleString |
OLD_QUEUE_QUALIFIED_PREFIX |
static SimpleString |
OLD_TEMP_QUEUE_QUALIFED_PREFIX |
static SimpleString |
OLD_TEMP_TOPIC_QUALIFED_PREFIX |
static SimpleString |
OLD_TOPIC_QUALIFIED_PREFIX |
protected boolean |
propertiesReadOnly |
protected boolean |
readOnly |
protected Destination |
replyTo |
static byte |
TYPE |
DEFAULT_DELIVERY_DELAY, DEFAULT_DELIVERY_MODE, DEFAULT_PRIORITY, DEFAULT_TIME_TO_LIVE
Modifier | Constructor and Description |
---|---|
|
ActiveMQMessage() |
protected |
ActiveMQMessage(byte type,
ClientSession session) |
|
ActiveMQMessage(ClientMessage message,
ClientSession session)
Constructor for when receiving a message from the server
|
protected |
ActiveMQMessage(ClientSession session) |
protected |
ActiveMQMessage(Message foreign,
byte type,
ClientSession session) |
|
ActiveMQMessage(Message foreign,
ClientSession session) |
Modifier and Type | Method and Description |
---|---|
void |
acknowledge()
Acknowledges all consumed messages of the session of this consumed message.
|
void |
checkBuffer() |
protected SimpleString |
checkPrefix(SimpleString address) |
protected SimpleString |
checkPrefixStr(SimpleString address) |
protected void |
checkRead() |
protected void |
checkWrite() |
void |
clearBody()
Clears out the message body.
|
void |
clearProperties()
Clears a message's properties.
|
static CompositeData |
coreCompositeTypeToJMSCompositeType(CompositeDataSupport data) |
static Map<String,Object> |
coreMaptoJMSMap(Map<String,Object> coreMessage) |
static ActiveMQMessage |
createMessage(ClientMessage message,
ClientSession session) |
static ActiveMQMessage |
createMessage(ClientMessage message,
ClientSession session,
ConnectionFactoryOptions options) |
void |
doBeforeReceive() |
void |
doBeforeSend() |
<T> T |
getBody(Class<T> c)
Returns the message body as an object of the specified type.
|
protected <T> T |
getBodyInternal(Class<T> c) |
boolean |
getBooleanProperty(String name)
Returns the value of the
boolean property with the specified name. |
byte |
getByteProperty(String name)
Returns the value of the
byte property with the specified name. |
ClientMessage |
getCoreMessage() |
double |
getDoubleProperty(String name)
Returns the value of the
double property with the specified name. |
float |
getFloatProperty(String name)
Returns the value of the
float property with the specified name. |
int |
getIntProperty(String name)
Returns the value of the
int property with the specified name. |
String |
getJMSCorrelationID()
Gets the correlation ID for the message.
|
byte[] |
getJMSCorrelationIDAsBytes()
Gets the correlation ID as an array of bytes for the message.
|
int |
getJMSDeliveryMode()
Gets the
DeliveryMode value specified for this message. |
long |
getJMSDeliveryTime()
Gets the message's delivery time value.
|
Destination |
getJMSDestination()
Gets the
Destination object for this message. |
long |
getJMSExpiration()
Gets the message's expiration time.
|
String |
getJMSMessageID()
Gets the message ID.
|
int |
getJMSPriority()
Gets the message priority level.
|
boolean |
getJMSRedelivered()
Gets an indication of whether this message is being redelivered.
|
Destination |
getJMSReplyTo()
Gets the
Destination object to which a reply to this message should be sent. |
long |
getJMSTimestamp()
Gets the message timestamp.
|
String |
getJMSType()
Gets the message type identifier supplied by the client when the message was sent.
|
long |
getLongProperty(String name)
Returns the value of the
long property with the specified name. |
Object |
getObjectProperty(String name)
Returns the value of the Java object property with the specified name.
|
Enumeration |
getPropertyNames()
Returns an
Enumeration of all the property names. |
short |
getShortProperty(String name)
Returns the value of the
short property with the specified name. |
String |
getStringProperty(String name)
Returns the value of the
String property with the specified name. |
byte |
getType() |
protected boolean |
hasNoBody()
Helper method for
isBodyAssignableTo(Class) . |
boolean |
isBodyAssignableTo(Class c)
Returns whether the message body is capable of being assigned to the specified type.
|
static String |
prefixOf(Destination dest) |
boolean |
propertyExists(String name)
Indicates whether a property value exists.
|
void |
resetMessageID(String newMsgID) |
void |
saveToOutputStream(OutputStream output) |
void |
setBooleanProperty(String name,
boolean value)
Sets a
boolean property value with the specified name into the message. |
void |
setByteProperty(String name,
byte value)
Sets a
byte property value with the specified name into the message. |
void |
setClientAcknowledge() |
void |
setDoubleProperty(String name,
double value)
Sets a
double property value with the specified name into the message. |
void |
setFloatProperty(String name,
float value)
Sets a
float property value with the specified name into the message. |
void |
setIndividualAcknowledge() |
void |
setInputStream(InputStream input) |
void |
setIntProperty(String name,
int value)
Sets an
int property value with the specified name into the message. |
void |
setJMSCorrelationID(String correlationID)
Sets the correlation ID for the message.
|
void |
setJMSCorrelationIDAsBytes(byte[] correlationID)
Sets the correlation ID as an array of bytes for the message.
|
void |
setJMSDeliveryMode(int deliveryMode)
Sets the
DeliveryMode value for this message. |
void |
setJMSDeliveryTime(long deliveryTime)
Sets the message's delivery time value.
|
void |
setJMSDestination(Destination destination)
Sets the
Destination object for this message. |
void |
setJMSExpiration(long expiration)
Sets the message's expiration value.
|
void |
setJMSMessageID(String jmsMessageID)
Sets the message ID.
|
void |
setJMSPriority(int priority)
Sets the priority level for this message.
|
void |
setJMSRedelivered(boolean redelivered)
Specifies whether this message is being redelivered.
|
void |
setJMSReplyTo(Destination dest)
Sets the
Destination object to which a reply to this message should be sent. |
void |
setJMSTimestamp(long timestamp)
Sets the message timestamp.
|
void |
setJMSType(String type)
Sets the message type.
|
void |
setLongProperty(String name,
long value)
Sets a
long property value with the specified name into the message. |
void |
setObjectProperty(String name,
Object value)
Sets a Java object property value with the specified name into the message.
|
void |
setOutputStream(OutputStream output) |
void |
setShortProperty(String name,
short value)
Sets a
short property value with the specified name into the message. |
void |
setStringProperty(String name,
String value)
Sets a
String property value with the specified name into the message. |
String |
toString() |
boolean |
waitCompletionOnStream(long timeWait) |
public static final byte TYPE
public static final SimpleString OLD_QUEUE_QUALIFIED_PREFIX
public static final SimpleString OLD_TEMP_QUEUE_QUALIFED_PREFIX
public static final SimpleString OLD_TOPIC_QUALIFIED_PREFIX
public static final SimpleString OLD_TEMP_TOPIC_QUALIFED_PREFIX
protected ClientMessage message
protected boolean readOnly
protected boolean propertiesReadOnly
protected Destination replyTo
protected ActiveMQMessage(byte type, ClientSession session)
protected ActiveMQMessage(ClientSession session)
public ActiveMQMessage(ClientMessage message, ClientSession session)
public ActiveMQMessage(Message foreign, ClientSession session) throws JMSException
JMSException
public ActiveMQMessage()
protected ActiveMQMessage(Message foreign, byte type, ClientSession session) throws JMSException
JMSException
public static CompositeData coreCompositeTypeToJMSCompositeType(CompositeDataSupport data) throws Exception
Exception
public static ActiveMQMessage createMessage(ClientMessage message, ClientSession session)
public static ActiveMQMessage createMessage(ClientMessage message, ClientSession session, ConnectionFactoryOptions options)
public String getJMSMessageID()
Message
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 Jakarta Messaging 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 Jakarta Messaging client enables this potential optimization for all messages
sent by that message producer. If the Jakarta Messaging 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.
getJMSMessageID
in interface Message
Message.setJMSMessageID(String)
,
MessageProducer.setDisableMessageID(boolean)
public void setJMSMessageID(String jmsMessageID) throws JMSException
Message
This method is for use by Jakarta Messaging providers only to set this field when a message is sent. This message cannot be used by clients to configure the message ID. This method is public to allow a Jakarta Messaging provider to set this field when sending a message whose implementation is not its own.
setJMSMessageID
in interface Message
jmsMessageID
- the ID of the messageJMSException
- if the Jakarta Messaging provider fails to set the message ID due to some internal error.Message.getJMSMessageID()
public long getJMSTimestamp() throws JMSException
Message
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 Jakarta Messaging 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 Jakarta Messaging client enables this potential optimization for all
messages sent by that message producer. If the Jakarta Messaging 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.
getJMSTimestamp
in interface Message
JMSException
- if the Jakarta Messaging provider fails to get the timestamp due to some internal error.Message.setJMSTimestamp(long)
,
MessageProducer.setDisableMessageTimestamp(boolean)
public void setJMSTimestamp(long timestamp) throws JMSException
Message
This method is for use by Jakarta Messaging providers only to set this field when a message is sent. This message cannot be used by clients to configure the message timestamp. This method is public to allow a Jakarta Messaging provider to set this field when sending a message whose implementation is not its own.
setJMSTimestamp
in interface Message
timestamp
- the timestamp for this messageJMSException
- if the Jakarta Messaging provider fails to set the timestamp due to some internal error.Message.getJMSTimestamp()
public byte[] getJMSCorrelationIDAsBytes() throws JMSException
Message
The use of a byte[]
value for JMSCorrelationID
is non-portable.
getJMSCorrelationIDAsBytes
in interface Message
JMSException
- if the Jakarta Messaging provider fails to get the correlation ID due to some internal error.Message.setJMSCorrelationID(String)
,
Message.getJMSCorrelationID()
,
Message.setJMSCorrelationIDAsBytes(byte[])
public void setJMSCorrelationIDAsBytes(byte[] correlationID) throws JMSException
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 Jakarta Messaging client may need to assign specific
JMSCorrelationID
values to match those expected by native messaging clients. Jakarta Messaging 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.
setJMSCorrelationIDAsBytes
in interface Message
correlationID
- the correlation ID value as an array of bytesJMSException
- if the Jakarta Messaging provider fails to set the correlation ID due to some internal error.Message.setJMSCorrelationID(String)
,
Message.getJMSCorrelationID()
,
Message.getJMSCorrelationIDAsBytes()
public void setJMSCorrelationID(String correlationID) throws JMSException
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:
String
byte[]
value
Since each message sent by a Jakarta Messaging 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 Jakarta Messaging client may need to assign specific
JMSCorrelationID
values to match those expected by clients that do not use the Jakarta Messaging API. A byte[]
value is used for this purpose. Jakarta Messaging providers without native correlation ID values are not required to support
byte[]
values. The use of a byte[]
value for JMSCorrelationID
is non-portable.
setJMSCorrelationID
in interface Message
correlationID
- the message ID of a message being referred toJMSException
- if the Jakarta Messaging provider fails to set the correlation ID due to some internal error.Message.getJMSCorrelationID()
,
Message.getJMSCorrelationIDAsBytes()
,
Message.setJMSCorrelationIDAsBytes(byte[])
public String getJMSCorrelationID() throws JMSException
Message
This method is used to return correlation ID values that are either provider-specific message IDs or
application-specific String
values.
getJMSCorrelationID
in interface Message
String
JMSException
- if the Jakarta Messaging provider fails to get the correlation ID due to some internal error.Message.setJMSCorrelationID(String)
,
Message.getJMSCorrelationIDAsBytes()
,
Message.setJMSCorrelationIDAsBytes(byte[])
public Destination getJMSReplyTo() throws JMSException
Message
Destination
object to which a reply to this message should be sent.getJMSReplyTo
in interface Message
Destination
to which to send a response to this messageJMSException
- if the Jakarta Messaging provider fails to get the JMSReplyTo
destination due to some internal
error.Message.setJMSReplyTo(Destination)
public void setJMSReplyTo(Destination dest) throws JMSException
Message
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.
setJMSReplyTo
in interface Message
dest
- Destination
to which to send a response to this messageJMSException
- if the Jakarta Messaging provider fails to set the JMSReplyTo
destination due to some internal
error.Message.getJMSReplyTo()
public static String prefixOf(Destination dest)
protected SimpleString checkPrefix(SimpleString address)
protected SimpleString checkPrefixStr(SimpleString address)
public Destination getJMSDestination() throws JMSException
Message
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.
getJMSDestination
in interface Message
JMSException
- if the Jakarta Messaging provider fails to get the destination due to some internal error.Message.setJMSDestination(Destination)
public void setJMSDestination(Destination destination) throws JMSException
Message
Destination
object for this message.
This method is for use by Jakarta Messaging providers only to set this field when a message is sent. This message cannot be used by clients to configure the destination of the message. This method is public to allow a Jakarta Messaging provider to set this field when sending a message whose implementation is not its own.
setJMSDestination
in interface Message
destination
- the destination for this messageJMSException
- if the Jakarta Messaging provider fails to set the destination due to some internal error.Message.getJMSDestination()
public int getJMSDeliveryMode() throws JMSException
Message
DeliveryMode
value specified for this message.getJMSDeliveryMode
in interface Message
JMSException
- if the Jakarta Messaging provider fails to get the delivery mode due to some internal error.Message.setJMSDeliveryMode(int)
,
DeliveryMode
public void setJMSDeliveryMode(int deliveryMode) throws JMSException
Message
DeliveryMode
value for this message.
This method is for use by Jakarta Messaging providers only to set this field when a message is sent. This message cannot be used by clients to configure the delivery mode of the message. This method is public to allow a Jakarta Messaging provider to set this field when sending a message whose implementation is not its own.
setJMSDeliveryMode
in interface Message
deliveryMode
- the delivery mode for this messageJMSException
- if the Jakarta Messaging provider fails to set the delivery mode due to some internal error.Message.getJMSDeliveryMode()
,
DeliveryMode
public boolean getJMSRedelivered() throws JMSException
Message
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.
getJMSRedelivered
in interface Message
JMSException
- if the Jakarta Messaging provider fails to get the redelivered state due to some internal error.Message.setJMSRedelivered(boolean)
public void setJMSRedelivered(boolean redelivered) throws JMSException
Message
This method is for use by Jakarta Messaging providers only to set this field when a message is delivered. This message cannot be used by clients to configure the redelivered status of the message. This method is public to allow a Jakarta Messaging provider to set this field when sending a message whose implementation is not its own.
setJMSRedelivered
in interface Message
redelivered
- an indication of whether this message is being redeliveredJMSException
- if the Jakarta Messaging provider fails to set the redelivered state due to some internal error.Message.getJMSRedelivered()
public void setJMSType(String type) throws JMSException
Message
Some Jakarta Messaging 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 Jakarta Messaging 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 Jakarta Messaging providers, Jakarta Messaging 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, Jakarta Messaging 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 Jakarta Messaging providers.
setJMSType
in interface Message
type
- the message typeJMSException
- if the Jakarta Messaging provider fails to set the message type due to some internal error.Message.getJMSType()
public String getJMSType() throws JMSException
Message
getJMSType
in interface Message
JMSException
- if the Jakarta Messaging provider fails to get the message type due to some internal error.Message.setJMSType(String)
public long getJMSExpiration() throws JMSException
Message
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 the difference,
measured in milliseconds, between the expiration time and midnight, January 1, 1970 UTC.
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 Jakarta Messaging API does not define any form of notification of message expiration.
Clients should not receive messages that have expired; however, the Jakarta Messaging API does not guarantee that this will not happen.
getJMSExpiration
in interface Message
JMSException
- if the Jakarta Messaging provider fails to get the message expiration due to some internal error.Message.setJMSExpiration(long)
public void setJMSExpiration(long expiration) throws JMSException
Message
This method is for use by Jakarta Messaging providers only to set this field when a message is sent. This message cannot be used by clients to configure the expiration time of the message. This method is public to allow a Jakarta Messaging provider to set this field when sending a message whose implementation is not its own.
setJMSExpiration
in interface Message
expiration
- the message's expiration timeJMSException
- if the Jakarta Messaging provider fails to set the message expiration due to some internal error.Message.getJMSExpiration()
public int getJMSPriority() throws JMSException
Message
The Jakarta Messaging 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 Jakarta Messaging 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.
getJMSPriority
in interface Message
JMSException
- if the Jakarta Messaging provider fails to get the message priority due to some internal error.Message.setJMSPriority(int)
public void setJMSPriority(int priority) throws JMSException
Message
This method is for use by Jakarta Messaging providers only to set this field when a message is sent. This message cannot be used by clients to configure the priority level of the message. This method is public to allow a Jakarta Messaging provider to set this field when sending a message whose implementation is not its own.
setJMSPriority
in interface Message
priority
- the priority of this messageJMSException
- if the Jakarta Messaging provider fails to set the message priority due to some internal error.Message.getJMSPriority()
public void clearProperties() throws JMSException
Message
The message's header fields and body are not cleared.
clearProperties
in interface Message
JMSException
- if the Jakarta Messaging provider fails to clear the message properties due to some internal error.public void clearBody() throws JMSException
Message
If this message body was read-only, calling this method leaves the message body in the same state as an empty body in a newly created message.
clearBody
in interface Message
JMSException
- if the Jakarta Messaging provider fails to clear the message body due to some internal error.public boolean propertyExists(String name) throws JMSException
Message
propertyExists
in interface Message
name
- the name of the property to testJMSException
- if the Jakarta Messaging provider fails to determine if the property exists due to some internal error.public boolean getBooleanProperty(String name) throws JMSException
Message
boolean
property with the specified name.getBooleanProperty
in interface Message
name
- the name of the boolean
propertyboolean
property value for the specified nameJMSException
- if the Jakarta Messaging provider fails to get the property value due to some internal error.MessageFormatException
- if this type conversion is invalid.public byte getByteProperty(String name) throws JMSException
Message
byte
property with the specified name.getByteProperty
in interface Message
name
- the name of the byte
propertybyte
property value for the specified nameJMSException
- if the Jakarta Messaging provider fails to get the property value due to some internal error.MessageFormatException
- if this type conversion is invalid.public short getShortProperty(String name) throws JMSException
Message
short
property with the specified name.getShortProperty
in interface Message
name
- the name of the short
propertyshort
property value for the specified nameJMSException
- if the Jakarta Messaging provider fails to get the property value due to some internal error.MessageFormatException
- if this type conversion is invalid.public int getIntProperty(String name) throws JMSException
Message
int
property with the specified name.getIntProperty
in interface Message
name
- the name of the int
propertyint
property value for the specified nameJMSException
- if the Jakarta Messaging provider fails to get the property value due to some internal error.MessageFormatException
- if this type conversion is invalid.public long getLongProperty(String name) throws JMSException
Message
long
property with the specified name.getLongProperty
in interface Message
name
- the name of the long
propertylong
property value for the specified nameJMSException
- if the Jakarta Messaging provider fails to get the property value due to some internal error.MessageFormatException
- if this type conversion is invalid.public float getFloatProperty(String name) throws JMSException
Message
float
property with the specified name.getFloatProperty
in interface Message
name
- the name of the float
propertyfloat
property value for the specified nameJMSException
- if the Jakarta Messaging provider fails to get the property value due to some internal error.MessageFormatException
- if this type conversion is invalid.public double getDoubleProperty(String name) throws JMSException
Message
double
property with the specified name.getDoubleProperty
in interface Message
name
- the name of the double
propertydouble
property value for the specified nameJMSException
- if the Jakarta Messaging provider fails to get the property value due to some internal error.MessageFormatException
- if this type conversion is invalid.public String getStringProperty(String name) throws JMSException
Message
String
property with the specified name.getStringProperty
in interface Message
name
- the name of the String
propertyString
property value for the specified name; if there is no property by this name, a null value
is returnedJMSException
- if the Jakarta Messaging provider fails to get the property value due to some internal error.MessageFormatException
- if this type conversion is invalid.public Object getObjectProperty(String name) throws JMSException
Message
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.
getObjectProperty
in interface Message
name
- the name of the Java object propertyint
, an Integer
is returned); if there is no property by this name, a null value is
returnedJMSException
- if the Jakarta Messaging provider fails to get the property value due to some internal error.public Enumeration getPropertyNames() throws JMSException
Message
Enumeration
of all the property names.
Note that Jakarta Messaging standard header fields are not considered properties and are not returned in this enumeration.
getPropertyNames
in interface Message
JMSException
- if the Jakarta Messaging provider fails to get the property names due to some internal error.public void setBooleanProperty(String name, boolean value) throws JMSException
Message
boolean
property value with the specified name into the message.setBooleanProperty
in interface Message
name
- the name of the boolean
propertyvalue
- the boolean
property value to setJMSException
- if the Jakarta Messaging provider fails to set the property due to some internal error.MessageNotWriteableException
- if properties are read-onlypublic void setByteProperty(String name, byte value) throws JMSException
Message
byte
property value with the specified name into the message.setByteProperty
in interface Message
name
- the name of the byte
propertyvalue
- the byte
property value to setJMSException
- if the Jakarta Messaging provider fails to set the property due to some internal error.MessageNotWriteableException
- if properties are read-onlypublic void setShortProperty(String name, short value) throws JMSException
Message
short
property value with the specified name into the message.setShortProperty
in interface Message
name
- the name of the short
propertyvalue
- the short
property value to setJMSException
- if the Jakarta Messaging provider fails to set the property due to some internal error.MessageNotWriteableException
- if properties are read-onlypublic void setIntProperty(String name, int value) throws JMSException
Message
int
property value with the specified name into the message.setIntProperty
in interface Message
name
- the name of the int
propertyvalue
- the int
property value to setJMSException
- if the Jakarta Messaging provider fails to set the property due to some internal error.MessageNotWriteableException
- if properties are read-onlypublic void setLongProperty(String name, long value) throws JMSException
Message
long
property value with the specified name into the message.setLongProperty
in interface Message
name
- the name of the long
propertyvalue
- the long
property value to setJMSException
- if the Jakarta Messaging provider fails to set the property due to some internal error.MessageNotWriteableException
- if properties are read-onlypublic void setFloatProperty(String name, float value) throws JMSException
Message
float
property value with the specified name into the message.setFloatProperty
in interface Message
name
- the name of the float
propertyvalue
- the float
property value to setJMSException
- if the Jakarta Messaging provider fails to set the property due to some internal error.MessageNotWriteableException
- if properties are read-onlypublic void setDoubleProperty(String name, double value) throws JMSException
Message
double
property value with the specified name into the message.setDoubleProperty
in interface Message
name
- the name of the double
propertyvalue
- the double
property value to setJMSException
- if the Jakarta Messaging provider fails to set the property due to some internal error.MessageNotWriteableException
- if properties are read-onlypublic void setStringProperty(String name, String value) throws JMSException
Message
String
property value with the specified name into the message.setStringProperty
in interface Message
name
- the name of the String
propertyvalue
- the String
property value to setJMSException
- if the Jakarta Messaging provider fails to set the property due to some internal error.MessageNotWriteableException
- if properties are read-onlypublic void setObjectProperty(String name, Object value) throws JMSException
Message
Note that this method works only for the objectified primitive object types (Integer
, Double
,
Long
...) and String
objects.
setObjectProperty
in interface Message
name
- the name of the Java object propertyvalue
- the Java object property value to setJMSException
- if the Jakarta Messaging provider fails to set the property due to some internal error.MessageFormatException
- if the object is invalidMessageNotWriteableException
- if properties are read-onlypublic void acknowledge() throws JMSException
Message
All consumed Jakarta Messaging messages support the acknowledge
method for use when a client has specified that its JMS
session's consumed messages are to be explicitly acknowledged. By invoking acknowledge
on a consumed message,
a client acknowledges all messages consumed by the session that the message was delivered to.
Calls to acknowledge
are ignored for both transacted sessions and sessions specified to use implicit
acknowledgement modes.
A client may individually acknowledge each message as it is consumed, or it may choose to acknowledge messages as an application-defined group (which is done by calling acknowledge on the last received message of the group, thereby acknowledging all messages consumed by the session.)
Messages that have been received but not acknowledged may be redelivered.
acknowledge
in interface Message
JMSException
- if the Jakarta Messaging provider fails to acknowledge the messages due to some internal error.IllegalStateException
- if this method is called on a closed session.Session.CLIENT_ACKNOWLEDGE
public long getJMSDeliveryTime() throws JMSException
Message
When a message is sent, the JMSDeliveryTime
header field is left unassigned. After completion of the
send
or publish
method, it holds the delivery time of the message. This is the the difference,
measured in milliseconds, between the delivery time and midnight, January 1, 1970 UTC.
A message's delivery time is the earliest time when a Jakarta Messaging provider may deliver the message to a consumer. The provider must not deliver messages before the delivery time has been reached.
getJMSDeliveryTime
in interface Message
JMSException
- if the Jakarta Messaging provider fails to get the delivery time due to some internal error.Message.setJMSDeliveryTime(long)
public void setJMSDeliveryTime(long deliveryTime) throws JMSException
Message
This method is for use by Jakarta Messaging providers only to set this field when a message is sent. This message cannot be used by clients to configure the delivery time of the message. This method is public to allow a Jakarta Messaging provider to set this field when sending a message whose implementation is not its own.
setJMSDeliveryTime
in interface Message
deliveryTime
- the message's delivery time valueJMSException
- if the Jakarta Messaging provider fails to set the delivery time due to some internal error.Message.getJMSDeliveryTime()
public <T> T getBody(Class<T> c) throws JMSException
Message
getBody
in interface Message
T
- The type of the message bodyc
- The type to which the message body will be assigned. TextMessage
then this parameter must be set to String.class
or another type to
which a String
is assignable. ObjectMessage
then parameter must must be set to java.io.Serializable.class
or
another type to which the body is assignable. MapMessage
then this parameter must be set to java.util.Map.class
(or
java.lang.Object.class
). BytesMessage
then this parameter must be set to byte[].class
(or
java.lang.Object.class
). This method will reset the BytesMessage
before and after use.TextMessage
, ObjectMessage
, MapMessage
or BytesMessage
and the
message has no body, then the above does not apply and this parameter may be set to any type; the returned value will
always be null.Message
(but not one of its subtypes) then this parameter may be set to any type; the
returned value will always be null.MessageFormatException
- StreamMessage
ObjectMessage
and object deserialization fails.
JMSException
- if the Jakarta Messaging provider fails to get the message body due to some internal error.protected <T> T getBodyInternal(Class<T> c) throws MessageFormatException
MessageFormatException
public boolean isBodyAssignableTo(Class c)
Message
getBody
on the same message with the same type argument would not throw a
MessageFormatException.
If the message is a StreamMessage
then false is always returned. If the message is a ObjectMessage
and object deserialization fails then false is returned. If the message has no body then any type may be specified
and true is returned.
isBodyAssignableTo
in interface Message
c
- The specified type TextMessage
then this method will only return true if this parameter is set to
String.class
or another type to which a String
is assignable. ObjectMessage
then this method will only return true if this parameter is set to
java.io.Serializable.class
or another class to which the body is assignable. MapMessage
then this method will only return true if this parameter is set to
java.util.Map.class
(or java.lang.Object.class
). BytesMessage
then this this method will only return true if this parameter is set to
byte[].class
(or java.lang.Object.class
). TextMessage
, ObjectMessage
, MapMessage
or BytesMessage
and the
message has no body, then the above does not apply and this method will return true irrespective of the value of this
parameter.Message
(but not one of its subtypes) then this method will return true irrespective of
the value of this parameter.protected boolean hasNoBody()
isBodyAssignableTo(Class)
.public void setIndividualAcknowledge()
public void setClientAcknowledge()
public void resetMessageID(String newMsgID)
public ClientMessage getCoreMessage()
public void checkBuffer()
public void doBeforeReceive() throws ActiveMQException
ActiveMQException
public byte getType()
public void setInputStream(InputStream input) throws JMSException
JMSException
public void setOutputStream(OutputStream output) throws JMSException
JMSException
public void saveToOutputStream(OutputStream output) throws JMSException
JMSException
public boolean waitCompletionOnStream(long timeWait) throws JMSException
JMSException
protected void checkWrite() throws JMSException
JMSException
protected void checkRead() throws JMSException
JMSException
Copyright © 2019 JBoss by Red Hat. All rights reserved.