com.solace.messaging.receiver

Interface InboundMessage

All Superinterfaces:

InteroperabilitySupport, Message, Serializable

@ProviderType
public interface InboundMessage
extends Message

An interface for inbound messages.

Since:

1.0

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	InboundMessage.IncompatibleMessageHandler An interface for incompatible message listeners.
static interface	InboundMessage.MessageDiscardNotification An interface for message discard notifications.
static interface	InboundMessage.ReplicationGroupMessageId An interface to access Replication Group Message ID.

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

InteroperabilitySupport.RestInteroperabilitySupport

Method Summary

Modifier and Type	Method and Description
<T extends Serializable> T	getAndConvertPayload(Converter.BytesToObject<T> converter, Class<T> outputType) Retrieves the raw payload and converts to the target type using given converter.
int	getClassOfService() Retrieves the Class of Service level of a given message.
String	getDestinationName() Retrieves the name of the destination of the received message (topic or queue).
InboundMessage.MessageDiscardNotification	getMessageDiscardNotification() Retrieves the Message Discard Notification about previously discarded messages.
InboundMessage.ReplicationGroupMessageId	getReplicationGroupMessageId() Retrieves the Replication Group Message ID if available
String	getSenderId() Returns the Sender's ID.
Long	getSenderTimestamp() Retrieves the sender's timestamp.
long	getTimeStamp() Gets the receive timestamp (in milliseconds, from midnight, January 1, 1970 UTC).
boolean	isCached() Retrieves the indicator if this message was part of a cache reply
boolean	isRedelivered() Retrieves the message redelivery status.

Methods inherited from interface com.solace.messaging.Message

dump, getApplicationMessageId, getApplicationMessageType, getCorrelationId, getCorrelationKey, getExpiration, getPayloadAsBytes, getPayloadAsString, getPriority, getProperties, getProperty, getSequenceNumber, hasContent, hasProperty

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

getRestInteroperabilitySupport

Method Detail

isRedelivered

boolean isRedelivered()

Retrieves the message redelivery status.

Returns:

message redelivery status, true if the message redelivery occurred in the past

Since:

1.0

getMessageDiscardNotification

InboundMessage.MessageDiscardNotification getMessageDiscardNotification()

Retrieves the Message Discard Notification about previously discarded messages.

Returns:

value an instance of MessageDiscardNotification and this is not expected to be null

Since:

1.0

getAndConvertPayload

<T extends Serializable> T getAndConvertPayload(Converter.BytesToObject<T> converter,
                                                Class<T> outputType)
                                         throws PubSubPlusClientException.IncompatibleMessageException

Retrieves the raw payload and converts to the target type using given converter.

Type Parameters:

T - the user-defined type for returned value

Parameters:

converter - the instance to convert bytes to expected type of object

outputType - the class of the expected type

Returns:

an instance of the expected type created by the specified converter using the provided raw payload

Throws:

PubSubPlusClientException.IncompatibleMessageException - if an incompatible message payload is found

Since:

1.0

getDestinationName

String getDestinationName()

Retrieves the name of the destination of the received message (topic or queue).

Returns:

destination the name or null if information is not available

Since:

1.0

getTimeStamp

long getTimeStamp()

Gets the receive timestamp (in milliseconds, from midnight, January 1, 1970 UTC).

Returns:

the timestamp (in milliseconds since midnight, January 1, 1970 UTC)

Since:

1.0

isCached

boolean isCached()

Retrieves the indicator if this message was part of a cache reply

Returns:

true if this message was part of a cache reply, false otherwise

Since:

1.0

getReplicationGroupMessageId

InboundMessage.ReplicationGroupMessageId getReplicationGroupMessageId()

Retrieves the Replication Group Message ID if available

Returns:

the Replication Group Message ID null if information is not available

getClassOfService

int getClassOfService()

Retrieves the Class of Service level of a given message. The Class of Service has different semantics for direct and guaranteed messages. For direct messaging, it determines the WRR weight for the message. For guaranteed messaging, it indicates the discard eligibility of the message if the endpoint is congested. the values of 0, 1, 2 are permitted, where 2 represents a highest class of service and 0 is the lowest.

Returns:

the Class of Service level value

getSenderTimestamp

Long getSenderTimestamp()

Retrieves the sender's timestamp. This field is often set automatically during message publishing.

Returns:

timestamp the timestamp (in milliseconds since midnight, January 1, 1970 UTC) or null if not set

Since:

1.0

getSenderId

String getSenderId()

Returns the Sender's ID. This field can be set automatically during message publishing, but existing values are not overwritten if non-null, as when a message is sent multiple times.

Returns:

the sender's ID or null, if not set

Since:

1.0