de.otto.synapse.message

Class Header

java.lang.Object

de.otto.synapse.message.Header

All Implemented Interfaces:

java.io.Serializable

public class Header
extends java.lang.Object
implements java.io.Serializable

The Header of a Message.

Headers contain metadata about a message which may only be available on one side of a channel: MessageLogReceiverEndpoint, MessageQueueReceiverEndpoint or MessageSenderEndpoint might add different information to the message header.

See Also:

EIP: Message, Serialized Form

Method Summary

Modifier and Type	Method and Description
static Header	emptyHeader()
boolean	equals(java.lang.Object o)
java.time.Instant	getArrivalTimestamp()
java.util.Optional<java.time.Duration>	getDurationBehind() Returns the approx. duration of this event behind the latest event in the event source.
java.util.Optional<ShardPosition>	getShardPosition()
int	hashCode()
static Header	responseHeader(ShardPosition shardPosition, java.time.Instant arrivalTimestamp)
static Header	responseHeader(ShardPosition shardPosition, java.time.Instant arrivalTimestamp, java.time.Duration durationBehind)
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

emptyHeader

public static Header emptyHeader()

responseHeader

public static Header responseHeader(ShardPosition shardPosition,
                                    java.time.Instant arrivalTimestamp,
                                    java.time.Duration durationBehind)

responseHeader

public static Header responseHeader(ShardPosition shardPosition,
                                    java.time.Instant arrivalTimestamp)

getShardPosition

@Nonnull
public java.util.Optional<ShardPosition> getShardPosition()

getArrivalTimestamp

@Nonnull
public java.time.Instant getArrivalTimestamp()

getDurationBehind

@Nonnull
public java.util.Optional<java.time.Duration> getDurationBehind()

Returns the approx. duration of this event behind the latest event in the event source.

Returns:

Duration

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object