com.lightbend.lagom.javadsl.api.transport

Class RequestHeader

Object

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

com.lightbend.lagom.javadsl.api.transport.RequestHeader

public final class RequestHeader
extends MessageHeader

A request header.

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 RequestHeader	DEFAULT A default request header object.

Constructor Summary

Constructors

Constructor and Description
RequestHeader(Method method, URI uri, MessageProtocol protocol, org.pcollections.PSequence<MessageProtocol> acceptedResponseProtocols, Optional<Principal> principal, org.pcollections.PMap<String,org.pcollections.PSequence<String>> headers)

Method Summary

Modifier and Type	Method and Description
org.pcollections.PSequence<MessageProtocol>	acceptedResponseProtocols() Get the accepted response protocols for this request.
RequestHeader	clearPrincipal() Return a copy of this request header with the principal cleared.
boolean	equals(Object o)
int	hashCode()
Method	method() Get the method used to make this request.
Optional<Principal>	principal() Get the principal for this request, if there is one.
RequestHeader	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.
String	toString()
URI	uri() Get the URI for this request.
RequestHeader	withAcceptedResponseProtocols(org.pcollections.PSequence<MessageProtocol> acceptedResponseProtocols) Return a copy of this request header with the given accepted response protocols set.
RequestHeader	withHeader(String name, String value) Return a copy of this message header with the given header added to the map of headers.
RequestHeader	withMethod(Method method) Return a copy of this request header with the given method set.
RequestHeader	withPrincipal(Principal principal) Return a copy of this request header with the principal set.
RequestHeader	withProtocol(MessageProtocol protocol) Return a copy of this message header with the given protocol.
RequestHeader	withUri(URI uri) Return a copy of this request header with the given uri 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

DEFAULT

public static final RequestHeader DEFAULT

A default request header object.

This is a convenience supplied so that server implementations of service calls can pass this request to the request header handler, in order to get the actual incoming request header.

See ServiceCall.handleRequestHeader(Function)

Constructor Detail

RequestHeader

public RequestHeader(Method method,
                     URI uri,
                     MessageProtocol protocol,
                     org.pcollections.PSequence<MessageProtocol> acceptedResponseProtocols,
                     Optional<Principal> principal,
                     org.pcollections.PMap<String,org.pcollections.PSequence<String>> headers)

Method Detail

method

public Method method()

Get the method used to make this request.

Returns:

The method.

uri

public URI uri()

Get the URI for this request.

Returns:

The URI.

acceptedResponseProtocols

public org.pcollections.PSequence<MessageProtocol> acceptedResponseProtocols()

Get the accepted response protocols for this request.

Returns:

The accepted response protocols.

principal

public Optional<Principal> principal()

Get the principal for this request, if there is one.

Returns:

The principal for this request.

withMethod

public RequestHeader withMethod(Method method)

Return a copy of this request header with the given method set.

Parameters:

method - The method to set.

Returns:

A copy of this request header.

withUri

public RequestHeader withUri(URI uri)

Return a copy of this request header with the given uri set.

Parameters:

uri - The uri to set.

Returns:

A copy of this request header.

withProtocol

public RequestHeader 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.

withAcceptedResponseProtocols

public RequestHeader withAcceptedResponseProtocols(org.pcollections.PSequence<MessageProtocol> acceptedResponseProtocols)

Return a copy of this request header with the given accepted response protocols set.

Parameters:

acceptedResponseProtocols - The accepted response protocols to set.

Returns:

A copy of this request header.

withPrincipal

public RequestHeader withPrincipal(Principal principal)

Return a copy of this request header with the principal set.

Parameters:

principal - The principal to set.

Returns:

A copy of this request header.

clearPrincipal

public RequestHeader clearPrincipal()

Return a copy of this request header with the principal cleared.

Returns:

A copy of this request header.

replaceAllHeaders

public RequestHeader 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 RequestHeader 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