com.solace.messaging

Interface MessageQueueBrowserBuilder

All Superinterfaces:

PropertyBasedConfiguration, ReceiverPropertyConfiguration

@ProviderType
public interface MessageQueueBrowserBuilder
extends ReceiverPropertyConfiguration

An interface to configure and create instances of MessageQueueBrowser to look at persistent messages without consuming them. A client can selectively remove spooled persistent messages while browsing a Queue. Removing browsed messages deletes them from the Queue, so that they can no longer be delivered to consuming clients (or redelivered if they were already delivered to consumers at some point. No confirmation is returned when a message is removed. Further, no error is returned if you try to remove a non-existent message or a message that has already been removed from a Queue.

This API expected to be thread safe.

Since:

1.2.0

Method Summary

Modifier and Type	Method and Description
MessageQueueBrowser	build(Queue endpointToConsumeFrom) Creates an instance of MessageQueueBrowser.
MessageQueueBrowserBuilder	fromProperties(Properties configuration) Enables property-based configuration.
MessageQueueBrowserBuilder	withMessageSelector(String selectorQueryExpression) Enables support for message selection for a queue browser based on message header parameter and message properties values.
MessageQueueBrowserBuilder	withQueueBrowserWindowSize(int windowSize) Provides an option to configure a maximum number of messages that can be pre-fetched by the Browser

Method Detail

build

MessageQueueBrowser build(Queue endpointToConsumeFrom)
                   throws PubSubPlusClientException

Creates an instance of MessageQueueBrowser.

Parameters:

endpointToConsumeFrom - a queue for message browsing; use factory methods in Queue interface to create Queue object that represents the target queue on the broker. Queue to be browsed must exist on Broker as MessageQueueBrowser does not support MissingResourcesCreationStrategy to create a queue that does not previously exist.

Returns:

message browser instance

Throws:

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

Since:

1.2.0

fromProperties

MessageQueueBrowserBuilder fromProperties(Properties configuration)

Enables property-based configuration.

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.QueueBrowserProperties for the list of MessageQueueBrowser properties configurable through this MessageQueueBrowserBuilder

Returns:

instance of itself

Throws:

IllegalArgumentException - if invalid properties were specified

Since:

1.0

withMessageSelector

MessageQueueBrowserBuilder withMessageSelector(String selectorQueryExpression)

Enables support for message selection for a queue browser based on message header parameter and message properties values. When selector is applied, then the browser 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.2.0

See Also:

Message Selectors JavaDoc section

withQueueBrowserWindowSize

MessageQueueBrowserBuilder withQueueBrowserWindowSize(int windowSize)
                                               throws IllegalArgumentException

Provides an option to configure a maximum number of messages that can be pre-fetched by the Browser

Parameters:

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

Returns:

instance of itself for method chaining.

Throws:

IllegalArgumentException - if window size is out of range

Since:

1.2.0