HibernateDatastore (Grails 9.0.0-SNAPSHOT)

org.grails.orm.hibernate.HibernateDatastore

All Implemented Interfaces and Traits:

MessageSourceAware
```
public class HibernateDatastore
extends AbstractHibernateDatastore
implements MessageSourceAware
```
Datastore implementation that uses a Hibernate SessionFactory underneath.
Authors:
Graeme Rocher
Since:
2.0

Field Summary

Fields
Modifiers	Name	Description
`protected java.util.Map<java.lang.String, HibernateDatastore>`	`datastoresByConnectionSource`
`protected ConfigurableApplicationEventPublisher`	`eventPublisher`
`protected HibernateGormEnhancer`	`gormEnhancer`
`protected org.hibernate.boot.Metadata`	`metadata`
`protected GrailsHibernateTransactionManager`	`transactionManager`

Inherited fields
Fields inherited from class	Fields
`class AbstractHibernateDatastore`	`CONFIG_PROPERTY_CACHE_QUERIES, CONFIG_PROPERTY_OSIV_READONLY, CONFIG_PROPERTY_PASS_READONLY_TO_HIBERNATE, autoTimestampEventListener, connectionSources, dataSourceName, defaultFlushMode, defaultFlushModeName, eventTriggeringInterceptor, failOnError, isCacheQueries, markDirty, multiTenantMode, osivReadOnly, passReadOnlyToHibernate, schemaHandler, sessionFactory, tenantResolver`
`class AbstractDatastore`	`LOG, applicationEventPublisher, cacheAdapterRepository, connectionDetails, mappingContext, serviceRegistry`

Constructor Summary

Constructors
Constructor and description
`HibernateDatastore(ConnectionSources<org.hibernate.SessionFactory, HibernateConnectionSourceSettings> connectionSources, HibernateMappingContext mappingContext, ConfigurableApplicationEventPublisher eventPublisher)` Create a new HibernateDatastore for the given connection sources and mapping context
`HibernateDatastore(PropertyResolver configuration, HibernateConnectionSourceFactory connectionSourceFactory, ConfigurableApplicationEventPublisher eventPublisher)` Create a new HibernateDatastore for the given connection sources and mapping context
`HibernateDatastore(PropertyResolver configuration, HibernateConnectionSourceFactory connectionSourceFactory)` Create a new HibernateDatastore for the given connection sources and mapping context
`HibernateDatastore(PropertyResolver configuration, ConfigurableApplicationEventPublisher eventPublisher, java.lang.Class classes)` Create a new HibernateDatastore for the given connection sources and mapping context
`HibernateDatastore(javax.sql.DataSource dataSource, PropertyResolver configuration, ConfigurableApplicationEventPublisher eventPublisher, java.lang.Class classes)` Create a new HibernateDatastore for the given connection sources and mapping context
`HibernateDatastore(PropertyResolver configuration, ConfigurableApplicationEventPublisher eventPublisher, java.lang.Package packagesToScan)` Construct a Hibernate datastore scanning the given packages
`HibernateDatastore(javax.sql.DataSource dataSource, PropertyResolver configuration, ConfigurableApplicationEventPublisher eventPublisher, java.lang.Package packagesToScan)` Construct a Hibernate datastore scanning the given packages for the given datasource
`HibernateDatastore(PropertyResolver configuration, java.lang.Class classes)` Create a new HibernateDatastore for the given connection sources and mapping context
`HibernateDatastore(PropertyResolver configuration, java.lang.Package packagesToScan)` Construct a Hibernate datastore scanning the given packages
`HibernateDatastore(java.util.Map<java.lang.String, java.lang.Object> configuration, java.lang.Class classes)` Constructor used purely for testing purposes.
`HibernateDatastore(java.util.Map<java.lang.String, java.lang.Object> configuration, java.lang.Package packagesToScan)` Construct a Hibernate datastore scanning the given packages
`HibernateDatastore(java.lang.Class classes)` Constructor used purely for testing purposes.
`HibernateDatastore(java.lang.Package packagesToScan)` Construct a Hibernate datastore scanning the given packages
`HibernateDatastore(java.lang.Package packageToScan)` Construct a Hibernate datastore scanning the given packages

Methods Summary

Methods
Type Params	Return Type	Name and description
	`public void`	`addTenantForSchema(java.lang.String schemaName)`
	`protected void`	`configureValidatorRegistry(HibernateConnectionSourceSettings settings, HibernateMappingContext mappingContext)`
	`protected void`	`configureValidatorRegistry(HibernateConnectionSourceSettings settings, HibernateMappingContext mappingContext, ValidatorRegistry validatorRegistry, MessageSource messageSource)`
	`protected Session`	`createSession(PropertyResolver connectionDetails)`
	`public void`	`destroy()`
	`public ApplicationEventPublisher`	`getApplicationEventPublisher()`
	`public Session`	`getCurrentSession()`
	`public HibernateDatastore`	`getDatastoreForConnection(java.lang.String connectionName)` Obtain a child HibernateDatastore by connection name
	`public IHibernateTemplate`	`getHibernateTemplate(int flushMode)`
	`public HibernateMappingContext`	`getMappingContext()`
	`public org.hibernate.boot.Metadata`	`getMetadata()`
	`public GrailsHibernateTransactionManager`	`getTransactionManager()` Returns: The PlatformTransactionManager instance
	`public boolean`	`hasCurrentSession()`
	`protected HibernateGormEnhancer`	`initialize()`
	`public org.hibernate.Session`	`openSession()`
	`protected void`	`registerAllEntitiesWithEnhancer()`
	`protected void`	`registerEventListeners(ConfigurableApplicationEventPublisher eventPublisher)`
	`public void`	`setApplicationContext(ApplicationContext applicationContext)`
	`public void`	`setMessageSource(MessageSource messageSource)`
	`public java.lang.String`	`toString()`
	`public void`	`withFlushMode(FlushMode flushMode, java.util.concurrent.Callable<java.lang.Boolean> callable)`

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class AbstractHibernateDatastore`	close, createValidatorRegistry, destroy, disableMultiTenancyFilter, enableMultiTenancyFilter, getAutoTimestampEventListener, getConnectionSources, getDataSource, getDataSourceName, getDatastoreForConnection, getDatastoreForTenantId, getDefaultFlushMode, getDefaultFlushModeName, getEventTriggeringInterceptor, getHibernateTemplate, getHibernateTemplate, getMultiTenancyMode, getSessionFactory, getTenantResolver, isAutoFlush, isCacheQueries, isFailOnError, isOsivReadOnly, isPassReadOnlyToHibernate, openSession, prepareMultiTenantClosure, resolveTenantIdentifier, resolveTenantIds, setMessageSource, withFlushMode, withNewSession, withNewSession, withSession
`class AbstractDatastore`	`connect, connect, connectStateless, createSession, createStatelessSession, destroy, getApplicationContext, getApplicationEventPublisher, getCurrentSession, getMappingContext, getService, getServices, getSessionResolver, hasCurrentSession, initializeConverters, isIndexed, isSchemaless, mapToPropertyResolver, retrieveSession, retrieveSession, setApplicationContext, withSession`

- Field Detail
  - protected final java.util.Map<java.lang.String, HibernateDatastore> datastoresByConnectionSource
  - protected ConfigurableApplicationEventPublisher eventPublisher
  - protected final HibernateGormEnhancer gormEnhancer
  - protected final org.hibernate.boot.Metadata metadata
  - protected final GrailsHibernateTransactionManager transactionManager
- Constructor Detail
  - public HibernateDatastore(ConnectionSources<org.hibernate.SessionFactory, HibernateConnectionSourceSettings> connectionSources, HibernateMappingContext mappingContext, ConfigurableApplicationEventPublisher eventPublisher)
    
    Create a new HibernateDatastore for the given connection sources and mapping context
    Parameters:
    connectionSources - The ConnectionSources instance
    mappingContext - The MappingContext instance
    eventPublisher - The ConfigurableApplicationEventPublisher instance
  - public HibernateDatastore(PropertyResolver configuration, HibernateConnectionSourceFactory connectionSourceFactory, ConfigurableApplicationEventPublisher eventPublisher)
    
    Create a new HibernateDatastore for the given connection sources and mapping context
    Parameters:
    configuration - The configuration
    connectionSourceFactory - The HibernateConnectionSourceFactory instance
    eventPublisher - The ConfigurableApplicationEventPublisher instance
  - public HibernateDatastore(PropertyResolver configuration, HibernateConnectionSourceFactory connectionSourceFactory)
    
    Create a new HibernateDatastore for the given connection sources and mapping context
    Parameters:
    configuration - The configuration
    connectionSourceFactory - The HibernateConnectionSourceFactory instance
  - public HibernateDatastore(PropertyResolver configuration, ConfigurableApplicationEventPublisher eventPublisher, java.lang.Class classes)
    
    Create a new HibernateDatastore for the given connection sources and mapping context
    Parameters:
    configuration - The configuration
    eventPublisher - The ConfigurableApplicationEventPublisher instance
    classes - The persistent classes
  - public HibernateDatastore(javax.sql.DataSource dataSource, PropertyResolver configuration, ConfigurableApplicationEventPublisher eventPublisher, java.lang.Class classes)
    
    Create a new HibernateDatastore for the given connection sources and mapping context
    Parameters:
    configuration - The configuration
    eventPublisher - The ConfigurableApplicationEventPublisher instance
    classes - The persistent classes
  - public HibernateDatastore(PropertyResolver configuration, ConfigurableApplicationEventPublisher eventPublisher, java.lang.Package packagesToScan)
    
    Construct a Hibernate datastore scanning the given packages
    Parameters:
    configuration - The configuration
    eventPublisher - The event publisher
    packagesToScan - The packages to scan
  - public HibernateDatastore(javax.sql.DataSource dataSource, PropertyResolver configuration, ConfigurableApplicationEventPublisher eventPublisher, java.lang.Package packagesToScan)
    
    Construct a Hibernate datastore scanning the given packages for the given datasource
    Parameters:
    configuration - The configuration
    eventPublisher - The event publisher
    packagesToScan - The packages to scan
  - public HibernateDatastore(PropertyResolver configuration, java.lang.Class classes)
    
    Create a new HibernateDatastore for the given connection sources and mapping context
    Parameters:
    configuration - The configuration
    classes - The persistent classes
  - public HibernateDatastore(PropertyResolver configuration, java.lang.Package packagesToScan)
    
    Construct a Hibernate datastore scanning the given packages
    Parameters:
    configuration - The configuration
    packagesToScan - The packages to scan
  - public HibernateDatastore(java.util.Map<java.lang.String, java.lang.Object> configuration, java.lang.Class classes)
    
    Constructor used purely for testing purposes. Creates a datastore with an in-memory database and dbCreate set to 'create-drop'
    Parameters:
    classes - The classes
  - public HibernateDatastore(java.util.Map<java.lang.String, java.lang.Object> configuration, java.lang.Package packagesToScan)
    
    Construct a Hibernate datastore scanning the given packages
    Parameters:
    configuration - The configuration
    packagesToScan - The packages to scan
  - public HibernateDatastore(java.lang.Class classes)
    
    Constructor used purely for testing purposes. Creates a datastore with an in-memory database and dbCreate set to 'create-drop'
    Parameters:
    classes - The classes
  - public HibernateDatastore(java.lang.Package packagesToScan)
    
    Construct a Hibernate datastore scanning the given packages
    Parameters:
    packagesToScan - The packages to scan
  - public HibernateDatastore(java.lang.Package packageToScan)
    
    Construct a Hibernate datastore scanning the given packages
    Parameters:
    packageToScan - The package to scan
- Method Detail
  - public void addTenantForSchema(java.lang.String schemaName)
  - protected void configureValidatorRegistry(HibernateConnectionSourceSettings settings, HibernateMappingContext mappingContext)
  - protected void configureValidatorRegistry(HibernateConnectionSourceSettings settings, HibernateMappingContext mappingContext, ValidatorRegistry validatorRegistry, MessageSource messageSource)
  - protected Session createSession(PropertyResolver connectionDetails)
  - public void destroy()
  - public ApplicationEventPublisher getApplicationEventPublisher()
  - public Session getCurrentSession()
  - public HibernateDatastore getDatastoreForConnection(java.lang.String connectionName)
    
    Obtain a child HibernateDatastore by connection name
    Parameters:
    connectionName - The connection name
    Returns:
    The HibernateDatastore
  - public IHibernateTemplate getHibernateTemplate(int flushMode)
  - public HibernateMappingContext getMappingContext()
  - public org.hibernate.boot.Metadata getMetadata()
  - public GrailsHibernateTransactionManager getTransactionManager()
    
    Returns:
    The PlatformTransactionManager instance
  - public boolean hasCurrentSession()
  - protected HibernateGormEnhancer initialize()
  - public org.hibernate.Session openSession()
  - protected void registerAllEntitiesWithEnhancer()
  - protected void registerEventListeners(ConfigurableApplicationEventPublisher eventPublisher)
  - public void setApplicationContext(ApplicationContext applicationContext)
  - public void setMessageSource(MessageSource messageSource)
  - public java.lang.String toString()
  - public void withFlushMode(FlushMode flushMode, java.util.concurrent.Callable<java.lang.Boolean> callable)

Summary:
Field
Constructor
Method

| Detail:
Field
Constructor
Method

[Java] Class HibernateDatastore

Field Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Field Detail

protected final java.util.Map<java.lang.String, HibernateDatastore> datastoresByConnectionSource

protected ConfigurableApplicationEventPublisher eventPublisher

protected final HibernateGormEnhancer gormEnhancer

protected final org.hibernate.boot.Metadata metadata

protected final GrailsHibernateTransactionManager transactionManager

Constructor Detail

public HibernateDatastore(ConnectionSources<org.hibernate.SessionFactory, HibernateConnectionSourceSettings> connectionSources, HibernateMappingContext mappingContext, ConfigurableApplicationEventPublisher eventPublisher)

public HibernateDatastore(PropertyResolver configuration, HibernateConnectionSourceFactory connectionSourceFactory, ConfigurableApplicationEventPublisher eventPublisher)

public HibernateDatastore(PropertyResolver configuration, HibernateConnectionSourceFactory connectionSourceFactory)

public HibernateDatastore(PropertyResolver configuration, ConfigurableApplicationEventPublisher eventPublisher, java.lang.Class classes)

public HibernateDatastore(javax.sql.DataSource dataSource, PropertyResolver configuration, ConfigurableApplicationEventPublisher eventPublisher, java.lang.Class classes)

public HibernateDatastore(PropertyResolver configuration, ConfigurableApplicationEventPublisher eventPublisher, java.lang.Package packagesToScan)

public HibernateDatastore(javax.sql.DataSource dataSource, PropertyResolver configuration, ConfigurableApplicationEventPublisher eventPublisher, java.lang.Package packagesToScan)

public HibernateDatastore(PropertyResolver configuration, java.lang.Class classes)

public HibernateDatastore(PropertyResolver configuration, java.lang.Package packagesToScan)

public HibernateDatastore(java.util.Map<java.lang.String, java.lang.Object> configuration, java.lang.Class classes)

public HibernateDatastore(java.util.Map<java.lang.String, java.lang.Object> configuration, java.lang.Package packagesToScan)

public HibernateDatastore(java.lang.Class classes)

public HibernateDatastore(java.lang.Package packagesToScan)

public HibernateDatastore(java.lang.Package packageToScan)

Method Detail

public void addTenantForSchema(java.lang.String schemaName)

protected void configureValidatorRegistry(HibernateConnectionSourceSettings settings, HibernateMappingContext mappingContext)

protected void configureValidatorRegistry(HibernateConnectionSourceSettings settings, HibernateMappingContext mappingContext, ValidatorRegistry validatorRegistry, MessageSource messageSource)

protected Session createSession(PropertyResolver connectionDetails)

public void destroy()

public ApplicationEventPublisher getApplicationEventPublisher()

public Session getCurrentSession()

public HibernateDatastore getDatastoreForConnection(java.lang.String connectionName)

public IHibernateTemplate getHibernateTemplate(int flushMode)

public HibernateMappingContext getMappingContext()

public org.hibernate.boot.Metadata getMetadata()

public GrailsHibernateTransactionManager getTransactionManager()

public boolean hasCurrentSession()

protected HibernateGormEnhancer initialize()

public org.hibernate.Session openSession()

protected void registerAllEntitiesWithEnhancer()

protected void registerEventListeners(ConfigurableApplicationEventPublisher eventPublisher)

public void setApplicationContext(ApplicationContext applicationContext)

public void setMessageSource(MessageSource messageSource)

public java.lang.String toString()

public void withFlushMode(FlushMode flushMode, java.util.concurrent.Callable<java.lang.Boolean> callable)