Class TopLevelCache

java.lang.Object

services.moleculer.service.MoleculerComponent

services.moleculer.service.Service

services.moleculer.web.middleware.HttpMiddleware

services.moleculer.web.middleware.TopLevelCache

All Implemented Interfaces:

services.moleculer.service.MoleculerLifecycle, HttpConstants

public class TopLevelCache
extends HttpMiddleware
implements HttpConstants

URL-based content cache. It is good for caching the responses of non-authenticated REST services with large responses. For example, if the service generates blog/wiki content using a HTML Template Egine. It is not advisable to cache POST requests and/or requests that depend not only on the URL but also on the content of the request. TopLevelCache speeds up querying of various reports (tables, charts) and dynamically generated images. Sample:

restRoute.use(new TopLevelCache("/blog/posts/**"));

Field Summary

Fields

Modifier and Type	Field	Description
protected final services.moleculer.cacher.Cacher	cacher
protected static final org.slf4j.Logger	logger
protected final io.datatree.dom.Cache<String,Boolean>	pathCache
protected String[]	pathPatterns
protected String	region	Cache region (~= prefix).
protected int	ttl	Expire time, in SECONDS (0 = never expires)
protected boolean	useETags	Use ETag headers

Fields inherited from class services.moleculer.service.MoleculerComponent

broker, name

Fields inherited from interface HttpConstants

ACCEPT, ACCEPT_ENCODING, AUTHORIZATION, CACHE_CONTROL, CHUNKED, CLOSE, CONNECT, CONNECTION, CONTENT_ENCODING, CONTENT_LENGTH, CONTENT_TYPE, CONTENT_TYPE_HTML, CONTENT_TYPE_JSON, COOKIE, DEFLATE, DELETE, ETAG, GET, GZIP, HEAD, IF_NONE_MATCH, KEEP_ALIVE, LOCATION, META_CONTENT_TYPE, META_HEADERS, META_LOCALE, META_LOCATION, META_SESSION, META_STATUS, META_TEMPLATE, NO_CACHE, OPTIONS, PATCH, POST, PROPERTY_COOKIES, PROPERTY_SESSION_ID, PROPERTY_USER, PUT, SET_COOKIE, TRACE, TRANSFER_ENCODING, WWW_AUTHENTICATE, X_FORWARDED_FOR

Constructor Summary

Constructors

Constructor	Description
TopLevelCache(services.moleculer.cacher.Cacher cacher, String... pathPatterns)

Method Summary

Modifier and Type	Method	Description
TopLevelCache	addPathPattern(String... pathPatterns)
String[]	getPathPatterns()
String	getRegion()
int	getTtl()
RequestProcessor	install(RequestProcessor next, io.datatree.Tree config)
void	setPathPatterns(String... pathPatterns)
void	setRegion(String region)
void	setTtl(int ttl)

Methods inherited from class services.moleculer.service.MoleculerComponent

getBroker, getLogger, getName, started, stopped

Methods inherited from class Object

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

Field Details

logger

protected static final org.slf4j.Logger logger

pathCache

protected final io.datatree.dom.Cache<String,Boolean> pathCache

cacher

protected final services.moleculer.cacher.Cacher cacher

region

protected String region

Cache region (~= prefix).

ttl

protected int ttl

Expire time, in SECONDS (0 = never expires)

pathPatterns

protected String[] pathPatterns

useETags

protected boolean useETags

Use ETag headers

Constructor Details

TopLevelCache

public TopLevelCache(services.moleculer.cacher.Cacher cacher,
 String... pathPatterns)

Method Details

install

public RequestProcessor install(RequestProcessor next,
 io.datatree.Tree config)

Specified by:

install in class HttpMiddleware

getRegion

public String getRegion()

setRegion

public void setRegion(String region)

getTtl

public int getTtl()

setTtl

public void setTtl(int ttl)

getPathPatterns

public String[] getPathPatterns()

setPathPatterns

public void setPathPatterns(String... pathPatterns)

addPathPattern

public TopLevelCache addPathPattern(String... pathPatterns)