Package 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.

Message

See Also:
EIP: Message, Serialized Form

  • Nested Class Summary

    Nested Classes 
    Modifier and Type Class Description
    static class  Header.Builder  

  • Method Summary

    Modifier and Type Method Description
    static Header.Builder builder()  
    boolean containsKey​(HeaderAttr attr)  
    boolean containsKey​(java.lang.String key)  
    static Header.Builder copyOf​(Header header)  
    boolean equals​(java.lang.Object o)  
    java.lang.Object get​(HeaderAttr attr)  
    java.lang.Object get​(HeaderAttr attr, java.lang.String defaultValue)  
    java.lang.Object get​(java.lang.String key)  
    java.lang.Object get​(java.lang.String key, java.lang.String defaultValue)  
    com.google.common.collect.ImmutableMap<java.lang.String,​java.lang.String> getAll()  
    java.time.Instant getAsInstant​(HeaderAttr attr)  
    java.time.Instant getAsInstant​(HeaderAttr attr, java.time.Instant defaultValue)  
    java.time.Instant getAsInstant​(java.lang.String key)  
    java.time.Instant getAsInstant​(java.lang.String key, java.time.Instant defaultValue)  
    java.lang.String getAsString​(HeaderAttr attr)  
    java.lang.String getAsString​(HeaderAttr attr, java.lang.String defaultValue)  
    java.lang.String getAsString​(java.lang.String key)  
    java.lang.String getAsString​(java.lang.String key, java.lang.String defaultValue)  
    java.util.Optional<ShardPosition> getShardPosition()  
    int hashCode()  
    static Header of()  
    static Header of​(com.google.common.collect.ImmutableMap<java.lang.String,​java.lang.String> attributes)  
    static Header of​(ShardPosition shardPosition)  
    static Header of​(ShardPosition shardPosition, 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 Details

    • of

      public static Header of()

    • of

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

    • of

      public static Header of​(ShardPosition shardPosition, com.google.common.collect.ImmutableMap<java.lang.String,​java.lang.String> attributes)

    • of

      public static Header of​(ShardPosition shardPosition)

    • builder

      public static Header.Builder builder()

    • copyOf

      public static Header.Builder copyOf​(Header header)

    • getShardPosition

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

    • getAll

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

    • containsKey

      public boolean containsKey​(java.lang.String key)

    • containsKey

      public boolean containsKey​(HeaderAttr attr)

    • get

      @Nullable public java.lang.Object get​(java.lang.String key)

    • get

      @Nullable public java.lang.Object get​(HeaderAttr attr)

    • get

      @Nullable public java.lang.Object get​(java.lang.String key, java.lang.String defaultValue)

    • get

      @Nullable public java.lang.Object get​(HeaderAttr attr, java.lang.String defaultValue)

    • getAsString

      @Nullable public java.lang.String getAsString​(java.lang.String key)

    • getAsString

      @Nullable public java.lang.String getAsString​(HeaderAttr attr)

    • getAsString

      @Nullable public java.lang.String getAsString​(java.lang.String key, java.lang.String defaultValue)

    • getAsString

      @Nullable public java.lang.String getAsString​(HeaderAttr attr, java.lang.String defaultValue)

    • getAsInstant

      @Nullable public java.time.Instant getAsInstant​(java.lang.String key)

    • getAsInstant

      @Nullable public java.time.Instant getAsInstant​(HeaderAttr attr)

    • getAsInstant

      @Nullable public java.time.Instant getAsInstant​(java.lang.String key, java.time.Instant defaultValue)

    • getAsInstant

      @Nullable public java.time.Instant getAsInstant​(HeaderAttr attr, java.time.Instant defaultValue)

    • 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