Movatterモバイル変換

Interface Session

All Superinterfaces:

java.lang.Runnable

All Known Subinterfaces:

QueueSession,TopicSession,XAQueueSession,XASession,XATopicSession

public interfaceSession

extends java.lang.Runnable

ASession object is a single-threaded context for producing and consuming messages. Although it may allocate provider resources outside the Java virtual machine (JVM), it is considered a lightweight JMS object.

A session serves several purposes:

• It is a factory for its message producers and consumers.
• It supplies provider-optimized message factories.
• It supports a single series of transactions that combine work spanning its producers and consumers into atomic units.
• It defines a serial order for the messages it consumes and the messages it produces.
• It retains messages it consumes until they have been acknowledged.
• It serializes execution of message listeners registered with its message consumers.

A session can create and service multiple message producers and consumers.

One typical use is to have a thread block on a synchronousMessageConsumer until a message arrives. The thread may then use one or more of theSession'sMessageProducers.

If a client desires to have one thread produce messages while others consume them, the client should use a separate session for its producing thread.

Once a connection has been started, any session with one or more registered message listeners is dedicated to the thread of control that delivers messages to it. It is erroneous for client code to use this session or any of its constituent objects from another thread of control. The only exception to this rule is the use of the session or connectionclose method.

It should be easy for most clients to partition their work naturally into sessions. This model allows clients to start simply and incrementally add message processing complexity as their need for concurrency grows.

Theclose method is the only session method that can be called while some other session method is being executed in another thread.

A session may be specified as transacted. Each transacted session supports a single series of transactions. Each transaction groups a set of message sends and a set of message receives into an atomic unit of work. In effect, transactions organize a session's input message stream and output message stream into series of atomic units. When a transaction commits, its atomic unit of input is acknowledged and its associated atomic unit of output is sent. If a transaction rollback is done, the transaction's sent messages are destroyed and the session's input is automatically recovered.

The content of a transaction's input and output units is simply those messages that have been produced and consumed within the session's current transaction.

A transaction is completed using either its session'scommit method or its session'srollback method. The completion of a session's current transaction automatically begins the next. The result is that a transacted session always has a current transaction within which its work is done.

The Java Transaction Service (JTS) or some other transaction monitor may be used to combine a session's transaction with transactions on other resources (databases, other JMS sessions, etc.). Since Java distributed transactions are controlled via the Java Transaction API (JTA), use of the session'scommit androllback methods in this context is prohibited.

The JMS API does not require support for JTA; however, it does define how a provider supplies this support.

Although it is also possible for a JMS client to handle distributed transactions directly, it is unlikely that many JMS clients will do this. Support for JTA in the JMS API is targeted at systems vendors who will be integrating the JMS API into their application server products.

See Also:

QueueSession,TopicSession,XASession

AUTO_ACKNOWLEDGE

public static final intAUTO_ACKNOWLEDGE

With this acknowledgment mode, the session automatically acknowledges a client's receipt of a message either when the session has successfully returned from a call toreceive or when the message listener the session has called to process the message successfully returns.

CLIENT_ACKNOWLEDGE

public static final intCLIENT_ACKNOWLEDGE

With this acknowledgment mode, the client acknowledges a consumed message by calling the message'sacknowledge method. Acknowledging a consumed message acknowledges all messages that the session has consumed.

When client acknowledgment mode is used, a client may build up a large number of unacknowledged messages while attempting to process them. A JMS provider should provide administrators with a way to limit client overrun so that clients are not driven to resource exhaustion and ensuing failure when some resource they are using is temporarily blocked.

See Also:

Message.acknowledge()

DUPS_OK_ACKNOWLEDGE

public static final intDUPS_OK_ACKNOWLEDGE

This acknowledgment mode instructs the session to lazily acknowledge the delivery of messages. This is likely to result in the delivery of some duplicate messages if the JMS provider fails, so it should only be used by consumers that can tolerate duplicate messages. Use of this mode can reduce session overhead by minimizing the work the session does to prevent duplicates.

createBytesMessage

publicBytesMessagecreateBytesMessage()                                throwsJMSException

Creates aBytesMessage object. ABytesMessage object is used to send a message containing a stream of uninterpreted bytes.

Throws:

JMSException - if the JMS provider fails to create this message due to some internal error.

createMapMessage

publicMapMessagecreateMapMessage()                            throwsJMSException

Creates aMapMessage object. AMapMessage object is used to send a self-defining set of name-value pairs, where names areString objects and values are primitive values in the Java programming language.

Throws:

JMSException - if the JMS provider fails to create this message due to some internal error.

createMessage

publicMessagecreateMessage()                      throwsJMSException

Creates aMessage object. TheMessage interface is the root interface of all JMS messages. AMessage object holds all the standard message header information. It can be sent when a message containing only header information is sufficient.

Throws:

JMSException - if the JMS provider fails to create this message due to some internal error.

createObjectMessage

publicObjectMessagecreateObjectMessage()                                  throwsJMSException

Creates anObjectMessage object. AnObjectMessage object is used to send a message that contains a serializable Java object.

Throws:

JMSException - if the JMS provider fails to create this message due to some internal error.

createObjectMessage

publicObjectMessagecreateObjectMessage(java.io.Serializable object)                                  throwsJMSException

Creates an initializedObjectMessage object. AnObjectMessage object is used to send a message that contains a serializable Java object.

Parameters:

object - the object to use to initialize this message

Throws:

JMSException - if the JMS provider fails to create this message due to some internal error.

createStreamMessage

publicStreamMessagecreateStreamMessage()                                  throwsJMSException

Creates aStreamMessage object. AStreamMessage object is used to send a self-defining stream of primitive values in the Java programming language.

Throws:

JMSException - if the JMS provider fails to create this message due to some internal error.

createTextMessage

publicTextMessagecreateTextMessage()                              throwsJMSException

Creates aTextMessage object. ATextMessage object is used to send a message containing aString object.

Throws:

JMSException - if the JMS provider fails to create this message due to some internal error.

createTextMessage

publicTextMessagecreateTextMessage(java.lang.String text)                              throwsJMSException

Creates an initializedTextMessage object. ATextMessage object is used to send a message containing aString.

Parameters:

text - the string used to initialize this message

Throws:

JMSException - if the JMS provider fails to create this message due to some internal error.

getTransacted

public booleangetTransacted()                      throwsJMSException

Indicates whether the session is in transacted mode.

Returns:

true if the session is in transacted mode

Throws:

JMSException - if the JMS provider fails to return the transaction mode due to some internal error.

commit

public voidcommit()            throwsJMSException

Commits all messages done in this transaction and releases any locks currently held.

Throws:

JMSException - if the JMS provider fails to commit the transaction due to some internal error.

TransactionRolledBackException - if the transaction is rolled back due to some internal error during commit.

IllegalStateException - if the method is not called by a transacted session.

rollback

public voidrollback()              throwsJMSException

Rolls back any messages done in this transaction and releases any locks currently held.

Throws:

JMSException - if the JMS provider fails to roll back the transaction due to some internal error.

IllegalStateException - if the method is not called by a transacted session.

close

public voidclose()           throwsJMSException

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 areceive call or message listener in progress has completed. A blocked message consumerreceive call returnsnull when this session is closed.

Closing a transacted session must roll back the transaction in progress.

This method is the onlySession method that can be called concurrently.

Invoking any otherSession method on a closed session must throw aJMSException.IllegalStateException. Closing a closed session mustnot throw an exception.

Throws:

JMSException - if the JMS provider fails to close the session due to some internal error.

recover

public voidrecover()             throwsJMSException

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.

Throws:

JMSException - if the JMS provider fails to stop and restart message delivery due to some internal error.

IllegalStateException - if the method is called by a transacted session.

getMessageListener

publicMessageListenergetMessageListener()                                   throwsJMSException

Returns the session's distinguished message listener (optional).

Returns:

the message listener associated with this session

Throws:

JMSException - if the JMS provider fails to get the message listener due to an internal error.

See Also:

setMessageListener(javax.jms.MessageListener),ServerSessionPool,ServerSession

setMessageListener

public voidsetMessageListener(MessageListener listener)                        throwsJMSException

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.

Parameters:

listener - the message listener to associate with this session

Throws:

JMSException - if the JMS provider fails to set the message listener due to an internal error.

See Also:

getMessageListener(),ServerSessionPool,ServerSession

run

public voidrun()

Optional operation, intended to be used only by Application Servers, not by ordinary JMS clients.

Specified by:

run in interfacejava.lang.Runnable

See Also:

ServerSession