Package org.springframework.cloud.gateway.filter.factory

Interface GatewayFilterFactory<C>

All Superinterfaces:

Configurable<C>, ShortcutConfigurable

All Known Implementing Classes:

AbstractChangeRequestUriGatewayFilterFactory, AbstractGatewayFilterFactory, AbstractNameValueGatewayFilterFactory, AddRequestHeaderGatewayFilterFactory, AddRequestParameterGatewayFilterFactory, AddResponseHeaderGatewayFilterFactory, CacheRequestBodyGatewayFilterFactory, DedupeResponseHeaderGatewayFilterFactory, FallbackHeadersGatewayFilterFactory, JsonToGrpcGatewayFilterFactory, MapRequestHeaderGatewayFilterFactory, ModifyRequestBodyGatewayFilterFactory, ModifyResponseBodyGatewayFilterFactory, PrefixPathGatewayFilterFactory, PreserveHostHeaderGatewayFilterFactory, RedirectToGatewayFilterFactory, RemoveRequestHeaderGatewayFilterFactory, RemoveRequestParameterGatewayFilterFactory, RemoveResponseHeaderGatewayFilterFactory, RequestHeaderSizeGatewayFilterFactory, RequestHeaderToRequestUriGatewayFilterFactory, RequestRateLimiterGatewayFilterFactory, RequestSizeGatewayFilterFactory, RetryGatewayFilterFactory, RewriteLocationResponseHeaderGatewayFilterFactory, RewritePathGatewayFilterFactory, RewriteResponseHeaderGatewayFilterFactory, SaveSessionGatewayFilterFactory, SecureHeadersGatewayFilterFactory, SetPathGatewayFilterFactory, SetRequestHeaderGatewayFilterFactory, SetRequestHostHeaderGatewayFilterFactory, SetResponseHeaderGatewayFilterFactory, SetStatusGatewayFilterFactory, SpringCloudCircuitBreakerFilterFactory, SpringCloudCircuitBreakerResilience4JFilterFactory, StripPrefixGatewayFilterFactory, TokenRelayGatewayFilterFactory

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@FunctionalInterface
public interface GatewayFilterFactory<C>
extends ShortcutConfigurable, Configurable<C>

Author:

Spencer Gibb

Nested Class Summary

Nested classes/interfaces inherited from interface org.springframework.cloud.gateway.support.ShortcutConfigurable

ShortcutConfigurable.GatewayEvaluationContext, ShortcutConfigurable.RestrictivePropertyAccessor, ShortcutConfigurable.ShortcutType

Field Summary

Fields

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

Method Summary

Modifier and Type	Method	Description
GatewayFilter	apply(C config)
default GatewayFilter	apply(String routeId, C config)
default GatewayFilter	apply(String routeId, Consumer<C> consumer)
default GatewayFilter	apply(Consumer<C> consumer)
default Class<C>	getConfigClass()
default String	name()
default C	newConfig()

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

apply

default GatewayFilter apply(String routeId,
                            Consumer<C> consumer)

apply

default GatewayFilter apply(Consumer<C> consumer)

getConfigClass

default Class<C> getConfigClass()

Specified by:

getConfigClass in interface Configurable<C>

newConfig

default C newConfig()

Specified by:

newConfig in interface Configurable<C>

apply

GatewayFilter apply(C config)

apply

default GatewayFilter apply(String routeId,
                            C config)

name

default String name()