org.hibernate.cache.infinispan

Class InfinispanRegionFactory

java.lang.Object

org.hibernate.cache.infinispan.InfinispanRegionFactory

All Implemented Interfaces:

java.io.Serializable, RegionFactory, Service

Direct Known Subclasses:

JndiInfinispanRegionFactory

public class InfinispanRegionFactory
extends java.lang.Object
implements RegionFactory

A RegionFactory for Infinispan-backed cache regions.

Since:

3.5

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	InfinispanRegionFactory.DataType

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.Map<java.lang.String,java.lang.String>	baseConfigurations Defines custom mapping for regionName -> cacheName and also DataType.key -> cacheName (for the case that you want to change the cache configuration for whole type)
static java.lang.String	COLLECTION_CACHE_RESOURCE_PROP Name of the configuration that should be used for collection caches.
protected java.util.Map<java.lang.String,org.infinispan.configuration.cache.ConfigurationBuilder>	configOverrides Defines configuration properties applied on top of configuration set in any file, by regionName or DataType.key
static java.lang.String	DEF_ENTITY_RESOURCE Default value for ENTITY_CACHE_RESOURCE_PROP.
static java.lang.String	DEF_INFINISPAN_CONFIG_RESOURCE Default value for INFINISPAN_CONFIG_RESOURCE_PROP.
static java.lang.String	DEF_PENDING_PUTS_RESOURCE Default value for PENDING_PUTS_CACHE_RESOURCE_PROP
static java.lang.String	DEF_QUERY_RESOURCE Default value for QUERY_CACHE_RESOURCE_PROP.
static java.lang.String	DEF_TIMESTAMPS_RESOURCE Default value for TIMESTAMPS_CACHE_RESOURCE_PROP.
static boolean	DEF_USE_SYNCHRONIZATION Default value for INFINISPAN_USE_SYNCHRONIZATION_PROP.
static java.lang.String	ENTITY_CACHE_RESOURCE_PROP Name of the configuration that should be used for entity caches.
static java.lang.String	IMMUTABLE_ENTITY_CACHE_RESOURCE_PROP Name of the configuration that should be used for immutable entity caches.
static java.lang.String	INFINISPAN_CONFIG_LOCAL_RESOURCE Default configuration for cases where non-clustered cache manager is provided.
static java.lang.String	INFINISPAN_CONFIG_RESOURCE_PROP Classpath or filesystem resource containing Infinispan configurations the factory should use.
static java.lang.String	INFINISPAN_GLOBAL_STATISTICS_PROP Property name that controls whether Infinispan statistics are enabled.
static java.lang.String	INFINISPAN_USE_SYNCHRONIZATION_PROP Deprecated. Infinispan Second Level Cache is designed to always register as synchronization on transactional caches, or use non-transactional caches.
static java.lang.String	NATURAL_ID_CACHE_RESOURCE_PROP Name of the configuration that should be used for natural id caches.
static java.lang.String	PENDING_PUTS_CACHE_NAME Deprecated. Use DEF_PENDING_PUTS_RESOURCE instead.
static java.lang.String	PENDING_PUTS_CACHE_RESOURCE_PROP Name of the configuration that should be used for pending-puts caches.
static java.lang.String	QUERY_CACHE_RESOURCE_PROP Name of the configuration that should be used for query caches.
static java.lang.String	TIMESTAMPS_CACHE_RESOURCE_PROP Name of the configuration that should be used for timestamp caches.

Constructor Summary

Constructors

Constructor and Description
InfinispanRegionFactory() Create a new instance using the default configuration.
InfinispanRegionFactory(java.util.Properties props) Create a new instance using conifguration properties in props.

Method Summary

Modifier and Type	Method and Description
CollectionRegion	buildCollectionRegion(java.lang.String regionName, java.util.Map<java.lang.String,java.lang.Object> configValues, CacheDataDescription metadata) Build a cache region specialized for storing collection data.
CollectionRegion	buildCollectionRegion(java.lang.String regionName, java.util.Properties properties, CacheDataDescription metadata) Build a cache region specialized for storing collection data.
EntityRegion	buildEntityRegion(java.lang.String regionName, java.util.Map<java.lang.String,java.lang.Object> configValues, CacheDataDescription metadata) Build a cache region specialized for storing entity data.
EntityRegion	buildEntityRegion(java.lang.String regionName, java.util.Properties properties, CacheDataDescription metadata) Build a cache region specialized for storing entity data.
NaturalIdRegion	buildNaturalIdRegion(java.lang.String regionName, java.util.Map<java.lang.String,java.lang.Object> configValues, CacheDataDescription metadata) Build a cache region specialized for storing NaturalId to Primary Key mappings.
NaturalIdRegion	buildNaturalIdRegion(java.lang.String regionName, java.util.Properties properties, CacheDataDescription metadata) Build a cache region specialized for storing NaturalId to Primary Key mappings.
QueryResultsRegion	buildQueryResultsRegion(java.lang.String regionName, java.util.Map<java.lang.String,java.lang.Object> configValues) Build a cache region specialized for storing query results.
QueryResultsRegion	buildQueryResultsRegion(java.lang.String regionName, java.util.Properties properties) Build a cache region specialized for storing query results.
TimestampsRegion	buildTimestampsRegion(java.lang.String regionName, java.util.Map<java.lang.String,java.lang.Object> configValues) Build a cache region specialized for storing update-timestamps data.
TimestampsRegion	buildTimestampsRegion(java.lang.String regionName, java.util.Properties properties) Build a cache region specialized for storing update-timestamps data.
protected org.infinispan.manager.EmbeddedCacheManager	createCacheManager(org.infinispan.configuration.parsing.ConfigurationBuilderHolder cfgHolder)
protected org.infinispan.manager.EmbeddedCacheManager	createCacheManager(java.util.Properties properties, ServiceRegistry serviceRegistry)
protected org.infinispan.AdvancedCache	createCacheWrapper(org.infinispan.AdvancedCache cache)
protected TimestampsRegionImpl	createTimestampsRegion(org.infinispan.AdvancedCache cache, java.lang.String regionName)
protected org.infinispan.transaction.lookup.TransactionManagerLookup	createTransactionManagerLookup(SessionFactoryOptions settings, java.util.Properties properties)
protected org.infinispan.AdvancedCache	getCache(java.lang.String regionName, InfinispanRegionFactory.DataType type, CacheDataDescription metadata)
org.infinispan.manager.EmbeddedCacheManager	getCacheManager()
AccessType	getDefaultAccessType() Get the default access type for entity and collection regions.
org.infinispan.configuration.cache.Configuration	getPendingPutsCacheConfiguration()
boolean	isMinimalPutsEnabledByDefault() By default should we perform "minimal puts" when using this second level cache implementation?
long	nextTimestamp() Generate a timestamp.
void	setCacheManager(org.infinispan.manager.EmbeddedCacheManager manager)
void	start(SessionFactoryOptions settings, java.util.Properties properties) Lifecycle callback to perform any necessary initialization of the underlying cache implementation(s).
void	stop() Lifecycle callback to perform any necessary cleanup of the underlying cache implementation(s).
protected void	stopCacheManager()
protected void	stopCacheRegions()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.hibernate.cache.spi.RegionFactory

start

Field Detail

INFINISPAN_CONFIG_RESOURCE_PROP

public static final java.lang.String INFINISPAN_CONFIG_RESOURCE_PROP

Classpath or filesystem resource containing Infinispan configurations the factory should use.

See Also:

DEF_INFINISPAN_CONFIG_RESOURCE, Constant Field Values

INFINISPAN_GLOBAL_STATISTICS_PROP

public static final java.lang.String INFINISPAN_GLOBAL_STATISTICS_PROP

Property name that controls whether Infinispan statistics are enabled. The property value is expected to be a boolean true or false, and it overrides statistic configuration in base Infinispan configuration, if provided.

See Also:

Constant Field Values

INFINISPAN_USE_SYNCHRONIZATION_PROP

@Deprecated
public static final java.lang.String INFINISPAN_USE_SYNCHRONIZATION_PROP

Deprecated. Infinispan Second Level Cache is designed to always register as synchronization on transactional caches, or use non-transactional caches.

Property that controls whether Infinispan should interact with the transaction manager as a Synchronization or as an XA resource.

See Also:

DEF_USE_SYNCHRONIZATION, Constant Field Values

NATURAL_ID_CACHE_RESOURCE_PROP

public static final java.lang.String NATURAL_ID_CACHE_RESOURCE_PROP

Name of the configuration that should be used for natural id caches.

See Also:

DEF_ENTITY_RESOURCE

ENTITY_CACHE_RESOURCE_PROP

public static final java.lang.String ENTITY_CACHE_RESOURCE_PROP

Name of the configuration that should be used for entity caches.

See Also:

DEF_ENTITY_RESOURCE

IMMUTABLE_ENTITY_CACHE_RESOURCE_PROP

public static final java.lang.String IMMUTABLE_ENTITY_CACHE_RESOURCE_PROP

Name of the configuration that should be used for immutable entity caches. Defaults to the same configuration as ENTITY_CACHE_RESOURCE_PROP - DEF_ENTITY_RESOURCE

COLLECTION_CACHE_RESOURCE_PROP

public static final java.lang.String COLLECTION_CACHE_RESOURCE_PROP

Name of the configuration that should be used for collection caches. No default value, as by default we try to use the same Infinispan cache instance we use for entity caching.

See Also:

ENTITY_CACHE_RESOURCE_PROP, DEF_ENTITY_RESOURCE

TIMESTAMPS_CACHE_RESOURCE_PROP

public static final java.lang.String TIMESTAMPS_CACHE_RESOURCE_PROP

Name of the configuration that should be used for timestamp caches.

See Also:

DEF_TIMESTAMPS_RESOURCE

QUERY_CACHE_RESOURCE_PROP

public static final java.lang.String QUERY_CACHE_RESOURCE_PROP

Name of the configuration that should be used for query caches.

See Also:

DEF_QUERY_RESOURCE

PENDING_PUTS_CACHE_RESOURCE_PROP

public static final java.lang.String PENDING_PUTS_CACHE_RESOURCE_PROP

Name of the configuration that should be used for pending-puts caches.

See Also:

DEF_PENDING_PUTS_RESOURCE

DEF_INFINISPAN_CONFIG_RESOURCE

public static final java.lang.String DEF_INFINISPAN_CONFIG_RESOURCE

Default value for INFINISPAN_CONFIG_RESOURCE_PROP. Specifies the "infinispan-configs.xml" file in this package.

See Also:

Constant Field Values

INFINISPAN_CONFIG_LOCAL_RESOURCE

public static final java.lang.String INFINISPAN_CONFIG_LOCAL_RESOURCE

Default configuration for cases where non-clustered cache manager is provided.

See Also:

Constant Field Values

DEF_ENTITY_RESOURCE

public static final java.lang.String DEF_ENTITY_RESOURCE

Default value for ENTITY_CACHE_RESOURCE_PROP.

See Also:

Constant Field Values

DEF_TIMESTAMPS_RESOURCE

public static final java.lang.String DEF_TIMESTAMPS_RESOURCE

Default value for TIMESTAMPS_CACHE_RESOURCE_PROP.

See Also:

Constant Field Values

DEF_QUERY_RESOURCE

public static final java.lang.String DEF_QUERY_RESOURCE

Default value for QUERY_CACHE_RESOURCE_PROP.

See Also:

Constant Field Values

DEF_PENDING_PUTS_RESOURCE

public static final java.lang.String DEF_PENDING_PUTS_RESOURCE

Default value for PENDING_PUTS_CACHE_RESOURCE_PROP

See Also:

Constant Field Values

PENDING_PUTS_CACHE_NAME

@Deprecated
public static final java.lang.String PENDING_PUTS_CACHE_NAME

Deprecated. Use DEF_PENDING_PUTS_RESOURCE instead.

See Also:

Constant Field Values

DEF_USE_SYNCHRONIZATION

public static final boolean DEF_USE_SYNCHRONIZATION

Default value for INFINISPAN_USE_SYNCHRONIZATION_PROP.

See Also:

Constant Field Values

baseConfigurations

protected final java.util.Map<java.lang.String,java.lang.String> baseConfigurations

Defines custom mapping for regionName -> cacheName and also DataType.key -> cacheName (for the case that you want to change the cache configuration for whole type)

configOverrides

protected final java.util.Map<java.lang.String,org.infinispan.configuration.cache.ConfigurationBuilder> configOverrides

Defines configuration properties applied on top of configuration set in any file, by regionName or DataType.key

Constructor Detail

InfinispanRegionFactory

public InfinispanRegionFactory()

Create a new instance using the default configuration.

InfinispanRegionFactory

public InfinispanRegionFactory(java.util.Properties props)

Create a new instance using conifguration properties in props.

Parameters:

props - Environmental properties; currently unused.

Method Detail

buildCollectionRegion

public CollectionRegion buildCollectionRegion(java.lang.String regionName,
                                              java.util.Map<java.lang.String,java.lang.Object> configValues,
                                              CacheDataDescription metadata)

Description copied from interface: RegionFactory

Build a cache region specialized for storing collection data.

Specified by:

buildCollectionRegion in interface RegionFactory

Parameters:

regionName - The name of the region.

configValues - Available config values.

metadata - Information regarding the type of data to be cached

Returns:

The built region

buildCollectionRegion

public CollectionRegion buildCollectionRegion(java.lang.String regionName,
                                              java.util.Properties properties,
                                              CacheDataDescription metadata)
                                       throws CacheException

Description copied from interface: RegionFactory

Build a cache region specialized for storing collection data.

Specified by:

buildCollectionRegion in interface RegionFactory

Parameters:

regionName - The name of the region.

properties - Configuration properties.

metadata - Information regarding the type of data to be cached

Returns:

The built region

Throws:

CacheException - Indicates problems building the region.

buildEntityRegion

public EntityRegion buildEntityRegion(java.lang.String regionName,
                                      java.util.Map<java.lang.String,java.lang.Object> configValues,
                                      CacheDataDescription metadata)

Description copied from interface: RegionFactory

Build a cache region specialized for storing entity data.

Specified by:

buildEntityRegion in interface RegionFactory

Parameters:

regionName - The name of the region.

configValues - Available config values.

metadata - Information regarding the type of data to be cached

Returns:

The built region

buildEntityRegion

public EntityRegion buildEntityRegion(java.lang.String regionName,
                                      java.util.Properties properties,
                                      CacheDataDescription metadata)

Description copied from interface: RegionFactory

Build a cache region specialized for storing entity data.

Specified by:

buildEntityRegion in interface RegionFactory

Parameters:

regionName - The name of the region.

properties - Configuration properties.

metadata - Information regarding the type of data to be cached

Returns:

The built region

buildNaturalIdRegion

public NaturalIdRegion buildNaturalIdRegion(java.lang.String regionName,
                                            java.util.Map<java.lang.String,java.lang.Object> configValues,
                                            CacheDataDescription metadata)

Description copied from interface: RegionFactory

Build a cache region specialized for storing NaturalId to Primary Key mappings.

Specified by:

buildNaturalIdRegion in interface RegionFactory

Parameters:

regionName - The name of the region.

configValues - Available config values.

metadata - Information regarding the type of data to be cached

Returns:

The built region

buildNaturalIdRegion

public NaturalIdRegion buildNaturalIdRegion(java.lang.String regionName,
                                            java.util.Properties properties,
                                            CacheDataDescription metadata)

Description copied from interface: RegionFactory

Build a cache region specialized for storing NaturalId to Primary Key mappings.

Specified by:

buildNaturalIdRegion in interface RegionFactory

Parameters:

regionName - The name of the region.

properties - Configuration properties.

metadata - Information regarding the type of data to be cached

Returns:

The built region

buildQueryResultsRegion

public QueryResultsRegion buildQueryResultsRegion(java.lang.String regionName,
                                                  java.util.Map<java.lang.String,java.lang.Object> configValues)

Description copied from interface: RegionFactory

Build a cache region specialized for storing query results.

Specified by:

buildQueryResultsRegion in interface RegionFactory

Parameters:

regionName - The qualified name of the region.

configValues - Available config values.

Returns:

The built region

buildQueryResultsRegion

public QueryResultsRegion buildQueryResultsRegion(java.lang.String regionName,
                                                  java.util.Properties properties)

Description copied from interface: RegionFactory

Build a cache region specialized for storing query results.

Specified by:

buildQueryResultsRegion in interface RegionFactory

Parameters:

regionName - The name of the region.

properties - Configuration properties.

Returns:

The built region

buildTimestampsRegion

public TimestampsRegion buildTimestampsRegion(java.lang.String regionName,
                                              java.util.Map<java.lang.String,java.lang.Object> configValues)

Description copied from interface: RegionFactory

Build a cache region specialized for storing update-timestamps data.

Specified by:

buildTimestampsRegion in interface RegionFactory

Parameters:

regionName - The name of the region.

configValues - The available config values.

Returns:

The built region

buildTimestampsRegion

public TimestampsRegion buildTimestampsRegion(java.lang.String regionName,
                                              java.util.Properties properties)

Description copied from interface: RegionFactory

Build a cache region specialized for storing update-timestamps data.

Specified by:

buildTimestampsRegion in interface RegionFactory

Parameters:

regionName - The name of the region.

properties - Configuration properties.

Returns:

The built region

createTimestampsRegion

protected TimestampsRegionImpl createTimestampsRegion(org.infinispan.AdvancedCache cache,
                                                      java.lang.String regionName)

getPendingPutsCacheConfiguration

public org.infinispan.configuration.cache.Configuration getPendingPutsCacheConfiguration()

isMinimalPutsEnabledByDefault

public boolean isMinimalPutsEnabledByDefault()

Description copied from interface: RegionFactory

By default should we perform "minimal puts" when using this second level cache implementation?

Specified by:

isMinimalPutsEnabledByDefault in interface RegionFactory

Returns:

True if "minimal puts" should be performed by default; false otherwise.

getDefaultAccessType

public AccessType getDefaultAccessType()

Description copied from interface: RegionFactory

Get the default access type for entity and collection regions.

Specified by:

getDefaultAccessType in interface RegionFactory

Returns:

This factory's default access type.

nextTimestamp

public long nextTimestamp()

Description copied from interface: RegionFactory

Generate a timestamp.

This is generally used for cache content locking/unlocking purposes depending upon the access-strategy being used.

Specified by:

nextTimestamp in interface RegionFactory

Returns:

The generated timestamp.

setCacheManager

public void setCacheManager(org.infinispan.manager.EmbeddedCacheManager manager)

getCacheManager

public org.infinispan.manager.EmbeddedCacheManager getCacheManager()

start

public void start(SessionFactoryOptions settings,
                  java.util.Properties properties)
           throws CacheException

Description copied from interface: RegionFactory

Lifecycle callback to perform any necessary initialization of the underlying cache implementation(s). Called exactly once during the construction of a SessionFactoryImpl.

Specified by:

start in interface RegionFactory

Parameters:

settings - The settings in effect.

properties - The defined cfg properties

Throws:

CacheException - Indicates problems starting the L2 cache impl; considered as a sign to stop SessionFactory building.

createCacheManager

protected org.infinispan.manager.EmbeddedCacheManager createCacheManager(java.util.Properties properties,
                                                                         ServiceRegistry serviceRegistry)

createCacheManager

protected org.infinispan.manager.EmbeddedCacheManager createCacheManager(org.infinispan.configuration.parsing.ConfigurationBuilderHolder cfgHolder)

createTransactionManagerLookup

protected org.infinispan.transaction.lookup.TransactionManagerLookup createTransactionManagerLookup(SessionFactoryOptions settings,
                                                                                                    java.util.Properties properties)

stop

public void stop()

Description copied from interface: RegionFactory

Lifecycle callback to perform any necessary cleanup of the underlying cache implementation(s). Called exactly once during SessionFactory.close().

Specified by:

stop in interface RegionFactory

stopCacheRegions

protected void stopCacheRegions()

stopCacheManager

protected void stopCacheManager()

getCache

protected org.infinispan.AdvancedCache getCache(java.lang.String regionName,
                                                InfinispanRegionFactory.DataType type,
                                                CacheDataDescription metadata)

createCacheWrapper

protected org.infinispan.AdvancedCache createCacheWrapper(org.infinispan.AdvancedCache cache)