Top Description Fields Constructors Methods
jakarta.jms

public Class TopicRequestor

extends Object
Class Inheritance
The TopicRequestor helper class simplifies making service requests.

The TopicRequestor constructor is given a non-transacted TopicSession and a destination Topic. It creates a TemporaryTopic for the responses and provides a request method that sends the request message and waits for its reply.

This is a very basic request/reply abstraction which assumes the session is non-transacted with a delivery mode of either AUTO_ACKNOWLEDGE or DUPS_OK_ACKNOWLEDGE. It is expected that most applications will create less basic implementations.

Since
JMS 1.0
Version
Jakarta Messaging 2.0
See Also
jakarta.jms.QueueRequestor

Field Summary

Modifier and TypeField and Description
pack-priv TopicPublisher
publisher

pack-priv TopicSession
session

pack-priv TopicSubscriber
subscriber

pack-priv TemporaryTopic
tempTopic

Constructor Summary

AccessConstructor and Description
public
TopicRequestor(TopicSession
the TopicSession the topic belongs to
session, Topic
the topic to perform the request/reply call on
topic)

Constructor for the TopicRequestor class.

Method Summary

Modifier and TypeMethod and Description
public void
close()

Closes the TopicRequestor and its session.

public Message

Returns:

the reply message
request(Message
the message to send
message)

Sends a request and waits for a reply.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

publisherback to summary
pack-priv TopicPublisher publisher
sessionback to summary
pack-priv TopicSession session
subscriberback to summary
pack-priv TopicSubscriber subscriber
tempTopicback to summary
pack-priv TemporaryTopic tempTopic

Constructor Detail

TopicRequestorback to summary
public TopicRequestor(TopicSession session, Topic topic) throws JMSException

Constructor for the TopicRequestor class.

This implementation assumes the session parameter to be non-transacted, with a delivery mode of either AUTO_ACKNOWLEDGE or DUPS_OK_ACKNOWLEDGE.

Parameters
session:TopicSession

the TopicSession the topic belongs to

topic:Topic

the topic to perform the request/reply call on

Exceptions
JMSException:
if the Jakarta Messaging provider fails to create the TopicRequestor due to some internal error.
InvalidDestinationException:
if an invalid topic is specified.

Method Detail

closeback to summary
public void close() throws JMSException

Closes the TopicRequestor and its session.

Since a provider may allocate some resources on behalf of a TopicRequestor 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.

Note that this method closes the TopicSession object passed to the TopicRequestor constructor.

Exceptions
JMSException:
if the Jakarta Messaging provider fails to close the TopicRequestor due to some internal error.
requestback to summary
public Message request(Message message) throws JMSException

Sends a request and waits for a reply. The temporary topic is used for the JMSReplyTo destination; the first reply is returned, and any following replies are discarded.

Parameters
message:Message

the message to send

Returns:Message

the reply message

Exceptions
JMSException:
if the Jakarta Messaging provider fails to complete the request due to some internal error.