com.solace.messaging

Interface DirectMessageReceiverBuilder

All Superinterfaces:

DirectReceiverBackPressureConfiguration, MessageReceiverBuilder, PropertyBasedConfiguration, ReceiverPropertyConfiguration

@ProviderType
public interface DirectMessageReceiverBuilder
extends MessageReceiverBuilder, DirectReceiverBackPressureConfiguration

An interface to configure and create instances of DirectMessageReceiver.

This API expected to be thread safe.

Since:

1.0

Method Summary

Modifier and Type	Method and Description
DirectMessageReceiver	build() Creates a new instance of DirectMessageReceiver based on the provided configuration, to be used in applications when distribution of messages among different application instances for horizontal scalability purposes does not matter.
DirectMessageReceiver	build(ShareName shareName) Creates a new instance of DirectMessageReceiver to be used in applications designed with horizontal scalability in mind with more than one instance running.
DirectMessageReceiverBuilder	fromProperties(Properties configuration) Enables property-based configuration.
DirectMessageReceiverBuilder	onBackPressureDropLatest(int bufferCapacity) The Configuration for back-pressure with a specified number of pre-buffered received messages.
DirectMessageReceiverBuilder	onBackPressureDropOldest(int bufferCapacity) The Configuration for back-pressure with a specified number of pre-buffered received messages.
DirectMessageReceiverBuilder	onBackPressureElastic() The configuration for back-pressure with an elastic, unlimited capacity buffer.
DirectMessageReceiverBuilder	withSubscriptions(TopicSubscription... subscriptions) A TopicSubscription can be added to the message receiver before the receiver is started.

Method Detail

build

DirectMessageReceiver build()
                     throws PubSubPlusClientException

Creates a new instance of DirectMessageReceiver based on the provided configuration, to be used in applications when distribution of messages among different application instances for horizontal scalability purposes does not matter. ALL messages matching configured TopicSubscription will be routed to the message receiver instance. It does not matter if application scaled horizontally and there is more than one instance running; all messages will be routed to all receiver based on configured topic subscriptions.

Returns:

receiver instance

Throws:

PubSubPlusClientException - if the receiver instance cannot be built due to invalid properties or invalid configuration

build

DirectMessageReceiver build(ShareName shareName)
                     throws PubSubPlusClientException

Creates a new instance of DirectMessageReceiver to be used in applications designed with horizontal scalability in mind with more than one instance running.

This method should be used when more then one instance of the application is running for horizontal scaling and messages should be distributed among different instances

Parameters:

shareName - he 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:

message receiver instance for an shared access to subscriptions

Throws:

PubSubPlusClientException - if the receiver instance cannot be built due to invalid properties or invalid configuration

fromProperties

DirectMessageReceiverBuilder fromProperties(Properties configuration)
                                     throws IllegalArgumentException

Description copied from interface: MessageReceiverBuilder

Enables property-based configuration.

Specified by:

fromProperties in interface MessageReceiverBuilder

Specified by:

fromProperties in interface PropertyBasedConfiguration

Specified by:

fromProperties in interface ReceiverPropertyConfiguration

Parameters:

configuration - the properties (key of type String and value of type String) for configuration and fine-tuning. Common properties can be found in SolaceProperties and its sub-interfaces. Refer the SolaceProperties.ReceiverProperties for the list of MessageReceiver properties configurable through this MessageReceiverBuilder

Returns:

instance of itself

Throws:

IllegalArgumentException - if invalid properties were specified

onBackPressureDropLatest

DirectMessageReceiverBuilder onBackPressureDropLatest(int bufferCapacity)

Description copied from interface: DirectReceiverBackPressureConfiguration

The Configuration for back-pressure with a specified number of pre-buffered received messages. This configuration drops any new items emitted by the producer (publisher) when the buffer is full.

Specified by:

onBackPressureDropLatest in interface DirectReceiverBackPressureConfiguration

Parameters:

bufferCapacity - the maximum number of messages in a buffer; a value '>' 0 is permitted

Returns:

an instance of itself

onBackPressureDropOldest

DirectMessageReceiverBuilder onBackPressureDropOldest(int bufferCapacity)

Description copied from interface: DirectReceiverBackPressureConfiguration

The Configuration for back-pressure with a specified number of pre-buffered received messages. This configuration drops the oldest messages emitted by the producer (publisher) when the buffer is full.

Specified by:

onBackPressureDropOldest in interface DirectReceiverBackPressureConfiguration

Parameters:

bufferCapacity - the maximum number of messages in a buffer; a value '>' 0 is permitted

Returns:

an instance of itself

onBackPressureElastic

DirectMessageReceiverBuilder onBackPressureElastic()

Description copied from interface: DirectReceiverBackPressureConfiguration

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.

Specified by:

onBackPressureElastic in interface DirectReceiverBackPressureConfiguration

Returns:

an instance of itself

withSubscriptions

DirectMessageReceiverBuilder withSubscriptions(TopicSubscription... subscriptions)

Description copied from interface: MessageReceiverBuilder

A TopicSubscription can be added to the message receiver before the receiver is started. It is also possible to add topic subscriptions at later time before or after receiver is started. When topic subscriptions are successfully added, the receiver is expected to receive messages that are sent to the matching topic subscriptions.

Specified by:

withSubscriptions in interface MessageReceiverBuilder

Parameters:

subscriptions - the list of topic subscriptions to add

Returns:

an instance of itself for method chaining