|
Préférences
Moteurs de recherche
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
JavaTM Platform, Enterprise Edition, v 5.0
javax.jms
|
Field Summary | |
---|---|
static int |
DEFAULT_DELIVERY_MODE
The message producer's default delivery mode is PERSISTENT . |
static int |
DEFAULT_PRIORITY
The message producer's default priority is 4. |
static long |
DEFAULT_TIME_TO_LIVE
The message producer's default time to live is unlimited; the message never expires. |
Method Summary | |
---|---|
void |
acknowledge()
Acknowledges all consumed messages of the session of this consumed message. |
void |
clearBody()
Clears out the message body. |
void |
clearProperties()
Clears a message's properties. |
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. |
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. |
Destination |
getJMSDestination()
Gets the Destination object for this message. |
long |
getJMSExpiration()
Gets the message's expiration value. |
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. |
boolean |
propertyExists(String name)
Indicates whether a property value exists. |
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 |
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 |
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 |
setJMSDestination(Destination destination)
Sets the Destination object for this message. |
void |
setJMSExpiration(long expiration)
Sets the message's expiration value. |
void |
setJMSMessageID(String id)
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 replyTo)
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 |
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. |
Field Detail |
---|
static final int DEFAULT_DELIVERY_MODE
PERSISTENT
.
DeliveryMode.PERSISTENT
,
Constant Field Valuesstatic final int DEFAULT_PRIORITY
static final long DEFAULT_TIME_TO_LIVE
Method Detail |
---|
String getJMSMessageID() throws JMSException
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.
JMSException
- if the JMS provider fails to get the message ID
due to some internal error.setJMSMessageID(String)
,
MessageProducer.setDisableMessageID(boolean)
void setJMSMessageID(String id) throws JMSException
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.
id
- the ID of the message
JMSException
- if the JMS provider fails to set the message ID
due to some internal error.getJMSMessageID()
long getJMSTimestamp() throws JMSException
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.
JMSException
- if the JMS provider fails to get the timestamp
due to some internal error.setJMSTimestamp(long)
,
MessageProducer.setDisableMessageTimestamp(boolean)
void setJMSTimestamp(long timestamp) throws JMSException
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.
timestamp
- the timestamp for this message
JMSException
- if the JMS provider fails to set the timestamp
due to some internal error.getJMSTimestamp()
byte[] getJMSCorrelationIDAsBytes() throws JMSException
The use of a byte[]
value for
JMSCorrelationID
is non-portable.
JMSException
- if the JMS provider fails to get the correlation
ID due to some internal error.setJMSCorrelationID(String)
,
getJMSCorrelationID()
,
setJMSCorrelationIDAsBytes(byte[])
void setJMSCorrelationIDAsBytes(byte[] correlationID) throws JMSException
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.
correlationID
- the correlation ID value as an array of bytes
JMSException
- if the JMS provider fails to set the correlation
ID due to some internal error.setJMSCorrelationID(String)
,
getJMSCorrelationID()
,
getJMSCorrelationIDAsBytes()
void setJMSCorrelationID(String correlationID) throws JMSException
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 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.
correlationID
- the message ID of a message being referred to
JMSException
- if the JMS provider fails to set the correlation
ID due to some internal error.getJMSCorrelationID()
,
getJMSCorrelationIDAsBytes()
,
setJMSCorrelationIDAsBytes(byte[])
String getJMSCorrelationID() throws JMSException
This method is used to return correlation ID values that are
either provider-specific message IDs or application-specific
String
values.
String
JMSException
- if the JMS provider fails to get the correlation
ID due to some internal error.setJMSCorrelationID(String)
,
getJMSCorrelationIDAsBytes()
,
setJMSCorrelationIDAsBytes(byte[])
Destination getJMSReplyTo() throws JMSException
Destination
object to which a reply to this
message should be sent.
Destination
to which to send a response to this
message
JMSException
- if the JMS provider fails to get the
JMSReplyTo
destination due to some
internal error.setJMSReplyTo(Destination)
void setJMSReplyTo(Destination replyTo) throws JMSException
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.
replyTo
- Destination
to which to send a response to
this message
JMSException
- if the JMS provider fails to set the
JMSReplyTo
destination due to some
internal error.getJMSReplyTo()
Destination getJMSDestination() throws JMSException
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.
JMSException
- if the JMS provider fails to get the destination
due to some internal error.setJMSDestination(Destination)
void setJMSDestination(Destination destination) throws JMSException
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.
destination
- the destination for this message
JMSException
- if the JMS provider fails to set the destination
due to some internal error.getJMSDestination()
int getJMSDeliveryMode() throws JMSException
DeliveryMode
value specified for this message.
JMSException
- if the JMS provider fails to get the
delivery mode due to some internal error.setJMSDeliveryMode(int)
,
DeliveryMode
void setJMSDeliveryMode(int deliveryMode) throws JMSException
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.
deliveryMode
- the delivery mode for this message
JMSException
- if the JMS provider fails to set the
delivery mode due to some internal error.getJMSDeliveryMode()
,
DeliveryMode
boolean getJMSRedelivered() throws JMSException
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.
JMSException
- if the JMS provider fails to get the redelivered
state due to some internal error.setJMSRedelivered(boolean)
void setJMSRedelivered(boolean redelivered) throws JMSException
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.
redelivered
- an indication of whether this message is being
redelivered
JMSException
- if the JMS provider fails to set the redelivered
state due to some internal error.getJMSRedelivered()
String getJMSType() throws JMSException
JMSException
- if the JMS provider fails to get the message
type due to some internal error.setJMSType(String)
void setJMSType(String type) throws JMSException
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.
type
- the message type
JMSException
- if the JMS provider fails to set the message
type due to some internal error.getJMSType()
long getJMSExpiration() throws JMSException
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.
JMSException
- if the JMS provider fails to get the message
expiration due to some internal error.setJMSExpiration(long)
void setJMSExpiration(long expiration) throws JMSException
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.
expiration
- the message's expiration time
JMSException
- if the JMS provider fails to set the message
expiration due to some internal error.getJMSExpiration()
int getJMSPriority() throws JMSException
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.
JMSException
- if the JMS provider fails to get the message
priority due to some internal error.setJMSPriority(int)
void setJMSPriority(int priority) throws JMSException
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.
priority
- the priority of this message
JMSException
- if the JMS provider fails to set the message
priority due to some internal error.getJMSPriority()
void clearProperties() throws JMSException
The message's header fields and body are not cleared.
JMSException
- if the JMS provider fails to clear the message
properties due to some internal error.boolean propertyExists(String name) throws JMSException
name
- the name of the property to test
JMSException
- if the JMS provider fails to determine if the
property exists due to some internal error.boolean getBooleanProperty(String name) throws JMSException
boolean
property with the
specified name.
name
- the name of the boolean
property
boolean
property value for the specified name
JMSException
- if the JMS provider fails to get the property
value due to some internal error.
MessageFormatException
- if this type conversion is invalid.byte getByteProperty(String name) throws JMSException
byte
property with the specified
name.
name
- the name of the byte
property
byte
property value for the specified name
JMSException
- if the JMS provider fails to get the property
value due to some internal error.
MessageFormatException
- if this type conversion is invalid.short getShortProperty(String name) throws JMSException
short
property with the specified
name.
name
- the name of the short
property
short
property value for the specified name
JMSException
- if the JMS provider fails to get the property
value due to some internal error.
MessageFormatException
- if this type conversion is invalid.int getIntProperty(String name) throws JMSException
int
property with the specified
name.
name
- the name of the int
property
int
property value for the specified name
JMSException
- if the JMS provider fails to get the property
value due to some internal error.
MessageFormatException
- if this type conversion is invalid.long getLongProperty(String name) throws JMSException
long
property with the specified
name.
name
- the name of the long
property
long
property value for the specified name
JMSException
- if the JMS provider fails to get the property
value due to some internal error.
MessageFormatException
- if this type conversion is invalid.float getFloatProperty(String name) throws JMSException
float
property with the specified
name.
name
- the name of the float
property
float
property value for the specified name
JMSException
- if the JMS provider fails to get the property
value due to some internal error.
MessageFormatException
- if this type conversion is invalid.double getDoubleProperty(String name) throws JMSException
double
property with the specified
name.
name
- the name of the double
property
double
property value for the specified name
JMSException
- if the JMS provider fails to get the property
value due to some internal error.
MessageFormatException
- if this type conversion is invalid.String getStringProperty(String name) throws JMSException
String
property with the specified
name.
name
- the name of the String
property
String
property value for the specified name;
if there is no property by this name, a null value is returned
JMSException
- if the JMS provider fails to get the property
value due to some internal error.
MessageFormatException
- if this type conversion is invalid.Object getObjectProperty(String name) throws JMSException
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.
name
- the name of the Java object property
int
, an Integer
is
returned); if there is no property by this name, a null value
is returned
JMSException
- if the JMS provider fails to get the property
value due to some internal error.Enumeration getPropertyNames() throws JMSException
Enumeration
of all the property names.
Note that JMS standard header fields are not considered properties and are not returned in this enumeration.
JMSException
- if the JMS provider fails to get the property
names due to some internal error.void setBooleanProperty(String name, boolean value) throws JMSException
boolean
property value with the specified name into
the message.
name
- the name of the boolean
propertyvalue
- the boolean
property value to set
JMSException
- if the JMS provider fails to set the property
due to some internal error.
IllegalArgumentException
- if the name is null or if the name is
an empty string.
MessageNotWriteableException
- if properties are read-onlyvoid setByteProperty(String name, byte value) throws JMSException
byte
property value with the specified name into
the message.
name
- the name of the byte
propertyvalue
- the byte
property value to set
JMSException
- if the JMS provider fails to set the property
due to some internal error.
IllegalArgumentException
- if the name is null or if the name is
an empty string.
MessageNotWriteableException
- if properties are read-onlyvoid setShortProperty(String name, short value) throws JMSException
short
property value with the specified name into
the message.
name
- the name of the short
propertyvalue
- the short
property value to set
JMSException
- if the JMS provider fails to set the property
due to some internal error.
IllegalArgumentException
- if the name is null or if the name is
an empty string.
MessageNotWriteableException
- if properties are read-onlyvoid setIntProperty(String name, int value) throws JMSException
int
property value with the specified name into
the message.
name
- the name of the int
propertyvalue
- the int
property value to set
JMSException
- if the JMS provider fails to set the property
due to some internal error.
IllegalArgumentException
- if the name is null or if the name is
an empty string.
MessageNotWriteableException
- if properties are read-onlyvoid setLongProperty(String name, long value) throws JMSException
long
property value with the specified name into
the message.
name
- the name of the long
propertyvalue
- the long
property value to set
JMSException
- if the JMS provider fails to set the property
due to some internal error.
IllegalArgumentException
- if the name is null or if the name is
an empty string.
MessageNotWriteableException
- if properties are read-onlyvoid setFloatProperty(String name, float value) throws JMSException
float
property value with the specified name into
the message.
name
- the name of the float
propertyvalue
- the float
property value to set
JMSException
- if the JMS provider fails to set the property
due to some internal error.
IllegalArgumentException
- if the name is null or if the name is
an empty string.
MessageNotWriteableException
- if properties are read-onlyvoid setDoubleProperty(String name, double value) throws JMSException
double
property value with the specified name into
the message.
name
- the name of the double
propertyvalue
- the double
property value to set
JMSException
- if the JMS provider fails to set the property
due to some internal error.
IllegalArgumentException
- if the name is null or if the name is
an empty string.
MessageNotWriteableException
- if properties are read-onlyvoid setStringProperty(String name, String value) throws JMSException
String
property value with the specified name into
the message.
name
- the name of the String
propertyvalue
- the String
property value to set
JMSException
- if the JMS provider fails to set the property
due to some internal error.
IllegalArgumentException
- if the name is null or if the name is
an empty string.
MessageNotWriteableException
- if properties are read-onlyvoid setObjectProperty(String name, Object value) throws JMSException
Note that this method works only for the objectified primitive
object types (Integer
, Double
,
Long
...) and String
objects.
name
- the name of the Java object propertyvalue
- the Java object property value to set
JMSException
- if the JMS provider fails to set the property
due to some internal error.
IllegalArgumentException
- if the name is null or if the name is
an empty string.
MessageFormatException
- if the object is invalid
MessageNotWriteableException
- if properties are read-onlyvoid acknowledge() throws JMSException
All consumed JMS 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.
JMSException
- if the JMS provider fails to acknowledge the
messages due to some internal error.
IllegalStateException
- if this method is called on a closed
session.Session.CLIENT_ACKNOWLEDGE
void clearBody() throws JMSException
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.
JMSException
- if the JMS provider fails to clear the message
body due to some internal error.