com.solace.messaging

Interface DirectMessagePublisherBuilder

All Superinterfaces:

MessagePublisherBuilder, PropertyBasedConfiguration, PublisherBackPressureConfiguration, PublisherPropertyConfiguration

@ProviderType
public interface DirectMessagePublisherBuilder
extends MessagePublisherBuilder

An interface to configure and create instances of DirectMessagePublisher to publish direct messages.

This API expected to be thread safe.

Since:

1.0

Method Summary

Modifier and Type	Method and Description
DirectMessagePublisher	build() Builds a new instance of DirectMessagePublisher based on the provided configuration.
DirectMessagePublisherBuilder	fromProperties(Properties configuration) Enables property-based configuration.
DirectMessagePublisherBuilder	onBackPressureElastic() The configuration for back-pressure with an elastic, unlimited capacity buffer.
DirectMessagePublisherBuilder	onBackPressureReject(int bufferCapacity) The configuration for back-pressure with a specified number of buffered messages.
DirectMessagePublisherBuilder	onBackPressureWait(int bufferCapacity) The configuration for back-pressure with specified number of buffered messages.

Method Detail

fromProperties

DirectMessagePublisherBuilder fromProperties(Properties configuration)
                                      throws IllegalArgumentException

Description copied from interface: MessagePublisherBuilder

Enables property-based configuration.

Specified by:

fromProperties in interface MessagePublisherBuilder

Specified by:

fromProperties in interface PropertyBasedConfiguration

Specified by:

fromProperties in interface PublisherPropertyConfiguration

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.PublisherProperties for the list of MessagePublisher properties configurable through this MessagePublisherBuilder

Returns:

instance of itself

Throws:

IllegalArgumentException - if invalid properties were specified

onBackPressureReject

DirectMessagePublisherBuilder onBackPressureReject(int bufferCapacity)

Description copied from interface: PublisherBackPressureConfiguration

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.

Specified by:

onBackPressureReject in interface PublisherBackPressureConfiguration

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

onBackPressureWait

DirectMessagePublisherBuilder onBackPressureWait(int bufferCapacity)

Description copied from interface: PublisherBackPressureConfiguration

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.

Specified by:

onBackPressureWait in interface PublisherBackPressureConfiguration

Parameters:

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

Returns:

an instance of itself

onBackPressureElastic

DirectMessagePublisherBuilder onBackPressureElastic()

Description copied from interface: PublisherBackPressureConfiguration

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 PublisherBackPressureConfiguration

Returns:

an instance of itself

build

DirectMessagePublisher build()
                      throws PubSubPlusClientException

Builds a new instance of DirectMessagePublisher based on the provided configuration.

Throws:

PubSubPlusClientException - if a publisher for direct messages cannot be created due to invalid properties or invalid configuration

Since:

1.0