Class ForwardedHeadersFilter

java.lang.Object

org.springframework.cloud.gateway.filter.headers.ForwardedHeadersFilter

All Implemented Interfaces:

HttpHeadersFilter, org.springframework.core.Ordered

public class ForwardedHeadersFilter
extends Object
implements HttpHeadersFilter, org.springframework.core.Ordered

Author:

Olga Maciaszek-Sharma, Tillmann Heigel

Nested Class Summary

Nested classes/interfaces inherited from interface HttpHeadersFilter

HttpHeadersFilter.Type

Field Summary

Fields

Modifier and Type	Field	Description
static final String	FORWARDED_HEADER	Forwarded header.

Fields inherited from interface org.springframework.core.Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

Constructors

Constructor	Description
ForwardedHeadersFilter()	Deprecated.
ForwardedHeadersFilter(String trustedProxiesRegex)

Method Summary

Modifier and Type	Method	Description
org.springframework.http.HttpHeaders	filter(org.springframework.http.HttpHeaders input, org.springframework.web.server.ServerWebExchange exchange)	Filters a set of Http Headers.
int	getOrder()
void	setForwardedByEnabled(boolean forwardedByEnabled)
void	setServerPort(Integer serverPort)

Methods inherited from class Object

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

Methods inherited from interface HttpHeadersFilter

supports

Field Details

FORWARDED_HEADER

public static final String FORWARDED_HEADER

Forwarded header.

See Also:

• Constant Field Values

Constructor Details

ForwardedHeadersFilter

@Deprecated
public ForwardedHeadersFilter()

Deprecated.

ForwardedHeadersFilter

public ForwardedHeadersFilter(String trustedProxiesRegex)

Method Details

setForwardedByEnabled

public void setForwardedByEnabled(boolean forwardedByEnabled)

setServerPort

public void setServerPort(Integer serverPort)

getOrder

public int getOrder()

Specified by:

getOrder in interface org.springframework.core.Ordered

filter

public org.springframework.http.HttpHeaders filter(org.springframework.http.HttpHeaders input,
 org.springframework.web.server.ServerWebExchange exchange)

Description copied from interface: HttpHeadersFilter

Filters a set of Http Headers.

Specified by:

filter in interface HttpHeadersFilter

Parameters:

input - Http Headers

exchange - a ServerWebExchange that should be filtered

Returns:

filtered Http Headers