io.neba.core.resourcemodels.caching

Class RequestScopedResourceModelCache

java.lang.Object

io.neba.core.resourcemodels.caching.RequestScopedResourceModelCache

All Implemented Interfaces:

javax.servlet.Filter

public class RequestScopedResourceModelCache
extends Object
implements javax.servlet.Filter

A request-scoped resource model cache. Models added to this cache may either be cached for the entire request regardless of state changes (selectors, suffixes, extension, query string...) during the request processing, or in a request-state sensitive manner.

Author:

Olaf Otto

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	RequestScopedResourceModelCache.Configuration

Constructor Summary

Constructors

Constructor and Description
RequestScopedResourceModelCache()

Method Summary

Modifier and Type	Method and Description
protected void	activate(RequestScopedResourceModelCache.Configuration configuration)
void	destroy()
void	doFilter(javax.servlet.ServletRequest request, javax.servlet.ServletResponse response, javax.servlet.FilterChain chain)
<T> Optional<T>	get(org.apache.sling.api.resource.Resource resource, Key key) Retrieve a cached model.
void	init(javax.servlet.FilterConfig filterConfig)
<T> void	put(org.apache.sling.api.resource.Resource resource, Key key, T model)

Methods inherited from class java.lang.Object

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

Constructor Detail

RequestScopedResourceModelCache

public RequestScopedResourceModelCache()

Method Detail

activate

protected void activate(RequestScopedResourceModelCache.Configuration configuration)

get

@CheckForNull
public <T> Optional<T> get(@Nonnull
                                          org.apache.sling.api.resource.Resource resource,
                                          @Nonnull
                                          Key key)

Retrieve a cached model.

Parameters:

resource - The resource adapted to the target type. Never null.

key - The key used to identify the stored model. Never null.

Returns:

Either an instance of Optional - which means the object was stored as non null or known null value, depending on whether the option Optional.isPresent(), or null, signaling that the key is not known to the cache.

put

public <T> void put(@Nonnull
                    org.apache.sling.api.resource.Resource resource,
                    @Nonnull
                    Key key,
                    @CheckForNull
                    T model)

Parameters:

resource - The resource adapted to the target type. Never null.

model - the model representing the mapped result of the adaptation. Can be null.

key - the key by which the model is identified and get(Resource, Key) retrieved}. Never null.

doFilter

public void doFilter(@Nonnull
                     javax.servlet.ServletRequest request,
                     @Nonnull
                     javax.servlet.ServletResponse response,
                     @Nonnull
                     javax.servlet.FilterChain chain)
              throws IOException,
                     javax.servlet.ServletException

Specified by:

doFilter in interface javax.servlet.Filter

Throws:

IOException

javax.servlet.ServletException

init

public void init(javax.servlet.FilterConfig filterConfig)

Specified by:

init in interface javax.servlet.Filter

destroy

public void destroy()

Specified by:

destroy in interface javax.servlet.Filter