com.solace.messaging.config

Interface SolaceProperties.ServiceProperties

Enclosing interface:

SolaceProperties

@ProviderType
public static interface SolaceProperties.ServiceProperties

An interface that defines the properties to configure MessagingService instances. The properties are for use with MessagingServiceClientBuilder.fromProperties(Properties).

Example usage:

     final Properties serviceProperties = new Properties();
     serviceProperties.setProperty(ServiceProperties.GENERATE_SENDER_ID, "true");
     serviceProperties.setProperty(ServiceProperties.GENERATE_RECEIVE_TIMESTAMPS, "true");
     serviceProperties.setProperty(ServiceProperties.GENERATE_SEND_TIMESTAMPS, "true");
     serviceProperties.setProperty(ServiceProperties.RECEIVER_DIRECT_SUBSCRIPTION_REAPPLY, "true");
     serviceProperties.setProperty(ServiceProperties.VPN_NAME, "default");

     final MessagingServiceClientBuilder serviceBuilder = new MessagingServiceClientBuilder(ConfigurationProfile.V1);
     final MessagingService service = serviceBuilder.fromProperties(serviceProperties).build();
 

Since:

1.0

See Also:

MessagingServiceClientBuilder.fromProperties(Properties)

Field Summary

Fields

Modifier and Type	Field and Description
static String	GENERATE_RECEIVE_TIMESTAMPS A property key to specify whether to generate a receive timestamp on incoming messages.
static String	GENERATE_SEND_TIMESTAMPS A property key to specify whether to generate a send timestamp in outgoing messages.
static String	GENERATE_SENDER_ID A property key to specify whether the client name should be included in the SenderID message header parameter.
static String	PAYLOAD_COMPRESSION_LEVEL A property key to enable payload compression and set the compression level.
static String	PUBLISHER_PERSISTENT_ACK_TIMEOUT A property key to specify acknowledgement timeout period in milliseconds.
static String	PUBLISHER_PERSISTENT_ACK_WINDOW_SIZE A property key to specify size of the sliding publisher window for persistent message publisher.
static String	RECEIVER_DIRECT_NO_LOCAL_PUBLISHED_MESSAGES A property key to specify whether direct messages published on the session are received on the same session, even if the client has a subscription that matches the published topic.
static String	RECEIVER_DIRECT_SUBSCRIPTION_REAPPLY A property key to that enables reapplying a subscription when a session reconnection occurs for a direct message receiver; the value type is boolean.
static String	RECEIVER_PERSISTENT_NO_LOCAL_PUBLISHED_MESSAGES A property key to specify whether persistent messages published on the session are received on the same session, even if the client has a subscription that matches the published topic.
static String	RECEIVER_PERSISTENT_TRANSPORT_WINDOW_SIZE A property key to specify the maximum number of messages that can be in transit (messages are sent from the appliance, but are not yet delivered to the API).
static String	RECEIVER_PERSISTENT_TRANSPORT_WINDOW_THRESHOLD A property key to specify the threshold for sending an acknowledgement, configured as a percentage.
static String	VPN_NAME A property key that specifies the name of the Message VPN to attempt to join when connecting to an appliance.

Field Detail

GENERATE_RECEIVE_TIMESTAMPS

@PropertiesKeyMapping(mappedClass=com.solacesystems.jcsmp.JCSMPProperties.class,
                      mappedFieldName="GENERATE_RCV_TIMESTAMPS",
                      valueType=boolean.class)
static final String GENERATE_RECEIVE_TIMESTAMPS

A property key to specify whether to generate a receive timestamp on incoming messages. Setting this property is optional.

Since:

1.0

See Also:

Constant Field Values

GENERATE_SEND_TIMESTAMPS

@PropertiesKeyMapping(mappedClass=com.solacesystems.jcsmp.JCSMPProperties.class,
                      mappedFieldName="GENERATE_SEND_TIMESTAMPS",
                      valueType=boolean.class)
static final String GENERATE_SEND_TIMESTAMPS

A property key to specify whether to generate a send timestamp in outgoing messages. Setting this property is optional.

Since:

1.0

See Also:

Constant Field Values

GENERATE_SENDER_ID

@PropertiesKeyMapping(mappedClass=com.solacesystems.jcsmp.JCSMPProperties.class,
                      mappedFieldName="GENERATE_SENDER_ID",
                      valueType=boolean.class)
static final String GENERATE_SENDER_ID

A property key to specify whether the client name should be included in the SenderID message header parameter. Setting this property is optional.

Since:

1.0

See Also:

Constant Field Values

PAYLOAD_COMPRESSION_LEVEL

@PropertiesKeyMapping(mappedClass=com.solacesystems.jcsmp.JCSMPProperties.class,
                      mappedFieldName="PAYLOAD_COMPRESSION_LEVEL",
                      valueType=int.class)
static final String PAYLOAD_COMPRESSION_LEVEL

A property key to enable payload compression and set the compression level. Valid values for the payload compression level to be applied to the payload of a message published by a client are 0-9.

Value meanings:

• 0 - "disable payload compression" (the default)
• 1 - least amount of compression and fastest data throughput
• 9 - most compression and slowest data throughput

The payload compression value should be adjusted according to particular network requirements and the performance required.

Note: Please ensure that both publishers and consumers are updated to support payload compression before enabling this property. In the case where a publisher compresses the payload and a consumer does not support payload decompression, the untouched compressed message will be received which can lead to potential issues within the consuming application. Therefore, the consumer would either need to update to a newer version of the API or the user would need to handle the decompression on the receiving side in their own application. If a publishing application is able to send a compressed message, brokers currently will discard messages on egress to other protocols such as MQTT, AMQP & HTTP (Kafka too?).

Default: 0 (disabled)

Since:

1.7.0

See Also:

Constant Field Values

PUBLISHER_PERSISTENT_ACK_TIMEOUT

@PropertiesKeyMapping(mappedClass=com.solacesystems.jcsmp.JCSMPProperties.class,
                      mappedFieldName="PUB_ACK_TIME",
                      valueType=int.class)
static final String PUBLISHER_PERSISTENT_ACK_TIMEOUT

A property key to specify acknowledgement timeout period in milliseconds. When a published message is not acknowledged within the time specified for this timer, the API automatically retransmits the message. The valid range is from 20 to 60000.

Since:

1.0

See Also:

Constant Field Values

PUBLISHER_PERSISTENT_ACK_WINDOW_SIZE

@PropertiesKeyMapping(mappedClass=com.solacesystems.jcsmp.JCSMPProperties.class,
                      mappedFieldName="PUB_ACK_WINDOW_SIZE",
                      valueType=int.class)
static final String PUBLISHER_PERSISTENT_ACK_WINDOW_SIZE

A property key to specify size of the sliding publisher window for persistent message publisher. The value to be configured limits the maximum number of messages that can be published before the API must receive an acknowledgement from the appliance. The valid range from 1 to 255.

Since:

1.0

See Also:

Constant Field Values

RECEIVER_DIRECT_NO_LOCAL_PUBLISHED_MESSAGES

@PropertiesKeyMapping(mappedClass=com.solacesystems.jcsmp.JCSMPProperties.class,
                      mappedFieldName="NO_LOCAL",
                      valueType=boolean.class)
static final String RECEIVER_DIRECT_NO_LOCAL_PUBLISHED_MESSAGES

A property key to specify whether direct messages published on the session are received on the same session, even if the client has a subscription that matches the published topic. The default value is false to indicate that messages will not be received on the same session. Setting this property is optional.

Since:

1.0

See Also:

Constant Field Values

RECEIVER_DIRECT_SUBSCRIPTION_REAPPLY

@PropertiesKeyMapping(mappedClass=com.solacesystems.jcsmp.JCSMPProperties.class,
                      mappedFieldName="REAPPLY_SUBSCRIPTIONS",
                      valueType=boolean.class)
static final String RECEIVER_DIRECT_SUBSCRIPTION_REAPPLY

A property key to that enables reapplying a subscription when a session reconnection occurs for a direct message receiver; the value type is boolean.

Since:

1.0

See Also:

Constant Field Values

RECEIVER_PERSISTENT_NO_LOCAL_PUBLISHED_MESSAGES

@PropertiesKeyMapping(mappedClass=com.solacesystems.jcsmp.JCSMPProperties.class,
                      mappedFieldName="NO_LOCAL",
                      valueType=boolean.class)
static final String RECEIVER_PERSISTENT_NO_LOCAL_PUBLISHED_MESSAGES

A property key to specify whether persistent messages published on the session are received on the same session, even if the client has a subscription that matches the published topic. The default value is false to indicate that messages will not be received on the same session. Setting this property is optional.

Since:

1.0

See Also:

Constant Field Values

RECEIVER_PERSISTENT_TRANSPORT_WINDOW_SIZE

@PropertiesKeyMapping(mappedClass=com.solacesystems.jcsmp.JCSMPProperties.class,
                      mappedFieldName="SUB_ACK_WINDOW_SIZE",
                      valueType=int.class)
static final String RECEIVER_PERSISTENT_TRANSPORT_WINDOW_SIZE

A property key to specify the maximum number of messages that can be in transit (messages are sent from the appliance, but are not yet delivered to the API).

Since:

1.0

See Also:

Constant Field Values

RECEIVER_PERSISTENT_TRANSPORT_WINDOW_THRESHOLD

@PropertiesKeyMapping(mappedClass=com.solacesystems.jcsmp.JCSMPProperties.class,
                      mappedFieldName="SUB_ACK_WINDOW_THRESHOLD",
                      valueType=int.class)
static final String RECEIVER_PERSISTENT_TRANSPORT_WINDOW_THRESHOLD

A property key to specify the threshold for sending an acknowledgement, configured as a percentage.

The valid priority value range is from 1 to 75

Since:

1.0

See Also:

Constant Field Values

VPN_NAME

@PropertiesKeyMapping(mappedClass=com.solacesystems.jcsmp.JCSMPProperties.class,
                      mappedFieldName="VPN_NAME",
                      valueType=java.lang.String.class)
static final String VPN_NAME

A property key that specifies the name of the Message VPN to attempt to join when connecting to an appliance. The default value is "" when this property is not specified. When using the default value, the client attempts to join the default Message VPN. This parameter is valid only for sessions operating in client mode. If specified, it must be a maximum of 32 bytes in length and encoded as UTF-8.

Since:

1.0

See Also:

Constant Field Values