com.solace.messaging.config

Interface SolaceProperties.QueueBrowserProperties

Enclosing interface:

SolaceProperties

@ProviderType
public static interface SolaceProperties.QueueBrowserProperties

An interface that defines the message queue browser configurable properties for MessageQueueBrowser instances. The properties are for use with implementation of MessageQueueBrowserBuilder.fromProperties(Properties).

Example usage:

     final Properties browserProperties = new Properties();
     browserProperties.setProperty(QueueBrowserProperties.QUEUE_BROWSER_WINDOW_SIZE, "50");
     browserProperties.setProperty(QueueBrowserProperties.QUEUE_BROWSER_RECONNECTION_ATTEMPTS, "5");

     final MessagingService service = new MessagingServiceClientBuilder(ConfigurationProfile.V1).build();
     final MessageQueueBrowserBuilder messageBrowserBuilder = service.createMessageQueueBrowserBuilder();
     final Queue endpointToConsumeFrom = Queue.durableExclusiveQueue("testQueue");
     final MessageQueueBrowser browser = messageBrowserBuilder.fromProperties(browserProperties).build(endpointToConsumeFrom);
 

Since:

1.2.0

See Also:

MessageQueueBrowserBuilder.fromProperties(Properties)

Field Summary

Fields

Modifier and Type	Field and Description
static String	QUEUE_BROWSER_MESSAGE_SELECTOR_QUERY A property key to specify the message-selection query for a queue browser based on the message header parameter and message properties values.
static String	QUEUE_BROWSER_RECONNECTION_ATTEMPTS Property key to specify the number of times to attempt to reconnect to an endpoint after the initial bound flow goes down.
static String	QUEUE_BROWSER_RECONNECTION_ATTEMPTS_WAIT_INTERVAL Property key to specify the time (in ms) to wait between each attempt to reconnect from a queue browser to an endpoint.
static String	QUEUE_BROWSER_WINDOW_SIZE A property key to specify a maximum number of messages that can be pre-fetched by the queue browser.

Field Detail

QUEUE_BROWSER_MESSAGE_SELECTOR_QUERY

@PropertiesKey(target=MessageQueueBrowser.class,
               valueType=java.lang.String.class)
static final String QUEUE_BROWSER_MESSAGE_SELECTOR_QUERY

A property key to specify the message-selection query for a queue browser based on the message header parameter and message properties values. When a selector is applied then the receiver receives 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.

Since:

1.2.0

See Also:

Message Selectors JavaDoc section, Constant Field Values

QUEUE_BROWSER_RECONNECTION_ATTEMPTS

@PropertiesKey(target=MessageQueueBrowser.class,
               valueType=int.class)
static final String QUEUE_BROWSER_RECONNECTION_ATTEMPTS

Property key to specify the number of times to attempt to reconnect to an endpoint after the initial bound flow goes down.

The valid value range is from -1 to Integer.MAX_VALUE. A value of -1 indicates the infinite retry. Default value is -1. Setting this property is optional.

Since:

1.2.0

See Also:

Constant Field Values

QUEUE_BROWSER_RECONNECTION_ATTEMPTS_WAIT_INTERVAL

@PropertiesKey(target=MessageQueueBrowser.class,
               valueType=int.class)
static final String QUEUE_BROWSER_RECONNECTION_ATTEMPTS_WAIT_INTERVAL

Property key to specify the time (in ms) to wait between each attempt to reconnect from a queue browser to an endpoint.

The valid value range is from 50 to Integer.MAX_VALUE. Default value is 3000. Setting this property is optional.

Since:

1.2.0

See Also:

Constant Field Values

QUEUE_BROWSER_WINDOW_SIZE

@PropertiesKey(target=MessageQueueBrowser.class,
               valueType=int.class)
static final String QUEUE_BROWSER_WINDOW_SIZE

A property key to specify a maximum number of messages that can be pre-fetched by the queue browser. The valid range from 1 to 255. Default value is 255.

Since:

1.2.0

See Also:

Constant Field Values