Class LocalResponseCacheGatewayFilterFactory

java.lang.Object

org.springframework.cloud.gateway.support.AbstractConfigurable<LocalResponseCacheGatewayFilterFactory.RouteCacheConfiguration>

org.springframework.cloud.gateway.filter.factory.AbstractGatewayFilterFactory<LocalResponseCacheGatewayFilterFactory.RouteCacheConfiguration>

org.springframework.cloud.gateway.filter.factory.cache.LocalResponseCacheGatewayFilterFactory

All Implemented Interfaces:

org.springframework.beans.factory.Aware, GatewayFilterFactory<LocalResponseCacheGatewayFilterFactory.RouteCacheConfiguration>, Configurable<LocalResponseCacheGatewayFilterFactory.RouteCacheConfiguration>, ShortcutConfigurable, org.springframework.context.ApplicationEventPublisherAware

@ConditionalOnProperty(value="spring.cloud.gateway.server.webflux.filter.local-response-cache.enabled",
                       havingValue="true")
public class LocalResponseCacheGatewayFilterFactory
extends AbstractGatewayFilterFactory<LocalResponseCacheGatewayFilterFactory.RouteCacheConfiguration>

GatewayFilterFactory of ResponseCacheGatewayFilter. By default, a global cache (defined as properties in the application) is used. For specific route configuration, parameters can be added following LocalResponseCacheGatewayFilterFactory.RouteCacheConfiguration class.

Author:

Marta Medio, Ignacio Lozano

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	LocalResponseCacheGatewayFilterFactory.RouteCacheConfiguration

Nested classes/interfaces inherited from class AbstractGatewayFilterFactory

AbstractGatewayFilterFactory.NameConfig

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	LOCAL_RESPONSE_CACHE_FILTER_APPLIED	Exchange attribute name to track if the request has been already process by cache at route filter level.

Fields inherited from interface GatewayFilterFactory

NAME_KEY, VALUE_KEY

Constructor Summary

Constructors

Constructor	Description
LocalResponseCacheGatewayFilterFactory(ResponseCacheManagerFactory cacheManagerFactory, Duration defaultTimeToLive, org.springframework.util.unit.DataSize defaultSize, LocalResponseCacheProperties.RequestOptions requestOptions)
LocalResponseCacheGatewayFilterFactory(ResponseCacheManagerFactory cacheManagerFactory, Duration defaultTimeToLive, org.springframework.util.unit.DataSize defaultSize, LocalResponseCacheProperties.RequestOptions requestOptions, org.springframework.cache.caffeine.CaffeineCacheManager caffeineCacheManager)

Method Summary

Modifier and Type	Method	Description
GatewayFilter	apply(LocalResponseCacheGatewayFilterFactory.RouteCacheConfiguration config)
List<String>	shortcutFieldOrder()	Returns hints about the number of args and the order for shortcut parsing.

Methods inherited from class AbstractGatewayFilterFactory

enableBodyCaching, getPublisher, setApplicationEventPublisher

Methods inherited from class AbstractConfigurable

getConfigClass, newConfig, toString

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface GatewayFilterFactory

apply, apply, apply, getConfigClass, name, newConfig

Methods inherited from interface ShortcutConfigurable

shortcutFieldPrefix, shortcutType

Field Details

LOCAL_RESPONSE_CACHE_FILTER_APPLIED

public static final String LOCAL_RESPONSE_CACHE_FILTER_APPLIED

Exchange attribute name to track if the request has been already process by cache at route filter level.

See Also:

• Constant Field Values

Constructor Details

LocalResponseCacheGatewayFilterFactory

public LocalResponseCacheGatewayFilterFactory(ResponseCacheManagerFactory cacheManagerFactory,
 Duration defaultTimeToLive,
 org.springframework.util.unit.DataSize defaultSize,
 LocalResponseCacheProperties.RequestOptions requestOptions)

LocalResponseCacheGatewayFilterFactory

public LocalResponseCacheGatewayFilterFactory(ResponseCacheManagerFactory cacheManagerFactory,
 Duration defaultTimeToLive,
 org.springframework.util.unit.DataSize defaultSize,
 LocalResponseCacheProperties.RequestOptions requestOptions,
 org.springframework.cache.caffeine.CaffeineCacheManager caffeineCacheManager)

Method Details

apply

public GatewayFilter apply(LocalResponseCacheGatewayFilterFactory.RouteCacheConfiguration config)

shortcutFieldOrder

public List<String> shortcutFieldOrder()

Description copied from interface: ShortcutConfigurable

Returns hints about the number of args and the order for shortcut parsing.

Returns:

the list of hints