ScheduledRefreshConfiguration (ehcache-scheduled-refresh 2.10.10-atlassian-2 API)

java.lang.Object
- net.sf.ehcache.constructs.scheduledrefresh.ScheduledRefreshConfiguration

All Implemented Interfaces:

Serializable, Cloneable
```
public class ScheduledRefreshConfiguration
extends Object
implements Serializable, Cloneable
```
Configuration for a ScheduledRefreshCacheExtension. Can be initialized from a Properties object. Currently, the use of a clustered TerracottaJobStore is not supported. This usage will be supported in the future.

Author:

cschanck

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class ScheduledRefreshConfiguration.PropKey
Property keys for configuration.

Nested Classes
Modifier and Type	Class and Description
`static class`	`ScheduledRefreshConfiguration.PropKey` Property keys for configuration.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`DEFAULT_BATCHSIZE` Default batch size for key refresh processing.
`static boolean`	`DEFAULT_NULL_EVICTS` Default setting for null eviction.
`static int`	`DEFAULT_PARALLEL_JOB_COUNT` Default number of in process job count over the entire cluster.
`static int`	`DEFAULT_POLL_TIME_MS` Default polling timeout for monitoring refresh jobs.
`static int`	`DEFAULT_QUARTZ_THREADCOUNT` Default simultaneous Quartz thread count per node.
`static boolean`	`DEFAULT_USE_BULKLOAD` Default setting for using bulkload.

Constructor Summary

Constructors
Constructor and Description

ScheduledRefreshConfiguration()
Create a default, valid configuration.

Constructors
Constructor and Description
`ScheduledRefreshConfiguration()` Create a default, valid configuration.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ScheduledRefreshConfiguration`	`batchSize(int batchSize)` Fluently set the batch size for processing refresh requests.
`ScheduledRefreshConfiguration`	`build()` Validate and mark this configuration good to use.
`protected Object`	`clone()`
`ScheduledRefreshConfiguration`	`cronExpression(String cronExpression)` Fluently set the cron expression Quartz will use for scheduling this refresh job.
`ScheduledRefreshConfiguration`	`evictOnLoadMiss(boolean loadMissEvicts)` Fluently set whether now value found in all CacheLoaders will force an eviction eviction prematurely from the underlying cache.
`ScheduledRefreshConfiguration`	`fromProperties(Properties properties)` Initialize this configuration from a `Properties` object.
`int`	`getBatchSize()` Get the batch size with which refresh requests will be processed.
`String`	`getCronExpression()` Return the string cron expression which will be passed to Quartz to schedule the refresh.
`Properties`	`getExcessProperties()` Get any unrecognized properties that were passed to this config when constructed via a Properties object.
`String`	`getJobStoreFactoryClass()` Gets the job store factory class.
`String`	`getKeyGeneratorClass()` Get the key generator class used to generate the list of keys to refresh.
`int`	`getParallelJobCount()` Gets parallel job count.
`int`	`getPollTimeMs()` Get the time interval the `OverseerJob` will use to poll for job completion.
`int`	`getQuartzThreadCount()` Get the quartz thread count.
`String`	`getScheduledRefreshName()` Get an additional identifier used in addition to the cache manager and cache name for this extension, and for the job scheduler, and job group.
`String`	`getTerracottaConfigUrl()` Gets terracotta config url.
`boolean`	`isEvictOnLoadMiss()` Get whether now value found in all CacheLoaders will force an eviction prematurely from the underlying cache.
`boolean`	`isUseBulkload()` Get whether the cache will be put in bulk load mode prior to refresh.
`boolean`	`isValid()` is this configuration valid to use?.
`ScheduledRefreshConfiguration`	`jobStoreFactory(String className)` Fluently set the Job store factory.
`ScheduledRefreshConfiguration`	`keyGeneratorClass(String keyGeneratorClass)` Fluently set the key generator class used to generate the list of keys to refresh.
`ScheduledRefreshConfiguration`	`parallelJobCount(int parallelJobCount)` Parallel job count.
`ScheduledRefreshConfiguration`	`pollTimeMs(int pollTimeMs)` Fluently set the time interval the `OverseerJob` will use to poll for job completion.
`ScheduledRefreshConfiguration`	`quartzThreadCount(int quartzThreadCount)` Fluently set the Quartz thread count.
`ScheduledRefreshConfiguration`	`scheduledRefreshName(String part)` Fluently set an additional identifier used in addition to the cache manager and cache name for this extension, and for the job scheduler, and job group.
`void`	`setBatchSize(int batchSize)` Set the batch size for processing refresh requests.
`void`	`setCronExpression(String cronExpression)` Set the cron expression Quartz will use for scheduling this refresh job.
`void`	`setEvictOnLoadMiss(boolean loadMissEvicts)` Set whether now value found in all CacheLoaders will force an eviction prematurely from the underlying cache.
`void`	`setJobStoreFactoryClassName(String className)` Sets the job store factory class name.
`void`	`setKeyGeneratorClass(String keyGeneratorClass)` Set the key generator class used to generate the list of keys to refresh.
`void`	`setParallelJobCount(int parallelJobCount)` Sets parallel job count.
`void`	`setPollTimeMs(int pollTimeMs)` Set the time interval the `OverseerJob` will use to poll for job completion.
`void`	`setQuartzThreadCount(int quartzThreadCount)` Set the Quartz thread count.
`void`	`setScheduledRefreshName(String part)` Set an additional identifier used in addition to the cache manager and cache name for this extension, and for the job scheduler, and job group.
`void`	`setTerracottaConfigUrl(String terracottaConfigUrl)` Sets terracotta config url.
`void`	`setUseBulkload(boolean useBulkload)` Set the flag to use bulk load for refreshing the keys.
`ScheduledRefreshConfiguration`	`terracottaConfigUrl(String terracottaConfigUrl)` Set the Terracotta config url, fluently.
`Properties`	`toProperties()` Express this configuration as a `Properties` object.
`String`	`toString()`
`ScheduledRefreshConfiguration`	`useBulkload(boolean yes)` Fluently set the bulk load flag.
`void`	`validate()` Validate this configuration.

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - DEFAULT_NULL_EVICTS
```
public static final boolean DEFAULT_NULL_EVICTS
```
    Default setting for null eviction.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_USE_BULKLOAD
```
public static final boolean DEFAULT_USE_BULKLOAD
```
    Default setting for using bulkload.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_BATCHSIZE
```
public static final int DEFAULT_BATCHSIZE
```
    Default batch size for key refresh processing.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_QUARTZ_THREADCOUNT
```
public static final int DEFAULT_QUARTZ_THREADCOUNT
```
    Default simultaneous Quartz thread count per node.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_PARALLEL_JOB_COUNT
```
public static final int DEFAULT_PARALLEL_JOB_COUNT
```
    Default number of in process job count over the entire cluster.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_POLL_TIME_MS
```
public static final int DEFAULT_POLL_TIME_MS
```
    Default polling timeout for monitoring refresh jobs.
- Constructor Detail
  - ScheduledRefreshConfiguration
```
public ScheduledRefreshConfiguration()
```
    Create a default, valid configuration.
- Method Detail
  - fromProperties
```
public ScheduledRefreshConfiguration fromProperties(Properties properties)
```
    Initialize this configuration from a Properties object. Will be validated before returning.
    
    Parameters:
    
    properties - the properties
    
    Returns:
    
    this configuration
  - toProperties
```
public Properties toProperties()
```
    Express this configuration as a Properties object.
    
    Returns:
    
    properties version of this config
  - build
```
public ScheduledRefreshConfiguration build()
```
    Validate and mark this configuration good to use.
    
    Returns:
    
    validated configuration
  - validate
```
public void validate()
```
    Validate this configuration.
  - isValid
```
public boolean isValid()
```
    is this configuration valid to use?.
    
    Returns:
    
    true if it is valid
  - getBatchSize
```
public int getBatchSize()
```
    Get the batch size with which refresh requests will be processed.
    
    Returns:
    
    batch size
  - setBatchSize
```
public void setBatchSize(int batchSize)
```
    Set the batch size for processing refresh requests. This is the number of keys will be processed in a batch.
    
    Parameters:
    
    batchSize - maximum batch size
  - batchSize
```
public ScheduledRefreshConfiguration batchSize(int batchSize)
```
    Fluently set the batch size for processing refresh requests.
    
    Parameters:
    
    batchSize - maximum batch size
    
    Returns:
    
    this configuration object
  - isUseBulkload
```
public boolean isUseBulkload()
```
    Get whether the cache will be put in bulk load mode prior to refresh.
    
    Returns:
    
    true if bulk load mode will be used for loading
  - setUseBulkload
```
public void setUseBulkload(boolean useBulkload)
```
    Set the flag to use bulk load for refreshing the keys. If true, the cache will be put in bulkLoade mode prior to running the refresh, and after all the jobs are finished, it will be restored to it's prior state.
    
    Parameters:
    
    useBulkload - the new use bulkload
  - useBulkload
```
public ScheduledRefreshConfiguration useBulkload(boolean yes)
```
    Fluently set the bulk load flag.
    
    Parameters:
    
    yes - the yes
    
    Returns:
    
    this configuration
  - getCronExpression
```
public String getCronExpression()
```
    Return the string cron expression which will be passed to Quartz to schedule the refresh.
    
    Returns:
    
    cron expression string
  - setCronExpression
```
public void setCronExpression(String cronExpression)
```
    Set the cron expression Quartz will use for scheduling this refresh job. See Quartz documentation for a further explanation.
    
    Parameters:
    
    cronExpression - the new cron expression
  - cronExpression
```
public ScheduledRefreshConfiguration cronExpression(String cronExpression)
```
    Fluently set the cron expression Quartz will use for scheduling this refresh job.
    
    Parameters:
    
    cronExpression - the cron expression
    
    Returns:
    
    this configuration
  - getQuartzThreadCount
```
public int getQuartzThreadCount()
```
    Get the quartz thread count.
    
    Returns:
    
    the quartz thread count
  - setQuartzThreadCount
```
public void setQuartzThreadCount(int quartzThreadCount)
```
    Set the Quartz thread count. This is the number of concurrent refresh batches which can be processed at one time. The overseeing job will poll and not schedule more than this many jobs at one time.
    
    Parameters:
    
    quartzThreadCount - the new quartz thread count
  - quartzThreadCount
```
public ScheduledRefreshConfiguration quartzThreadCount(int quartzThreadCount)
```
    Fluently set the Quartz thread count.
    
    Parameters:
    
    quartzThreadCount - the quartz thread count
    
    Returns:
    
    this configuration
  - getKeyGeneratorClass
```
public String getKeyGeneratorClass()
```
    Get the key generator class used to generate the list of keys to refresh.
    
    Returns:
    
    the fully qualified class name of the ScheduledRefreshKeyGenerator class
  - setKeyGeneratorClass
```
public void setKeyGeneratorClass(String keyGeneratorClass)
```
    Set the key generator class used to generate the list of keys to refresh. This is the class used to generate keys from the target cache. A simple implementation of the naive getKeys() approach is supplied.
    
    Parameters:
    
    keyGeneratorClass - the new key generator class
  - keyGeneratorClass
```
public ScheduledRefreshConfiguration keyGeneratorClass(String keyGeneratorClass)
```
    Fluently set the key generator class used to generate the list of keys to refresh.
    
    Parameters:
    
    keyGeneratorClass - the key generator class
    
    Returns:
    
    this configuration
  - getScheduledRefreshName
```
public String getScheduledRefreshName()
```
    Get an additional identifier used in addition to the cache manager and cache name for this extension, and for the job scheduler, and job group. If you are going to have multiple scheduled refresh extensions on the same cache, this is necessary.
    
    Returns:
    
    An additional unique identifier for the scheduler and it's jobs
  - setScheduledRefreshName
```
public void setScheduledRefreshName(String part)
```
    Set an additional identifier used in addition to the cache manager and cache name for this extension, and for the job scheduler, and job group. If you are going to have multiple scheduled refresh extensions on the same cache, this is necessary.
    
    Parameters:
    
    part - the new unique name part
  - scheduledRefreshName
```
public ScheduledRefreshConfiguration scheduledRefreshName(String part)
```
    Fluently set an additional identifier used in addition to the cache manager and cache name for this extension, and for the job scheduler, and job group. If you are going to have multiple scheduled refresh extensions on the same cache, this is necessary.
    
    Parameters:
    
    part - unique identifier used to distinguish this scheduled refresh instance from others on the same cache
    
    Returns:
    
    this configuration
  - isEvictOnLoadMiss
```
public boolean isEvictOnLoadMiss()
```
    Get whether now value found in all CacheLoaders will force an eviction prematurely from the underlying cache.
    
    Returns:
    
    true if refresh will remove keys it annot load through the cache loaders
  - setEvictOnLoadMiss
```
public void setEvictOnLoadMiss(boolean loadMissEvicts)
```
    Set whether now value found in all CacheLoaders will force an eviction prematurely from the underlying cache.
    
    Parameters:
    
    loadMissEvicts - true to evict
  - evictOnLoadMiss
```
public ScheduledRefreshConfiguration evictOnLoadMiss(boolean loadMissEvicts)
```
    Fluently set whether now value found in all CacheLoaders will force an eviction eviction prematurely from the underlying cache.
    
    Parameters:
    
    loadMissEvicts - true to evict
    
    Returns:
    
    this configuration
  - getPollTimeMs
```
public int getPollTimeMs()
```
    Get the time interval the OverseerJob will use to poll for job completion.
    
    Returns:
    
    time in milliseconds the controlling job will poll the scheduler's JobStore in order to schedule the next batch of keys.
  - setPollTimeMs
```
public void setPollTimeMs(int pollTimeMs)
```
    Set the time interval the OverseerJob will use to poll for job completion.
    
    Parameters:
    
    pollTimeMs - time in milliseconds the controlling job will poll the scheduler's JobStore in order to schedule the next batch of keys.
  - pollTimeMs
```
public ScheduledRefreshConfiguration pollTimeMs(int pollTimeMs)
```
    Fluently set the time interval the OverseerJob will use to poll for job completion.
    
    Parameters:
    
    pollTimeMs - time in milliseconds the controlling job will poll the scheduler's
    
    Returns:
    
    this configuration JobStore in order to schedule the next batch of keys.
  - getJobStoreFactoryClass
```
public String getJobStoreFactoryClass()
```
    Gets the job store factory class.
    
    Returns:
    
    the job store factory class
  - setJobStoreFactoryClassName
```
public void setJobStoreFactoryClassName(String className)
```
    Sets the job store factory class name.
    
    Parameters:
    
    className - the new job store factory class name
  - jobStoreFactory
```
public ScheduledRefreshConfiguration jobStoreFactory(String className)
```
    Fluently set the Job store factory.
    
    Parameters:
    
    className - the class name
    
    Returns:
    
    the scheduled refresh configuration
  - getExcessProperties
```
public Properties getExcessProperties()
```
    Get any unrecognized properties that were passed to this config when constructed via a Properties object.
    
    Returns:
    
    properties
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - clone
```
protected Object clone()
                throws CloneNotSupportedException
```
    Overrides:
    
    clone in class Object
    
    Throws:
    
    CloneNotSupportedException
  - setTerracottaConfigUrl
```
public void setTerracottaConfigUrl(String terracottaConfigUrl)
```
    Sets terracotta config url. Also sets (or clears) the job store factory to ScheduledRefreshTerracottaJobStoreFactory or null.
    
    Parameters:
    
    terracottaConfigUrl - the terracotta config url
  - terracottaConfigUrl
```
public ScheduledRefreshConfiguration terracottaConfigUrl(String terracottaConfigUrl)
```
    Set the Terracotta config url, fluently.
    
    Parameters:
    
    terracottaConfigUrl - the terracotta config url
    
    Returns:
    
    the scheduled refresh configuration
  - getTerracottaConfigUrl
```
public String getTerracottaConfigUrl()
```
    Gets terracotta config url.
    
    Returns:
    
    the terracotta config url
  - setParallelJobCount
```
public void setParallelJobCount(int parallelJobCount)
```
    Sets parallel job count.
    
    Parameters:
    
    parallelJobCount - the parallel job count
  - parallelJobCount
```
public ScheduledRefreshConfiguration parallelJobCount(int parallelJobCount)
```
    Parallel job count.
    
    Parameters:
    
    parallelJobCount - the parallel job count
    
    Returns:
    
    the scheduled refresh configuration
  - getParallelJobCount
```
public int getParallelJobCount()
```
    Gets parallel job count.
    
    Returns:
    
    the parallel job count

Class ScheduledRefreshConfiguration

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_NULL_EVICTS

DEFAULT_USE_BULKLOAD

DEFAULT_BATCHSIZE

DEFAULT_QUARTZ_THREADCOUNT

DEFAULT_PARALLEL_JOB_COUNT

DEFAULT_POLL_TIME_MS

Constructor Detail

ScheduledRefreshConfiguration

Method Detail

fromProperties

toProperties

build

validate

isValid

getBatchSize

setBatchSize

batchSize

isUseBulkload

setUseBulkload

useBulkload

getCronExpression

setCronExpression

cronExpression

getQuartzThreadCount

setQuartzThreadCount

quartzThreadCount

getKeyGeneratorClass

setKeyGeneratorClass

keyGeneratorClass

getScheduledRefreshName

setScheduledRefreshName

scheduledRefreshName

isEvictOnLoadMiss

setEvictOnLoadMiss

evictOnLoadMiss

getPollTimeMs

setPollTimeMs

pollTimeMs

getJobStoreFactoryClass

setJobStoreFactoryClassName

jobStoreFactory

getExcessProperties

toString

clone

setTerracottaConfigUrl

terracottaConfigUrl

getTerracottaConfigUrl

setParallelJobCount

parallelJobCount

getParallelJobCount