Top Description Fields Constructors Methods
org.hibernate.cache.spi.support

public Class DomainDataRegionTemplate

extends AbstractDomainDataRegion
Class Inheritance
Known Direct Subclasses
org.hibernate.cache.spi.support.DomainDataRegionImpl
Imports
org.hibernate.cache.cfg.spi.CollectionDataCachingConfig, .DomainDataRegionBuildingContext, .DomainDataRegionConfig, .EntityDataCachingConfig, .NaturalIdDataCachingConfig, org.hibernate.cache.spi.CacheKeysFactory, .RegionFactory, org.hibernate.cache.spi.access.AccessType, .CollectionDataAccess, .EntityDataAccess, .NaturalIdDataAccess, org.hibernate.metamodel.model.domain.NavigableRole, org.jboss.logging.Logger
Abstract implementation of org.hibernate.cache.spi.DomainDataRegion based on implementations just needing to provide a DomainDataStorageAccess reference for basic caching support - DomainDataStorageAccess acts as a simple wrapper around some generalized cache actions such as put or get. Most implementations (our own JCache-based one included) can likely be as simple as: * Custom DomainDataStorageAccess implementation, bridging calls back to the specific cache provider's APIs * Custom DomainDataRegionTemplate implementation that creates its custom DomainDataStorageAccess reference * Custom RegionFactory implementation that creates its custom DomainDataRegionTemplate todo (5.3) : move this javadoc into DomainDataRegion and/or package javadoc
Author
Steve Ebersole

Field Summary

Modifier and TypeField and Description
private static final Logger
log

Hides org.hibernate.cache.spi.support.AbstractDomainDataRegion.log.

private final DomainDataStorageAccess
storageAccess

Constructor Summary

AccessConstructor and Description
public
DomainDataRegionTemplate(DomainDataRegionConfig regionConfig, RegionFactory regionFactory, DomainDataStorageAccess storageAccess, CacheKeysFactory defaultKeysFactory, DomainDataRegionBuildingContext buildingContext)

Method Summary

Modifier and TypeMethod and Description
public CollectionDataAccess
generateCollectionAccess(CollectionDataCachingConfig accessConfig)

Implements abstract org.hibernate.cache.spi.support.AbstractDomainDataRegion.generateCollectionAccess.

public EntityDataAccess
generateEntityAccess(EntityDataCachingConfig entityAccessConfig)

Implements abstract org.hibernate.cache.spi.support.AbstractDomainDataRegion.generateEntityAccess.

public NaturalIdDataAccess
generateNaturalIdAccess(NaturalIdDataCachingConfig accessConfig)

Implements abstract org.hibernate.cache.spi.support.AbstractDomainDataRegion.generateNaturalIdAccess.

private CollectionDataAccess
generateNonStrictReadWriteCollectionAccess(CollectionDataCachingConfig accessConfig)

protected EntityDataAccess
generateNonStrictReadWriteEntityAccess(EntityDataCachingConfig accessConfig)

protected NaturalIdDataAccess
generateNonStrictReadWriteNaturalIdAccess(NaturalIdDataCachingConfig accessConfig)

private CollectionDataAccess
generateReadOnlyCollectionAccess(CollectionDataCachingConfig accessConfig)

protected EntityDataAccess
generateReadOnlyEntityAccess(EntityDataCachingConfig accessConfig)

protected NaturalIdDataAccess
generateReadOnlyNaturalIdAccess(NaturalIdDataCachingConfig accessConfig)

private CollectionDataAccess
generateReadWriteCollectionAccess(CollectionDataCachingConfig accessConfig)

protected EntityDataAccess
generateReadWriteEntityAccess(EntityDataCachingConfig accessConfig)

protected NaturalIdDataAccess
generateReadWriteNaturalIdAccess(NaturalIdDataCachingConfig accessConfig)

protected CollectionDataAccess
generateTransactionalCollectionDataAccess(CollectionDataCachingConfig accessConfig)

protected EntityDataAccess
generateTransactionalEntityDataAccess(EntityDataCachingConfig entityAccessConfig)

protected NaturalIdDataAccess
generateTransactionalNaturalIdDataAccess(NaturalIdDataCachingConfig accessConfig)

private UnsupportedOperationException
generateTransactionalNotSupportedException()

public DomainDataStorageAccess
getCacheStorageAccess()

Public for testing purposes

Inherited from org.hibernate.cache.spi.support.AbstractDomainDataRegion:
clearcompleteInstantiationdestroygetCollectionDataAccessgetEffectiveKeysFactorygetEntityDataAccessgetNaturalIdDataAccessgetSessionFactoryreleaseDataAccessreleaseDataAccessreleaseDataAccess

Field Detail

logback to summary
private static final Logger log

Hides org.hibernate.cache.spi.support.AbstractDomainDataRegion.log.

storageAccessback to summary
private final DomainDataStorageAccess storageAccess

Constructor Detail

DomainDataRegionTemplateback to summary
public DomainDataRegionTemplate(DomainDataRegionConfig regionConfig, RegionFactory regionFactory, DomainDataStorageAccess storageAccess, CacheKeysFactory defaultKeysFactory, DomainDataRegionBuildingContext buildingContext)

Method Detail

generateCollectionAccessback to summary
public CollectionDataAccess generateCollectionAccess(CollectionDataCachingConfig accessConfig)

Implements abstract org.hibernate.cache.spi.support.AbstractDomainDataRegion.generateCollectionAccess.

Annotations
@Override
generateEntityAccessback to summary
public EntityDataAccess generateEntityAccess(EntityDataCachingConfig entityAccessConfig)

Implements abstract org.hibernate.cache.spi.support.AbstractDomainDataRegion.generateEntityAccess.

Annotations
@Override
generateNaturalIdAccessback to summary
public NaturalIdDataAccess generateNaturalIdAccess(NaturalIdDataCachingConfig accessConfig)

Implements abstract org.hibernate.cache.spi.support.AbstractDomainDataRegion.generateNaturalIdAccess.

Annotations
@Override
generateNonStrictReadWriteCollectionAccessback to summary
private CollectionDataAccess generateNonStrictReadWriteCollectionAccess(CollectionDataCachingConfig accessConfig)
generateNonStrictReadWriteEntityAccessback to summary
protected EntityDataAccess generateNonStrictReadWriteEntityAccess(EntityDataCachingConfig accessConfig)
Annotations
@SuppressWarnings:WeakerAccess
generateNonStrictReadWriteNaturalIdAccessback to summary
protected NaturalIdDataAccess generateNonStrictReadWriteNaturalIdAccess(NaturalIdDataCachingConfig accessConfig)
Annotations
@SuppressWarnings:WeakerAccess
generateReadOnlyCollectionAccessback to summary
private CollectionDataAccess generateReadOnlyCollectionAccess(CollectionDataCachingConfig accessConfig)
generateReadOnlyEntityAccessback to summary
protected EntityDataAccess generateReadOnlyEntityAccess(EntityDataCachingConfig accessConfig)
Annotations
@SuppressWarnings:WeakerAccess
generateReadOnlyNaturalIdAccessback to summary
protected NaturalIdDataAccess generateReadOnlyNaturalIdAccess(NaturalIdDataCachingConfig accessConfig)
Annotations
@SuppressWarnings:WeakerAccess
generateReadWriteCollectionAccessback to summary
private CollectionDataAccess generateReadWriteCollectionAccess(CollectionDataCachingConfig accessConfig)
generateReadWriteEntityAccessback to summary
protected EntityDataAccess generateReadWriteEntityAccess(EntityDataCachingConfig accessConfig)
Annotations
@SuppressWarnings:WeakerAccess
generateReadWriteNaturalIdAccessback to summary
protected NaturalIdDataAccess generateReadWriteNaturalIdAccess(NaturalIdDataCachingConfig accessConfig)
Annotations
@SuppressWarnings:WeakerAccess
generateTransactionalCollectionDataAccessback to summary
protected CollectionDataAccess generateTransactionalCollectionDataAccess(CollectionDataCachingConfig accessConfig)
Annotations
@SuppressWarnings:WeakerAccess, unused
generateTransactionalEntityDataAccessback to summary
protected EntityDataAccess generateTransactionalEntityDataAccess(EntityDataCachingConfig entityAccessConfig)
Annotations
@SuppressWarnings:WeakerAccess
generateTransactionalNaturalIdDataAccessback to summary
protected NaturalIdDataAccess generateTransactionalNaturalIdDataAccess(NaturalIdDataCachingConfig accessConfig)
Annotations
@SuppressWarnings:WeakerAccess
generateTransactionalNotSupportedExceptionback to summary
private UnsupportedOperationException generateTransactionalNotSupportedException()
getCacheStorageAccessback to summary
public DomainDataStorageAccess getCacheStorageAccess()

Public for testing purposes