org.springframework.web.filter.reactive

Class ForwardedHeaderFilter

java.lang.Object

org.springframework.web.server.adapter.ForwardedHeaderTransformer

org.springframework.web.filter.reactive.ForwardedHeaderFilter

All Implemented Interfaces:

java.util.function.Function<ServerHttpRequest,ServerHttpRequest>, WebFilter

Deprecated.

as of 5.1 this filter is deprecated in favor of using ForwardedHeaderTransformer which can be declared as a bean with the name "forwardedHeaderTransformer" or registered explicitly in WebHttpHandlerBuilder.

@Deprecated
public class ForwardedHeaderFilter
extends ForwardedHeaderTransformer
implements WebFilter

Extract values from "Forwarded" and "X-Forwarded-*" headers to override the request URI (i.e. HttpRequest.getURI()) so it reflects the client-originated protocol and address.

Alternatively if removeOnly is set to "true", then "Forwarded" and "X-Forwarded-*" headers are only removed, and not used.

Since:

5.0

Author:

Arjen Poutsma, Rossen Stoyanchev

See Also:

https://tools.ietf.org/html/rfc7239

Constructor Summary

Constructors

Constructor and Description
ForwardedHeaderFilter() Deprecated.

Method Summary

Modifier and Type	Method and Description
<any>	filter(ServerWebExchange exchange, WebFilterChain chain) Deprecated. Process the Web request and (optionally) delegate to the next WebFilter through the given WebFilterChain.

Methods inherited from class org.springframework.web.server.adapter.ForwardedHeaderTransformer

apply, hasForwardedHeaders, isRemoveOnly, setRemoveOnly

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.function.Function

andThen, compose, identity

Constructor Detail

ForwardedHeaderFilter

public ForwardedHeaderFilter()

Deprecated.

Method Detail

filter

public <any> filter(ServerWebExchange exchange,
                    WebFilterChain chain)

Deprecated.

Description copied from interface: WebFilter

Process the Web request and (optionally) delegate to the next WebFilter through the given WebFilterChain.

Specified by:

filter in interface WebFilter

Parameters:

exchange - the current server exchange

chain - provides a way to delegate to the next filter

Returns:

Mono<Void> to indicate when request processing is complete