com.solace.messaging.publisher

Interface RequestReplyMessagePublisher

All Superinterfaces:

AsyncLifecycleControl, LifecycleControl, ManageablePublisher, MessagePublisher, PublisherHealthCheck

@ProviderType
public interface RequestReplyMessagePublisher
extends MessagePublisher

An interface for a publisher application in a request-reply messaging use case.

This API expected to be thread safe.

Since:

1.1

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	RequestReplyMessagePublisher.ReplyMessageHandler An interface to handle a reply message for the request-reply use case.

Nested classes/interfaces inherited from interface com.solace.messaging.util.LifecycleControl

LifecycleControl.TerminationEvent, LifecycleControl.TerminationNotificationListener

Nested classes/interfaces inherited from interface com.solace.messaging.publisher.PublisherHealthCheck

PublisherHealthCheck.PublisherReadinessListener

Nested classes/interfaces inherited from interface com.solace.messaging.util.ManageablePublisher

ManageablePublisher.DirectPublisherInfo, ManageablePublisher.PersistentPublisherInfo, ManageablePublisher.PublisherInfo

Method Summary

Modifier and Type	Method and Description
void	publish(OutboundMessage requestMessage, Properties additionalMessageProperties, RequestReplyMessagePublisher.ReplyMessageHandler replyMessageHandler, Object userContext, Topic requestDestination, long replyTimeout) Sends a request for reply message; nonblocking.
void	publish(OutboundMessage requestMessage, RequestReplyMessagePublisher.ReplyMessageHandler replyMessageHandler, Object userContext, Topic requestDestination, long replyTimeout) Sends a request for reply message; nonblocking.
void	publish(OutboundMessage requestMessage, RequestReplyMessagePublisher.ReplyMessageHandler replyMessageHandler, Topic requestDestination, long replyTimeout) Sends a request for reply message; nonblocking.
InboundMessage	publishAwaitResponse(OutboundMessage requestMessage, Properties additionalMessageProperties, Topic requestDestination, long replyTimeout) Sends a request message return response message that blocks until a response is received or a timeout occurs.
InboundMessage	publishAwaitResponse(OutboundMessage requestMessage, Topic requestDestination, long replyTimeout) Sends a request message return response message that blocks until a response is received or a timeout occurs.
RequestReplyMessagePublisher	start() Enables service regular duties.
<RequestReplyMessagePublisher> CompletableFuture<RequestReplyMessagePublisher>	startAsync() Asynchronously starts service for consuming/publishing operations.
<RequestReplyMessagePublisher> void	startAsync(CompletionListener<RequestReplyMessagePublisher> startListener) Asynchronously starts service for consuming/publishing operations using a callback for completion notification.

Methods inherited from interface com.solace.messaging.util.LifecycleControl

isRunning, isTerminated, isTerminating, setTerminationNotificationListener, terminate

Methods inherited from interface com.solace.messaging.util.AsyncLifecycleControl

terminateAsync, terminateAsync

Methods inherited from interface com.solace.messaging.publisher.PublisherHealthCheck

isReady, notifyWhenReady, setPublisherReadinessListener

Methods inherited from interface com.solace.messaging.util.ManageablePublisher

publisherInfo

Method Detail

publish

void publish(OutboundMessage requestMessage,
             Properties additionalMessageProperties,
             RequestReplyMessagePublisher.ReplyMessageHandler replyMessageHandler,
             Object userContext,
             Topic requestDestination,
             long replyTimeout)

Sends a request for reply message; nonblocking.

Supports user-context propagation.

The API handles correlation so no special correlation identifier is required.

Parameters:

requestMessage - the request message to send

additionalMessageProperties - the additional properties (Key of type String and Value of type String) to customize a particular message where each key can be customer-provided, or it can be a key from a SolaceProperties.MessageProperties instance

replyMessageHandler - the callback handler to process the reply message when it has arrived or when a timeout has occurred

userContext - the context that's available during response message processing

requestDestination - the destination for request messages

replyTimeout - the maximum time to wait for a response message (in milliseconds)

Throws:

IllegalArgumentException - if the value of the specified replyTimeout is negative value

Since:

1.1

publish

void publish(OutboundMessage requestMessage,
             RequestReplyMessagePublisher.ReplyMessageHandler replyMessageHandler,
             Object userContext,
             Topic requestDestination,
             long replyTimeout)

Sends a request for reply message; nonblocking.

Supports user-context propagation.

The API handles correlation so no special correlation identifier is required.

Parameters:

requestMessage - the request message to send

replyMessageHandler - the callback handler to process the reply message when it has arrived or when a timeout has occurred

userContext - the context that's available during response message processing

requestDestination - the destination for request messages

replyTimeout - the maximum time to wait for a response message (in milliseconds)

Throws:

IllegalArgumentException - if the value of the specified replyTimeout is negative value

Since:

1.1

publish

void publish(OutboundMessage requestMessage,
             RequestReplyMessagePublisher.ReplyMessageHandler replyMessageHandler,
             Topic requestDestination,
             long replyTimeout)

Sends a request for reply message; nonblocking.

The API handles correlation so no special correlation identifier is required.

Parameters:

requestMessage - the request message to send

replyMessageHandler - the callback handler to process the reply message when it has arrived or when a timeout has occurred

requestDestination - the destination for request messages

replyTimeout - the maximum time to wait for a response message (in milliseconds)

Throws:

IllegalArgumentException - if the value of the specified replyTimeout is negative value

Since:

1.1

publishAwaitResponse

InboundMessage publishAwaitResponse(OutboundMessage requestMessage,
                                    Properties additionalMessageProperties,
                                    Topic requestDestination,
                                    long replyTimeout)
                             throws PubSubPlusClientException.TimeoutException,
                                    PubSubPlusClientException.MessageRejectedByBrokerException,
                                    PubSubPlusClientException.PublisherOverflowException,
                                    PubSubPlusClientException,
                                    InterruptedException,
                                    IllegalArgumentException

Sends a request message return response message that blocks until a response is received or a timeout occurs.

Parameters:

requestMessage - the request message to send

additionalMessageProperties - the additional properties (Key of type String and Value of type String) to customize a particular message where each key can be customer-provided, or it can be a key from a SolaceProperties.MessageProperties instance

requestDestination - the destination for request messages

replyTimeout - the maximum time to wait for a response message (in milliseconds)

Returns:

a response message if one is received

Throws:

PubSubPlusClientException.TimeoutException - if the response from a replier does not come on time

PubSubPlusClientException.MessageRejectedByBrokerException - if the broker rejects messages from a publisher

PubSubPlusClientException.PublisherOverflowException - if the internal publishing capacities are exceeded

PubSubPlusClientException - if some internal error occurs

InterruptedException - if any thread has interrupted the current thread. The interrupted status of the current thread is cleared when this exception is thrown.

IllegalArgumentException - if the value of the specified replyTimeout is negative value

Since:

1.1

publishAwaitResponse

InboundMessage publishAwaitResponse(OutboundMessage requestMessage,
                                    Topic requestDestination,
                                    long replyTimeout)
                             throws PubSubPlusClientException.TimeoutException,
                                    PubSubPlusClientException.MessageRejectedByBrokerException,
                                    PubSubPlusClientException.PublisherOverflowException,
                                    PubSubPlusClientException,
                                    InterruptedException,
                                    IllegalArgumentException

Sends a request message return response message that blocks until a response is received or a timeout occurs.

Parameters:

requestMessage - the request message to send

requestDestination - the destination for request messages

replyTimeout - the maximum time to wait for a response message (in milliseconds)

Returns:

a response message if one is received

Throws:

PubSubPlusClientException.TimeoutException - if the response from a replier does not come on time

PubSubPlusClientException.MessageRejectedByBrokerException - if the broker rejects messages from a publisher

PubSubPlusClientException.PublisherOverflowException - if the internal publishing capacities are exceeded

PubSubPlusClientException - if some internal error occurs

InterruptedException - if any thread has interrupted the current thread. The interrupted status of the current thread is cleared when this exception is thrown.

IllegalArgumentException - if the value of the specified replyTimeout is negative value

Since:

1.1

start

RequestReplyMessagePublisher start()

Description copied from interface: LifecycleControl

Enables service regular duties. Before this method is called, the service is considered off-duty. To operate normally, this method needs to be called on a receiver or publisher instance. This method is idempotent.

Specified by:

start in interface LifecycleControl

Returns:

an instance of class on which the method was called to support chaining

startAsync

<RequestReplyMessagePublisher> CompletableFuture<RequestReplyMessagePublisher> startAsync()
                                                                                   throws PubSubPlusClientException

Description copied from interface: AsyncLifecycleControl

Asynchronously starts service for consuming/publishing operations. In order to operate normally, this method needs to be called on a service instance. If the service is started or in the process of being started, this operation has no effect.

This method is an idempotent operation when no another connect/disconnect operation is ongoing.

Specified by:

startAsync in interface AsyncLifecycleControl

Returns:

a future state of the start request that can complete successfully or fail.

Throws:

PubSubPlusClientException - if the messaging service will not start in the future

startAsync

<RequestReplyMessagePublisher> void startAsync(CompletionListener<RequestReplyMessagePublisher> startListener)
                                        throws PubSubPlusClientException,
                                               IllegalStateException

Description copied from interface: AsyncLifecycleControl

Asynchronously starts service for consuming/publishing operations using a callback for completion notification. In order to operate normally, this method needs to be called on a service instance. If the service is started or in the process of being started, this operation has no effect.

Specified by:

startAsync in interface AsyncLifecycleControl

Type Parameters:

RequestReplyMessagePublisher - the type of response returned on a successful start operation

Parameters:

startListener - the callback for future notifications about the completion of the start process

Throws:

PubSubPlusClientException - if the messaging service will not start in the future

IllegalStateException - if the method has been invoked at an illegal or inappropriate time