org.jboss.resource.adapter.jms.JmsSession
|
||||||||||
| PREV CLASS (src) NEXT CLASS (src) | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Object
Adapts the JMS QueueSession and TopicSession API to a JmsManagedConnection.
Created: Tue Apr 17 22:39:45 2001
| Field Summary |
| Fields inherited from interface javax.jms.Session (src) |
AUTO_ACKNOWLEDGE, CLIENT_ACKNOWLEDGE, DUPS_OK_ACKNOWLEDGE, SESSION_TRANSACTED |
| Constructor Summary | |
JmsSession(JmsManagedConnection (src) mc,
JmsConnectionRequestInfo (src) info)
Construct a JmsSession. |
|
| 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 string)
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()
Always throws an Exception. |
boolean |
getTransacted()
Indicates whether the session is in transacted mode. |
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()
Always throws an Error. |
void |
setJmsSessionFactory(JmsSessionFactory (src) sf)
|
void |
setMessageListener(MessageListener (src) listener)
Always throws an Exception. |
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 |
public JmsSession(JmsManagedConnection (src) mc,
JmsConnectionRequestInfo (src) info)
mc - The managed connection for this session.| Method Detail |
public void setJmsSessionFactory(JmsSessionFactory (src) sf)
public BytesMessage (src) createBytesMessage()
throws JMSException (src)
Session (src) BytesMessage object. A BytesMessage
object is used to send a message containing a stream of uninterpreted
bytes.
createBytesMessage in interface Session (src) JMSException (src) - if the JMS provider fails to create this message
due to some internal error.
public MapMessage (src) createMapMessage()
throws JMSException (src)
Session (src) 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.
createMapMessage in interface Session (src) JMSException (src) - if the JMS provider fails to create this message
due to some internal error.
public Message (src) createMessage()
throws JMSException (src)
Session (src) 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.
createMessage in interface Session (src) JMSException (src) - if the JMS provider fails to create this message
due to some internal error.
public ObjectMessage (src) createObjectMessage()
throws JMSException (src)
Session (src) ObjectMessage object. An
ObjectMessage object is used to send a message
that contains a serializable Java object.
createObjectMessage in interface Session (src) JMSException (src) - if the JMS provider fails to create this message
due to some internal error.
public ObjectMessage (src) createObjectMessage(java.io.Serializable object)
throws JMSException (src)
Session (src) ObjectMessage object. An
ObjectMessage object is used
to send a message that contains a serializable Java object.
createObjectMessage in interface Session (src) object - the object to use to initialize this message
JMSException (src) - if the JMS provider fails to create this message
due to some internal error.
public StreamMessage (src) createStreamMessage()
throws JMSException (src)
Session (src) StreamMessage object. A
StreamMessage object is used to send a
self-defining stream of primitive values in the Java programming
language.
createStreamMessage in interface Session (src) JMSException (src) - if the JMS provider fails to create this message
due to some internal error.
public TextMessage (src) createTextMessage()
throws JMSException (src)
Session (src) TextMessage object. A TextMessage
object is used to send a message containing a String
object.
createTextMessage in interface Session (src) JMSException (src) - if the JMS provider fails to create this message
due to some internal error.
public TextMessage (src) createTextMessage(java.lang.String string)
throws JMSException (src)
Session (src) TextMessage object. A
TextMessage object is used to send
a message containing a String.
createTextMessage in interface Session (src) string - the string used to initialize this message
JMSException (src) - if the JMS provider fails to create this message
due to some internal error.
public boolean getTransacted()
throws JMSException (src)
Session (src)
getTransacted in interface Session (src) JMSException (src) - if the JMS provider fails to return the
transaction mode due to some internal error.
public MessageListener (src) getMessageListener()
throws JMSException (src)
getMessageListener in interface Session (src) IllegalStateException (src) - Method not allowed.
JMSException (src) - if the JMS provider fails to get the message
listener due to an internal error.Session.setMessageListener(javax.jms.MessageListener),
ServerSessionPool (src) ,
ServerSession (src)
public void setMessageListener(MessageListener (src) listener)
throws JMSException (src)
setMessageListener in interface Session (src) listener - the message listener to associate with this session
IllegalStateException (src) - Method not allowed.
JMSException (src) - if the JMS provider fails to set the message
listener due to an internal error.Session.getMessageListener(),
ServerSessionPool (src) ,
ServerSession (src) public void run()
run in interface Session (src) java.lang.Error - Method not allowed.ServerSession (src)
public void close()
throws JMSException (src)
close in interface Session (src) JMSException (src) - Failed to close session.
public void commit()
throws JMSException (src)
Session (src)
commit in interface Session (src) JMSException (src) - if the JMS provider fails to commit the
transaction due to some internal error.
public void rollback()
throws JMSException (src)
Session (src)
rollback in interface Session (src) JMSException (src) - if the JMS provider fails to roll back the
transaction due to some internal error.
public void recover()
throws JMSException (src)
Session (src) 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:
recover in interface Session (src) JMSException (src) - if the JMS provider fails to stop and restart
message delivery due to some internal error.
public Topic (src) createTopic(java.lang.String topicName)
throws JMSException (src)
Session (src) 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.
createTopic in interface Session (src) topicName - the name of this Topic
Topic with the given name
JMSException (src) - if the session fails to create a topic
due to some internal error.
public TopicSubscriber (src) createSubscriber(Topic (src) topic)
throws JMSException (src)
TopicSession (src) 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.
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.
createSubscriber in interface TopicSession (src) topic - the Topic to subscribe to
JMSException (src) - if the session fails to create a subscriber
due to some internal error.
public TopicSubscriber (src) createSubscriber(Topic (src) topic,
java.lang.String messageSelector,
boolean noLocal)
throws JMSException (src)
TopicSession (src) 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.
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.
createSubscriber in interface TopicSession (src) topic - the Topic to subscribe tomessageSelector - 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
JMSException (src) - if the session fails to create a subscriber
due to some internal error.
public TopicSubscriber (src) createDurableSubscriber(Topic (src) topic,
java.lang.String name)
throws JMSException (src)
Session (src) 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.
createDurableSubscriber in interface Session (src) topic - the non-temporary Topic to subscribe toname - the name used to identify this subscription
JMSException (src) - if the session fails to create a subscriber
due to some internal error.
public TopicSubscriber (src) createDurableSubscriber(Topic (src) topic,
java.lang.String name,
java.lang.String messageSelector,
boolean noLocal)
throws JMSException (src)
Session (src) 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.
createDurableSubscriber in interface Session (src) topic - the non-temporary Topic to subscribe toname - the name used to identify this subscriptionmessageSelector - 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
JMSException (src) - if the session fails to create a subscriber
due to some internal error.
public TopicPublisher (src) createPublisher(Topic (src) topic)
throws JMSException (src)
TopicSession (src) 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.
createPublisher in interface TopicSession (src) topic - the Topic to publish to, or null if this is an
unidentified producer
JMSException (src) - if the session fails to create a publisher
due to some internal error.
public TemporaryTopic (src) createTemporaryTopic()
throws JMSException (src)
Session (src) TemporaryTopic object. Its lifetime will be that
of the Connection unless it is deleted earlier.
createTemporaryTopic in interface Session (src) JMSException (src) - if the session fails to create a temporary
topic due to some internal error.
public void unsubscribe(java.lang.String name)
throws JMSException (src)
Session (src) 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.
unsubscribe in interface Session (src) name - the name used to identify this subscription
JMSException (src) - if the session fails to unsubscribe to the
durable subscription due to some internal error.
public QueueBrowser (src) createBrowser(Queue (src) queue)
throws JMSException (src)
Session (src) QueueBrowser object to peek at the messages on
the specified queue.
createBrowser in interface Session (src) queue - the queue to access
JMSException (src) - if the session fails to create a browser
due to some internal error.
public QueueBrowser (src) createBrowser(Queue (src) queue,
java.lang.String messageSelector)
throws JMSException (src)
Session (src) QueueBrowser object to peek at the messages on
the specified queue using a message selector.
createBrowser in interface Session (src) queue - the queue to accessmessageSelector - 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.
JMSException (src) - if the session fails to create a browser
due to some internal error.
public Queue (src) createQueue(java.lang.String queueName)
throws JMSException (src)
Session (src) 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.
createQueue in interface Session (src) queueName - the name of this Queue
Queue with the given name
JMSException (src) - if the session fails to create a queue
due to some internal error.
public QueueReceiver (src) createReceiver(Queue (src) queue)
throws JMSException (src)
QueueSession (src) QueueReceiver object to receive messages from the
specified queue.
createReceiver in interface QueueSession (src) queue - the Queue to access
JMSException (src) - if the session fails to create a receiver
due to some internal error.
public QueueReceiver (src) createReceiver(Queue (src) queue,
java.lang.String messageSelector)
throws JMSException (src)
QueueSession (src) QueueReceiver object to receive messages from the
specified queue using a message selector.
createReceiver in interface QueueSession (src) queue - the Queue to accessmessageSelector - 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.
JMSException (src) - if the session fails to create a receiver
due to some internal error.
public QueueSender (src) createSender(Queue (src) queue)
throws JMSException (src)
QueueSession (src) QueueSender object to send messages to the
specified queue.
createSender in interface QueueSession (src) queue - the Queue to access, or null if this is an
unidentified producer
JMSException (src) - if the session fails to create a sender
due to some internal error.
public TemporaryQueue (src) createTemporaryQueue()
throws JMSException (src)
Session (src) TemporaryQueue object. Its lifetime will be that
of the Connection unless it is deleted earlier.
createTemporaryQueue in interface Session (src) JMSException (src) - if the session fails to create a temporary queue
due to some internal error.
public MessageConsumer (src) createConsumer(Destination (src) destination)
throws JMSException (src)
Session (src) 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.
createConsumer in interface Session (src) destination - the Destination to access.
JMSException (src) - if the session fails to create a consumer
due to some internal error.
public MessageConsumer (src) createConsumer(Destination (src) destination,
java.lang.String messageSelector)
throws JMSException (src)
Session (src) 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.
createConsumer in interface Session (src) destination - the Destination to accessmessageSelector - 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.
JMSException (src) - if the session fails to create a MessageConsumer
due to some internal error.
public MessageConsumer (src) createConsumer(Destination (src) destination,
java.lang.String messageSelector,
boolean noLocal)
throws JMSException (src)
Session (src) 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.
createConsumer in interface Session (src) destination - the Destination to accessmessageSelector - 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.
JMSException (src) - if the session fails to create a MessageConsumer
due to some internal error.
public MessageProducer (src) createProducer(Destination (src) destination)
throws JMSException (src)
Session (src) 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.
createProducer in interface Session (src) destination - the Destination to send to,
or null if this is a producer which does not have a specified
destination.
JMSException (src) - if the session fails to create a MessageProducer
due to some internal error.
public int getAcknowledgeMode()
throws JMSException (src)
Session (src)
getAcknowledgeMode in interface Session (src) JMSException (src) - if the JMS provider fails to return the
acknowledgment mode due to some internal error.Connection.createSession(boolean, int)
|
||||||||||
| PREV CLASS (src) NEXT CLASS (src) | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||