Package org.springframework.cloud.gateway.filter.headers

Class XForwardedHeadersFilter

java.lang.Object

org.springframework.cloud.gateway.filter.headers.XForwardedHeadersFilter

All Implemented Interfaces:

HttpHeadersFilter, org.springframework.core.Ordered

@ConfigurationProperties("spring.cloud.gateway.x-forwarded")
public class XForwardedHeadersFilter
extends Object
implements HttpHeadersFilter, org.springframework.core.Ordered

Nested Class Summary

Nested classes/interfaces inherited from interface org.springframework.cloud.gateway.filter.headers.HttpHeadersFilter

HttpHeadersFilter.Type

Field Summary

Fields

Modifier and Type	Field	Description
static int	HTTP_PORT	Default http port.
static String	HTTP_SCHEME	Http url scheme.
static int	HTTPS_PORT	Default https port.
static String	HTTPS_SCHEME	Https url scheme.
static String	X_FORWARDED_FOR_HEADER	X-Forwarded-For Header.
static String	X_FORWARDED_HOST_HEADER	X-Forwarded-Host Header.
static String	X_FORWARDED_PORT_HEADER	X-Forwarded-Port Header.
static String	X_FORWARDED_PREFIX_HEADER	X-Forwarded-Prefix Header.
static String	X_FORWARDED_PROTO_HEADER	X-Forwarded-Proto Header.

Fields inherited from interface org.springframework.core.Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

Constructors

Constructor	Description
XForwardedHeadersFilter()

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()
boolean	isEnabled()
boolean	isForAppend()
boolean	isForEnabled()
boolean	isHostAppend()
boolean	isHostEnabled()
boolean	isPortAppend()
boolean	isPortEnabled()
boolean	isPrefixAppend()
boolean	isPrefixEnabled()
boolean	isProtoAppend()
boolean	isProtoEnabled()
void	setEnabled(boolean enabled)
void	setForAppend(boolean forAppend)
void	setForEnabled(boolean forEnabled)
void	setHostAppend(boolean hostAppend)
void	setHostEnabled(boolean hostEnabled)
void	setOrder(int order)
void	setPortAppend(boolean portAppend)
void	setPortEnabled(boolean portEnabled)
void	setPrefixAppend(boolean prefixAppend)
void	setPrefixEnabled(boolean prefixEnabled)
void	setProtoAppend(boolean protoAppend)
void	setProtoEnabled(boolean protoEnabled)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.cloud.gateway.filter.headers.HttpHeadersFilter

supports

Field Detail

HTTP_PORT

public static final int HTTP_PORT

Default http port.

See Also:

Constant Field Values

HTTPS_PORT

public static final int HTTPS_PORT

Default https port.

See Also:

Constant Field Values

HTTP_SCHEME

public static final String HTTP_SCHEME

Http url scheme.

See Also:

Constant Field Values

HTTPS_SCHEME

public static final String HTTPS_SCHEME

Https url scheme.

See Also:

Constant Field Values

X_FORWARDED_FOR_HEADER

public static final String X_FORWARDED_FOR_HEADER

X-Forwarded-For Header.

See Also:

Constant Field Values

X_FORWARDED_HOST_HEADER

public static final String X_FORWARDED_HOST_HEADER

X-Forwarded-Host Header.

See Also:

Constant Field Values

X_FORWARDED_PORT_HEADER

public static final String X_FORWARDED_PORT_HEADER

X-Forwarded-Port Header.

See Also:

Constant Field Values

X_FORWARDED_PROTO_HEADER

public static final String X_FORWARDED_PROTO_HEADER

X-Forwarded-Proto Header.

See Also:

Constant Field Values

X_FORWARDED_PREFIX_HEADER

public static final String X_FORWARDED_PREFIX_HEADER

X-Forwarded-Prefix Header.

See Also:

Constant Field Values

Constructor Detail

XForwardedHeadersFilter

public XForwardedHeadersFilter()

Method Detail

getOrder

public int getOrder()

Specified by:

getOrder in interface org.springframework.core.Ordered

setOrder

public void setOrder(int order)

isEnabled

public boolean isEnabled()

setEnabled

public void setEnabled(boolean enabled)

isForEnabled

public boolean isForEnabled()

setForEnabled

public void setForEnabled(boolean forEnabled)

isHostEnabled

public boolean isHostEnabled()

setHostEnabled

public void setHostEnabled(boolean hostEnabled)

isPortEnabled

public boolean isPortEnabled()

setPortEnabled

public void setPortEnabled(boolean portEnabled)

isProtoEnabled

public boolean isProtoEnabled()

setProtoEnabled

public void setProtoEnabled(boolean protoEnabled)

isPrefixEnabled

public boolean isPrefixEnabled()

setPrefixEnabled

public void setPrefixEnabled(boolean prefixEnabled)

isForAppend

public boolean isForAppend()

setForAppend

public void setForAppend(boolean forAppend)

isHostAppend

public boolean isHostAppend()

setHostAppend

public void setHostAppend(boolean hostAppend)

isPortAppend

public boolean isPortAppend()

setPortAppend

public void setPortAppend(boolean portAppend)

isProtoAppend

public boolean isProtoAppend()

setProtoAppend

public void setProtoAppend(boolean protoAppend)

isPrefixAppend

public boolean isPrefixAppend()

setPrefixAppend

public void setPrefixAppend(boolean prefixAppend)

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