Interface GatewayFilter

All Superinterfaces:

ShortcutConfigurable

All Known Implementing Classes:

ModifyResponseBodyGatewayFilterFactory.ModifyResponseGatewayFilter, OrderedGatewayFilter, ResponseCacheGatewayFilter

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 ShortcutConfigurable

ShortcutConfigurable.GatewayBeanFactoryResolver, ShortcutConfigurable.GatewayEvaluationContext, ShortcutConfigurable.RestrictivePropertyAccessor, ShortcutConfigurable.ShortcutType

Field Summary

Fields

Modifier and Type	Field	Description
static final String	NAME_KEY	Name key.
static final String	VALUE_KEY	Value key.

Method Summary

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 next WebFilter through the given GatewayFilterChain.

Methods inherited from interface ShortcutConfigurable

shortcutFieldOrder, shortcutFieldPrefix, shortcutType

Field Details

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 Details

filter

reactor.core.publisher.Mono<Void> filter(org.springframework.web.server.ServerWebExchange exchange,
 GatewayFilterChain chain)

Process the Web request and (optionally) delegate to the next WebFilter through the given GatewayFilterChain.

Parameters:

exchange - the current server exchange

chain - provides a way to delegate to the next filter

Returns:

Mono<Void> to indicate when request processing is complete