com.lightbend.lagom.javadsl.api.transport

Class ResponseHeader

Object

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

com.lightbend.lagom.javadsl.api.transport.ResponseHeader

public final class ResponseHeader
extends MessageHeader

This header may or may not be mapped down onto HTTP. In order to remain agnostic to the underlying protocol, information required by Lagom, such as protocol information, is extracted. It is encouraged that the protocol information always be used in preference to reading the information directly out of headers, since the headers may not contain the necessary protocol information.

The headers are however still provided, in case information needs to be extracted out of non standard headers.

Field Summary

Fields

Modifier and Type	Field and Description
static ResponseHeader	NO_CONTENT
static ResponseHeader	OK

Constructor Summary

Constructors

Constructor and Description
ResponseHeader(int status, MessageProtocol protocol, org.pcollections.PMap<String,org.pcollections.PSequence<String>> headers)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
int	hashCode()
ResponseHeader	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.
int	status() Get the status of this response.
String	toString()
ResponseHeader	withHeader(String name, String value) Return a copy of this message header with the given header added to the map of headers.
ResponseHeader	withProtocol(MessageProtocol protocol) Return a copy of this message header with the given protocol.
ResponseHeader	withStatus(int status) Return a copy of this response header with the status set.

Methods inherited from class com.lightbend.lagom.javadsl.api.transport.MessageHeader

getHeader, headers, protocol

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Field Detail

OK

public static final ResponseHeader OK

NO_CONTENT

public static final ResponseHeader NO_CONTENT

Constructor Detail

ResponseHeader

public ResponseHeader(int status,
                      MessageProtocol protocol,
                      org.pcollections.PMap<String,org.pcollections.PSequence<String>> headers)

Method Detail

status

public int status()

Get the status of this response.

Returns:

The status of this response.

withStatus

public ResponseHeader withStatus(int status)

Return a copy of this response header with the status set.

Parameters:

status - The status to set.

Returns:

A copy of this response header.

withProtocol

public ResponseHeader withProtocol(MessageProtocol protocol)

Description copied from class: MessageHeader

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

Specified by:

withProtocol in class MessageHeader

Parameters:

protocol - The protocol to set.

Returns:

A copy of the message header with the given protocol.

replaceAllHeaders

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

Description copied from class: MessageHeader

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

Specified by:

replaceAllHeaders in class MessageHeader

Parameters:

headers - The map of headers.

Returns:

A copy of the message header with the given headers.

withHeader

public ResponseHeader withHeader(String name,
                                 String value)

Description copied from class: MessageHeader

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.

Specified by:

withHeader in class MessageHeader

Parameters:

name - The name of the header to add.

value - The value of the header to add.

Returns:

The new message header.

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object