JBossSession

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS (src) NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.jboss.jms.client
Class JBossSession

java.lang.Object
  org.jboss.jms.client.JBossSession

All Implemented Interfaces:: QueueSession (src) , java.lang.Runnable, Session (src) , TopicSession (src) , XAQueueSession (src) , XASession (src) , XATopicSession (src)

public class JBossSession
extends java.lang.Object
implements Session (src) , QueueSession (src) , TopicSession (src) , XASession (src) , XAQueueSession (src) , XATopicSession (src)

A session

Field Summary

Fields inherited from interface javax.jms.Session (src)

AUTO_ACKNOWLEDGE, CLIENT_ACKNOWLEDGE, DUPS_OK_ACKNOWLEDGE, SESSION_TRANSACTED

Constructor Summary
`JBossSession(SessionDelegate (src) delegate, boolean isXA, boolean transacted, int acknowledgeMode)` Construct a new JBossSession

Method Summary
`void`	`close()` Closes the session.
`void`	`commit()` Commits all messages done in this transaction and releases any locks currently held.
`QueueBrowser (src)`	`createBrowser(Queue (src) queue)` Creates a `QueueBrowser` object to peek at the messages on the specified queue.
`QueueBrowser (src)`	`createBrowser(Queue (src) queue, java.lang.String messageSelector)` Creates a `QueueBrowser` object to peek at the messages on the specified queue using a message selector.
`BytesMessage (src)`	`createBytesMessage()` Creates a `BytesMessage` object.
`MessageConsumer (src)`	`createConsumer(Destination (src) destination)` Creates a `MessageConsumer` for the specified destination.
`MessageConsumer (src)`	`createConsumer(Destination (src) destination, java.lang.String messageSelector)` Creates a `MessageConsumer` for the specified destination, using a message selector.
`MessageConsumer (src)`	`createConsumer(Destination (src) destination, java.lang.String messageSelector, boolean noLocal)` Creates `MessageConsumer` for the specified destination, using a message selector.
`TopicSubscriber (src)`	`createDurableSubscriber(Topic (src) topic, java.lang.String name)` Creates a durable subscriber to the specified topic.
`TopicSubscriber (src)`	`createDurableSubscriber(Topic (src) 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.
`MapMessage (src)`	`createMapMessage()` Creates a `MapMessage` object.
`Message (src)`	`createMessage()` Creates a `Message` object.
`ObjectMessage (src)`	`createObjectMessage()` Creates an `ObjectMessage` object.
`ObjectMessage (src)`	`createObjectMessage(java.io.Serializable object)` Creates an initialized `ObjectMessage` object.
`MessageProducer (src)`	`createProducer(Destination (src) destination)` Creates a `MessageProducer` to send messages to the specified destination.
`TopicPublisher (src)`	`createPublisher(Topic (src) topic)` Creates a publisher for the specified topic.
`Queue (src)`	`createQueue(java.lang.String queueName)` Creates a queue identity given a `Queue` name.
`QueueReceiver (src)`	`createReceiver(Queue (src) queue)` Creates a `QueueReceiver` object to receive messages from the specified queue.
`QueueReceiver (src)`	`createReceiver(Queue (src) queue, java.lang.String messageSelector)` Creates a `QueueReceiver` object to receive messages from the specified queue using a message selector.
`QueueSender (src)`	`createSender(Queue (src) queue)` Creates a `QueueSender` object to send messages to the specified queue.
`StreamMessage (src)`	`createStreamMessage()` Creates a `StreamMessage` object.
`TopicSubscriber (src)`	`createSubscriber(Topic (src) topic)` Creates a nondurable subscriber to the specified topic.
`TopicSubscriber (src)`	`createSubscriber(Topic (src) topic, java.lang.String messageSelector, boolean noLocal)` Creates a nondurable subscriber to the specified topic, using a message selector or specifying whether messages published by its own connection should be delivered to it.
`TemporaryQueue (src)`	`createTemporaryQueue()` Creates a `TemporaryQueue` object.
`TemporaryTopic (src)`	`createTemporaryTopic()` Creates a `TemporaryTopic` object.
`TextMessage (src)`	`createTextMessage()` Creates a `TextMessage` object.
`TextMessage (src)`	`createTextMessage(java.lang.String text)` Creates an initialized `TextMessage` object.
`Topic (src)`	`createTopic(java.lang.String topicName)` Creates a topic identity given a `Topic` name.
`int`	`getAcknowledgeMode()` Returns the acknowledgement mode of the session.
`MessageListener (src)`	`getMessageListener()` Returns the session's distinguished message listener (optional).
`QueueSession (src)`	`getQueueSession()` Gets the queue session associated with this `XAQueueSession`.
`Session (src)`	`getSession()` Gets the session associated with this `XASession`.
`TopicSession (src)`	`getTopicSession()` Gets the topic session associated with this `XATopicSession`.
`boolean`	`getTransacted()` Indicates whether the session is in transacted mode.
`XAResource (src)`	`getXAResource()` Returns an XA resource to the caller.
`void`	`recover()` Stops message delivery in this session, and restarts message delivery with the oldest unacknowledged message.
`void`	`rollback()` Rolls back any messages done in this transaction and releases any locks currently held.
`void`	`run()` Optional operation, intended to be used only by Application Servers, not by ordinary JMS clients.
`void`	`setMessageListener(MessageListener (src) listener)` Sets the session's distinguished message listener (optional).
`void`	`unsubscribe(java.lang.String name)` Unsubscribes a durable subscription that has been created by a client.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

JBossSession

public JBossSession(SessionDelegate (src)  delegate,
                    boolean isXA,
                    boolean transacted,
                    int acknowledgeMode)
             throws JMSException (src)

Construct a new JBossSession
Parameters:: delegate - the session delegate; isXA - whether the session is xa; transacted - whether the session is transacted; acknowledgeMode - the acknowledgement mode
Throws:: JMSException (src) - for any error

Method Detail

close

public void close()
           throws JMSException (src)

Description copied from interface: Session (src)

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.

Specified by:: close in interface Session (src)

Throws:: JMSException (src) - if the JMS provider fails to close the session due to some internal error.

commit

public void commit()
            throws JMSException (src)

Description copied from interface: Session (src)

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

Specified by:: commit in interface Session (src)

Throws:: JMSException (src) - if the JMS provider fails to commit the transaction due to some internal error.

createBrowser

public QueueBrowser (src)  createBrowser(Queue (src)  queue,
                                  java.lang.String messageSelector)
                           throws JMSException (src)

Description copied from interface: Session (src)

Creates a QueueBrowser object to peek at the messages on the specified queue using a message selector.

Specified by:: createBrowser in interface Session (src)

Parameters:: queue - the queue to access; messageSelector - only messages with properties matching the message selector expression are delivered. A value of null or an empty string indicates that there is no message selector for the message consumer.
Throws:: JMSException (src) - if the session fails to create a browser due to some internal error.

createBrowser

public QueueBrowser (src)  createBrowser(Queue (src)  queue)
                           throws JMSException (src)

Description copied from interface: Session (src)

Creates a QueueBrowser object to peek at the messages on the specified queue.

Specified by:: createBrowser in interface Session (src)

Parameters:: queue - the queue to access
Throws:: JMSException (src) - if the session fails to create a browser due to some internal error.

createBytesMessage

public BytesMessage (src)  createBytesMessage()
                                throws JMSException (src)

Description copied from interface: Session (src)

Creates a BytesMessage object. A BytesMessage object is used to send a message containing a stream of uninterpreted bytes.

Specified by:: createBytesMessage in interface Session (src)

Throws:: JMSException (src) - if the JMS provider fails to create this message due to some internal error.

createConsumer

public MessageConsumer (src)  createConsumer(Destination (src)  destination,
                                      java.lang.String messageSelector,
                                      boolean noLocal)
                               throws JMSException (src)

Description copied from interface: Session (src)

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.

Specified by:: createConsumer in interface Session (src)

Parameters:: destination - the Destination to access; messageSelector - only messages with properties matching the message selector expression are delivered. A value of null or an empty string indicates that there is no message selector for the message consumer.; noLocal - - if true, and the destination is a topic, inhibits the delivery of messages published by its own connection. The behavior for NoLocal is not specified if the destination is a queue.
Throws:: JMSException (src) - if the session fails to create a MessageConsumer due to some internal error.

createConsumer

public MessageConsumer (src)  createConsumer(Destination (src)  destination,
                                      java.lang.String messageSelector)
                               throws JMSException (src)

Description copied from interface: Session (src)

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.

Specified by:: createConsumer in interface Session (src)

Parameters:: destination - the Destination to access; messageSelector - only messages with properties matching the message selector expression are delivered. A value of null or an empty string indicates that there is no message selector for the message consumer.
Throws:: JMSException (src) - if the session fails to create a MessageConsumer due to some internal error.

createConsumer

public MessageConsumer (src)  createConsumer(Destination (src)  destination)
                               throws JMSException (src)

Description copied from interface: Session (src)

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.

Specified by:: createConsumer in interface Session (src)

Parameters:: destination - the Destination to access.
Throws:: JMSException (src) - if the session fails to create a consumer due to some internal error.

createDurableSubscriber

public TopicSubscriber (src)  createDurableSubscriber(Topic (src)  topic,
                                               java.lang.String name,
                                               java.lang.String messageSelector,
                                               boolean noLocal)
                                        throws JMSException (src)

Description copied from interface: Session (src)

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.

Specified by:: createDurableSubscriber in interface Session (src)

Parameters:: topic - the non-temporary Topic to subscribe to; name - the name used to identify this subscription; messageSelector - only messages with properties matching the message selector expression are delivered. A value of null or an empty string indicates that there is no message selector for the message consumer.; noLocal - if set, inhibits the delivery of messages published by its own connection
Throws:: JMSException (src) - if the session fails to create a subscriber due to some internal error.

createDurableSubscriber

public TopicSubscriber (src)  createDurableSubscriber(Topic (src)  topic,
                                               java.lang.String name)
                                        throws JMSException (src)

Description copied from interface: Session (src)

Creates a durable subscriber to the specified topic.

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.

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.

Specified by:: createDurableSubscriber in interface Session (src)

Parameters:: topic - the non-temporary Topic to subscribe to; name - the name used to identify this subscription
Throws:: JMSException (src) - if the session fails to create a subscriber due to some internal error.

createMapMessage

public MapMessage (src)  createMapMessage()
                            throws JMSException (src)

Description copied from interface: Session (src)

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.

Specified by:: createMapMessage in interface Session (src)

Throws:: JMSException (src) - if the JMS provider fails to create this message due to some internal error.

createMessage

public Message (src)  createMessage()
                      throws JMSException (src)

Description copied from interface: Session (src)

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.

Specified by:: createMessage in interface Session (src)

Throws:: JMSException (src) - if the JMS provider fails to create this message due to some internal error.

createObjectMessage

public ObjectMessage (src)  createObjectMessage()
                                  throws JMSException (src)

Description copied from interface: Session (src)

Creates an ObjectMessage object. An ObjectMessage object is used to send a message that contains a serializable Java object.

Specified by:: createObjectMessage in interface Session (src)

Throws:: JMSException (src) - if the JMS provider fails to create this message due to some internal error.

createObjectMessage

public ObjectMessage (src)  createObjectMessage(java.io.Serializable object)
                                  throws JMSException (src)

Description copied from interface: Session (src)

Creates an initialized ObjectMessage object. An ObjectMessage object is used to send a message that contains a serializable Java object.

Specified by:: createObjectMessage in interface Session (src)

Parameters:: object - the object to use to initialize this message
Throws:: JMSException (src) - if the JMS provider fails to create this message due to some internal error.

createProducer

public MessageProducer (src)  createProducer(Destination (src)  destination)
                               throws JMSException (src)

Description copied from interface: Session (src)

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.

Specified by:: createProducer in interface Session (src)

Parameters:: destination - the Destination to send to, or null if this is a producer which does not have a specified destination.
Throws:: JMSException (src) - if the session fails to create a MessageProducer due to some internal error.

createQueue

public Queue (src)  createQueue(java.lang.String queueName)
                  throws JMSException (src)

Description copied from interface: Session (src)

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.

Specified by:: createQueue in interface Session (src)

Parameters:: queueName - the name of this Queue
Returns:: a Queue with the given name
Throws:: JMSException (src) - if the session fails to create a queue due to some internal error.

createStreamMessage

public StreamMessage (src)  createStreamMessage()
                                  throws JMSException (src)

Description copied from interface: Session (src)

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

Specified by:: createStreamMessage in interface Session (src)

Throws:: JMSException (src) - if the JMS provider fails to create this message due to some internal error.

createTemporaryQueue

public TemporaryQueue (src)  createTemporaryQueue()
                                    throws JMSException (src)

Description copied from interface: Session (src)

Creates a TemporaryQueue object. Its lifetime will be that of the Connection unless it is deleted earlier.

Specified by:: createTemporaryQueue in interface Session (src)

Returns:: a temporary queue identity
Throws:: JMSException (src) - if the session fails to create a temporary queue due to some internal error.

createTemporaryTopic

public TemporaryTopic (src)  createTemporaryTopic()
                                    throws JMSException (src)

Description copied from interface: Session (src)

Creates a TemporaryTopic object. Its lifetime will be that of the Connection unless it is deleted earlier.

Specified by:: createTemporaryTopic in interface Session (src)

Returns:: a temporary topic identity
Throws:: JMSException (src) - if the session fails to create a temporary topic due to some internal error.

createTextMessage

public TextMessage (src)  createTextMessage()
                              throws JMSException (src)

Description copied from interface: Session (src)

Creates a TextMessage object. A TextMessage object is used to send a message containing a String object.

Specified by:: createTextMessage in interface Session (src)

Throws:: JMSException (src) - if the JMS provider fails to create this message due to some internal error.

createTextMessage

public TextMessage (src)  createTextMessage(java.lang.String text)
                              throws JMSException (src)

Description copied from interface: Session (src)

Creates an initialized TextMessage object. A TextMessage object is used to send a message containing a String.

Specified by:: createTextMessage in interface Session (src)

Parameters:: text - the string used to initialize this message
Throws:: JMSException (src) - if the JMS provider fails to create this message due to some internal error.

createTopic

public Topic (src)  createTopic(java.lang.String topicName)
                  throws JMSException (src)

Description copied from interface: Session (src)

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.

Specified by:: createTopic in interface Session (src)

Parameters:: topicName - the name of this Topic
Returns:: a Topic with the given name
Throws:: JMSException (src) - if the session fails to create a topic due to some internal error.

getAcknowledgeMode

public int getAcknowledgeMode()
                       throws JMSException (src)

Description copied from interface: Session (src)

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.

Specified by:: getAcknowledgeMode in interface Session (src)

Returns:: If the session is not transacted, returns the current acknowledgement mode for the session. If the session is transacted, returns SESSION_TRANSACTED.
Throws:: JMSException (src) - if the JMS provider fails to return the acknowledgment mode due to some internal error.
See Also:: Connection.createSession(boolean, int)

getMessageListener

public MessageListener (src)  getMessageListener()
                                   throws JMSException (src)

Description copied from interface: Session (src)

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

Specified by:: getMessageListener in interface Session (src)

Returns:: the message listener associated with this session
Throws:: JMSException (src) - if the JMS provider fails to get the message listener due to an internal error.
See Also:: Session.setMessageListener(javax.jms.MessageListener), ServerSessionPool (src) , ServerSession (src)

getTransacted

public boolean getTransacted()
                      throws JMSException (src)

Description copied from interface: Session (src)

Indicates whether the session is in transacted mode.

Specified by:: getTransacted in interface Session (src)

Returns:: true if the session is in transacted mode
Throws:: JMSException (src) - if the JMS provider fails to return the transaction mode due to some internal error.

recover

public void recover()
             throws JMSException (src)

Description copied from interface: Session (src)

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.

Specified by:: recover in interface Session (src)

Throws:: JMSException (src) - if the JMS provider fails to stop and restart message delivery due to some internal error.

rollback

public void rollback()
              throws JMSException (src)

Description copied from interface: Session (src)

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

Specified by:: rollback in interface Session (src)

Throws:: JMSException (src) - if the JMS provider fails to roll back the transaction due to some internal error.

run

public void run()

Description copied from interface: Session (src)

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

Specified by:: run in interface Session (src)

See Also:: ServerSession (src)

setMessageListener

public void setMessageListener(MessageListener (src)  listener)
                        throws JMSException (src)

Description copied from interface: Session (src)

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.

Specified by:: setMessageListener in interface Session (src)

Parameters:: listener - the message listener to associate with this session
Throws:: JMSException (src) - if the JMS provider fails to set the message listener due to an internal error.
See Also:: Session.getMessageListener(), ServerSessionPool (src) , ServerSession (src)

unsubscribe

public void unsubscribe(java.lang.String name)
                 throws JMSException (src)

Description copied from interface: Session (src)

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.

Specified by:: unsubscribe in interface Session (src)

Parameters:: name - the name used to identify this subscription
Throws:: JMSException (src) - if the session fails to unsubscribe to the durable subscription due to some internal error.

getSession

public Session (src)  getSession()
                   throws JMSException (src)

Description copied from interface: XASession (src)

Gets the session associated with this XASession.

Specified by:: getSession in interface XASession (src)

Returns:: the session object
Throws:: JMSException (src) - if an internal error occurs.

getXAResource

public XAResource (src)  getXAResource()

Description copied from interface: XASession (src)

Returns an XA resource to the caller.

Specified by:: getXAResource in interface XASession (src)

Returns:: an XA resource to the caller

createReceiver

public QueueReceiver (src)  createReceiver(Queue (src)  queue,
                                    java.lang.String messageSelector)
                             throws JMSException (src)

Description copied from interface: QueueSession (src)

Creates a QueueReceiver object to receive messages from the specified queue using a message selector.

Specified by:: createReceiver in interface QueueSession (src)

Parameters:: queue - the Queue to access; messageSelector - only messages with properties matching the message selector expression are delivered. A value of null or an empty string indicates that there is no message selector for the message consumer.
Throws:: JMSException (src) - if the session fails to create a receiver due to some internal error.

createReceiver

public QueueReceiver (src)  createReceiver(Queue (src)  queue)
                             throws JMSException (src)

Description copied from interface: QueueSession (src)

Creates a QueueReceiver object to receive messages from the specified queue.

Specified by:: createReceiver in interface QueueSession (src)

Parameters:: queue - the Queue to access
Throws:: JMSException (src) - if the session fails to create a receiver due to some internal error.

createSender

public QueueSender (src)  createSender(Queue (src)  queue)
                         throws JMSException (src)

Description copied from interface: QueueSession (src)

Creates a QueueSender object to send messages to the specified queue.

Specified by:: createSender in interface QueueSession (src)

Parameters:: queue - the Queue to access, or null if this is an unidentified producer
Throws:: JMSException (src) - if the session fails to create a sender due to some internal error.

createSubscriber

public TopicSubscriber (src)  createSubscriber(Topic (src)  topic)
                                 throws JMSException (src)

Description copied from interface: TopicSession (src)

Creates a nondurable subscriber to the specified topic.

A client uses a TopicSubscriber object to receive messages that have been published to a topic.

Regular TopicSubscriber objects are not durable. They receive only messages that are published while they are active.

Specified by:: createSubscriber in interface TopicSession (src)

Parameters:: topic - the Topic to subscribe to
Throws:: JMSException (src) - if the session fails to create a subscriber due to some internal error.

createSubscriber

public TopicSubscriber (src)  createSubscriber(Topic (src)  topic,
                                        java.lang.String messageSelector,
                                        boolean noLocal)
                                 throws JMSException (src)

Description copied from interface: TopicSession (src)

Creates a nondurable subscriber to the specified topic, using a message selector or specifying whether messages published by its own connection should be delivered to it.

A client uses a TopicSubscriber object to receive messages that have been published to a topic.

Regular TopicSubscriber objects are not durable. They receive only messages that are published while they are active.

Messages filtered out by a subscriber's message selector will never be delivered to the subscriber. From the subscriber's perspective, they do not exist.

Specified by:: createSubscriber in interface TopicSession (src)

Parameters:: topic - the Topic to subscribe to; messageSelector - only messages with properties matching the message selector expression are delivered. A value of null or an empty string indicates that there is no message selector for the message consumer.; noLocal - if set, inhibits the delivery of messages published by its own connection
Throws:: JMSException (src) - if the session fails to create a subscriber due to some internal error.

createPublisher

public TopicPublisher (src)  createPublisher(Topic (src)  topic)
                               throws JMSException (src)

Description copied from interface: TopicSession (src)

Creates a publisher for the specified topic.

A client uses a TopicPublisher object to publish messages on a topic. Each time a client creates a TopicPublisher on a topic, it defines a new sequence of messages that have no ordering relationship with the messages it has previously sent.

Specified by:: createPublisher in interface TopicSession (src)

Parameters:: topic - the Topic to publish to, or null if this is an unidentified producer
Throws:: JMSException (src) - if the session fails to create a publisher due to some internal error.

getQueueSession

public QueueSession (src)  getQueueSession()
                             throws JMSException (src)

Description copied from interface: XAQueueSession (src)

Gets the queue session associated with this XAQueueSession.

Specified by:: getQueueSession in interface XAQueueSession (src)

Returns:: the queue session object
Throws:: JMSException (src) - if an internal error occurs.

getTopicSession

public TopicSession (src)  getTopicSession()
                             throws JMSException (src)

Description copied from interface: XATopicSession (src)

Gets the topic session associated with this XATopicSession.

Specified by:: getTopicSession in interface XATopicSession (src)

Returns:: the topic session object
Throws:: JMSException (src) - if an internal error occurs.

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS (src) NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.jboss.jms.client Class JBossSession

JBossSession

close

commit

createBrowser

createBrowser

createBytesMessage

createConsumer

createConsumer

createConsumer

createDurableSubscriber

createDurableSubscriber

createMapMessage

createMessage

createObjectMessage

createObjectMessage

createProducer

createQueue

createStreamMessage

createTemporaryQueue

createTemporaryTopic

createTextMessage

createTextMessage

createTopic

getAcknowledgeMode

getMessageListener

getTransacted

recover

rollback

run

setMessageListener

unsubscribe

getSession

getXAResource

createReceiver

createReceiver

createSender

createSubscriber

createSubscriber

createPublisher

getQueueSession

getTopicSession

org.jboss.jms.client
Class JBossSession