com.lightbend.lagom.javadsl.api.transport

Interface HeaderFilter

All Known Implementing Classes:

HeaderFilter.Composite, UserAgentHeaderFilter

public interface HeaderFilter

Filter for headers.

This is used to transform transport and protocol headers according to various strategies for protocol and version negotiation, as well as authentication.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	HeaderFilter.Composite A composite header filter.

Field Summary

Fields

Modifier and Type	Field and Description
static HeaderFilter	NONE A noop header transformer, used to deconfigure specific transformers.

Method Summary

Modifier and Type	Method and Description
static HeaderFilter	composite(HeaderFilter... filters) Create a composite header filter from multiple header filters.
RequestHeader	transformClientRequest(RequestHeader request) Transform the given client request.
ResponseHeader	transformClientResponse(ResponseHeader response, RequestHeader request) Transform the given client response.
RequestHeader	transformServerRequest(RequestHeader request) Transform the given server request.
ResponseHeader	transformServerResponse(ResponseHeader response, RequestHeader request) Transform the given server response.

Field Detail

NONE

static final HeaderFilter NONE

A noop header transformer, used to deconfigure specific transformers.

Method Detail

transformClientRequest

RequestHeader transformClientRequest(RequestHeader request)

Transform the given client request.

This will be invoked on all requests outgoing from the client.

Parameters:

request - The client request header.

Returns:

The transformed client request header.

transformServerRequest

RequestHeader transformServerRequest(RequestHeader request)

Transform the given server request.

This will be invoked on all requests incoming to the server.

Parameters:

request - The server request header.

Returns:

The transformed server request header.

transformServerResponse

ResponseHeader transformServerResponse(ResponseHeader response,
                                       RequestHeader request)

Transform the given server response.

This will be invoked on all responses outgoing from the server.

Parameters:

response - The server response.

request - The transformed server request. Useful for when the response transformation requires information from the client.

Returns:

The transformed server response header.

transformClientResponse

ResponseHeader transformClientResponse(ResponseHeader response,
                                       RequestHeader request)

Transform the given client response.

This will be invoked on all responses incoming to the client.

Parameters:

response - The client response.

request - The client request. Useful for when the response transformation requires information from the client request.

Returns:

The transformed client response header.

composite

static HeaderFilter composite(HeaderFilter... filters)

Create a composite header filter from multiple header filters.

The order that the filters are applied are forward for headers being sent over the wire, and in reverse for headers that are received from the wire.

Parameters:

filters - The filters to create the composite filter from.

Returns:

The composite filter.