com.solace.messaging

Interface PersistentMessageReceiverBuilder

All Superinterfaces:

MessageAcknowledgementConfiguration, MessageReceiverBuilder, MessageReplayConfiguration, MissingResourcesCreationConfiguration, PropertyBasedConfiguration, ReceiverActivationPassivationConfiguration, ReceiverPropertyConfiguration

@ProviderType
public interface PersistentMessageReceiverBuilder
extends MessageReceiverBuilder, ReceiverActivationPassivationConfiguration, MessageAcknowledgementConfiguration, MessageReplayConfiguration, MissingResourcesCreationConfiguration

An interface to configure and create instances of PersistentMessageReceiver to receive persistent messages.

This API expected to be thread safe.

Since:

1.0

Nested Class Summary

Nested classes/interfaces inherited from interface com.solace.messaging.config.ReceiverActivationPassivationConfiguration

ReceiverActivationPassivationConfiguration.ReceiverStateChangeListener

Nested classes/interfaces inherited from interface com.solace.messaging.config.MessageAcknowledgementConfiguration

MessageAcknowledgementConfiguration.Outcome

Nested classes/interfaces inherited from interface com.solace.messaging.config.MissingResourcesCreationConfiguration

MissingResourcesCreationConfiguration.MissingResourcesCreationStrategy

Method Summary

Modifier and Type	Method and Description
PersistentMessageReceiver	build(Queue endpointToConsumeFrom) Creates an instance of PersistentMessageReceiver.
PersistentMessageReceiverBuilder	fromProperties(Properties configuration) Enables property-based configuration.
PersistentMessageReceiverBuilder	withActivationPassivationSupport(ReceiverActivationPassivationConfiguration.ReceiverStateChangeListener receiverStateChangeListener) Configures a callback to receive notifications from the broker about state changes regarding a given receiver instance.
PersistentMessageReceiverBuilder	withMessageAutoAcknowledgement() Enables support for message Auto-Acknowledgement (auto-ack) for persistent message receiver.
PersistentMessageReceiverBuilder	withMessageClientAcknowledgement() Enables support for client message acknowledgement on persistent message receiver.
PersistentMessageReceiverBuilder	withMessageReplay(ReplayStrategy replayStrategy) Enables support for message replay using a specific replay strategy.
PersistentMessageReceiverBuilder	withMessageSelector(String selectorQueryExpression) Enables support for message selection based on message header parameter and message properties values.
PersistentMessageReceiverBuilder	withMissingResourcesCreationStrategy(MissingResourcesCreationConfiguration.MissingResourcesCreationStrategy strategy) Provides a framework to configure the missing resources creation strategy using a given instance of MissingResourcesCreationStrategy.
PersistentMessageReceiverBuilder	withRequiredMessageClientOutcomeOperationSupport(MessageAcknowledgementConfiguration.Outcome... requiredOutcomes) Enables required support for all specified settlement options
PersistentMessageReceiverBuilder	withSubscriptions(TopicSubscription... subscriptions) A TopicSubscription can be added to the message receiver before the receiver is started.

Method Detail

build

PersistentMessageReceiver build(Queue endpointToConsumeFrom)
                         throws PubSubPlusClientException

Creates an instance of PersistentMessageReceiver.

Parameters:

endpointToConsumeFrom - a queue for message consumption; use factory methods in Queue interface to create queues for particular purpose (shared or exclusive, durable or non durable)

Returns:

message receiver instance

Throws:

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

Since:

1.0

fromProperties

PersistentMessageReceiverBuilder fromProperties(Properties configuration)

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

withActivationPassivationSupport

PersistentMessageReceiverBuilder withActivationPassivationSupport(ReceiverActivationPassivationConfiguration.ReceiverStateChangeListener receiverStateChangeListener)

Description copied from interface: ReceiverActivationPassivationConfiguration

Configures a callback to receive notifications from the broker about state changes regarding a given receiver instance.

Specified by:

withActivationPassivationSupport in interface ReceiverActivationPassivationConfiguration

Parameters:

receiverStateChangeListener - a listener that is capable to notify about state change of a receiver instance

Returns:

an instance of itself

withMessageAutoAcknowledgement

PersistentMessageReceiverBuilder withMessageAutoAcknowledgement()

Description copied from interface: MessageAcknowledgementConfiguration

Enables support for message Auto-Acknowledgement (auto-ack) for persistent message receiver.

Note:

- For messages received on callback based methods, auto-ack is performed when the message-processing callback method finishes without an error. This means that if the message-processing callback method decides to process messages using another thread, message acknowledgement may be performed before another thread finishes, and any exceptions thrown in the other thread won't be considered.

- For messages received on a blocking receive methods (without callback), auto-ack is performed immediately when the message is passed to the receive (..) method.

Caution is required if this method is used in conjunction with MessageAcknowledgementConfiguration.withRequiredMessageClientOutcomeOperationSupport(Outcome...). See provided javadoc for more details

Specified by:

withMessageAutoAcknowledgement in interface MessageAcknowledgementConfiguration

Returns:

an instance of itself

withMessageClientAcknowledgement

PersistentMessageReceiverBuilder withMessageClientAcknowledgement()

Description copied from interface: MessageAcknowledgementConfiguration

Enables support for client message acknowledgement on persistent message receiver.

Client message acknowledgement is default behaviour, and this method's purpose is to switch back to client acknowledgement after auto-ack was turned on.

Specified by:

withMessageClientAcknowledgement in interface MessageAcknowledgementConfiguration

Returns:

an instance of itself

withMessageReplay

PersistentMessageReceiverBuilder withMessageReplay(ReplayStrategy replayStrategy)

Description copied from interface: MessageReplayConfiguration

Enables support for message replay using a specific replay strategy.

Specified by:

withMessageReplay in interface MessageReplayConfiguration

Parameters:

replayStrategy - the replay strategy to use

Returns:

instance of itself

withMessageSelector

PersistentMessageReceiverBuilder withMessageSelector(String selectorQueryExpression)

Enables support for message selection based on message header parameter and message properties values. When selector is applied, then the receiver gets only messages whose headers and properties match the selector. A message selector cannot select messages on the basis of the content of the message body.

Syntax of the expression is based on a subset of the SQL92 conditional expression syntax. For syntax https://docs.oracle.com/en/database/oracle/oracle-database/20/jajms/javax/jms/Message.html.

Parameters:

selectorQueryExpression - uses JMS like syntax for message selector query expression

Returns:

instance of itself for method chaining

Since:

1.0

See Also:

Message Selectors JavaDoc section

withMissingResourcesCreationStrategy

PersistentMessageReceiverBuilder withMissingResourcesCreationStrategy(MissingResourcesCreationConfiguration.MissingResourcesCreationStrategy strategy)

Description copied from interface: MissingResourcesCreationConfiguration

Provides a framework to configure the missing resources creation strategy using a given instance of MissingResourcesCreationStrategy.

Specified by:

withMissingResourcesCreationStrategy in interface MissingResourcesCreationConfiguration

Parameters:

strategy - the missing resources creation strategy to be used

Returns:

an instance of itself

withRequiredMessageClientOutcomeOperationSupport

PersistentMessageReceiverBuilder withRequiredMessageClientOutcomeOperationSupport(MessageAcknowledgementConfiguration.Outcome... requiredOutcomes)

Description copied from interface: MessageAcknowledgementConfiguration

Enables required support for all specified settlement options

The default value is: Outcome.ACCEPTED.

Enable of negative message settlement options is required to prepare the receiver to work with any of negative message settlement options such as Outcome.FAILED or Outcome.REJECTED

Usage this configuration option in conjunction with Outcome.FAILED and Outcome.REJECTED is mutually exclusive with MessageAcknowledgementConfiguration.withMessageAutoAcknowledgement()

Specified by:

withRequiredMessageClientOutcomeOperationSupport in interface MessageAcknowledgementConfiguration

Parameters:

requiredOutcomes - if set, receiver will respect requirements provided. Start of the receiver with older unsupported broker will be prevented.

Returns:

an instance of itself

withSubscriptions

PersistentMessageReceiverBuilder 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