org.jboss.cache.config

Class EvictionConfig

java.lang.Object

org.jboss.cache.config.ConfigurationComponent

org.jboss.cache.config.EvictionConfig

All Implemented Interfaces:

Serializable, Cloneable, CloneableConfigurationComponent

public class EvictionConfig
extends ConfigurationComponent

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static int	EVENT_QUEUE_SIZE_DEFAULT
static String	EVICTION_ACTION_POLICY_CLASS_DEFAULT
static int	WAKEUP_DEFAULT

Fields inherited from class org.jboss.cache.config.ConfigurationComponent

log

Constructor Summary

Constructors

Constructor and Description
EvictionConfig()
EvictionConfig(EvictionRegionConfig defaultEvictionRegionConfig)
EvictionConfig(EvictionRegionConfig defaultEvictionRegionConfig, int wakeupInterval)
EvictionConfig(String defaultEvictionPolicyClass) Deprecated. Use EvictionConfig(EvictionRegionConfig) instead.

Method Summary

Methods

Modifier and Type	Method and Description
void	addEvictionRegionConfig(EvictionRegionConfig evictionRegionConfig)
void	applyDefaults(EvictionRegionConfig config) Applies defaults to a config passed in
static void	assertIsTransformable(String evictionPolicyClass) Deprecated.
EvictionConfig	clone()
EvictionRegionConfig	createDefaultEvictionRegionConfig() Deprecated. the default region is now created when this instance is constructed. Use getDefaultEvictionRegionConfig() instead.
boolean	equals(Object o)
String	getDefaultEvictionPolicyClass() Deprecated. use getDefaultEvictionRegionConfig() instead.
EvictionRegionConfig	getDefaultEvictionRegionConfig()
EvictionRegionConfig	getEvictionRegionConfig(String region) Returns the EvictionRegionConfig coresponding to given region fqn, or null if no match is found.
List<EvictionRegionConfig>	getEvictionRegionConfigs()
long	getWakeupInterval()
int	getWakeupIntervalSeconds() Deprecated. Use getWakeupIntervalSeconds().
int	hashCode()
boolean	isValidConfig()
void	setDefaultEventQueueSize(int queueSize) Deprecated. set these attributes on the default eviction region config.
void	setDefaultEvictionPolicyClass(String defaultEvictionPolicyClass) Deprecated. use setDefaultEvictionRegionConfig(EvictionRegionConfig) instead.
void	setDefaultEvictionRegionConfig(EvictionRegionConfig defaultEvictionRegionConfig)
void	setEvictionRegionConfigs(List<EvictionRegionConfig> evictionRegionConfigs)
void	setWakeupInterval(long wakeupInterval) Set the wake up interval for the eviction thread.
void	setWakeupInterval(long wakeupInterval, TimeUnit timeUnit) Set the wake up interval for the eviction thread.
void	setWakeupIntervalSeconds(int wakeupIntervalSeconds) Deprecated. Use setWakeupInterval(long).

Methods inherited from class org.jboss.cache.config.ConfigurationComponent

addChildConfig, addChildConfigs, passCacheToChildConfig, removeChildConfig, removeChildConfigs, replaceChildConfig, replaceChildConfigs, setCache, testImmutability

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

WAKEUP_DEFAULT

public static final int WAKEUP_DEFAULT

See Also:

Constant Field Values

EVENT_QUEUE_SIZE_DEFAULT

public static final int EVENT_QUEUE_SIZE_DEFAULT

See Also:

Constant Field Values

EVICTION_ACTION_POLICY_CLASS_DEFAULT

public static final String EVICTION_ACTION_POLICY_CLASS_DEFAULT

Constructor Detail

EvictionConfig

public EvictionConfig()

EvictionConfig

@Deprecated
public EvictionConfig(String defaultEvictionPolicyClass)

Deprecated. Use EvictionConfig(EvictionRegionConfig) instead.

EvictionConfig

public EvictionConfig(EvictionRegionConfig defaultEvictionRegionConfig)

EvictionConfig

public EvictionConfig(EvictionRegionConfig defaultEvictionRegionConfig,
              int wakeupInterval)

Method Detail

isValidConfig

public boolean isValidConfig()

getDefaultEvictionRegionConfig

public EvictionRegionConfig getDefaultEvictionRegionConfig()

setDefaultEvictionRegionConfig

public void setDefaultEvictionRegionConfig(EvictionRegionConfig defaultEvictionRegionConfig)

getDefaultEvictionPolicyClass

@Deprecated
public String getDefaultEvictionPolicyClass()

Deprecated. use getDefaultEvictionRegionConfig() instead.

setDefaultEvictionPolicyClass

@Deprecated
public void setDefaultEvictionPolicyClass(String defaultEvictionPolicyClass)

Deprecated. use setDefaultEvictionRegionConfig(EvictionRegionConfig) instead.

assertIsTransformable

@Deprecated
public static final void assertIsTransformable(String evictionPolicyClass)
                                        throws UnsupportedEvictionImplException

Deprecated.

Tests whether an eviction policy class can be transformed from the legacy format to the new interfaces introduced in 3.x. If not, this methow throws a UnsupportedEvictionImplException.

Parameters:

evictionPolicyClass - class to test

Throws:

UnsupportedEvictionImplException - thrown if the eviction policy passed in is unusable

createDefaultEvictionRegionConfig

@Deprecated
public EvictionRegionConfig createDefaultEvictionRegionConfig()

Deprecated. the default region is now created when this instance is constructed. Use getDefaultEvictionRegionConfig() instead.

Creates an EvictionRegionConfig for the "_default_" region using the getDefaultEvictionPolicyClass() default eviction policy class}. Throws a ConfigurationException if a default eviction policy class has not been set.

Returns:

an EvictionRegionConfig whose FQN is RegionManagerImpl.DEFAULT_REGION and whose EvictionPolicyConfig is the default config for the default eviction policy class.

Throws:

ConfigurationException - if a a default eviction policy class has not been set or there is a problem instantiating the configuration.

getEvictionRegionConfigs

public List<EvictionRegionConfig> getEvictionRegionConfigs()

setEvictionRegionConfigs

public void setEvictionRegionConfigs(List<EvictionRegionConfig> evictionRegionConfigs)

addEvictionRegionConfig

public void addEvictionRegionConfig(EvictionRegionConfig evictionRegionConfig)

getWakeupInterval

public long getWakeupInterval()

Returns:

the wake up interval of the eviction thread, in milliseconds.

setWakeupInterval

public void setWakeupInterval(long wakeupInterval)

Set the wake up interval for the eviction thread. 0 or a negative number disables the eviction thread.

Parameters:

wakeupInterval - interval, in milliseconds.

setWakeupInterval

public void setWakeupInterval(long wakeupInterval,
                     TimeUnit timeUnit)

Set the wake up interval for the eviction thread. 0 or a negative number disables the eviction thread.

Parameters:

wakeupInterval - interval

timeUnit - for the interval provided

getWakeupIntervalSeconds

@Deprecated
public int getWakeupIntervalSeconds()

Deprecated. Use getWakeupIntervalSeconds().

setWakeupIntervalSeconds

@Deprecated
public void setWakeupIntervalSeconds(int wakeupIntervalSeconds)

Deprecated. Use setWakeupInterval(long).

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public EvictionConfig clone()
                     throws CloneNotSupportedException

Specified by:

clone in interface CloneableConfigurationComponent

Overrides:

clone in class ConfigurationComponent

Throws:

CloneNotSupportedException

getEvictionRegionConfig

public EvictionRegionConfig getEvictionRegionConfig(String region)

Returns the EvictionRegionConfig coresponding to given region fqn, or null if no match is found.

applyDefaults

public void applyDefaults(EvictionRegionConfig config)

Applies defaults to a config passed in

Parameters:

config - config to apply defaults to

setDefaultEventQueueSize

@Deprecated
public void setDefaultEventQueueSize(int queueSize)

Deprecated. set these attributes on the default eviction region config.