Uses of Class
org.springframework.cloud.gateway.route.builder.GatewayFilterSpec

Packages that use GatewayFilterSpec

Package	Description
org.springframework.cloud.gateway.route.builder

Uses of GatewayFilterSpec in org.springframework.cloud.gateway.route.builder

Methods in org.springframework.cloud.gateway.route.builder that return GatewayFilterSpec

Modifier and Type	Method	Description
GatewayFilterSpec	GatewayFilterSpec.addRequestHeader(String headerName, String headerValue)	Adds a request header to the request before it is routed by the Gateway.
GatewayFilterSpec	GatewayFilterSpec.addRequestHeadersIfNotPresent(String... headers)	Adds a request header to the request before it is routed by the Gateway.
GatewayFilterSpec	GatewayFilterSpec.addRequestParameter(String param, String value)	Adds a request parameter to the request before it is routed by the Gateway.
GatewayFilterSpec	GatewayFilterSpec.addResponseHeader(String headerName, String headerValue)	Adds a header to the response returned to the Gateway from the route.
GatewayFilterSpec	GatewayFilterSpec.addResponseHeader(String headerName, String headerValue, boolean override)	Adds a header to the response returned to the Gateway from the route.
GatewayFilterSpec	GatewayFilterSpec.RequestRateLimiterSpec.and()
GatewayFilterSpec	GatewayFilterSpec.cacheRequestBody(Class<?> bodyClass)	A filter that can cache the request body.
GatewayFilterSpec	GatewayFilterSpec.changeRequestUri(Function<org.springframework.web.server.ServerWebExchange, Optional<URI>> determineRequestUri)	A filter which change the URI the request will be routed to by the Gateway.
GatewayFilterSpec	GatewayFilterSpec.circuitBreaker(Consumer<SpringCloudCircuitBreakerFilterFactory.Config> configConsumer)
GatewayFilterSpec	GatewayFilterSpec.RequestRateLimiterSpec.configure(Consumer<RequestRateLimiterGatewayFilterFactory.Config> configConsumer)
protected GatewayFilterSpec	PredicateSpec.createGatewayFilterSpec()
GatewayFilterSpec	GatewayFilterSpec.dedupeResponseHeader(String headerName, String strategy)	A filter that removes duplication on a response header before it is returned to the client by the Gateway.
GatewayFilterSpec	GatewayFilterSpec.fallbackHeaders(Consumer<FallbackHeadersGatewayFilterFactory.Config> configConsumer)	Adds hystrix execution exception headers to fallback request.
GatewayFilterSpec	GatewayFilterSpec.fallbackHeaders(FallbackHeadersGatewayFilterFactory.Config config)	Adds hystrix execution exception headers to fallback request.
GatewayFilterSpec	GatewayFilterSpec.filter(GatewayFilter gatewayFilter)	Applies the filter to the route.
GatewayFilterSpec	GatewayFilterSpec.filter(GatewayFilter gatewayFilter, int order)	Applies the filter to the route.
GatewayFilterSpec	GatewayFilterSpec.filter(GatewayFilter gatewayFilter, int order, boolean forceOrder)	Applies the filter to the route.
GatewayFilterSpec	GatewayFilterSpec.filters(Collection<GatewayFilter> gatewayFilters)	Applies the list of filters to the route.
GatewayFilterSpec	GatewayFilterSpec.filters(GatewayFilter... gatewayFilters)	Applies the list of filters to the route.
GatewayFilterSpec	GatewayFilterSpec.jsonToGRPC(String service, String method, String protoDescriptor)	A filter that transforms a JSON request into a gRPC one.
GatewayFilterSpec	GatewayFilterSpec.localResponseCache(@Nullable Duration timeToLive, @Nullable org.springframework.util.unit.DataSize size)	A filter that adds a local cache for storing response body for repeated requests.
GatewayFilterSpec	GatewayFilterSpec.mapRequestHeader(String fromHeader, String toHeader)	Maps headers from one name to another.
<T,R> GatewayFilterSpec	GatewayFilterSpec.modifyRequestBody(Class<T> inClass, Class<R> outClass, @Nullable String newContentType, RewriteFunction<T,R> rewriteFunction)	A filter that can be used to modify the request body.
<T,R> GatewayFilterSpec	GatewayFilterSpec.modifyRequestBody(Class<T> inClass, Class<R> outClass, RewriteFunction<T,R> rewriteFunction)	A filter that can be used to modify the request body.
<T,R> GatewayFilterSpec	GatewayFilterSpec.modifyRequestBody(Consumer<ModifyRequestBodyGatewayFilterFactory.Config> configConsumer)	A filter that can be used to modify the request body.
<T,R> GatewayFilterSpec	GatewayFilterSpec.modifyRequestBody(org.springframework.core.ParameterizedTypeReference<T> inClass, org.springframework.core.ParameterizedTypeReference<R> outClass, @Nullable String newContentType, RewriteFunction<T,R> rewriteFunction)	A filter that can be used to modify the request body.
<T,R> GatewayFilterSpec	GatewayFilterSpec.modifyRequestBody(org.springframework.core.ParameterizedTypeReference<T> inClass, org.springframework.core.ParameterizedTypeReference<R> outClass, RewriteFunction<T,R> rewriteFunction)	A filter that can be used to modify the request body.
<T,R> GatewayFilterSpec	GatewayFilterSpec.modifyResponseBody(Class<T> inClass, Class<R> outClass, String newContentType, RewriteFunction<T,R> rewriteFunction)	A filter that can be used to modify the response body.
<T,R> GatewayFilterSpec	GatewayFilterSpec.modifyResponseBody(Class<T> inClass, Class<R> outClass, RewriteFunction<T,R> rewriteFunction)	A filter that can be used to modify the response body.
<T,R> GatewayFilterSpec	GatewayFilterSpec.modifyResponseBody(Consumer<ModifyResponseBodyGatewayFilterFactory.Config> configConsumer)	A filter that can be used to modify the response body using custom spec.
GatewayFilterSpec	GatewayFilterSpec.prefixPath(String prefix)	A filter that can be used to add a prefix to the path of a request before it is routed by the Gateway.
GatewayFilterSpec	GatewayFilterSpec.preserveHostHeader()	A filter that will preserve the host header of the request on the outgoing request from the Gateway.
GatewayFilterSpec	GatewayFilterSpec.redirect(int status, String url)	A filter that will return a redirect response back to the client.
GatewayFilterSpec	GatewayFilterSpec.redirect(int status, String url, boolean includeRequestParams)	A filter that will return a redirect response back to the client.
GatewayFilterSpec	GatewayFilterSpec.redirect(int status, URI url)	A filter that will return a redirect response back to the client.
GatewayFilterSpec	GatewayFilterSpec.redirect(int status, URI url, boolean includeRequestParams)	A filter that will return a redirect response back to the client.
GatewayFilterSpec	GatewayFilterSpec.redirect(String status, String url)	A filter that will return a redirect response back to the client.
GatewayFilterSpec	GatewayFilterSpec.redirect(String status, String url, boolean includeRequestParams)	A filter that will return a redirect response back to the client.
GatewayFilterSpec	GatewayFilterSpec.redirect(String status, URI url)	A filter that will return a redirect response back to the client.
GatewayFilterSpec	GatewayFilterSpec.redirect(org.springframework.http.HttpStatus status, URL url)	A filter that will return a redirect response back to the client.
GatewayFilterSpec	GatewayFilterSpec.redirect(org.springframework.http.HttpStatus status, URL url, boolean includeRequestParams)	A filter that will return a redirect response back to the client.
GatewayFilterSpec	GatewayFilterSpec.removeJsonAttributes(boolean deleteRecursively, String... attributes)	A filter that can be used to modify the response body.
GatewayFilterSpec	GatewayFilterSpec.removeJsonAttributes(String... attributes)	A filter that can be used to modify the response body.
GatewayFilterSpec	GatewayFilterSpec.removeRequestHeader(String headerName)	A filter that will remove a request header before the request is routed by the Gateway.
GatewayFilterSpec	GatewayFilterSpec.removeRequestParameter(String paramName)	A filter that will remove a request param before the request is routed by the Gateway.
GatewayFilterSpec	GatewayFilterSpec.removeResponseHeader(String headerName)	A filter that will remove a response header before the Gateway returns the response to the client.
GatewayFilterSpec	GatewayFilterSpec.requestHeaderToRequestUri(String headerName)	A filter which changes the URI the request will be routed to by the Gateway by pulling it from a header on the request.
GatewayFilterSpec	GatewayFilterSpec.requestRateLimiter(Consumer<RequestRateLimiterGatewayFilterFactory.Config> configConsumer)	A filter that will set up a request rate limiter for a route.
GatewayFilterSpec	GatewayFilterSpec.retry(int retries)	A filter that will retry failed requests.
GatewayFilterSpec	GatewayFilterSpec.retry(Consumer<RetryGatewayFilterFactory.RetryConfig> retryConsumer)	A filter that will retry failed requests.
GatewayFilterSpec	GatewayFilterSpec.retry(reactor.retry.Repeat<org.springframework.web.server.ServerWebExchange> repeat, reactor.retry.Retry<org.springframework.web.server.ServerWebExchange> retry)	A filter that will retry failed requests.
GatewayFilterSpec	GatewayFilterSpec.rewriteLocationResponseHeader(String stripVersionMode, String locationHeaderName, String hostValue, String protocolsRegex)	A filter that rewrites the value of Location response header, ridding it of backend specific details.
GatewayFilterSpec	GatewayFilterSpec.rewritePath(String regex, String replacement)	A filter which rewrites the request path before it is routed by the Gateway.
GatewayFilterSpec	GatewayFilterSpec.rewriteRequestParameter(String name, String replacement)	A filter that rewrites the value of a request parameter
GatewayFilterSpec	GatewayFilterSpec.rewriteResponseHeader(String headerName, String regex, String replacement)	A filter that rewrites a header value on the response before it is returned to the client by the Gateway.
GatewayFilterSpec	GatewayFilterSpec.saveSession()	A filter which forces a WebSession::save operation before forwarding the call downstream.
GatewayFilterSpec	GatewayFilterSpec.secureHeaders()	A filter that adds a number of headers to the response at the reccomendation from this blog post.
GatewayFilterSpec	GatewayFilterSpec.secureHeaders(Consumer<SecureHeadersGatewayFilterFactory.Config> configConsumer)	A filter that adds a number of headers to the response at the reccomendation from this blog post.
GatewayFilterSpec	GatewayFilterSpec.setHostHeader(String hostName)	A filter that will set the Host header to on the outgoing request.
GatewayFilterSpec	GatewayFilterSpec.setPath(String template)	A filter that sets the path of the request before it is routed by the Gateway.
GatewayFilterSpec	GatewayFilterSpec.setRequestHeader(String headerName, String headerValue)	A filter that sets a header on the request before it is routed by the Gateway.
GatewayFilterSpec	GatewayFilterSpec.setRequestHeaderSize(org.springframework.util.unit.DataSize size)	A filter that sets the maximum permissible size of headers of Request.
GatewayFilterSpec	GatewayFilterSpec.setRequestSize(Long size)	A filter that sets the maximum permissible size of a Content-Length header value in the Request.
GatewayFilterSpec	GatewayFilterSpec.setRequestSize(org.springframework.util.unit.DataSize size)	A filter that sets the maximum permissible size of a Content-Length header value in the Request.
GatewayFilterSpec	GatewayFilterSpec.setRequestUri(String uri)	A filter which changes the URI the request will be routed to by the Gateway by pulling it from a header on the request.
GatewayFilterSpec	GatewayFilterSpec.setResponseHeader(String headerName, String headerValue)	A filter that sets a header on the response before it is returned to the client by the Gateway.
GatewayFilterSpec	GatewayFilterSpec.setStatus(int status)	A filter that sets the status on the response before it is returned to the client by the Gateway.
GatewayFilterSpec	GatewayFilterSpec.setStatus(String status)	A filter that sets the status on the response before it is returned to the client by the Gateway.
GatewayFilterSpec	GatewayFilterSpec.setStatus(org.springframework.http.HttpStatus status)	A filter that sets the status on the response before it is returned to the client by the Gateway.
GatewayFilterSpec	GatewayFilterSpec.stripPrefix(int parts)	Strips the prefix from the path of the request before it is routed by the Gateway.
GatewayFilterSpec	GatewayFilterSpec.tokenRelay()	A filter that enables token relay by extracting the access token from the currently authenticated user and puts it in a request header for downstream requests.
GatewayFilterSpec	GatewayFilterSpec.tokenRelay(String clientRegistrationId)	A filter that enables token relay by extracting the access token of a specified ClientRegistration and puts it in a request header for downstream requests.

Method parameters in org.springframework.cloud.gateway.route.builder with type arguments of type GatewayFilterSpec

Modifier and Type	Method	Description
UriSpec	BooleanSpec.filters(Function<GatewayFilterSpec, UriSpec> fn)	Add filters to the route definition.