Interface GatewayFilter
-
- All Superinterfaces:
ShortcutConfigurable
- All Known Implementing Classes:
ModifyResponseBodyGatewayFilterFactory.ModifyResponseGatewayFilter
,OrderedGatewayFilter
public interface GatewayFilter extends ShortcutConfigurable
Contract for interception-style, chained processing of Web requests that may be used to implement cross-cutting, application-agnostic requirements such as security, timeouts, and others. Specific to a Gateway Copied from WebFilter- Since:
- 5.0
- Author:
- Rossen Stoyanchev
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from interface org.springframework.cloud.gateway.support.ShortcutConfigurable
ShortcutConfigurable.GatewayEvaluationContext, ShortcutConfigurable.RestrictivePropertyAccessor, ShortcutConfigurable.ShortcutType
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description reactor.core.publisher.Mono<Void>
filter(org.springframework.web.server.ServerWebExchange exchange, GatewayFilterChain chain)
Process the Web request and (optionally) delegate to the nextWebFilter
through the givenGatewayFilterChain
.-
Methods inherited from interface org.springframework.cloud.gateway.support.ShortcutConfigurable
shortcutFieldOrder, shortcutFieldPrefix, shortcutType
-
-
-
-
Field Detail
-
NAME_KEY
static final String NAME_KEY
Name key.- See Also:
- Constant Field Values
-
VALUE_KEY
static final String VALUE_KEY
Value key.- See Also:
- Constant Field Values
-
-
Method Detail
-
filter
reactor.core.publisher.Mono<Void> filter(org.springframework.web.server.ServerWebExchange exchange, GatewayFilterChain chain)
Process the Web request and (optionally) delegate to the nextWebFilter
through the givenGatewayFilterChain
.- Parameters:
exchange
- the current server exchangechain
- provides a way to delegate to the next filter- Returns:
Mono<Void>
to indicate when request processing is complete
-
-