org.hibernate.cache.infinispan

Class TypeOverrides

java.lang.Object

org.hibernate.cache.infinispan.TypeOverrides

Direct Known Subclasses:

TimestampTypeOverrides

public class TypeOverrides
extends Object

This class represents Infinispan cache parameters that can be configured via hibernate configuration properties for either general entity/collection/query/timestamp data type caches and overrides for individual entity or collection caches. Configuration these properties override previously defined properties in XML file.

Since:

3.5

Constructor Summary

Constructors

Constructor and Description
TypeOverrides()

Method Summary

Methods

Modifier and Type	Method and Description
void	applyTo(org.infinispan.configuration.cache.ConfigurationBuilder builder) Apply the configuration overrides in this TypeOverrides instance to the cache configuration builder passed as parameter.
String	getCacheName()
int	getEvictionMaxEntries()
org.infinispan.eviction.EvictionStrategy	getEvictionStrategy()
long	getEvictionWakeUpInterval()
long	getExpirationLifespan()
long	getExpirationMaxIdle()
boolean	isExposeStatistics()
void	setCacheName(String cacheName)
void	setEvictionMaxEntries(int evictionMaxEntries) Maximum number of entries in a cache for this cached type.
void	setEvictionStrategy(String evictionStrategy) Sets eviction strategy for cached type.
void	setEvictionWakeUpInterval(long evictionWakeUpInterval) Sets how often eviction process should be run for the cached type.
void	setExpirationLifespan(long expirationLifespan) Maximum lifespan of a cache entry, after which the entry is expired cluster-wide, in milliseconds.
void	setExpirationMaxIdle(long expirationMaxIdle) Maximum idle time a cache entry will be maintained in the cache, in milliseconds.
void	setExposeStatistics(boolean isExposeStatistics) Enable statistics gathering and reporting via JMX.
String	toString()
void	validateInfinispanConfiguration(org.infinispan.configuration.cache.Configuration cfg) Validate the configuration for this cached type.

Methods inherited from class java.lang.Object

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

Constructor Detail

TypeOverrides

public TypeOverrides()

Method Detail

getCacheName

public String getCacheName()

setCacheName

public void setCacheName(String cacheName)

getEvictionStrategy

public org.infinispan.eviction.EvictionStrategy getEvictionStrategy()

setEvictionStrategy

public void setEvictionStrategy(String evictionStrategy)

Sets eviction strategy for cached type.

Parameters:

evictionStrategy - String defining eviction strategy allowed. Possible values are defined in EvictionStrategy

getEvictionWakeUpInterval

public long getEvictionWakeUpInterval()

setEvictionWakeUpInterval

public void setEvictionWakeUpInterval(long evictionWakeUpInterval)

Sets how often eviction process should be run for the cached type.

Parameters:

evictionWakeUpInterval - long representing the frequency for executing the eviction process, in milliseconds

getEvictionMaxEntries

public int getEvictionMaxEntries()

setEvictionMaxEntries

public void setEvictionMaxEntries(int evictionMaxEntries)

Maximum number of entries in a cache for this cached type. Cache size is guaranteed not to exceed upper limit specified by max entries. However, due to the nature of eviction it is unlikely to ever be exactly maximum number of entries specified here.

Parameters:

evictionMaxEntries - number of maximum cache entries

getExpirationLifespan

public long getExpirationLifespan()

setExpirationLifespan

public void setExpirationLifespan(long expirationLifespan)

Maximum lifespan of a cache entry, after which the entry is expired cluster-wide, in milliseconds. -1 means the entries never expire.

Parameters:

expirationLifespan - long representing the maximum lifespan, in milliseconds, for a cached entry before it's expired

getExpirationMaxIdle

public long getExpirationMaxIdle()

setExpirationMaxIdle

public void setExpirationMaxIdle(long expirationMaxIdle)

Maximum idle time a cache entry will be maintained in the cache, in milliseconds. If the idle time is exceeded, the entry will be expired cluster-wide. -1 means the entries never expire.

Parameters:

expirationMaxIdle - long representing the maximum idle time, in milliseconds, for a cached entry before it's expired

isExposeStatistics

public boolean isExposeStatistics()

setExposeStatistics

public void setExposeStatistics(boolean isExposeStatistics)

Enable statistics gathering and reporting via JMX.

Parameters:

isExposeStatistics - boolean indicating whether statistics should be enabled or disabled

applyTo

public void applyTo(org.infinispan.configuration.cache.ConfigurationBuilder builder)

Apply the configuration overrides in this TypeOverrides instance to the cache configuration builder passed as parameter.

Parameters:

builder - cache configuration builder on which to apply configuration overrides

validateInfinispanConfiguration

public void validateInfinispanConfiguration(org.infinispan.configuration.cache.Configuration cfg)
                                     throws CacheException

Validate the configuration for this cached type.

Parameters:

cfg - configuration to validate

Throws:

CacheException - if validation fails

toString

public String toString()

Overrides:

toString in class Object