Package net.solarnetwork.central.web.support

Class ContentCachingFilter

java.lang.Object

net.solarnetwork.central.web.support.ContentCachingFilter

All Implemented Interfaces:

jakarta.servlet.Filter, net.solarnetwork.service.PingTest

public class ContentCachingFilter
extends Object
implements jakarta.servlet.Filter, net.solarnetwork.service.PingTest

Filter for caching HTTP responses, returning cached data when possible.

This filter delegates most behavior to a ContentCachingService.

Since:

1.16

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	ContentCachingFilter.ContentCachingFilterStats	Statistics for the content caching filter.
static class	ContentCachingFilter.LockAndCount	A lock with a corresponding counter.

Nested classes/interfaces inherited from interface net.solarnetwork.service.PingTest

net.solarnetwork.service.PingTest.Result

Field Summary

Fields

Modifier and Type	Field	Description
static final int	DEFAULT_STAT_LOG_ACCESS_COUNT	The default value for the statLogAccessCount property.

Constructor Summary

Constructors

Constructor	Description
ContentCachingFilter(ContentCachingService contentCachingService, int lockPoolCapacity)	Constructor.
ContentCachingFilter(ContentCachingService contentCachingService, BlockingQueue<ContentCachingFilter.LockAndCount> lockPool, ConcurrentMap<String,ContentCachingFilter.LockAndCount> requestLocks)	Constructor.

Method Summary

Modifier and Type	Method	Description
void	doFilter(jakarta.servlet.ServletRequest request, jakarta.servlet.ServletResponse response, jakarta.servlet.FilterChain chain)
String	getPingTestId()
long	getPingTestMaximumExecutionMilliseconds()
String	getPingTestName()
static BlockingQueue<ContentCachingFilter.LockAndCount>	lockPoolWithCapacity(int lockPoolCapacity)	Create a look pool.
net.solarnetwork.service.PingTest.Result	performPingTest()
void	setMethodsToCache(Set<String> methodsToCache)	Configure the HTTP methods that can be cached.
void	setRequestLockTimeout(long requestLockTimeout)	A timeout for waiting for a request lock.
void	setStatLogAccessCount(int statLogAccessCount)	Set the statistic log update count.

Methods inherited from class java.lang.Object

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

Methods inherited from interface jakarta.servlet.Filter

destroy, init

Field Details

DEFAULT_STAT_LOG_ACCESS_COUNT

public static final int DEFAULT_STAT_LOG_ACCESS_COUNT

The default value for the statLogAccessCount property.

See Also:

• Constant Field Values

Constructor Details

ContentCachingFilter

public ContentCachingFilter(ContentCachingService contentCachingService,
 int lockPoolCapacity)

Constructor.

Parameters:

contentCachingService - the caching service to use

lockPoolCapacity - the lock pool capacity

Throws:

IllegalArgumentException - if any argument is null

ContentCachingFilter

public ContentCachingFilter(ContentCachingService contentCachingService,
 BlockingQueue<ContentCachingFilter.LockAndCount> lockPool,
 ConcurrentMap<String,ContentCachingFilter.LockAndCount> requestLocks)

Constructor.

Parameters:

contentCachingService - the caching service to use

lockPool - the request lock pool to use; this must be pre-populated with the desired number of locks to use

requestLocks - the request lock map to use

Throws:

IllegalArgumentException - if any argument is null or the lock pool is empty

Method Details

lockPoolWithCapacity

public static BlockingQueue<ContentCachingFilter.LockAndCount> lockPoolWithCapacity(int lockPoolCapacity)

Create a look pool.

Parameters:

lockPoolCapacity - the desired capacity of the pool

Returns:

the pool

doFilter

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

Specified by:

doFilter in interface jakarta.servlet.Filter

Throws:

IOException

jakarta.servlet.ServletException

getPingTestId

public String getPingTestId()

Specified by:

getPingTestId in interface net.solarnetwork.service.PingTest

getPingTestName

public String getPingTestName()

Specified by:

getPingTestName in interface net.solarnetwork.service.PingTest

getPingTestMaximumExecutionMilliseconds

public long getPingTestMaximumExecutionMilliseconds()

Specified by:

getPingTestMaximumExecutionMilliseconds in interface net.solarnetwork.service.PingTest

performPingTest

public net.solarnetwork.service.PingTest.Result performPingTest()
                                                         throws Exception

Specified by:

performPingTest in interface net.solarnetwork.service.PingTest

Throws:

Exception

setMethodsToCache

public void setMethodsToCache(Set<String> methodsToCache)

Configure the HTTP methods that can be cached.

The method names should be all upper case.

Parameters:

methodsToCache - the methods to cache; defaults to GET only

setRequestLockTimeout

public void setRequestLockTimeout(long requestLockTimeout)

A timeout for waiting for a request lock.

Parameters:

requestLockTimeout - the timeout to use, in milliseconds; defaults to 4 minutes

setStatLogAccessCount

public void setStatLogAccessCount(int statLogAccessCount)

Set the statistic log update count.

Setting this to something greater than 0 will cause INFO level statistic log entries to be emitted every statLogAccessCount times a cachable request has been processed.

Parameters:

statLogAccessCount - the access count the access count; defaults to DEFAULT_STAT_LOG_ACCESS_COUNT

Since:

3.0