com.sssw.jms.api
Class JMQQueueRequestor

java.lang.Object
  com.sssw.jms.api.JMQQueueRequestor

public class JMQQueueRequestor

extends Object

The JMQQueueRequestor helper class simplifies making service requests. It is based on the standard JMS QueueRequestor with an additional method for issuing a request with a timeout.

The QueueRequestor constructor is given a non-transacted QueueSession and a Queue. It creates a TemporaryQueue for the responses and provides two request methods that sends the request message and waits for its reply with an optional timeout.

Since:

jBroker MQ 2.0

See Also:

QueueRequestor

Constructor Summary

JMQQueueRequestor(QueueSession session, Queue queue)
Constructor for the QueueRequestor class.

Method Summary

void	close() Closes the QueueRequestor and its session
Message	request(Message message) Sends a request and waits for a reply.
Message	request(Message message, long timeout) Sends a request and waits for a reply with timeout.

Methods inherited from class java.lang.Object

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

Constructor Detail

JMQQueueRequestor

public JMQQueueRequestor(QueueSession session,
                         Queue queue)
                  throws JMSException

Constructor for the QueueRequestor 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 - the QueueSession the queue belongs to

queue - the queue to perform the request/reply call on

Throws:

JMSException - if the JMS provider fails to create the QueueRequestor due to some internal error

InvalidDestinationException - if an invalid queue is specified

Method Detail

request

public Message request(Message message)
                throws JMSException

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

Parameters:

message - the message to send

Returns:

the reply message

Throws:

JMSException - if the JMS provider fails to complete the request due to some internal error

request

public Message request(Message message,
                       long timeout)
                throws JMSException

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

Parameters:

message - the message to send

timeout - the timeout in milliseconds

Returns:

the reply message

Throws:

JMSException - if the JMS provider fails to complete the request due to some internal error

close

public void close()
           throws JMSException

Closes the QueueRequestor and its session

Since a provider may allocate some resources on behalf of a QueueRequestor 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 QueueSession object passed to the QueueRequestor constructor.

Throws:

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