com.solace.messaging.config

Interface SolaceProperties.ReceiverProperties

Enclosing interface:

SolaceProperties

@ProviderType
public static interface SolaceProperties.ReceiverProperties

An interface that defines the configurable properties for MessageReceiver instances. The properties are for use with implementation of MessageReceiverBuilder.fromProperties(Properties).

Example usage:

     final Properties receiverProperties = new Properties();
     receiverProperties.setProperty(ReceiverProperties.DIRECT_BACK_PRESSURE_STRATEGY, ReceiverConstants.RECEIVER_BACK_PRESSURE_STRATEGY_ELASTIC);
     receiverProperties.setProperty(ReceiverProperties.DIRECT_BACK_PRESSURE_BUFFER_CAPACITY, "1000");

     final MessagingService service = new MessagingServiceClientBuilder(ConfigurationProfile.V1).build();
     final DirectMessageReceiverBuilder directMessageReceiverBuilder = service.createDirectMessageReceiverBuilder();
     final DirectMessageReceiver receiver = directMessageReceiverBuilder.fromProperties(receiverProperties).build();
 

Since:

1.0

See Also:

MessageReceiverBuilder.fromProperties(Properties)

Field Summary

Fields

Modifier and Type	Field and Description
static String	DIRECT_BACK_PRESSURE_BUFFER_CAPACITY A property key to define the direct reciever back-pressure buffer capacity measured in messages.
static String	DIRECT_BACK_PRESSURE_STRATEGY A property key to define a direct receiver back-pressure strategy.
static String	PERSISTENT_MESSAGE_ACK_STRATEGY A property key to specify the acknowledgement strategy for the message receiver.
static String	PERSISTENT_MESSAGE_REPLAY_STRATEGY A property key to enable message replay and to specify a replay strategy.
static String	PERSISTENT_MESSAGE_REPLAY_STRATEGY_TIME_BASED_START_TIME A property key to configure time-based replay strategy with a start time.
static String	PERSISTENT_MESSAGE_SELECTOR_QUERY A property key to specify the message-selection query based on the message header parameter and message properties values.
static String	PERSISTENT_MISSING_RESOURCE_CREATION_STRATEGY A property key to specify if and how missing remote resource (i.e., queues) are to be created on a broker prior to receiving persistent messages.
static String	PERSISTENT_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	PERSISTENT_RECONNECTION_ATTEMPTS_WAIT_INTERVAL Property key to specify the time (in ms) to wait between each attempt to reconnect to an endpoint.
static String	PERSISTENT_REPLAY_REPLICATION_GROUP_MESSAGE_ID A property key to configure replay after given replication message id.
static String	PERSISTENT_STATE_CHANGE_LISTENER A property key to specify to use the callback (ReceiverStateChangeListener and enable activation and passivation support.

Field Detail

DIRECT_BACK_PRESSURE_STRATEGY

@PropertiesKey(target=MessageReceiver.class,
               valueType=java.lang.String.class)
static final String DIRECT_BACK_PRESSURE_STRATEGY

A property key to define a direct receiver back-pressure strategy. The valid values are defined in SolaceConstants.ReceiverConstants.RECEIVER_BACK_PRESSURE_STRATEGY_DROP_LATEST and SolaceConstants.ReceiverConstants.RECEIVER_BACK_PRESSURE_STRATEGY_DROP_OLDEST; default value is SolaceConstants.ReceiverConstants.RECEIVER_BACK_PRESSURE_STRATEGY_ELASTIC.

Since:

1.0

See Also:

Constant Field Values

DIRECT_BACK_PRESSURE_BUFFER_CAPACITY

@PropertiesKey(target=MessageReceiver.class,
               valueType=int.class)
static final String DIRECT_BACK_PRESSURE_BUFFER_CAPACITY

A property key to define the direct reciever back-pressure buffer capacity measured in messages. This property only has effect in conjunction with the back-pressure strategy SolaceConstants.ReceiverConstants.RECEIVER_BACK_PRESSURE_STRATEGY_DROP_OLDEST and SolaceConstants.ReceiverConstants.RECEIVER_BACK_PRESSURE_STRATEGY_DROP_LATEST.

Since:

1.0

See Also:

Constant Field Values

PERSISTENT_RECONNECTION_ATTEMPTS

@PropertiesKey(target=MessageReceiver.class,
               valueType=int.class)
static final String PERSISTENT_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. Setting this property is optional.

Since:

1.0

See Also:

Constant Field Values

PERSISTENT_RECONNECTION_ATTEMPTS_WAIT_INTERVAL

@PropertiesKey(target=MessageReceiver.class,
               valueType=int.class)
static final String PERSISTENT_RECONNECTION_ATTEMPTS_WAIT_INTERVAL

Property key to specify the time (in ms) to wait between each attempt to reconnect 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.0

See Also:

Constant Field Values

PERSISTENT_MISSING_RESOURCE_CREATION_STRATEGY

@PropertiesKey(target=MessageReceiver.class,
               valueType=java.lang.String.class)
static final String PERSISTENT_MISSING_RESOURCE_CREATION_STRATEGY

A property key to specify if and how missing remote resource (i.e., queues) are to be created on a broker prior to receiving persistent messages.

The valid values are found in SolaceConstants.ReceiverConstants.PERSISTENT_RECEIVER_CREATE_ON_START_MISSING_RESOURCES and SolaceConstants.ReceiverConstants.PERSISTENT_RECEIVER_DO_NOT_CREATE_MISSING_RESOURCES.

Since:

1.0

See Also:

Constant Field Values

PERSISTENT_MESSAGE_SELECTOR_QUERY

@PropertiesKey(target=MessageReceiver.class,
               valueType=java.lang.String.class)
static final String PERSISTENT_MESSAGE_SELECTOR_QUERY

A property key to specify the message-selection query 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.0

See Also:

Message Selectors JavaDoc section, Constant Field Values

PERSISTENT_STATE_CHANGE_LISTENER

@PropertiesKey(target=MessageReceiver.class,
               valueType=java.lang.Object.class)
static final String PERSISTENT_STATE_CHANGE_LISTENER

A property key to specify to use the callback (ReceiverStateChangeListener and enable activation and passivation support.

Since:

1.0

See Also:

Constant Field Values

PERSISTENT_MESSAGE_ACK_STRATEGY

@PropertiesKey(target=MessageReceiver.class,
               valueType=java.lang.String.class)
static final String PERSISTENT_MESSAGE_ACK_STRATEGY

A property key to specify the acknowledgement strategy for the message receiver. The valid values are defined in SolaceConstants.ReceiverConstants.PERSISTENT_RECEIVER_AUTO_ACK and SolaceConstants.ReceiverConstants.PERSISTENT_RECEIVER_CLIENT_ACK.

Since:

1.0

See Also:

Constant Field Values

PERSISTENT_MESSAGE_REPLAY_STRATEGY

@PropertiesKey(target=MessageReceiver.class,
               valueType=java.lang.String.class)
static final String PERSISTENT_MESSAGE_REPLAY_STRATEGY

A property key to enable message replay and to specify a replay strategy. The valid values are defined in SolaceConstants.ReceiverConstants.PERSISTENT_REPLAY_ALL, SolaceConstants.ReceiverConstants.PERSISTENT_REPLAY_TIME_BASED and SolaceConstants.ReceiverConstants.PERSISTENT_REPLAY_REPLICATION_GROUP_MESSAGE_ID_BASED.

Since:

1.0

See Also:

Constant Field Values

PERSISTENT_MESSAGE_REPLAY_STRATEGY_TIME_BASED_START_TIME

@PropertiesKey(target=MessageReceiver.class,
               valueType=java.time.ZonedDateTime.class)
static final String PERSISTENT_MESSAGE_REPLAY_STRATEGY_TIME_BASED_START_TIME

A property key to configure time-based replay strategy with a start time.

Since:

1.0

See Also:

Constant Field Values

PERSISTENT_REPLAY_REPLICATION_GROUP_MESSAGE_ID

@PropertiesKey(target=MessageReceiver.class,
               valueType=java.lang.String.class)
static final String PERSISTENT_REPLAY_REPLICATION_GROUP_MESSAGE_ID

A property key to configure replay after given replication message id.

See Also:

Constant Field Values