com.solace.messaging

Interface RequestReplyMessageReceiverBuilder

All Superinterfaces:

PropertyBasedConfiguration, ReceiverPropertyConfiguration

@ProviderType
public interface RequestReplyMessageReceiverBuilder
extends ReceiverPropertyConfiguration

A builder class to configure and create instances of RequestReplyMessageReceiver.

This API expected to be thread safe.

Since:

1.1

Method Summary

Modifier and Type	Method and Description
RequestReplyMessageReceiver	build(TopicSubscription requestTopicSubscription) Builds a request-reply message receiver with the specified topic subscription.
RequestReplyMessageReceiver	build(TopicSubscription requestTopicSubscription, ShareName shareName) Builds a request-reply message receiver with a shared topic subscription and the shared name.
RequestReplyMessageReceiverBuilder	fromProperties(Properties configuration) Enables property-based configuration and extended fine-tuning of the message receiver.
RequestReplyMessageReceiverBuilder	onReplierBackPressureElastic() The configuration for back-pressure with an elastic, unlimited capacity buffer.
RequestReplyMessageReceiverBuilder	onReplierBackPressureReject(int bufferCapacity) The configuration for back-pressure with a specified number of buffered messages.
RequestReplyMessageReceiverBuilder	onReplierBackPressureWait(int bufferCapacity) The configuration for back-pressure with specified number of buffered messages.

Method Detail

build

RequestReplyMessageReceiver build(TopicSubscription requestTopicSubscription)
                           throws PubSubPlusClientException

Builds a request-reply message receiver with the specified topic subscription.

Parameters:

requestTopicSubscription - the topic subscription

Returns:

a new instance of RequestReplyMessageReceiver

Throws:

PubSubPlusClientException - if unable to build an new instance of a message receiver

Since:

1.1

build

RequestReplyMessageReceiver build(TopicSubscription requestTopicSubscription,
                                  ShareName shareName)
                           throws PubSubPlusClientException

Builds a request-reply message receiver with a shared topic subscription and the shared name.

Parameters:

requestTopicSubscription - the topic subscription

shareName - the share name describes a group of receiver to an identical set of topic subscriptions, expected not to be null or name not to be empty

Returns:

a new instance of RequestReplyMessageReceiver

Throws:

PubSubPlusClientException - if unable to build new instance of a receiver

Since:

1.1

fromProperties

RequestReplyMessageReceiverBuilder fromProperties(Properties configuration)
                                           throws IllegalArgumentException

Description copied from interface: ReceiverPropertyConfiguration

Enables property-based configuration and extended fine-tuning of the message receiver.

Note: Callbacks cannot be configured using properties.

Specified by:

fromProperties in interface PropertyBasedConfiguration

Specified by:

fromProperties in interface ReceiverPropertyConfiguration

Parameters:

configuration - the properties to use to fine-tune the message receiver

Returns:

an instance of itself

Throws:

IllegalArgumentException - if invalid properties where specified

onReplierBackPressureElastic

RequestReplyMessageReceiverBuilder onReplierBackPressureElastic()

The configuration for back-pressure with an elastic, unlimited capacity buffer. This configuration is recommended for microservices that run in a managed environment which can detect crashes and restart those microservices. Usage of this strategy for applications can lead to out-of-memory situations.

Returns:

an instance of itself

Since:

1.1

onReplierBackPressureReject

RequestReplyMessageReceiverBuilder onReplierBackPressureReject(int bufferCapacity)

The configuration for back-pressure with a specified number of buffered messages. Usage of this configuration means that attempts to publish are rejected with a PubSubPlusClientException.PublisherOverflowException exception when the publishing capabilities of the API are exceeded.

Parameters:

bufferCapacity - the maximum number of messages that can be buffered before the strategy fails and messages can no longer be sent over the wire. Once this number is exceeded, the publishing of new messages is no longer possible and exceptions are thrown until the buffer has free capacity; value > 0 is expected.

Returns:

an instance of itself

Since:

1.1

onReplierBackPressureWait

RequestReplyMessageReceiverBuilder onReplierBackPressureWait(int bufferCapacity)

The configuration for back-pressure with specified number of buffered messages. Usage of this configuration means that attempts to publish beyond the specified bufferCapacity causes the publisher thread to pause.

Parameters:

bufferCapacity - the maximum number of messages that can be buffered before the publishing thread is paused

Returns:

an instance of itself

Since:

1.1