com.solace.messaging

Interface PersistentMessagePublisherBuilder

All Superinterfaces:

MessagePublisherBuilder, PropertyBasedConfiguration, PublisherBackPressureConfiguration, PublisherPropertyConfiguration

@ProviderType
public interface PersistentMessagePublisherBuilder
extends MessagePublisherBuilder

An interface to configure and create instances of PersistentMessagePublisher to send persistent messages.

This API expected to be thread safe.

Since:

1.0

Method Summary

Modifier and Type	Method and Description
PersistentMessagePublisher	build() Creates an instance of PersistentMessagePublisher.
PersistentMessagePublisherBuilder	fromProperties(Properties configuration) Enables property-based configuration.
PersistentMessagePublisherBuilder	onBackPressureElastic() The configuration for back-pressure with an elastic, unlimited capacity buffer.
PersistentMessagePublisherBuilder	onBackPressureReject(int bufferCapacity) The configuration for back-pressure with a specified number of buffered messages.
PersistentMessagePublisherBuilder	onBackPressureWait(int bufferCapacity) The configuration for back-pressure with specified number of buffered messages.
PersistentMessagePublisherBuilder	withDeliveryAckTimeout(int timeout) Provides an option to configure a message delivery acknowledgement timeout.
PersistentMessagePublisherBuilder	withDeliveryAckWindowSize(int windowSize) Provides an option to configure a maximum number of messages the application can send before the Solace API must receive an acknowledgment from broker.

Method Detail

build

PersistentMessagePublisher build()
                          throws PubSubPlusClientException

Creates an instance of PersistentMessagePublisher.

Returns:

newly created instance of PersistentMessagePublisher

Throws:

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

Since:

1.0

fromProperties

PersistentMessagePublisherBuilder fromProperties(Properties configuration)

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

onBackPressureElastic

PersistentMessagePublisherBuilder 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

onBackPressureReject

PersistentMessagePublisherBuilder 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

PersistentMessagePublisherBuilder 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

withDeliveryAckTimeout

PersistentMessagePublisherBuilder withDeliveryAckTimeout(int timeout)
                                                  throws IllegalArgumentException

Provides an option to configure a message delivery acknowledgement timeout. When a published message is not acknowledged within the specified amount of time, the API automatically retransmits the message.

Parameters:

timeout - the delivery acknowledgement timeout value in milliseconds. The valid range is 20-60000.

Returns:

an instance of itself for method chaining

Throws:

IllegalArgumentException - if timeout is out of range

Since:

1.0

withDeliveryAckWindowSize

PersistentMessagePublisherBuilder withDeliveryAckWindowSize(int windowSize)
                                                     throws IllegalArgumentException

Provides an option to configure a maximum number of messages the application can send before the Solace API must receive an acknowledgment from broker.

Parameters:

windowSize - window size in messages. The valid range is 1-255.

Returns:

instance of itself for method chaining.

Throws:

IllegalArgumentException - if window size is out of range

Since:

1.0