com.lightbend.lagom.javadsl.api.transport

Class MessageHeader

Object

com.lightbend.lagom.javadsl.api.transport.MessageHeader

Direct Known Subclasses:

RequestHeader, ResponseHeader

public abstract class MessageHeader
extends Object

A message header.

Method Summary

Modifier and Type	Method and Description
Optional<String>	getHeader(String name) Get the header with the given name.
org.pcollections.PMap<String,org.pcollections.PSequence<String>>	headers() Get the headers for the message.
MessageProtocol	protocol() Get the protocol of the message.
abstract MessageHeader	replaceAllHeaders(org.pcollections.PMap<String,org.pcollections.PSequence<String>> headers) Return a copy of this message header with the headers replaced by the given map of headers.
abstract MessageHeader	withHeader(String name, String value) Return a copy of this message header with the given header added to the map of headers.
abstract MessageHeader	withProtocol(MessageProtocol protocol) Return a copy of this message header with the given protocol.

Methods inherited from class Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

protocol

public MessageProtocol protocol()

Get the protocol of the message.

Returns:

The protocol.

headers

public org.pcollections.PMap<String,org.pcollections.PSequence<String>> headers()

Get the headers for the message.

The returned map is case sensitive, it is recommended that you use getHeader instead.

Returns:

The headers for this message.

getHeader

public Optional<String> getHeader(String name)

Get the header with the given name.

The lookup is case insensitive.

Parameters:

name - The name of the header.

Returns:

The header value.

withProtocol

public abstract MessageHeader withProtocol(MessageProtocol protocol)

Return a copy of this message header with the given protocol.

Parameters:

protocol - The protocol to set.

Returns:

A copy of the message header with the given protocol.

replaceAllHeaders

public abstract MessageHeader replaceAllHeaders(org.pcollections.PMap<String,org.pcollections.PSequence<String>> headers)

Return a copy of this message header with the headers replaced by the given map of headers.

Parameters:

headers - The map of headers.

Returns:

A copy of the message header with the given headers.

withHeader

public abstract MessageHeader withHeader(String name,
                                         String value)

Return a copy of this message header with the given header added to the map of headers.

If the header already has a value, this value will replace it.

Parameters:

name - The name of the header to add.

value - The value of the header to add.

Returns:

The new message header.