com.lightbend.lagom.javadsl.api.security

Class UserAgentHeaderFilter

Object

com.lightbend.lagom.javadsl.api.security.UserAgentHeaderFilter

All Implemented Interfaces:

HeaderFilter

public class UserAgentHeaderFilter
extends Object
implements HeaderFilter

Transfers service principal information via the User-Agent header.

If using this on a service that serves requests from the outside world, it would be a good idea to block the User-Agent header in the web facing load balancer/proxy.

Nested Class Summary

Nested classes/interfaces inherited from interface com.lightbend.lagom.javadsl.api.transport.HeaderFilter

HeaderFilter.Composite

Field Summary

Fields inherited from interface com.lightbend.lagom.javadsl.api.transport.HeaderFilter

NONE

Constructor Summary

Constructors

Constructor and Description
UserAgentHeaderFilter()

Method Summary

Modifier and Type	Method and Description
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.

Methods inherited from class Object

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

Methods inherited from interface com.lightbend.lagom.javadsl.api.transport.HeaderFilter

composite

Constructor Detail

UserAgentHeaderFilter

public UserAgentHeaderFilter()

Method Detail

transformClientRequest

public RequestHeader transformClientRequest(RequestHeader request)

Description copied from interface: HeaderFilter

Transform the given client request.

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

Specified by:

transformClientRequest in interface HeaderFilter

Parameters:

request - The client request header.

Returns:

The transformed client request header.

transformServerRequest

public RequestHeader transformServerRequest(RequestHeader request)

Description copied from interface: HeaderFilter

Transform the given server request.

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

Specified by:

transformServerRequest in interface HeaderFilter

Parameters:

request - The server request header.

Returns:

The transformed server request header.

transformServerResponse

public ResponseHeader transformServerResponse(ResponseHeader response,
                                              RequestHeader request)

Description copied from interface: HeaderFilter

Transform the given server response.

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

Specified by:

transformServerResponse in interface HeaderFilter

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

public ResponseHeader transformClientResponse(ResponseHeader response,
                                              RequestHeader request)

Description copied from interface: HeaderFilter

Transform the given client response.

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

Specified by:

transformClientResponse in interface HeaderFilter

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.