rsb

Class EventId

java.lang.Object

rsb.EventId

public class EventId
extends Object

This class serves as a Uniform Resource Name to identify events in an RSB system. This URN is based on the participant's ID and a sequence number generated at the sender side unique for this participant. Both can be combined and returned as a UUID. Please note, that the sequence number is a 32bit unsigned integer and thus can overrun in a long-running system. In such cases, the timestamp has to be additionally considered to further distinguish between events.

Author:

swrede, jwienke

Constructor Summary

Constructors

Constructor and Description
EventId(ParticipantId participantId, long sequenceNumber) Creates a unique Id based on participant and sequence number.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj)
static String	formatSequenceNumber(long value) Formats an decimal sequence number as a string with 8 byte width encoding that number in hex.
UUID	getAsUUID() Converts this EventId to a UUID.
ParticipantId	getParticipantId() Returns the id of the participant that sent the event.
long	getSequenceNumber() Returns the sequence number which makes this id unique combined with the sending participants id.
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

EventId

public EventId(ParticipantId participantId,
       long sequenceNumber)

Creates a unique Id based on participant and sequence number.

Parameters:

participantId - the id of the participant causing this event

sequenceNumber - a number from a sequential list of numbers of events originating from that participant

Method Detail

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

getAsUUID

public UUID getAsUUID()

Converts this EventId to a UUID.

Returns:

the UUID representation of this event id

getParticipantId

public ParticipantId getParticipantId()

Returns the id of the participant that sent the event.

Returns:

participant id

getSequenceNumber

public long getSequenceNumber()

Returns the sequence number which makes this id unique combined with the sending participants id.

Returns:

sequence number for sending participant

See Also:

getParticipantId()

formatSequenceNumber

public static String formatSequenceNumber(long value)

Formats an decimal sequence number as a string with 8 byte width encoding that number in hex. E.g. 0 -< 00000000, 1 -< 00000000, 32 -< 00000020. This is the format used inside the UUID-based representation.

Parameters:

value - the number to encode

Returns:

string representation of the number in hex format with length 8

toString

public String toString()

Overrides:

toString in class Object