AbstractHibernateDatastore (Grails 8.0.0)

org.grails.orm.hibernate.AbstractHibernateDatastore

All Implemented Interfaces and Traits:

ApplicationContextAware, MultipleConnectionSourceCapableDatastore, SchemaMultiTenantCapableDatastore, Settings, TransactionCapableDatastore, java.io.Closeable, MessageSourceAware
```
public abstract class AbstractHibernateDatastore
extends AbstractDatastore
implements ApplicationContextAware, MultipleConnectionSourceCapableDatastore, SchemaMultiTenantCapableDatastore, Settings, TransactionCapableDatastore, java.io.Closeable, MessageSourceAware
```
Datastore implementation that uses a Hibernate SessionFactory underneath.
Authors:
Graeme Rocher
Since:
2.0

Nested Class Summary

Nested classes
Modifiers	Name	Description
`enum`	`AbstractHibernateDatastore.FlushMode`	We use a separate enum here because the classes differ between Hibernate 3 and 4

Field Summary

Fields
Modifiers	Name	Description
`static java.lang.String`	`CONFIG_PROPERTY_CACHE_QUERIES`
`static java.lang.String`	`CONFIG_PROPERTY_OSIV_READONLY`
`static java.lang.String`	`CONFIG_PROPERTY_PASS_READONLY_TO_HIBERNATE`
`protected AutoTimestampEventListener`	`autoTimestampEventListener`
`protected ConnectionSources<org.hibernate.SessionFactory, HibernateConnectionSourceSettings>`	`connectionSources`
`protected java.lang.String`	`dataSourceName`
`protected int`	`defaultFlushMode`
`protected java.lang.String`	`defaultFlushModeName`
`protected AbstractHibernateEventListener`	`eventTriggeringInterceptor`
`protected boolean`	`failOnError`
`protected boolean`	`isCacheQueries`
`protected boolean`	`markDirty`
`protected MultiTenancyMode`	`multiTenantMode`
`protected boolean`	`osivReadOnly`
`protected boolean`	`passReadOnlyToHibernate`
`protected SchemaHandler`	`schemaHandler`
`protected org.hibernate.SessionFactory`	`sessionFactory`
`protected TenantResolver`	`tenantResolver`

Inherited fields
Fields inherited from class	Fields
`class AbstractDatastore`	`LOG, applicationEventPublisher, cacheAdapterRepository, connectionDetails, mappingContext, serviceRegistry`

Constructor Summary

Constructors
Constructor and description
`protected AbstractHibernateDatastore(ConnectionSources<org.hibernate.SessionFactory, HibernateConnectionSourceSettings> connectionSources, HibernateMappingContext mappingContext)`
`protected AbstractHibernateDatastore(MappingContext mappingContext, org.hibernate.SessionFactory sessionFactory, PropertyResolver config, ApplicationContext applicationContext, java.lang.String dataSourceName)`
`AbstractHibernateDatastore(MappingContext mappingContext, org.hibernate.SessionFactory sessionFactory, PropertyResolver config)`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`public T`	`call(java.lang.Object args)`
	`public void`	`close()`
	`protected ValidatorRegistry`	`createValidatorRegistry(MessageSource messageSource)`
	`public void`	`destroy()`
	`public void`	`disableMultiTenancyFilter()` Disable the tenant id filter for the given datastore and entity
	`public void`	`enableMultiTenancyFilter()` Enable the tenant id filter for the given datastore and entity
	`public AutoTimestampEventListener`	`getAutoTimestampEventListener()` Returns: The event listener that populates lastUpdated and dateCreated
	`public ConnectionSources<org.hibernate.SessionFactory, HibernateConnectionSourceSettings>`	`getConnectionSources()`
	`public javax.sql.DataSource`	`getDataSource()` Returns: The javax.sql.DataSource being used by this datastore instance
	`public java.lang.String`	`getDataSourceName()` Returns: The data source name being used
	`public abstract AbstractHibernateDatastore`	`getDatastoreForConnection(java.lang.String connectionName)` Obtain a child datastore for the given connection name
	`public Datastore`	`getDatastoreForTenantId(java.io.Serializable tenantId)`
	`public int`	`getDefaultFlushMode()` Returns: Obtains the default flush mode level
	`public java.lang.String`	`getDefaultFlushModeName()` Returns: The name of the default value flush
	`public AbstractHibernateEventListener`	`getEventTriggeringInterceptor()`
	`public abstract IHibernateTemplate`	`getHibernateTemplate(int flushMode)` Obtains a hibernate template for the given flush mode
	`public IHibernateTemplate`	`getHibernateTemplate()` Returns: A hibernate template that uses the default flush mode of this datastore
	`public MultiTenancyMode`	`getMultiTenancyMode()`
	`public org.hibernate.SessionFactory`	`getSessionFactory()` Returns: The Hibernate org.hibernate.SessionFactory being used by this datastore instance
	`public TenantResolver`	`getTenantResolver()`
	`public boolean`	`isAutoFlush()`
	`public boolean`	`isCacheQueries()`
	`public boolean`	`isFailOnError()`
	`public boolean`	`isOsivReadOnly()`
	`public boolean`	`isPassReadOnlyToHibernate()`
	`public abstract org.hibernate.Session`	`openSession()` Returns: Opens a session
`<T>`	`protected Closure<T>`	`prepareMultiTenantClosure(Closure<T> callable)`
	`public java.io.Serializable`	`resolveTenantIdentifier()`
	`public java.lang.Iterable<java.io.Serializable>`	`resolveTenantIds()`
	`public void`	`setMessageSource(MessageSource messageSource)`
	`public abstract void`	`withFlushMode(AbstractHibernateDatastore.FlushMode flushMode, java.util.concurrent.Callable<java.lang.Boolean> callable)` Execute the given operation with the given flush mode.
`<T>`	`public T`	`withNewSession(Closure<T> callable)`
`<T1>`	`public T1`	`withNewSession(java.io.Serializable tenantId, Closure<T1> callable)`
`<T>`	`public T`	`withSession(Closure<T> callable)`

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class AbstractDatastore`	`connect, connect, connectStateless, createSession, createStatelessSession, destroy, doInSession, getApplicationContext, getApplicationEventPublisher, getCurrentSession, getMappingContext, getService, getServices, getSessionResolver, hasCurrentSession, initializeConverters, isIndexed, isSchemaless, mapToPropertyResolver, retrieveSession, retrieveSession, setApplicationContext, withSession`

- Field Detail
  - public static final java.lang.String CONFIG_PROPERTY_CACHE_QUERIES
  - public static final java.lang.String CONFIG_PROPERTY_OSIV_READONLY
  - public static final java.lang.String CONFIG_PROPERTY_PASS_READONLY_TO_HIBERNATE
  - protected AutoTimestampEventListener autoTimestampEventListener
  - protected final ConnectionSources<org.hibernate.SessionFactory, HibernateConnectionSourceSettings> connectionSources
  - protected final java.lang.String dataSourceName
  - protected final int defaultFlushMode
  - protected final java.lang.String defaultFlushModeName
  - protected AbstractHibernateEventListener eventTriggeringInterceptor
  - protected final boolean failOnError
  - protected final boolean isCacheQueries
  - protected final boolean markDirty
  - protected final MultiTenancyMode multiTenantMode
  - protected final boolean osivReadOnly
  - protected final boolean passReadOnlyToHibernate
  - protected final SchemaHandler schemaHandler
  - protected final org.hibernate.SessionFactory sessionFactory
  - protected final TenantResolver tenantResolver
- Constructor Detail
  - protected AbstractHibernateDatastore(ConnectionSources<org.hibernate.SessionFactory, HibernateConnectionSourceSettings> connectionSources, HibernateMappingContext mappingContext)
  - protected AbstractHibernateDatastore(MappingContext mappingContext, org.hibernate.SessionFactory sessionFactory, PropertyResolver config, ApplicationContext applicationContext, java.lang.String dataSourceName)
  - public AbstractHibernateDatastore(MappingContext mappingContext, org.hibernate.SessionFactory sessionFactory, PropertyResolver config)
- Method Detail
  - @java.lang.Override
    public T call(java.lang.Object args)
  - @java.lang.Override
    @jakarta.annotation.PreDestroy
    public void close()
  - protected ValidatorRegistry createValidatorRegistry(MessageSource messageSource)
  - @java.lang.Override
    public void destroy()
  - public void disableMultiTenancyFilter()
    
    Disable the tenant id filter for the given datastore and entity
  - public void enableMultiTenancyFilter()
    
    Enable the tenant id filter for the given datastore and entity
  - public AutoTimestampEventListener getAutoTimestampEventListener()
    
    Returns:
    The event listener that populates lastUpdated and dateCreated
  - @java.lang.Override
    public ConnectionSources<org.hibernate.SessionFactory, HibernateConnectionSourceSettings> getConnectionSources()
  - public javax.sql.DataSource getDataSource()
    
    Returns:
    The javax.sql.DataSource being used by this datastore instance
  - public java.lang.String getDataSourceName()
    
    Returns:
    The data source name being used
  - public abstract AbstractHibernateDatastore getDatastoreForConnection(java.lang.String connectionName)
    
    Obtain a child datastore for the given connection name
    Parameters:
    connectionName - The name of the connection
    Returns:
    The child data store
  - @java.lang.Override
    public Datastore getDatastoreForTenantId(java.io.Serializable tenantId)
  - public int getDefaultFlushMode()
    
    Returns:
    Obtains the default flush mode level
  - public java.lang.String getDefaultFlushModeName()
    
    Returns:
    The name of the default value flush
  - public AbstractHibernateEventListener getEventTriggeringInterceptor()
  - public abstract IHibernateTemplate getHibernateTemplate(int flushMode)
    
    Obtains a hibernate template for the given flush mode
    Parameters:
    flushMode - The flush mode, one of the FLUSH_* constants of GrailsHibernateTemplate
    Returns:
    The IHibernateTemplate
  - public IHibernateTemplate getHibernateTemplate()
    
    Returns:
    A hibernate template that uses the default flush mode of this datastore
  - @java.lang.Override
    public MultiTenancyMode getMultiTenancyMode()
  - public org.hibernate.SessionFactory getSessionFactory()
    
    Returns:
    The Hibernate org.hibernate.SessionFactory being used by this datastore instance
  - @java.lang.Override
    public TenantResolver getTenantResolver()
  - public boolean isAutoFlush()
  - public boolean isCacheQueries()
  - public boolean isFailOnError()
  - public boolean isOsivReadOnly()
  - public boolean isPassReadOnlyToHibernate()
  - public abstract org.hibernate.Session openSession()
    
    Returns:
    Opens a session
  - <T> protected Closure<T> prepareMultiTenantClosure(Closure<T> callable)
  - public java.io.Serializable resolveTenantIdentifier()
  - public java.lang.Iterable<java.io.Serializable> resolveTenantIds()
  - @java.lang.Override
    public void setMessageSource(MessageSource messageSource)
  - public abstract void withFlushMode(AbstractHibernateDatastore.FlushMode flushMode, java.util.concurrent.Callable<java.lang.Boolean> callable)
    
    Execute the given operation with the given flush mode. The previous flush mode of the current session is restored afterwards, also when the operation throws, unless the operation returns false. An exception thrown by the operation is rethrown; a checked exception is wrapped in an java.lang.reflect.UndeclaredThrowableException.
    Parameters:
    flushMode - The flush mode to apply while the operation runs
    callable - The operation, which returns false to keep the given flush mode
  - <T> public T withNewSession(Closure<T> callable)
  - <T1> @java.lang.Override
    public T1 withNewSession(java.io.Serializable tenantId, Closure<T1> callable)
  - <T> @java.lang.Override
    public T withSession(Closure<T> callable)

| Detail:
Field
Constructor
Method

[Java] Class AbstractHibernateDatastore

Nested Class Summary

Field Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Field Detail

public static final java.lang.String CONFIG_PROPERTY_CACHE_QUERIES

public static final java.lang.String CONFIG_PROPERTY_OSIV_READONLY

public static final java.lang.String CONFIG_PROPERTY_PASS_READONLY_TO_HIBERNATE

protected AutoTimestampEventListener autoTimestampEventListener

protected final ConnectionSources<org.hibernate.SessionFactory, HibernateConnectionSourceSettings> connectionSources

protected final java.lang.String dataSourceName

protected final int defaultFlushMode

protected final java.lang.String defaultFlushModeName

protected AbstractHibernateEventListener eventTriggeringInterceptor

protected final boolean failOnError

protected final boolean isCacheQueries

protected final boolean markDirty

protected final MultiTenancyMode multiTenantMode

protected final boolean osivReadOnly

protected final boolean passReadOnlyToHibernate

protected final SchemaHandler schemaHandler

protected final org.hibernate.SessionFactory sessionFactory

protected final TenantResolver tenantResolver

Constructor Detail

protected AbstractHibernateDatastore(ConnectionSources<org.hibernate.SessionFactory, HibernateConnectionSourceSettings> connectionSources, HibernateMappingContext mappingContext)

protected AbstractHibernateDatastore(MappingContext mappingContext, org.hibernate.SessionFactory sessionFactory, PropertyResolver config, ApplicationContext applicationContext, java.lang.String dataSourceName)

public AbstractHibernateDatastore(MappingContext mappingContext, org.hibernate.SessionFactory sessionFactory, PropertyResolver config)

Method Detail

@java.lang.Overridepublic T call(java.lang.Object args)

@java.lang.Override@jakarta.annotation.PreDestroypublic void close()

protected ValidatorRegistry createValidatorRegistry(MessageSource messageSource)

@java.lang.Overridepublic void destroy()

public void disableMultiTenancyFilter()

public void enableMultiTenancyFilter()

public AutoTimestampEventListener getAutoTimestampEventListener()

@java.lang.Overridepublic ConnectionSources<org.hibernate.SessionFactory, HibernateConnectionSourceSettings> getConnectionSources()

public javax.sql.DataSource getDataSource()

public java.lang.String getDataSourceName()

public abstract AbstractHibernateDatastore getDatastoreForConnection(java.lang.String connectionName)

@java.lang.Overridepublic Datastore getDatastoreForTenantId(java.io.Serializable tenantId)

public int getDefaultFlushMode()

public java.lang.String getDefaultFlushModeName()

public AbstractHibernateEventListener getEventTriggeringInterceptor()

public abstract IHibernateTemplate getHibernateTemplate(int flushMode)

public IHibernateTemplate getHibernateTemplate()

@java.lang.Overridepublic MultiTenancyMode getMultiTenancyMode()

public org.hibernate.SessionFactory getSessionFactory()

@java.lang.Overridepublic TenantResolver getTenantResolver()

public boolean isAutoFlush()

public boolean isCacheQueries()

public boolean isFailOnError()

public boolean isOsivReadOnly()

public boolean isPassReadOnlyToHibernate()

public abstract org.hibernate.Session openSession()

<T> protected Closure<T> prepareMultiTenantClosure(Closure<T> callable)

public java.io.Serializable resolveTenantIdentifier()

public java.lang.Iterable<java.io.Serializable> resolveTenantIds()

@java.lang.Overridepublic void setMessageSource(MessageSource messageSource)

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

<T> public T withNewSession(Closure<T> callable)

<T1> @java.lang.Overridepublic T1 withNewSession(java.io.Serializable tenantId, Closure<T1> callable)

<T> @java.lang.Overridepublic T withSession(Closure<T> callable)

@java.lang.Override
public T call(java.lang.Object args)

@java.lang.Override
@jakarta.annotation.PreDestroy
public void close()

@java.lang.Override
public void destroy()

@java.lang.Override
public ConnectionSources<org.hibernate.SessionFactory, HibernateConnectionSourceSettings> getConnectionSources()

@java.lang.Override
public Datastore getDatastoreForTenantId(java.io.Serializable tenantId)

@java.lang.Override
public MultiTenancyMode getMultiTenancyMode()

@java.lang.Override
public TenantResolver getTenantResolver()

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

<T1> @java.lang.Override
public T1 withNewSession(java.io.Serializable tenantId, Closure<T1> callable)

<T> @java.lang.Override
public T withSession(Closure<T> callable)