HibernateDatastore (GORM for Hibernate 5

org.grails.orm.hibernate.HibernateDatastore

All Implemented Interfaces and Traits:

org.springframework.context.MessageSourceAware
```
public class HibernateDatastore
extends AbstractHibernateDatastore
implements org.springframework.context.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, 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 (org.springframework.core.env.PropertyResolver configuration, HibernateConnectionSourceFactory connectionSourceFactory, ConfigurableApplicationEventPublisher eventPublisher)` Create a new HibernateDatastore for the given connection sources and mapping context
`HibernateDatastore (org.springframework.core.env.PropertyResolver configuration, HibernateConnectionSourceFactory connectionSourceFactory)` Create a new HibernateDatastore for the given connection sources and mapping context
`HibernateDatastore (org.springframework.core.env.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, org.springframework.core.env.PropertyResolver configuration, ConfigurableApplicationEventPublisher eventPublisher, java.lang.Class classes)` Create a new HibernateDatastore for the given connection sources and mapping context
`HibernateDatastore (org.springframework.core.env.PropertyResolver configuration, ConfigurableApplicationEventPublisher eventPublisher, java.lang.Package packagesToScan)` Construct a Hibernate datastore scanning the given packages
`HibernateDatastore (javax.sql.DataSource dataSource, org.springframework.core.env.PropertyResolver configuration, ConfigurableApplicationEventPublisher eventPublisher, java.lang.Package packagesToScan)` Construct a Hibernate datastore scanning the given packages for the given datasource
`HibernateDatastore (org.springframework.core.env.PropertyResolver configuration, java.lang.Class classes)` Create a new HibernateDatastore for the given connection sources and mapping context
`HibernateDatastore (org.springframework.core.env.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)`
	`public java.util.List<java.lang.String>`	`allQualifiers(Datastore datastore, PersistentEntity entity)`
	`protected void`	`configureValidatorRegistry(HibernateConnectionSourceSettings settings, HibernateMappingContext mappingContext)`
	`protected void`	`configureValidatorRegistry(HibernateConnectionSourceSettings settings, HibernateMappingContext mappingContext, ValidatorRegistry validatorRegistry, org.springframework.context.MessageSource messageSource)`
	`public ConnectionSource<javax.sql.DataSource, DataSourceSettings>`	`create(java.lang.String name, DataSourceSettings settings)`
	`protected Session`	`createSession(org.springframework.core.env.PropertyResolver connectionDetails)`
	`public void`	`destroy()`
	`public org.springframework.context.ApplicationEventPublisher`	`getApplicationEventPublisher()`
	`public java.sql.Connection`	`getConnection()`
	`public java.sql.Connection`	`getConnection(java.lang.String username, java.lang.String password)`
	`public Session`	`getCurrentSession()`
	`public HibernateDatastore`	`getDatastoreForConnection(java.lang.String connectionName)`
	`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 org.springframework.transaction.PlatformTransactionManager instance
	`public boolean`	`hasCurrentSession()`
	`protected HibernateGormEnhancer`	`initialize()`
	`protected HibernateGormEnhancer`	`initialize()`
	`protected HibernateGormEnhancer`	`initialize()`
	`public org.hibernate.Session`	`openSession()`
	`public void`	`persistentEntityAdded(PersistentEntity entity)`
	`protected void`	`registerAllEntitiesWithEnhancer()`
	`protected void`	`registerEventListeners(ConfigurableApplicationEventPublisher eventPublisher)`
	`public void`	`setApplicationContext(org.springframework.context.ApplicationContext applicationContext)`
	`public void`	`setMessageSource(org.springframework.context.MessageSource messageSource)`
	`public java.lang.String`	`toString()`
	`public void`	`withFlushMode(org.hibernate.FlushMode flushMode, java.util.concurrent.Callable<java.lang.Boolean> callable)`

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class AbstractHibernateDatastore`	call, 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, doInSession, getApplicationContext, getApplicationEventPublisher, getCurrentSession, getMappingContext, getService, getServices, 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(org.springframework.core.env.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(org.springframework.core.env.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(org.springframework.core.env.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, org.springframework.core.env.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(org.springframework.core.env.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, org.springframework.core.env.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(org.springframework.core.env.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(org.springframework.core.env.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
  - @java.lang.Override public void addTenantForSchema(java.lang.String schemaName)
  - @java.lang.Override public java.util.List<java.lang.String> allQualifiers(Datastore datastore, PersistentEntity entity)
  - protected void configureValidatorRegistry(HibernateConnectionSourceSettings settings, HibernateMappingContext mappingContext)
  - protected void configureValidatorRegistry(HibernateConnectionSourceSettings settings, HibernateMappingContext mappingContext, ValidatorRegistry validatorRegistry, org.springframework.context.MessageSource messageSource)
  - @java.lang.Override public ConnectionSource<javax.sql.DataSource, DataSourceSettings> create(java.lang.String name, DataSourceSettings settings)
  - @java.lang.Override protected Session createSession(org.springframework.core.env.PropertyResolver connectionDetails)
  - @java.lang.Override public void destroy()
  - @java.lang.Override public org.springframework.context.ApplicationEventPublisher getApplicationEventPublisher()
  - @java.lang.Override public java.sql.Connection getConnection()
  - @java.lang.Override public java.sql.Connection getConnection(java.lang.String username, java.lang.String password)
  - @java.lang.Override public Session getCurrentSession()
  - @java.lang.Override public HibernateDatastore getDatastoreForConnection(java.lang.String connectionName)
  - public HibernateDatastore getDatastoreForConnection(java.lang.String connectionName)
    
    Obtain a child HibernateDatastore by connection name
    Parameters:
    connectionName - The connection name
    Returns:
    The HibernateDatastore
  - @java.lang.Override public IHibernateTemplate getHibernateTemplate(int flushMode)
  - @java.lang.Override public HibernateMappingContext getMappingContext()
  - public org.hibernate.boot.Metadata getMetadata()
  - public GrailsHibernateTransactionManager getTransactionManager()
    
    Returns:
    The org.springframework.transaction.PlatformTransactionManager instance
  - @java.lang.Override public boolean hasCurrentSession()
  - @java.lang.Override protected HibernateGormEnhancer initialize()
  - protected HibernateGormEnhancer initialize()
  - @java.lang.Override protected HibernateGormEnhancer initialize()
  - @java.lang.Override public org.hibernate.Session openSession()
  - @java.lang.Override public void persistentEntityAdded(PersistentEntity entity)
  - protected void registerAllEntitiesWithEnhancer()
  - protected void registerEventListeners(ConfigurableApplicationEventPublisher eventPublisher)
  - public void setApplicationContext(org.springframework.context.ApplicationContext applicationContext)
  - @java.lang.Override public void setMessageSource(org.springframework.context.MessageSource messageSource)
  - @java.lang.Override public java.lang.String toString()
  - @java.lang.Override public void withFlushMode(org.hibernate.FlushMode flushMode, java.util.concurrent.Callable<java.lang.Boolean> callable)

Summary:
Field
Constructor
Method

| Detail:
Field
Constructor
Method

Groovy Documentation

[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(org.springframework.core.env.PropertyResolver configuration, HibernateConnectionSourceFactory connectionSourceFactory, ConfigurableApplicationEventPublisher eventPublisher)

public HibernateDatastore(org.springframework.core.env.PropertyResolver configuration, HibernateConnectionSourceFactory connectionSourceFactory)

public HibernateDatastore(org.springframework.core.env.PropertyResolver configuration, ConfigurableApplicationEventPublisher eventPublisher, java.lang.Class classes)

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

public HibernateDatastore(org.springframework.core.env.PropertyResolver configuration, ConfigurableApplicationEventPublisher eventPublisher, java.lang.Package packagesToScan)

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

public HibernateDatastore(org.springframework.core.env.PropertyResolver configuration, java.lang.Class classes)

public HibernateDatastore(org.springframework.core.env.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

@java.lang.Override public void addTenantForSchema(java.lang.String schemaName)

@java.lang.Override public java.util.List<java.lang.String> allQualifiers(Datastore datastore, PersistentEntity entity)

protected void configureValidatorRegistry(HibernateConnectionSourceSettings settings, HibernateMappingContext mappingContext)

protected void configureValidatorRegistry(HibernateConnectionSourceSettings settings, HibernateMappingContext mappingContext, ValidatorRegistry validatorRegistry, org.springframework.context.MessageSource messageSource)

@java.lang.Override public ConnectionSource<javax.sql.DataSource, DataSourceSettings> create(java.lang.String name, DataSourceSettings settings)

@java.lang.Override protected Session createSession(org.springframework.core.env.PropertyResolver connectionDetails)

@java.lang.Override public void destroy()

@java.lang.Override public org.springframework.context.ApplicationEventPublisher getApplicationEventPublisher()

@java.lang.Override public java.sql.Connection getConnection()

@java.lang.Override public java.sql.Connection getConnection(java.lang.String username, java.lang.String password)

@java.lang.Override public Session getCurrentSession()

@java.lang.Override public HibernateDatastore getDatastoreForConnection(java.lang.String connectionName)

public HibernateDatastore getDatastoreForConnection(java.lang.String connectionName)

@java.lang.Override public IHibernateTemplate getHibernateTemplate(int flushMode)

@java.lang.Override public HibernateMappingContext getMappingContext()

public org.hibernate.boot.Metadata getMetadata()

public GrailsHibernateTransactionManager getTransactionManager()

@java.lang.Override public boolean hasCurrentSession()

@java.lang.Override protected HibernateGormEnhancer initialize()

protected HibernateGormEnhancer initialize()

@java.lang.Override protected HibernateGormEnhancer initialize()

@java.lang.Override public org.hibernate.Session openSession()

@java.lang.Override public void persistentEntityAdded(PersistentEntity entity)

protected void registerAllEntitiesWithEnhancer()

protected void registerEventListeners(ConfigurableApplicationEventPublisher eventPublisher)

public void setApplicationContext(org.springframework.context.ApplicationContext applicationContext)

@java.lang.Override public void setMessageSource(org.springframework.context.MessageSource messageSource)

@java.lang.Override public java.lang.String toString()

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