info.magnolia.module.cache.filter

Class CacheFilter

java.lang.Object

info.magnolia.cms.filters.AbstractMgnlFilter

info.magnolia.cms.filters.OncePerRequestAbstractMgnlFilter

info.magnolia.module.cache.filter.CacheFilter

All Implemented Interfaces:

info.magnolia.cms.filters.MgnlFilter, CacheModuleLifecycleListener, javax.servlet.Filter

public class CacheFilter
extends info.magnolia.cms.filters.OncePerRequestAbstractMgnlFilter
implements CacheModuleLifecycleListener

Uses the CachePolicy to determine the cache behavior. Uses then the ContentCachingConfiguration to get the executors to be executed.

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_CONTENT_CACHING_CONFIGURATION_NAME Deprecated. since 5.4, use AbstractCacheModule.DEFAULT_CACHE_CONFIG.

Constructor Summary

Constructors

Constructor and Description
CacheFilter(CacheModule cacheModule, CacheMonitor cacheMonitor)

Method Summary

Modifier and Type	Method and Description
void	doFilter(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, javax.servlet.FilterChain chain)
String	getCacheConfigurationName() Deprecated. since 5.4, use getDefaultContentCachingConfigurationName().
protected Cache	getCurrentPageCache()
String	getDefaultContentCachingConfigurationName()
protected CacheModule	getModule()
void	init(javax.servlet.FilterConfig filterConfig)
void	onCacheModuleStart()
void	setCacheConfigurationName(String cacheConfigurationName) Deprecated. since 5.4, use setDefaultContentCachingConfigurationName(String).
void	setDefaultContentCachingConfigurationName(String defaultContentCachingConfigurationName)

Methods inherited from class info.magnolia.cms.filters.OncePerRequestAbstractMgnlFilter

bypasses, doFilter

Methods inherited from class info.magnolia.cms.filters.AbstractMgnlFilter

acceptsEncoding, acceptsGzipEncoding, addAndVerifyHeader, addBypass, addMapping, destroy, getBypasses, getDispatching, getMapping, getMappings, getName, headerContains, isEnabled, mapsTo, matches, matchesDispatching, setBypasses, setDispatching, setEnabled, setMappings, setName

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_CONTENT_CACHING_CONFIGURATION_NAME

@Deprecated
public static final String DEFAULT_CONTENT_CACHING_CONFIGURATION_NAME

Deprecated. since 5.4, use AbstractCacheModule.DEFAULT_CACHE_CONFIG.

See Also:

Constant Field Values

Constructor Detail

CacheFilter

@Inject
public CacheFilter(CacheModule cacheModule,
                           CacheMonitor cacheMonitor)

Method Detail

getCacheConfigurationName

@Deprecated
public String getCacheConfigurationName()

Deprecated. since 5.4, use getDefaultContentCachingConfigurationName().

setCacheConfigurationName

@Deprecated
public void setCacheConfigurationName(String cacheConfigurationName)

Deprecated. since 5.4, use setDefaultContentCachingConfigurationName(String).

getDefaultContentCachingConfigurationName

public String getDefaultContentCachingConfigurationName()

setDefaultContentCachingConfigurationName

public void setDefaultContentCachingConfigurationName(String defaultContentCachingConfigurationName)

init

public void init(javax.servlet.FilterConfig filterConfig)
          throws javax.servlet.ServletException

Specified by:

init in interface javax.servlet.Filter

Overrides:

init in class info.magnolia.cms.filters.AbstractMgnlFilter

Throws:

javax.servlet.ServletException

onCacheModuleStart

public void onCacheModuleStart()

Specified by:

onCacheModuleStart in interface CacheModuleLifecycleListener

getCurrentPageCache

protected Cache getCurrentPageCache()

getModule

protected CacheModule getModule()

doFilter

public void doFilter(javax.servlet.http.HttpServletRequest request,
                     javax.servlet.http.HttpServletResponse response,
                     javax.servlet.FilterChain chain)
              throws IOException,
                     javax.servlet.ServletException

Specified by:

doFilter in class info.magnolia.cms.filters.AbstractMgnlFilter

Throws:

IOException

javax.servlet.ServletException