Package org.hibernate.cache.internal

Class DefaultCacheKeysFactory

java.lang.Object

org.hibernate.cache.internal.DefaultCacheKeysFactory

All Implemented Interfaces:

CacheKeysFactory

public class DefaultCacheKeysFactory
extends Object
implements CacheKeysFactory

Second level cache providers now have the option to use custom key implementations. This was done as the default key implementation is very generic and is quite a large object to allocate in large quantities at runtime. In some extreme cases, for example when the hit ratio is very low, this was making the efficiency penalty vs its benefits tradeoff questionable.

Depending on configuration settings there might be opportunities to use simpler key implementations, for example when multi-tenancy is not being used to avoid the tenant identifier, or when a cache instance is entirely dedicated to a single type to use the primary id only, skipping the role or entity name.

Even with multiple types sharing the same cache, their identifiers could be of the same Type; in this case the cache container could use a single type reference to implement a custom equality function without having to look it up on each equality check: that's a small optimisation but the equality function is often invoked extremely frequently.

Another reason is to make it more convenient to implement custom serialization protocols when the implementation supports clustering.

Since:

5.0

See Also:

• Type.getHashCode(Object, SessionFactoryImplementor)
• Type.isEqual(Object, Object)

Field Summary

Fields

Modifier and Type	Field	Description
static final DefaultCacheKeysFactory	INSTANCE
static final String	SHORT_NAME

Constructor Summary

Constructors

Constructor	Description
DefaultCacheKeysFactory()

Method Summary

Modifier and Type	Method	Description
Object	createCollectionKey(Object id, CollectionPersister persister, SessionFactoryImplementor factory, String tenantIdentifier)
Object	createEntityKey(Object id, EntityPersister persister, SessionFactoryImplementor factory, String tenantIdentifier)
Object	createNaturalIdKey(Object naturalIdValues, EntityPersister persister, SharedSessionContractImplementor session)
Object	getCollectionId(Object cacheKey)
Object	getEntityId(Object cacheKey)
Object	getNaturalIdValues(Object cacheKey)
static Object	staticCreateCollectionKey(Object id, CollectionPersister persister, SessionFactoryImplementor factory, String tenantIdentifier)
static Object	staticCreateEntityKey(Object id, EntityPersister persister, SessionFactoryImplementor factory, String tenantIdentifier)
static Object	staticCreateNaturalIdKey(Object naturalIdValues, EntityPersister persister, SharedSessionContractImplementor session)
static Object	staticGetCollectionId(Object cacheKey)
static Object	staticGetEntityId(Object cacheKey)
static Object	staticGetNaturalIdValues(Object cacheKey)

Methods inherited from class java.lang.Object

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

Field Details

SHORT_NAME

public static final String SHORT_NAME

See Also:

• Constant Field Values

INSTANCE

public static final DefaultCacheKeysFactory INSTANCE

Constructor Details

DefaultCacheKeysFactory

public DefaultCacheKeysFactory()

Method Details

staticCreateCollectionKey

public static Object staticCreateCollectionKey(Object id,
 CollectionPersister persister,
 SessionFactoryImplementor factory,
 String tenantIdentifier)

staticCreateEntityKey

public static Object staticCreateEntityKey(Object id,
 EntityPersister persister,
 SessionFactoryImplementor factory,
 String tenantIdentifier)

staticCreateNaturalIdKey

public static Object staticCreateNaturalIdKey(Object naturalIdValues,
 EntityPersister persister,
 SharedSessionContractImplementor session)

staticGetEntityId

public static Object staticGetEntityId(Object cacheKey)

staticGetCollectionId

public static Object staticGetCollectionId(Object cacheKey)

staticGetNaturalIdValues

public static Object staticGetNaturalIdValues(Object cacheKey)

createCollectionKey

public Object createCollectionKey(Object id,
 CollectionPersister persister,
 SessionFactoryImplementor factory,
 String tenantIdentifier)

Specified by:

createCollectionKey in interface CacheKeysFactory

createEntityKey

public Object createEntityKey(Object id,
 EntityPersister persister,
 SessionFactoryImplementor factory,
 String tenantIdentifier)

Specified by:

createEntityKey in interface CacheKeysFactory

createNaturalIdKey

public Object createNaturalIdKey(Object naturalIdValues,
 EntityPersister persister,
 SharedSessionContractImplementor session)

Specified by:

createNaturalIdKey in interface CacheKeysFactory

getEntityId

public Object getEntityId(Object cacheKey)

Specified by:

getEntityId in interface CacheKeysFactory

getCollectionId

public Object getCollectionId(Object cacheKey)

Specified by:

getCollectionId in interface CacheKeysFactory

getNaturalIdValues

public Object getNaturalIdValues(Object cacheKey)

Specified by:

getNaturalIdValues in interface CacheKeysFactory