com.solace.messaging.config

Interface SolaceProperties.MessageProperties

Enclosing interface:

SolaceProperties

@ProviderType
public static interface SolaceProperties.MessageProperties

An interface that defines the configurable message properties for Message instances. The properties are for use with implementation of OutboundMessageBuilder.fromProperties(Properties) and OutboundMessageBuilder.withProperty(String, String)

Example usage:

    final Properties messageProperties = new Properties();
    messageProperties.setProperty(MessageProperties.APPLICATION_MESSAGE_TYPE, "someMessageType");
    messageProperties.setProperty(MessageProperties.APPLICATION_MESSAGE_ID, "some-message-id");

    final MessagingService service = new MessagingServiceClientBuilder(ConfigurationProfile.V1).build();
    final OutboundMessageBuilder messageBuilder = service.messageBuilder();
    messageBuilder.withProperty(MessageProperties.PRIORITY, "99");
    messageBuilder.fromProperties(messageProperties);
    final OutboundMessage outbound = messageBuilder.build("a-text-message");
  

Since:

1.0

See Also:

OutboundMessageBuilder.fromProperties(Properties), OutboundMessageBuilder.withProperty(String, String)

Field Summary

Fields

Modifier and Type	Field and Description
static String	APPLICATION_MESSAGE_ID A property key to specify application-specific message identifier.
static String	APPLICATION_MESSAGE_TYPE A property key to specify application message-type.
static String	CLASS_OF_SERVICE A property key to specify the class of service for the message.
static String	CORRELATION_ID A property key to specify correlation ID.
static String	ELIDING_ELIGIBLE A property key to specify whether the message is eligible for eliding.
static String	HTTP_CONTENT_ENCODING A property key to specify HTTP content-type encoding value for interaction with an HTTP client.
static String	HTTP_CONTENT_TYPE A property key to specify HTTP content-type header value for interaction with an HTTP client.
static String	PERSISTENT_ACK_IMMEDIATELY A property key to specify if the appliance should acknowledge (ACK) this message immediately upon receipt.
static String	PERSISTENT_DMQ_ELIGIBLE A property key to specify if the message is eligible to be moved to a Dead Message Queue.
static String	PERSISTENT_EXPIRATION A property key to specify when the message is supposed to expire (in milliseconds, from midnight, January 1, 1970 UTC).
static String	PERSISTENT_TIME_TO_LIVE A property key to specify number of milliseconds before the message is discarded or moved to a Dead Message Queue.
static String	PRIORITY A property key to specify optional message priority.
static String	SENDER_ID A property key to specify the custom sender ID in the message header.
static String	SEQUENCE_NUMBER A property key to specify the sequence number of the message.

Field Detail

APPLICATION_MESSAGE_ID

@PropertiesKey(target=OutboundMessageBuilder.class,
               valueType=java.lang.String.class)
static final String APPLICATION_MESSAGE_ID

A property key to specify application-specific message identifier. This value is used by applications only, and is passed through the API untouched.

Since:

1.0

See Also:

Constant Field Values

APPLICATION_MESSAGE_TYPE

@PropertiesKey(target=OutboundMessageBuilder.class,
               valueType=java.lang.String.class)
static final String APPLICATION_MESSAGE_TYPE

A property key to specify application message-type. This value is used only by applications, and is passed through the API untouched.

Since:

1.0

See Also:

Constant Field Values

CLASS_OF_SERVICE

@PropertiesKey(target=OutboundMessageBuilder.class,
               valueType=int.class)
static final String CLASS_OF_SERVICE

A property key to specify the class of service for the message.

The valid class of service value range is from 0 to 2.

Since:

1.1

See Also:

Constant Field Values

CORRELATION_ID

@PropertiesKey(target=OutboundMessageBuilder.class,
               valueType=java.lang.String.class)
static final String CORRELATION_ID

A property key to specify correlation ID. The correlation ID is used for correlating a request to a reply and the identifier should be a random value whenever possible.

This variable is being also used for the request-reply API. For this reason, it's recommended not to use this property on a message builder instance, but only on a publisher interface where available.

Since:

1.0

See Also:

Constant Field Values

ELIDING_ELIGIBLE

@PropertiesKey(target=OutboundMessageBuilder.class,
               valueType=boolean.class)
static final String ELIDING_ELIGIBLE

A property key to specify whether the message is eligible for eliding.

Since:

1.0

See Also:

Constant Field Values

HTTP_CONTENT_ENCODING

@PropertiesKey(target=OutboundMessageBuilder.class,
               valueType=java.lang.String.class)
static final String HTTP_CONTENT_ENCODING

A property key to specify HTTP content-type encoding value for interaction with an HTTP client.

The accepted values are defined in RFC 2616, section-14.11.

Since:

1.0

See Also:

Constant Field Values

HTTP_CONTENT_TYPE

@PropertiesKey(target=OutboundMessageBuilder.class,
               valueType=java.lang.String.class)
static final String HTTP_CONTENT_TYPE

A property key to specify HTTP content-type header value for interaction with an HTTP client.

The accepted values are defined in RFC7231, section-3.1.2.2.

Since:

1.0

See Also:

Constant Field Values

PERSISTENT_ACK_IMMEDIATELY

@PropertiesKey(target=OutboundMessageBuilder.class,
               valueType=boolean.class)
static final String PERSISTENT_ACK_IMMEDIATELY

A property key to specify if the appliance should acknowledge (ACK) this message immediately upon receipt.

The default value is false and this property is valid only for persistent messages.

Since:

1.0

See Also:

Constant Field Values

PERSISTENT_DMQ_ELIGIBLE

@PropertiesKey(target=OutboundMessageBuilder.class,
               valueType=boolean.class)
static final String PERSISTENT_DMQ_ELIGIBLE

A property key to specify if the message is eligible to be moved to a Dead Message Queue.

The default value is true and this property is valid only for persistent messages.

See Also:

Constant Field Values

PERSISTENT_EXPIRATION

@PropertiesKey(target=OutboundMessageBuilder.class,
               valueType=long.class)
static final String PERSISTENT_EXPIRATION

A property key to specify when the message is supposed to expire (in milliseconds, from midnight, January 1, 1970 UTC). Setting this property has no effect if the TimeToLive is set in the same message. It is carried to clients that receive the message, unmodified and does not affect the lifecycle of the message.

This property is valid only for persistent messages.

Since:

1.0

See Also:

Constant Field Values

PERSISTENT_TIME_TO_LIVE

@PropertiesKey(target=OutboundMessageBuilder.class,
               valueType=long.class)
static final String PERSISTENT_TIME_TO_LIVE

A property key to specify number of milliseconds before the message is discarded or moved to a Dead Message Queue.

The value of 0 means the message never expires. The default value is 0.

This property is valid only for persistent messages.

Since:

1.0

See Also:

Constant Field Values

PRIORITY

@PropertiesKey(target=OutboundMessageBuilder.class,
               valueType=int.class)
static final String PRIORITY

A property key to specify optional message priority.

The valid priority value range is from 0 to 255, with 0 as the lowest priority and 255 as the highest. A value of -1 indicates the priority is not set and a default priority value is used instead.

Since:

1.0

See Also:

Constant Field Values

SENDER_ID

@PropertiesKey(target=OutboundMessageBuilder.class,
               valueType=java.lang.String.class)
static final String SENDER_ID

A property key to specify the custom sender ID in the message header.

If a string value is passed, the sender ID header will be set to that string. If null is passed, any previously set sender ID will be deleted. Note: passing $null as the value of this property will not delete a sender ID automatically generated using the service property SolaceProperties.ServiceProperties.GENERATE_SENDER_ID

Since:

1.0

See Also:

Constant Field Values

SEQUENCE_NUMBER

@PropertiesKey(target=OutboundMessageBuilder.class,
               valueType=long.class)
static final String SEQUENCE_NUMBER

A property key to specify the sequence number of the message. If the sequence number generation is enabled, this method's argument overrides the generated value. This field can be set automatically during message publishing, but existing values are not overwritten if set, as when a message is sent multiple times.

Since:

1.0

See Also:

Constant Field Values