solace.messaging.config.solace_constants package
solace.messaging.config.solace_constants.authentication_constants module
This module contains the acceptable dictionary values for the keys found in
solace.messaging.config.solace_properties.authentication_properties
.
These keys are used to configure the properties of
solace.messaging.config.authentication_strategy.AuthenticationStrategy
.
- solace.messaging.config.solace_constants.authentication_constants.AUTHENTICATION_SCHEME_BASIC = 'AUTHENTICATION_SCHEME_BASIC'
This is an acceptable value for the authentication strategy property
SCHEME
.
- solace.messaging.config.solace_constants.authentication_constants.AUTHENTICATION_SCHEME_CLIENT_CERT = 'AUTHENTICATION_SCHEME_CLIENT_CERTIFICATE'
This is an acceptable value for the authentication strategy property
SCHEME
.
solace.messaging.config.solace_constants.message_user_property_constants module
An interface for constant property values to define user message properties that have a special reserved meaning or behaviour.
- solace.messaging.config.solace_constants.message_user_property_constants.QUEUE_PARTITION_KEY = 'JMSXGroupID'
A standard property key that clients should use if they want to group messages. It is used to specify a partition queue name, when supported by a PubSub+ messaging broker. Expected value is UTF-8 encoded up to 255 bytes long string. This constant can be passed as the property string to any generic property setter on the OutboundMessageBuilder that can take properties from
message_properties
as a parameter, such aswith_property()
.
solace.messaging.config.solace_constants.publisher_constants module
This module contains the acceptable dictionary values for the keys found in
solace.messaging.config.solace_properties.publisher_properties
.
These keys are used to configure the properties of
solace.messaging.publisher.message_publisher.MessagePublisher
.
- solace.messaging.config.solace_constants.publisher_constants.PUBLISHER_BACK_PRESSURE_STRATEGY_BUFFER_REJECT_WHEN_FULL = 'BUFFER_REJECT_WHEN_FULL'
This constant contains the acceptable value for configuring reject back pressure using the
solace.messaging.config.solace_properties.publisher_properties.PUBLISHER_BACK_PRESSURE_STRATEGY
property. This property of the message publisher can be configured using thesolace.messaging.builder.message_publisher_builder.MessagePublisherBuilder.from_properties()
method. This from_properties method is an alternative measn to the direct means of setting the back pressure of a publisher through thesolace.messaging.builder.message_publisher_builder.MessagePublisher.on_back_pressure_reject()
method.
- solace.messaging.config.solace_constants.publisher_constants.PUBLISHER_BACK_PRESSURE_STRATEGY_BUFFER_WAIT_WHEN_FULL = 'BUFFER_WAIT_WHEN_FULL'
This constant contains the acceptable value for configuring wait back pressure using the
solace.messaging.config.solace_properties.publisher_properties.PUBLISHER_BACK_PRESSURE_STRATEGY
property. This property of the message publisher can be configured using thesolace.messaging.builder.message_publisher_builder.MessagePublisherBuilder.from_properties()
method. This from_properties method is an alternative means to the direct means of setting the back pressure of a publisher through thesolace.messaging.builder.message_publisher_builder.MessagePublisher.on_back_pressure_wait()
method.
- solace.messaging.config.solace_constants.publisher_constants.PUBLISHER_BACK_PRESSURE_STRATEGY_ELASTIC = 'ELASTIC'
This constant contains the acceptable value for configuring elastic back pressure using the
solace.messaging.config.solace_properties.publisher_properties.PUBLISHER_BACK_PRESSURE_STRATEGY
property. This property of the message publisher can be configured using thesolace.messaging.builder.message_publisher_builder.MessagePublisherBuilder.from_properties()
method. This from_properties method is an alternative means to the direct means of setting the back pressure of a publisher through thesolace.messaging.builder.message_publisher_builder.MessagePublisher.on_back_pressure_elastic()
method.
solace.messaging.config.solace_constants.receiver_constants module
This module contains the acceptable dictionary values for the keys found in
solace.messaging.config.solace_properties.receiver_properties
.
These keys are used to configure the properties of
solace.messaging.receiver.message_receiver.MessageReceiver
.
- solace.messaging.config.solace_constants.receiver_constants.PERSISTENT_RECEIVER_AUTO_ACK = 'AUTO_ACK'
This is a constant containing the acceptable value of the
solace.messaging.config.solace_properties.receiver_properties.PERSISTENT_MESSAGE_ACK_STRATEGY
property key. This constant represents a strategy for the auto-acknowledgement of messages before they are processed by the application with any of receive methods. This property-constant mapping can be used in a dict typed configuration object to configure the strategy for acknowledging received messages through thePersistentMessageReceiverBuilder.from_properties()
method. This method is an alternative to the direct means of setting the strategy for acknowledging messages received by a persistent message receiver through thePersistentMessageReceiverBuilder.with_message_auto_acknowledgement
method.
- solace.messaging.config.solace_constants.receiver_constants.PERSISTENT_RECEIVER_CLIENT_ACK = 'CLIENT_ACK'
This is a constant containing the acceptable value of the
solace.messaging.config.solace_properties.receiver_properties.PERSISTENT_MESSAGE_ACK_STRATEGY
property key. This constant represents a strategy for the manual acknowledgement of messages by the client. This property-constant mapping can be used in a dict typed configuration object to configure the strategy for acknowledging received messages through thePersistentMessageReceiverBuilder.from_properties()
method. This method is an alternative to the direct means of setting the strategy for acknowledging messages received by a persistent message receiver through thePersistentMessageReceiverBuilder.with_message_client_acknowledgement
method.
- solace.messaging.config.solace_constants.receiver_constants.PERSISTENT_RECEIVER_CREATE_ON_START_MISSING_RESOURCES = 'CREATE_ON_START'
This is a constant containing the acceptable value of the
solace.messaging.config.solace_properties.receiver_properties.PERSISTENT_MISSING_RESOURCE_CREATION_STRATEGY
property key. This constant represents a strategy that tries to create all potentially missing resources (i.e. queues) on a broker when the receiver starts.This property-constant mapping can be used in a dict typed configuration object to configure the strategy for creating missing resources through thePersistentMessageReceiverBuilder.from_properties()
method. This method is an alternative to the direct means of setting the missing resource creation strategy of a persistent message receiver through thePersistentMessageReceiverBuilder.with_missing_resources_creation_strategy()`
method.
- solace.messaging.config.solace_constants.receiver_constants.PERSISTENT_RECEIVER_DO_NOT_CREATE_MISSING_RESOURCES = 'DO_NOT_CREATE'
This is a constant containing the acceptable value of the
solace.messaging.config.solace_properties.receiver_properties.PERSISTENT_MISSING_RESOURCE_CREATION_STRATEGY
property key. This constant represents a strategy to avoid the creation of any potentially missing resources (i.e. queues) on a broker. This property-constant mapping can be used in a dict typed configuration object to configure the strategy for creating missing resources through thePersistentMessageReceiverBuilder.from_properties()
method. This method is an alternative to the direct means of setting the missing resource creation strategy of a persistent message receiver through thePersistentMessageReceiverBuilder.with_missing_resources_creation_strategy()`
method.
- solace.messaging.config.solace_constants.receiver_constants.PERSISTENT_REPLAY_ALL = 'REPLAY_ALL'
This is a constant containing an acceptable value of the
solace.messaging.config.solace_properties.receiver_properties.PERSISTENT_MESSAGE_REPLAY_STRATEGY
property key. This property-constant mapping can be used in a dict typed configuration object to configure message replay for all messages for persistent receiver through thePersistentMessageReceiverBuilder.from_properties()
method. This method is an alternative to the direct means of setting the replay strategy of a persistent receiver through thePersistentMessageReceiverBuilder.with_replay_strategy()
method.
- solace.messaging.config.solace_constants.receiver_constants.PERSISTENT_REPLAY_ID_BASED = 'REPLAY_ID_BASED'
This is a constant containing an acceptable value of the
solace.messaging.config.solace_properties.receiver_properties.PERSISTENT_MESSAGE_REPLAY_STRATEGY
property key. This property-constant mapping can be used in a dict typed configuration object to configure message replay all messages after a message identified by a message ID in replay log for persistent receiver through thePersistentMessageReceiverBuilder.from_properties()
method. This method is an alternative to the direct means of setting the replay strategy of a persistent receiver through thePersistentMessageReceiverBuilder.with_replay_strategy()
method.
- solace.messaging.config.solace_constants.receiver_constants.PERSISTENT_REPLAY_TIME_BASED = 'REPLAY_TIME_BASED'
This is a constant containing an acceptable value of the
solace.messaging.config.solace_properties.receiver_properties.PERSISTENT_MESSAGE_REPLAY_STRATEGY
property key. This property-constant mapping can be used in a dict typed configuration object to configure message replay from a point of time in replay log for persistent receiver through thePersistentMessageReceiverBuilder.from_properties()
method. This method is an alternative to the direct means of setting the replay strategy of a persistent receiver through thePersistentMessageReceiverBuilder.with_replay_strategy()
method.
- solace.messaging.config.solace_constants.receiver_constants.RECEIVER_BACK_PRESSURE_STRATEGY_DROP_LATEST = 'BUFFER_DROP_LATEST_WHEN_FULL'
This is a constant containing the acceptable value of the
solace.messaging.config.solace_properties.receiver_properties.DIRECT_BACK_PRESSURE_STRATEGY
property key. This property-constant mapping can be used in a dict typed configuration object to configure drop-latest back pressure for a direct receiver through theDirectMessageReceiverBuilder.from_properties()
method. This method is an alternative to the direct means of setting the back pressure of a direct receiver through theDirectMessageReceiverBuilder.on_back_pressure_latest().solace.messaging.builder.direct_message_receiver_builder.DirectMessageReceiverBuilder.on_back_pressure_latest>()
method.
- solace.messaging.config.solace_constants.receiver_constants.RECEIVER_BACK_PRESSURE_STRATEGY_DROP_OLDEST = 'BUFFER_DROP_OLDEST_WHEN_FULL'
This is a constant containing the acceptable value of the
solace.messaging.config.solace_properties.receiver_properties.DIRECT_BACK_PRESSURE_STRATEGY
property key. This property-constant mapping can be used in a dict typed configuration object to configure drop-oldest back pressure for a direct receiver through theDirectMessageReceiverBuilder.from_properties()
method. This method is an alternative to the direct means of setting the back pressure of a direct receiver through theDirectMessageReceiverBuilder.on_back_pressure_oldest()
method.
- solace.messaging.config.solace_constants.receiver_constants.RECEIVER_BACK_PRESSURE_STRATEGY_ELASTIC = 'ELASTIC'
This is a constant containing the acceptable value of the
solace.messaging.config.solace_properties.receiver_properties.DIRECT_BACK_PRESSURE_STRATEGY
property key. This property-constant mapping can be used in a dict typed configuration object to configure elastic back pressure for a direct receiver through theDirectMessageReceiverBuilder.from_properties()
method. This method is an alternative to the direct means of setting the back pressure of a direct receiver through theDirectMessageReceiverBuilder.on_back_pressure_elastic()
method.