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 AbstractMessageSenderEndpoint might add different information to the message header.

See Also:

EIP: Message, Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Header.Builder

Method Summary

Modifier and Type	Method and Description
static Header.Builder	builder()
static Header.Builder	copyOf(Header header)
static Header	emptyHeader()
boolean	equals(java.lang.Object o)
java.time.Instant	getArrivalTimestamp()
java.lang.Object	getAttribute(java.lang.String key)
com.google.common.collect.ImmutableMap<java.lang.String,java.lang.String>	getAttributes()
java.util.Optional<ShardPosition>	getShardPosition()
java.lang.String	getStringAttribute(java.lang.String key)
boolean	hasAttribute(java.lang.String key)
int	hashCode()
static Header	requestHeader(com.google.common.collect.ImmutableMap<java.lang.String,java.lang.String> attributes)
static Header	responseHeader(ShardPosition shardPosition, java.time.Instant arrivalTimestamp)
static Header	responseHeader(ShardPosition shardPosition, java.time.Instant arrivalTimestamp, com.google.common.collect.ImmutableMap<java.lang.String,java.lang.String> attributes)
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()

requestHeader

public static Header requestHeader(com.google.common.collect.ImmutableMap<java.lang.String,java.lang.String> attributes)

responseHeader

public static Header responseHeader(ShardPosition shardPosition,
                                    java.time.Instant arrivalTimestamp,
                                    com.google.common.collect.ImmutableMap<java.lang.String,java.lang.String> attributes)

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()

getAttributes

@Nonnull
public com.google.common.collect.ImmutableMap<java.lang.String,java.lang.String> getAttributes()

hasAttribute

public boolean hasAttribute(java.lang.String key)

getAttribute

@Nullable
public java.lang.Object getAttribute(java.lang.String key)

getStringAttribute

@Nullable
public java.lang.String getStringAttribute(java.lang.String key)

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

builder

public static Header.Builder builder()

copyOf

public static Header.Builder copyOf(Header header)