com.solace.messaging.receiver

Interface InboundMessage.ReplicationGroupMessageId

All Superinterfaces:

Serializable

Enclosing interface:

InboundMessage

@ProviderType
public static interface InboundMessage.ReplicationGroupMessageId
extends Serializable

An interface to access Replication Group Message ID.

Method Summary

Modifier and Type	Method and Description
int	compare(InboundMessage.ReplicationGroupMessageId replicationGroupMessageId) Attempts to compare a given instance of ReplicationGroupMessageId with an another instance for order.
static InboundMessage.ReplicationGroupMessageId	of(String replicationGroupMessageIdString) A factory method to create instances of a InboundMessage.ReplicationGroupMessageId from a specified string.
String	toString() Returns a string representation of the Replication Group Message identifier.

Method Detail

compare

int compare(InboundMessage.ReplicationGroupMessageId replicationGroupMessageId)
     throws IllegalArgumentException

Attempts to compare a given instance of ReplicationGroupMessageId with an another instance for order.

Parameters:

replicationGroupMessageId - to compare current instance with

Returns:

negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified one.

Throws:

IllegalArgumentException - if the both replication group message IDs can't be compared, i.e when corresponding messages were not published to the same broker or HA pair.

NullPointerException - when another replicationGroupMessageId to compare to is null

of

static InboundMessage.ReplicationGroupMessageId of(String replicationGroupMessageIdString)
                                            throws IllegalArgumentException

A factory method to create instances of a InboundMessage.ReplicationGroupMessageId from a specified string.

This method can be used to create instances of ReplicationGroupMessageId for message replay configuration.

Parameters:

replicationGroupMessageIdString - the sting identifier associated with Replication Group Message ID previously returned from InboundMessage.ReplicationGroupMessageId.toString() method.

Returns:

a InboundMessage.ReplicationGroupMessageId object corresponding to a string argument

Throws:

IllegalArgumentException - if string argument is empty or was changed after it was returned form InboundMessage.ReplicationGroupMessageId.toString() previously

NullPointerException - if string argument is null

Since:

1.0

toString

String toString()

Returns a string representation of the Replication Group Message identifier.

Returned String identifier can be used for administratively triggered message replay via SEMP or CLI interface

Overrides:

toString in class Object

Returns:

a string representation of the value of this object