com.solacesystems.jcsmp

Interface Requestor

@ProviderType
public interface Requestor

An interface for submitting requests to the Solace appliance network. Acquire a Requestor instance from JCSMPSession.createRequestor().

Method Summary

Modifier and Type	Method and Description
BytesXMLMessage	request(XMLMessage request, long timeoutMillis, Destination sendDestination) Performs a request to the specified destination.

Method Detail

request

BytesXMLMessage request(XMLMessage request,
                        long timeoutMillis,
                        Destination sendDestination)
                 throws JCSMPException

Performs a request to the specified destination.

If request has no ReplyTo destination or ReplyToSuffix set, the session's default ReplyTo destination is set on the message.

Blocking mode

The timeoutMillis parameter controls whether this call should operate in a blocking fashion.

If >0, the call blocks for up to the number of milliseconds specified by timeoutMillis while the Requestor waits for a reply. If none is received during this time, a JCSMPRequestTimeoutException is thrown.

If 0, the call returns null after the request message has been sent. The application should then examine incoming messages on a XMLMessageConsumer or its XMLMessageListener for a reply, which will be sent to the Destination specified in the request's ReplyTo header field. To correlate replies to sent requests, an application can use the CorrelationId field on outgoing requests.

Correlation IDs

Requestor uses CorrelationId values starting with '#' which are reserved for internal use such as two party request/reply. If other applications are required to receive the reply, specify an application CorrelationId.

Delivery Mode

The request message cannot be an Guaranteed delivery message ( DeliveryMode.PERSISTENT or DeliveryMode.NON_PERSISTENT).

Parameters:

request - The request message to send.

timeoutMillis - The amount of time to allow for a reply to come in.

sendDestination - The Destination the request should be addressed to. Currently, Topics are supported.

Returns:

The reply message, if operating in blocking mode and a reply is received within the timeout period.

Throws:

IllegalArgumentException - If the Topic is invalid in the current session mode.

JCSMPRequestTimeoutException - If a blocking request times out.

JCSMPException - If there is an error sending the request, or any other JCSMP error.