com.solace.messaging

Interface Message

All Superinterfaces:

InteroperabilitySupport, Serializable

All Known Subinterfaces:

InboundMessage, OutboundMessage

@ProviderType
public interface Message
extends InteroperabilitySupport, Serializable

An interface that abstracts a Solace PubSub+ Message

Nested Class Summary

Nested classes/interfaces inherited from interface com.solace.messaging.util.InteroperabilitySupport

InteroperabilitySupport.RestInteroperabilitySupport

Method Summary

Modifier and Type	Method and Description
String	dump() Produces a human-readable dump of the message properties and its contents.
String	getApplicationMessageId() Gets an optional application message identifier when sender application set one.
String	getApplicationMessageType() Gets the application message type.
String	getCorrelationId() Gets the correlation identifier passed from a message producer.
Object	getCorrelationKey() Gets the correlation key passed from a message producer.
long	getExpiration() The UTC time (in milliseconds) in Epoch time when the message is supposed to expire.
byte[]	getPayloadAsBytes() Gets the raw payload of the message as a byte array.
String	getPayloadAsString() Gets the payload as a UTF-8 decoded as a String.
int	getPriority() Gets priority value in the range of 0 - 255, or -1 if it is not set.
Map<String,String>	getProperties() Gets the non-solace properties attached to the message.
String	getProperty(String name) Gets the value of a specific non-solace property.
long	getSequenceNumber() Gets the sequence number.
boolean	hasContent() Checks whether the message has content.
boolean	hasProperty(String name) Checks if the message has a specific non-solace property attached.

Methods inherited from interface com.solace.messaging.util.InteroperabilitySupport

getRestInteroperabilitySupport

Method Detail

dump

String dump()

Produces a human-readable dump of the message properties and its contents. Applications must not parse the output as its format is undefined.

Returns:

A String representation of the message, to be used for debugging

getApplicationMessageId

String getApplicationMessageId()

Gets an optional application message identifier when sender application set one.

Returns:

sender application identifier if set by message publisher or null or empty if not set

Since:

1.0

getApplicationMessageType

String getApplicationMessageType()

Gets the application message type. This value is used by applications only, and is passed through the API untouched.

Returns:

application message type or null if not set

Since:

1.0

getCorrelationId

String getCorrelationId()

Gets the correlation identifier passed from a message producer.

Returns:

a unique identifier for the message set by producer or null

Since:

1.0

getCorrelationKey

Object getCorrelationKey()

Gets the correlation key passed from a message producer. Has to be serializable object, otherwise null is returned when the message is received from a producer.

Returns:

identifier key for the message set by producer or null

Since:

1.0

getExpiration

long getExpiration()

The UTC time (in milliseconds) in Epoch time when the message is supposed to expire.

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

Returns:

the UTC time (in milliseconds) of when the message was discarded or was moved to a Dead Message Queue

Since:

1.0

getPayloadAsBytes

byte[] getPayloadAsBytes()

Gets the raw payload of the message as a byte array.

Returns:

the byte[] containing the message payload

Since:

1.0

getPayloadAsString

String getPayloadAsString()

Gets the payload as a UTF-8 decoded as a String.

Returns:

the representation of a payload

Since:

1.0

getPriority

int getPriority()

Gets priority value in the range of 0 - 255, or -1 if it is not set.

Returns:

priority value in the range of 0 to 255, or -1 if it is not set

Since:

1.0

getProperties

Map<String,String> getProperties()

Gets the non-solace properties attached to the message.

Any property defined in SolaceProperties.MessageProperties is not included in the returned Map. Solace defined property keys begin with "solace.messaging", however any key even those beginning with "solace." may be a non solace property if it is not defined in this API.

Returns:

a Map that's an unmodifiable view of the properties map.

Since:

1.0

getProperty

String getProperty(String name)

Gets the value of a specific non-solace property.

Any property defined in SolaceProperties.MessageProperties is not available and this method will return null. Solace defined property keys begin with "solace.messaging", however any key even those beginning with "solace." may be a non solace property if it is not defined in this API.

Parameters:

name - the name of the property

Returns:

the value of the property or null if the property was not defined

Since:

1.0

getSequenceNumber

long getSequenceNumber()

Gets the sequence number.

Returns:

the positive sequence number or -1 if it was not set

Since:

1.0

hasContent

boolean hasContent()

Checks whether the message has content.

Returns:

true if the message has content, false otherwise

Since:

1.0

hasProperty

boolean hasProperty(String name)

Checks if the message has a specific non-solace property attached.

Any property defined in SolaceProperties.MessageProperties is not available and this method will return false. Solace defined property keys begin with "solace.messaging", however any key even those beginning with "solace." may be a non solace property if it is not defined in this API.

Parameters:

name - the name of the property to check

Returns:

true only if the message has the specified property, false otherwise

Since:

1.0