net.sf.ehcache.constructs.scheduledrefresh

Class ScheduledRefreshCacheExtension

java.lang.Object

net.sf.ehcache.constructs.scheduledrefresh.ScheduledRefreshCacheExtension

All Implemented Interfaces:

CacheExtension

public class ScheduledRefreshCacheExtension
extends Object
implements CacheExtension

This class provides a cache extension which allows for the scheduled refresh of all keys currently in the cache, using whichever CacheLoader's are defined. It uses Quartz to do the job scheduling. One extension should be active for a single clustered cache, as multiple extensions will run independently of each other.

Author:

cschanck

Constructor Summary

Constructors

Constructor and Description
ScheduledRefreshCacheExtension(ScheduledRefreshConfiguration config, Ehcache cache) Constructor.

Method Summary

Modifier and Type	Method and Description
CacheExtension	clone(Ehcache cache)
void	dispose() Note that this will not stop other instances of this refresh extension on other nodes (in a clustered environment) from running.
static ExtendedStatistics.Statistic<Number>	findJobStatistic(Ehcache cache) Finds a single job statistic for this cache.
static Set<ExtendedStatistics.Statistic<Number>>	findJobStatistics(Ehcache cache) Find job counter statistic.
static ExtendedStatistics.Statistic<Number>	findKeysProcessedStatistic(Ehcache cache) Finds a single keys processed statistic for this cache.
static Set<ExtendedStatistics.Statistic<Number>>	findKeysProcessedStatistics(Ehcache cache) Find queued counter statistic.
static ExtendedStatistics.Statistic<Number>	findRefreshStatistic(Ehcache cache) Finds a single refresh statistic for this cache.
static Set<ExtendedStatistics.Statistic<Number>>	findRefreshStatistics(Ehcache cache) Find refreshed counter statistic.
long	getJobCount() Gets job count.
long	getKeysProcessedCount() Gets keys processed count.
long	getRefreshCount() Gets refresh count.
Status	getStatus()
void	init()

Methods inherited from class java.lang.Object

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

Constructor Detail

ScheduledRefreshCacheExtension

public ScheduledRefreshCacheExtension(ScheduledRefreshConfiguration config,
                                      Ehcache cache)

Constructor. Create an extension with the specified config object against the specified cache.

Parameters:

config - Configuration to use.

cache - Cache to process against.

Method Detail

init

public void init()

Specified by:

init in interface CacheExtension

dispose

public void dispose()
             throws CacheException

Note that this will not stop other instances of this refresh extension on other nodes (in a clustered environment) from running. Until and unless the last scheduled refresh cache extension for a particular cache/cache manager/unique name is shutdown, they will continue to run. This is only an issue for clustered, TerracottaJobStore-backed scheduled refresh cache extensions.

Specified by:

dispose in interface CacheExtension

Throws:

CacheException

clone

public CacheExtension clone(Ehcache cache)
                     throws CloneNotSupportedException

Specified by:

clone in interface CacheExtension

Throws:

CloneNotSupportedException

getStatus

public Status getStatus()

Specified by:

getStatus in interface CacheExtension

getRefreshCount

public long getRefreshCount()

Gets refresh count.

Returns:

the refresh count

getJobCount

public long getJobCount()

Gets job count.

Returns:

the job count

getKeysProcessedCount

public long getKeysProcessedCount()

Gets keys processed count.

Returns:

the keys processed count

findRefreshStatistics

public static Set<ExtendedStatistics.Statistic<Number>> findRefreshStatistics(Ehcache cache)

Find refreshed counter statistic. Number of times schedule refresh has been started on this node.

Parameters:

cache - the cache this statistic is attached to.

Returns:

the set

findJobStatistics

public static Set<ExtendedStatistics.Statistic<Number>> findJobStatistics(Ehcache cache)

Find job counter statistic. Number of batch jobs executed on this node.

Parameters:

cache - the cache this statistic is attached to.

Returns:

the set

findKeysProcessedStatistics

public static Set<ExtendedStatistics.Statistic<Number>> findKeysProcessedStatistics(Ehcache cache)

Find queued counter statistic. Number of batch jobs executed on this node.

Parameters:

cache - the cache this statistic is attached to.

Returns:

the set

findRefreshStatistic

public static ExtendedStatistics.Statistic<Number> findRefreshStatistic(Ehcache cache)

Finds a single refresh statistic for this cache. This is the count of scheduled refresh invocations for this node. Throws IllegalStateException if there are none or more than one.

Parameters:

cache - the cache

Returns:

the extended statistics . statistic

findJobStatistic

public static ExtendedStatistics.Statistic<Number> findJobStatistic(Ehcache cache)

Finds a single job statistic for this cache. This is the count of refresh batch jobs executed on this node. Throws IllegalStateException if there are none or more than one.

Parameters:

cache - the cache

Returns:

the extended statistics . statistic

findKeysProcessedStatistic

public static ExtendedStatistics.Statistic<Number> findKeysProcessedStatistic(Ehcache cache)

Finds a single keys processed statistic for this cache. This is the count of keys refreshed on this node. Throws IllegalStateException if there are none or more than one.

Parameters:

cache - the cache

Returns:

the extended statistics . statistic