fr.paris.lutece.portal.service.cache
Class HeadersPageCachingFilter

java.lang.Object
  extended by net.sf.ehcache.constructs.web.filter.Filter
      extended by net.sf.ehcache.constructs.web.filter.CachingFilter
          extended by net.sf.ehcache.constructs.web.filter.SimplePageCachingFilter
              extended by net.sf.ehcache.constructs.web.filter.SimpleCachingHeadersPageCachingFilter
                  extended by fr.paris.lutece.portal.service.cache.HeadersPageCachingFilter
All Implemented Interfaces:
CacheableService, LuteceService, javax.servlet.Filter

public class HeadersPageCachingFilter
extends net.sf.ehcache.constructs.web.filter.SimpleCachingHeadersPageCachingFilter
implements CacheableService

Headers Page Caching Filter based on EHCACHE WEB


Field Summary
 
Fields inherited from class net.sf.ehcache.constructs.web.filter.SimpleCachingHeadersPageCachingFilter
NAME
 
Fields inherited from class net.sf.ehcache.constructs.web.filter.SimplePageCachingFilter
DEFAULT_CACHE_NAME
 
Fields inherited from class net.sf.ehcache.constructs.web.filter.CachingFilter
blockingCache, cacheName
 
Fields inherited from class net.sf.ehcache.constructs.web.filter.Filter
exceptionsToLogDifferently, filterConfig, NO_FILTER, suppressStackTraces
 
Constructor Summary
HeadersPageCachingFilter()
           
 
Method Summary
protected  void doFilter(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, javax.servlet.FilterChain chain)
          
 void doInit(javax.servlet.FilterConfig filterConfig)
          
 void enableCache(boolean bEnable)
          Enable the cache
protected  java.lang.String getCacheName()
           This method is overriden to provide the cache name
 int getCacheSize()
          Gets the number of item currently in the cache.
 java.lang.String getInfos()
          Returns cache infos
 java.util.List<java.lang.String> getKeys()
          Gets all keys in the cache
 int getMaxElements()
          Returns maximum elements accepted into the cache
 long getMemorySize()
          Return the memory size
 java.lang.String getName()
          Returns the Service name
 long getTimeToLive()
          Returns the time to live for objects in the cache
 boolean isCacheEnable()
          Gets the current cache status.
 void resetCache()
          Reset the cache.
 
Methods inherited from class net.sf.ehcache.constructs.web.filter.SimpleCachingHeadersPageCachingFilter
buildPage, calculateTimeToLiveMilliseconds, getHttpDateFormatter, writeResponse
 
Methods inherited from class net.sf.ehcache.constructs.web.filter.SimplePageCachingFilter
calculateKey, getCacheManager
 
Methods inherited from class net.sf.ehcache.constructs.web.filter.CachingFilter
buildPageInfo, checkNoReentry, doDestroy, setCacheNameIfAnyConfigured, setContentType, setCookies, setHeaders, setStatus, writeContent
 
Methods inherited from class net.sf.ehcache.constructs.web.filter.Filter
acceptsEncoding, acceptsGzipEncoding, destroy, doFilter, filterNotDisabled, getFilterConfig, init, logRequestHeaders, processInitParams
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

HeadersPageCachingFilter

public HeadersPageCachingFilter()
Method Detail

doInit

public void doInit(javax.servlet.FilterConfig filterConfig)
            throws net.sf.ehcache.CacheException

Overrides:
doInit in class net.sf.ehcache.constructs.web.filter.CachingFilter
Throws:
net.sf.ehcache.CacheException

getCacheName

protected java.lang.String getCacheName()
This method is overriden to provide the cache name

Overrides:
getCacheName in class net.sf.ehcache.constructs.web.filter.SimplePageCachingFilter

doFilter

protected void doFilter(javax.servlet.http.HttpServletRequest request,
                        javax.servlet.http.HttpServletResponse response,
                        javax.servlet.FilterChain chain)
                 throws net.sf.ehcache.constructs.web.AlreadyGzippedException,
                        net.sf.ehcache.constructs.web.AlreadyCommittedException,
                        net.sf.ehcache.constructs.web.filter.FilterNonReentrantException,
                        net.sf.ehcache.constructs.blocking.LockTimeoutException,
                        java.lang.Exception

Overrides:
doFilter in class net.sf.ehcache.constructs.web.filter.CachingFilter
Throws:
net.sf.ehcache.constructs.web.AlreadyGzippedException
net.sf.ehcache.constructs.web.AlreadyCommittedException
net.sf.ehcache.constructs.web.filter.FilterNonReentrantException
net.sf.ehcache.constructs.blocking.LockTimeoutException
java.lang.Exception

isCacheEnable

public boolean isCacheEnable()
Gets the current cache status.

Specified by:
isCacheEnable in interface CacheableService
Returns:
true if enable, otherwise false

getCacheSize

public int getCacheSize()
Gets the number of item currently in the cache.

Specified by:
getCacheSize in interface CacheableService
Returns:
the number of item currently in the cache.

resetCache

public void resetCache()
Reset the cache.

Specified by:
resetCache in interface CacheableService

getName

public java.lang.String getName()
Returns the Service name

Specified by:
getName in interface LuteceService
Returns:
The name as a String

enableCache

public void enableCache(boolean bEnable)
Enable the cache

Specified by:
enableCache in interface CacheableService
Parameters:
bEnable - true to enable, false to disable

getKeys

public java.util.List<java.lang.String> getKeys()
Gets all keys in the cache

Specified by:
getKeys in interface CacheableService
Returns:
The List

getMaxElements

public int getMaxElements()
Returns maximum elements accepted into the cache

Specified by:
getMaxElements in interface CacheableService
Returns:
The max elements

getTimeToLive

public long getTimeToLive()
Returns the time to live for objects in the cache

Specified by:
getTimeToLive in interface CacheableService
Returns:
The time to live in seconds

getMemorySize

public long getMemorySize()
Return the memory size

Specified by:
getMemorySize in interface CacheableService
Returns:
the memory size

getInfos

public java.lang.String getInfos()
Returns cache infos

Specified by:
getInfos in interface CacheableService
Returns:
cache infos


Copyright © 2011 Mairie de Paris. All Rights Reserved.