| javax.jms.MessageProducer
| MessageProducer | | public interface MessageProducer (Code) | | A client uses a MessageProducer object to send messages to a
destination. A MessageProducer object is created by passing a
Destination object to a message-producer creation method
supplied by a session.
MessageProducer is the parent interface for all message
producers.
A client also has the option of creating a message producer without
supplying a destination. In this case, a destination must be provided with
every send operation. A typical use for this kind of message producer is
to send replies to requests using the request's JMSReplyTo
destination.
A client can specify a default delivery mode, priority, and time to live
for messages sent by a message producer. It can also specify the delivery
mode, priority, and time to live for an individual message.
A client can specify a time-to-live value in milliseconds for each
message it sends. This value defines a message expiration time that
is the sum of the message's time-to-live and the GMT when it is sent (for
transacted sends, this is the time the client sends the message, not
the time the transaction is committed).
A JMS provider should do its best to expire messages accurately;
however, the JMS API does not define the accuracy provided.
version:
1.1 - February 2, 2002
author:
Mark Hapner
author:
Rich Burridge
author:
Kate Stout
See Also: javax.jms.TopicPublisher
See Also: javax.jms.QueueSender
See Also: javax.jms.Session.createProducer |
| Method Summary | |
| void | close()
Closes the message producer.
Since a provider may allocate some resources on behalf of a
MessageProducer outside the Java virtual machine, clients
should close them when they
are not needed. | | int | getDeliveryMode()
Gets the producer's default delivery mode. | | Destination | getDestination()
Gets the destination associated with this MessageProducer. | | boolean | getDisableMessageID()
Gets an indication of whether message IDs are disabled. | | boolean | getDisableMessageTimestamp()
Gets an indication of whether message timestamps are disabled. | | int | getPriority()
Gets the producer's default priority. | | long | getTimeToLive()
Gets the default length of time in milliseconds from its dispatch time
that a produced message should be retained by the message system. | | void | send(Message message)
Sends a message using the MessageProducer's
default delivery mode, priority, and time to live. | | void | send(Message message, int deliveryMode, int priority, long timeToLive)
Sends a message to the destination, specifying delivery mode, priority, and
time to live. | | void | send(Destination destination, Message message)
Sends a message to a destination for an unidentified message producer.
Uses the MessageProducer's default delivery mode, priority,
and time to live.
Typically, a message producer is assigned a destination at creation
time; however, the JMS API also supports unidentified message producers,
which require that the destination be supplied every time a message is
sent. | | void | send(Destination destination, Message message, int deliveryMode, int priority, long timeToLive)
Sends a message to a destination for an unidentified message producer,
specifying delivery mode, priority and time to live.
Typically, a message producer is assigned a destination at creation
time; however, the JMS API also supports unidentified message producers,
which require that the destination be supplied every time a message is
sent. | | void | setDeliveryMode(int deliveryMode)
Sets the producer's default delivery mode.
Delivery mode is set to PERSISTENT by default.
Parameters:
deliveryMode - the message delivery mode for this messageproducer; legal values are DeliveryMode.NON_PERSISTENTand DeliveryMode.PERSISTENT
exception:
JMSException - if the JMS provider fails to set the delivery mode due to some internal error. | | void | setDisableMessageID(boolean value)
Sets whether message IDs are disabled.
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. | | void | setDisableMessageTimestamp(boolean value)
Sets whether message timestamps are disabled.
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. | | void | setPriority(int defaultPriority)
Sets the producer's default priority.
The JMS API defines ten levels of priority value, with 0 as the
lowest priority and 9 as the highest. | | void | setTimeToLive(long timeToLive)
Sets the default length of time in milliseconds from its dispatch time
that a produced message should be retained by the message system. |
| close | | void close() throws JMSException(Code) | | Closes the message producer.
Since a provider may allocate some resources on behalf of a
MessageProducer outside the Java virtual machine, clients
should close them when they
are not needed. Relying on garbage collection to eventually reclaim
these resources may not be timely enough.
exception:
JMSException - if the JMS provider fails to close the producerdue to some internal error. |
| getDestination | | Destination getDestination() throws JMSException(Code) | | Gets the destination associated with this MessageProducer.
this producer's Destination/
exception:
JMSException - if the JMS provider fails to get the destination forthis MessageProducerdue to some internal error.
since:
1.1 |
| getDisableMessageID | | boolean getDisableMessageID() throws JMSException(Code) | | Gets an indication of whether message IDs are disabled.
an indication of whether message IDs are disabled
exception:
JMSException - if the JMS provider fails to determine if message IDs are disabled due to some internal error. |
| getDisableMessageTimestamp | | boolean getDisableMessageTimestamp() throws JMSException(Code) | | Gets an indication of whether message timestamps are disabled.
an indication of whether message timestamps are disabled
exception:
JMSException - if the JMS provider fails to determine if timestamps are disabled due to some internal error. |
| getTimeToLive | | long getTimeToLive() throws JMSException(Code) | | Gets the default length of time in milliseconds from its dispatch time
that a produced message should be retained by the message system.
the message time to live in milliseconds; zero is unlimited
exception:
JMSException - if the JMS provider fails to get the time to live due to some internal error.
See Also: javax.jms.MessageProducer.setTimeToLive |
| send | | void send(Message message, int deliveryMode, int priority, long timeToLive) throws JMSException(Code) | | Sends a message to the destination, specifying delivery mode, priority, and
time to live.
Parameters:
message - the message to send
Parameters:
deliveryMode - the delivery mode to use
Parameters:
priority - the priority for this message
Parameters:
timeToLive - the message's lifetime (in milliseconds)
exception:
JMSException - if the JMS provider fails to send the message due to some internal error.
exception:
MessageFormatException - if an invalid message is specified.
exception:
InvalidDestinationException - if a client usesthis method with a MessageProducer withan invalid destination.
exception:
java.lang.UnsupportedOperationException - if a client uses thismethod with a MessageProducer that didnot specify a destination at creation time.
See Also: javax.jms.Session.createProducer
since:
1.1 |
| send | | void send(Destination destination, Message message) throws JMSException(Code) | | Sends a message to a destination for an unidentified message producer.
Uses the MessageProducer's default delivery mode, priority,
and time to live.
Typically, a message producer is assigned a destination at creation
time; however, the JMS API also supports unidentified message producers,
which require that the destination be supplied every time a message is
sent.
Parameters:
destination - the destination to send this message to
Parameters:
message - the message to send
exception:
JMSException - if the JMS provider fails to send the message due to some internal error.
exception:
MessageFormatException - if an invalid message is specified.
exception:
InvalidDestinationException - if a client usesthis method with an invalid destination.
exception:
java.lang.UnsupportedOperationException - if a client uses thismethod with a MessageProducer that specified a destination at creation time.
See Also: javax.jms.Session.createProducer
See Also: javax.jms.MessageProducer
since:
1.1 |
| send | | void send(Destination destination, Message message, int deliveryMode, int priority, long timeToLive) throws JMSException(Code) | | Sends a message to a destination for an unidentified message producer,
specifying delivery mode, priority and time to live.
Typically, a message producer is assigned a destination at creation
time; however, the JMS API also supports unidentified message producers,
which require that the destination be supplied every time a message is
sent.
Parameters:
destination - the destination to send this message to
Parameters:
message - the message to send
Parameters:
deliveryMode - the delivery mode to use
Parameters:
priority - the priority for this message
Parameters:
timeToLive - the message's lifetime (in milliseconds)
exception:
JMSException - if the JMS provider fails to send the message due to some internal error.
exception:
MessageFormatException - if an invalid message is specified.
exception:
InvalidDestinationException - if a client usesthis method with an invalid destination.
See Also: javax.jms.Session.createProducer
since:
1.1 |
| setDisableMessageID | | void setDisableMessageID(boolean value) throws JMSException(Code) | | Sets whether message IDs are disabled.
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 setDisableMessageID
method on this message producer, a JMS client enables this potential
optimization for all messages sent by this 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.
Message IDs are enabled by default.
Parameters:
value - indicates if message IDs are disabled
exception:
JMSException - if the JMS provider fails to set message ID todisabled due to some internal error. |
| setDisableMessageTimestamp | | void setDisableMessageTimestamp(boolean value) throws JMSException(Code) | | Sets whether message timestamps are disabled.
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 setDisableMessageTimestamp
method on this message producer, a JMS client enables this potential
optimization for all messages sent by this 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.
Message timestamps are enabled by default.
Parameters:
value - indicates if message timestamps are disabled
exception:
JMSException - if the JMS provider fails to set timestamps todisabled due to some internal error. |
| setPriority | | void setPriority(int defaultPriority) throws JMSException(Code) | | Sets the producer's default priority.
The JMS API defines ten levels of priority value, with 0 as the
lowest priority and 9 as the highest. Clients should consider priorities
0-4 as gradations of normal priority and priorities 5-9 as gradations
of expedited priority. Priority is set to 4 by default.
Parameters:
defaultPriority - the message priority for this message producer;must be a value between 0 and 9
exception:
JMSException - if the JMS provider fails to set the prioritydue to some internal error.
See Also: javax.jms.MessageProducer.getPriority
See Also: javax.jms.Message.DEFAULT_PRIORITY |
| setTimeToLive | | void setTimeToLive(long timeToLive) throws JMSException(Code) | | Sets the default length of time in milliseconds from its dispatch time
that a produced message should be retained by the message system.
Time to live is set to zero by default.
Parameters:
timeToLive - the message time to live in milliseconds; zero isunlimited
exception:
JMSException - if the JMS provider fails to set the time to live due to some internal error.
See Also: javax.jms.MessageProducer.getTimeToLive
See Also: javax.jms.Message.DEFAULT_TIME_TO_LIVE |
|
|