| Methods Summary |
|---|
| public void | close()Closes the session.
Since a provider may allocate some resources on behalf of a session
outside the JVM, clients should close the resources when they are not
needed.
Relying on garbage collection to eventually reclaim these resources
may not be timely enough.
There is no need to close the producers and consumers
of a closed session.
This call will block until a receive call or message
listener in progress has completed. A blocked message consumer
receive call returns null when this session
is closed.
Closing a transacted session must roll back the transaction
in progress.
This method is the only Session method that can
be called concurrently.
Invoking any other Session method on a closed session
must throw a JMSException.IllegalStateException. Closing a
closed session must not throw an exception.
|
| public void | commit()Commits all messages done in this transaction and releases any locks
currently held.
|
| public QueueBrowser | createBrowser(Queue queue)Creates a QueueBrowser object to peek at the messages on
the specified queue.
|
| public QueueBrowser | createBrowser(Queue queue, java.lang.String messageSelector)Creates a QueueBrowser object to peek at the messages on
the specified queue using a message selector.
|
| public BytesMessage | createBytesMessage()Creates a BytesMessage object. A BytesMessage
object is used to send a message containing a stream of uninterpreted
bytes.
|
| public MessageConsumer | createConsumer(Destination destination)Creates a MessageConsumer for the specified destination.
Since Queue and Topic
both inherit from Destination, they can be used in
the destination parameter to create a MessageConsumer.
|
| public MessageConsumer | createConsumer(Destination destination, java.lang.String messageSelector)Creates a MessageConsumer for the specified destination,
using a message selector.
Since Queue and Topic
both inherit from Destination, they can be used in
the destination parameter to create a MessageConsumer.
A client uses a MessageConsumer object to receive
messages that have been sent to a destination.
|
| public MessageConsumer | createConsumer(Destination destination, java.lang.String messageSelector, boolean NoLocal)Creates MessageConsumer for the specified destination, using a
message selector. This method can specify whether messages published by
its own connection should be delivered to it, if the destination is a
topic.
Since Queue and Topic
both inherit from Destination, they can be used in
the destination parameter to create a MessageConsumer.
A client uses a MessageConsumer object to receive
messages that have been published to a destination.
In some cases, a connection may both publish and subscribe to a
topic. The consumer NoLocal attribute allows a consumer
to inhibit the delivery of messages published by its own connection.
The default value for this attribute is False. The noLocal
value must be supported by destinations that are topics.
|
| public TopicSubscriber | createDurableSubscriber(Topic topic, java.lang.String name)Creates a durable subscriber to the specified topic.
If a client needs to receive all the messages published on a
topic, including the ones published while the subscriber is inactive,
it uses a durable TopicSubscriber. The JMS provider
retains a record of this
durable subscription and insures that all messages from the topic's
publishers are retained until they are acknowledged by this
durable subscriber or they have expired.
Sessions with durable subscribers must always provide the same
client identifier. In addition, each client must specify a name that
uniquely identifies (within client identifier) each durable
subscription it creates. Only one session at a time can have a
TopicSubscriber for a particular durable subscription.
A client can change an existing durable subscription by creating
a durable TopicSubscriber with the same name and a new
topic and/or
message selector. Changing a durable subscriber is equivalent to
unsubscribing (deleting) the old one and creating a new one.
In some cases, a connection may both publish and subscribe to a
topic. The subscriber NoLocal attribute allows a subscriber
to inhibit the delivery of messages published by its own connection.
The default value for this attribute is false.
|
| public TopicSubscriber | createDurableSubscriber(Topic topic, java.lang.String name, java.lang.String messageSelector, boolean noLocal)Creates a durable subscriber to the specified topic, using a
message selector and specifying whether messages published by its
own connection should be delivered to it.
If a client needs to receive all the messages published on a
topic, including the ones published while the subscriber is inactive,
it uses a durable TopicSubscriber. The JMS provider
retains a record of this
durable subscription and insures that all messages from the topic's
publishers are retained until they are acknowledged by this
durable subscriber or they have expired.
Sessions with durable subscribers must always provide the same
client identifier. In addition, each client must specify a name which
uniquely identifies (within client identifier) each durable
subscription it creates. Only one session at a time can have a
TopicSubscriber for a particular durable subscription.
An inactive durable subscriber is one that exists but
does not currently have a message consumer associated with it.
A client can change an existing durable subscription by creating
a durable TopicSubscriber with the same name and a new
topic and/or
message selector. Changing a durable subscriber is equivalent to
unsubscribing (deleting) the old one and creating a new one.
|
| public MapMessage | createMapMessage()Creates a MapMessage object. A MapMessage
object is used to send a self-defining set of name-value pairs, where
names are String objects and values are primitive values
in the Java programming language.
|
| public Message | createMessage()Creates a Message object. The Message
interface is the root interface of all JMS messages. A
Message object holds all the
standard message header information. It can be sent when a message
containing only header information is sufficient.
|
| public ObjectMessage | createObjectMessage()Creates an ObjectMessage object. An
ObjectMessage object is used to send a message
that contains a serializable Java object.
|
| public ObjectMessage | createObjectMessage(java.io.Serializable object)Creates an initialized ObjectMessage object. An
ObjectMessage object is used
to send a message that contains a serializable Java object.
|
| public MessageProducer | createProducer(Destination destination)Creates a MessageProducer to send messages to the specified
destination.
A client uses a MessageProducer object to send
messages to a destination. Since Queue and Topic
both inherit from Destination, they can be used in
the destination parameter to create a MessageProducer object.
|
| public Queue | createQueue(java.lang.String queueName)Creates a queue identity given a Queue name.
This facility is provided for the rare cases where clients need to
dynamically manipulate queue identity. It allows the creation of a
queue identity with a provider-specific name. Clients that depend
on this ability are not portable.
Note that this method is not for creating the physical queue.
The physical creation of queues is an administrative task and is not
to be initiated by the JMS API. The one exception is the
creation of temporary queues, which is accomplished with the
createTemporaryQueue method.
|
| public StreamMessage | createStreamMessage()Creates a StreamMessage object. A
StreamMessage object is used to send a
self-defining stream of primitive values in the Java programming
language.
|
| public TemporaryQueue | createTemporaryQueue()Creates a TemporaryQueue object. Its lifetime will be that
of the Connection unless it is deleted earlier.
|
| public TemporaryTopic | createTemporaryTopic()Creates a TemporaryTopic object. Its lifetime will be that
of the Connection unless it is deleted earlier.
|
| public TextMessage | createTextMessage()Creates a TextMessage object. A TextMessage
object is used to send a message containing a String
object.
|
| public TextMessage | createTextMessage(java.lang.String text)Creates an initialized TextMessage object. A
TextMessage object is used to send
a message containing a String.
|
| public Topic | createTopic(java.lang.String topicName)Creates a topic identity given a Topic name.
This facility is provided for the rare cases where clients need to
dynamically manipulate topic identity. This allows the creation of a
topic identity with a provider-specific name. Clients that depend
on this ability are not portable.
Note that this method is not for creating the physical topic.
The physical creation of topics is an administrative task and is not
to be initiated by the JMS API. The one exception is the
creation of temporary topics, which is accomplished with the
createTemporaryTopic method.
|
| public int | getAcknowledgeMode()Returns the acknowledgement mode of the session. The acknowledgement
mode is set at the time that the session is created. If the session is
transacted, the acknowledgement mode is ignored.
|
| public MessageListener | getMessageListener()Returns the session's distinguished message listener (optional).
|
| public boolean | getTransacted()Indicates whether the session is in transacted mode.
|
| public void | recover()Stops message delivery in this session, and restarts message delivery
with the oldest unacknowledged message.
All consumers deliver messages in a serial order.
Acknowledging a received message automatically acknowledges all
messages that have been delivered to the client.
Restarting a session causes it to take the following actions:
- Stop message delivery
- Mark all messages that might have been delivered but not
acknowledged as "redelivered"
- Restart the delivery sequence including all unacknowledged
messages that had been previously delivered. Redelivered messages
do not have to be delivered in
exactly their original delivery order.
|
| public void | rollback()Rolls back any messages done in this transaction and releases any locks
currently held.
|
| public void | run()Optional operation, intended to be used only by Application Servers,
not by ordinary JMS clients.
|
| public void | setMessageListener(MessageListener listener)Sets the session's distinguished message listener (optional).
When the distinguished message listener is set, no other form of
message receipt in the session can
be used; however, all forms of sending messages are still supported.
This is an expert facility not used by regular JMS clients.
|
| public void | unsubscribe(java.lang.String name)Unsubscribes a durable subscription that has been created by a client.
This method deletes the state being maintained on behalf of the
subscriber by its provider.
It is erroneous for a client to delete a durable subscription
while there is an active MessageConsumer
or TopicSubscriber for the
subscription, or while a consumed message is part of a pending
transaction or has not been acknowledged in the session.
|
