Package org.apache.pekko.http.javadsl.server.directives

Class CachingDirectives

java.lang.Object

org.apache.pekko.http.javadsl.server.directives.CachingDirectives

public class CachingDirectives
extends Object

Constructor Summary

Constructors

Constructor	Description
CachingDirectives()

Method Summary

Modifier and Type	Method	Description
static <K> RouteAdapter	alwaysCache(Cache<K,RouteResult> cache, scala.PartialFunction<RequestContext,K> keyer, Supplier<Route> inner)	Wraps its inner Route with caching support using the given Cache implementation and keyer function.
static <K> RouteAdapter	cache(Cache<K,RouteResult> cache, scala.PartialFunction<RequestContext,K> keyer, Supplier<Route> inner)	Wraps its inner Route with caching support using the given pekko.http.caching.scaladsl.Cache implementation and keyer function.
static RouteAdapter	cachingProhibited(Supplier<Route> inner)	Passes only requests to the inner route that explicitly forbid caching with a Cache-Control header with either a no-cache or max-age=0 setting.
static <K> Cache<K,RouteResult>	routeCache(CachingSettings settings)	Creates an LfuCache

Methods inherited from class java.lang.Object

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

Constructor Details

CachingDirectives

public CachingDirectives()

Method Details

cache

public static <K> RouteAdapter cache(Cache<K,RouteResult> cache,
 scala.PartialFunction<RequestContext,K> keyer,
 Supplier<Route> inner)

Wraps its inner Route with caching support using the given pekko.http.caching.scaladsl.Cache implementation and keyer function.

Use pekko.japi.JavaPartialFunction to build the keyer.

Parameters:

cache - (undocumented)

keyer - (undocumented)

inner - (undocumented)

Returns:

(undocumented)

cachingProhibited

public static RouteAdapter cachingProhibited(Supplier<Route> inner)

Passes only requests to the inner route that explicitly forbid caching with a Cache-Control header with either a no-cache or max-age=0 setting.

Parameters:

inner - (undocumented)

Returns:

(undocumented)

alwaysCache

public static <K> RouteAdapter alwaysCache(Cache<K,RouteResult> cache,
 scala.PartialFunction<RequestContext,K> keyer,
 Supplier<Route> inner)

Wraps its inner Route with caching support using the given Cache implementation and keyer function. Note that routes producing streaming responses cannot be wrapped with this directive.

Parameters:

cache - (undocumented)

keyer - (undocumented)

inner - (undocumented)

Returns:

(undocumented)

routeCache

public static <K> Cache<K,RouteResult> routeCache(CachingSettings settings)

Creates an LfuCache

Default settings are available via pekko.http.caching.javadsl.CachingSettings.create.

Parameters:

settings - (undocumented)

Returns:

(undocumented)