Class XForwardedHeadersFilter
java.lang.Object
org.springframework.cloud.gateway.filter.headers.XForwardedHeadersFilter
- All Implemented Interfaces:
HttpHeadersFilter, org.springframework.core.Ordered
@ConfigurationProperties("spring.cloud.gateway.server.webflux.x-forwarded")
public class XForwardedHeadersFilter
extends Object
implements HttpHeadersFilter, org.springframework.core.Ordered
-
Nested Class Summary
Nested classes/interfaces inherited from interface HttpHeadersFilter
HttpHeadersFilter.Type -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final intDefault http port.static final StringHttp url scheme.static final intDefault https port.static final StringHttps url scheme.static final StringX-Forwarded-For Header.static final StringX-Forwarded-Host Header.static final StringX-Forwarded-Port Header.static final StringX-Forwarded-Prefix Header.static final StringX-Forwarded-Proto Header.Fields inherited from interface org.springframework.core.Ordered
HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionorg.springframework.http.HttpHeadersfilter(org.springframework.http.HttpHeaders input, org.springframework.web.server.ServerWebExchange exchange) Filters a set of Http Headers.intgetOrder()booleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanvoidsetEnabled(boolean enabled) voidsetForAppend(boolean forAppend) voidsetForEnabled(boolean forEnabled) voidsetHostAppend(boolean hostAppend) voidsetHostEnabled(boolean hostEnabled) voidsetOrder(int order) voidsetPortAppend(boolean portAppend) voidsetPortEnabled(boolean portEnabled) voidsetPrefixAppend(boolean prefixAppend) voidsetPrefixEnabled(boolean prefixEnabled) voidsetProtoAppend(boolean protoAppend) voidsetProtoEnabled(boolean protoEnabled) Methods inherited from class Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface HttpHeadersFilter
supports
-
Field Details
-
HTTP_PORT
public static final int HTTP_PORTDefault http port.- See Also:
-
HTTPS_PORT
public static final int HTTPS_PORTDefault https port.- See Also:
-
HTTP_SCHEME
-
HTTPS_SCHEME
-
X_FORWARDED_FOR_HEADER
-
X_FORWARDED_HOST_HEADER
-
X_FORWARDED_PORT_HEADER
-
X_FORWARDED_PROTO_HEADER
-
X_FORWARDED_PREFIX_HEADER
-
-
Constructor Details
-
XForwardedHeadersFilter
Deprecated. -
XForwardedHeadersFilter
-
-
Method Details
-
getOrder
public int getOrder()- Specified by:
getOrderin interfaceorg.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:HttpHeadersFilterFilters a set of Http Headers.- Specified by:
filterin interfaceHttpHeadersFilter- Parameters:
input- Http Headersexchange- aServerWebExchangethat should be filtered- Returns:
- filtered Http Headers
-