AbstractDatastore (Grails Data Mapping API

org.grails.datastore.mapping.core.AbstractDatastore

All Implemented Interfaces and Traits:

Datastore, ServiceRegistry, StatelessDatastore
```
@java.lang.SuppressWarnings({"rawtypes", "unchecked"})
public abstract class AbstractDatastore
extends java.lang.Object
implements Datastore, ServiceRegistry, StatelessDatastore
```
Abstract Datastore implementation that deals with binding the Session to thread locale upon creation.
Authors:
Graeme Rocher
Since:
1.0

Field Summary

Fields
Modifiers	Name	Description
`protected static Logger`	`LOG`
`protected ApplicationEventPublisher`	`applicationEventPublisher`
`protected TPCacheAdapterRepository`	`cacheAdapterRepository`
`protected PropertyResolver`	`connectionDetails`
`protected MappingContext`	`mappingContext`
`protected ServiceRegistry`	`serviceRegistry`

Constructor Summary

Constructors
Constructor and description
`AbstractDatastore(MappingContext mappingContext)`
`AbstractDatastore(MappingContext mappingContext, java.util.Map<java.lang.String, java.lang.Object> connectionDetails, ConfigurableApplicationContext ctx)`
`AbstractDatastore(MappingContext mappingContext, PropertyResolver connectionDetails, ConfigurableApplicationContext ctx)`
`AbstractDatastore(MappingContext mappingContext, PropertyResolver connectionDetails, ConfigurableApplicationContext ctx, TPCacheAdapterRepository cacheAdapterRepository)`
`AbstractDatastore(MappingContext mappingContext, java.util.Map<java.lang.String, java.lang.Object> connectionDetails, ConfigurableApplicationContext ctx, TPCacheAdapterRepository cacheAdapterRepository)`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`public Session`	`connect()`
	`public final Session`	`connect(PropertyResolver connDetails)`
	`public Session`	`connectStateless()`
	`protected abstract Session`	`createSession(PropertyResolver connectionDetails)` Creates the native session
	`protected Session`	`createStatelessSession(PropertyResolver connectionDetails)` Creates the native stateless session
	`public void`	`destroy()` Closes every session held by the current thread's SessionHolder, if any.
	`public T`	`doInSession(Session session)`
	`public ConfigurableApplicationContext`	`getApplicationContext()` deprecated: Deprecated, will be removed in a future version of GORM
	`public ApplicationEventPublisher`	`getApplicationEventPublisher()` Returns: The event publisher, or `null` if this datastore was constructed without an ApplicationContext and no subclass provides its own publisher
	`public Session`	`getCurrentSession()`
	`public MappingContext`	`getMappingContext()`
`<T>`	`public T`	`getService(java.lang.Class<T> interfaceType)`
`<T extends Service>`	`public java.lang.Iterable<T>`	`getServices()`
	`public SessionResolver`	`getSessionResolver()` Returns: The session resolver for this datastore: a stateless view over the same SessionHolder/TransactionSynchronizationManager state used elsewhere for this datastore.
	`public boolean`	`hasCurrentSession()` Returns: Whether getCurrentSession() would return an existing session rather than opening a new one: a validated (still connected) session is bound to the current thread.
	`protected void`	`initializeConverters(MappingContext mappingContext)`
	`protected boolean`	`isIndexed(PersistentProperty property)`
	`public boolean`	`isSchemaless()`
	`protected static PropertyResolver`	`mapToPropertyResolver(java.util.Map<java.lang.String, java.lang.Object> connectionDetails)`
	`public static Session`	`retrieveSession()` Static way to retrieve the session
	`public static Session`	`retrieveSession(java.lang.Class datastoreClass)` Static way to retrieve the session
	`public void`	`setApplicationContext(ApplicationContext ctx)`
`<T>`	`public T`	`withSession(groovy.lang.Closure<T> callable)`

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class java.lang.Object`	`java.lang.Object#equals(java.lang.Object), java.lang.Object#getClass(), java.lang.Object#hashCode(), java.lang.Object#notify(), java.lang.Object#notifyAll(), java.lang.Object#toString(), java.lang.Object#wait(), java.lang.Object#wait(long), java.lang.Object#wait(long, int)`

- Field Detail
  - protected static final Logger LOG
  - protected ApplicationEventPublisher applicationEventPublisher
  - protected final TPCacheAdapterRepository cacheAdapterRepository
  - protected final PropertyResolver connectionDetails
  - protected final MappingContext mappingContext
  - protected final ServiceRegistry serviceRegistry
- Constructor Detail
  - public AbstractDatastore(MappingContext mappingContext)
  - public AbstractDatastore(MappingContext mappingContext, java.util.Map<java.lang.String, java.lang.Object> connectionDetails, ConfigurableApplicationContext ctx)
  - public AbstractDatastore(MappingContext mappingContext, PropertyResolver connectionDetails, ConfigurableApplicationContext ctx)
  - public AbstractDatastore(MappingContext mappingContext, PropertyResolver connectionDetails, ConfigurableApplicationContext ctx, TPCacheAdapterRepository cacheAdapterRepository)
  - public AbstractDatastore(MappingContext mappingContext, java.util.Map<java.lang.String, java.lang.Object> connectionDetails, ConfigurableApplicationContext ctx, TPCacheAdapterRepository cacheAdapterRepository)
- Method Detail
  - public Session connect()
  - public final Session connect(PropertyResolver connDetails)
  - @java.lang.Override
    public Session connectStateless()
  - protected abstract Session createSession(PropertyResolver connectionDetails)
    
    Creates the native session
    Parameters:
    connectionDetails - The session details
    Returns:
    The session object
  - protected Session createStatelessSession(PropertyResolver connectionDetails)
    
    Creates the native stateless session
    Parameters:
    connectionDetails - The session details
    Returns:
    The session object
  - @jakarta.annotation.PreDestroy
    public void destroy()
    
    Closes every session held by the current thread's SessionHolder, if any. Since TransactionSynchronizationManager is thread-local, this only reaches the thread invoking @PreDestroy - sessions bound on other threads are not visible here and must be closed by their own owning thread. A holder that is synchronized with an active Spring transaction is left alone: DatastoreTransactionManager still owns those sessions and will operate on them during commit or rollback.
  - @java.lang.Override
    public T doInSession(Session session)
  - @java.lang.Deprecated
    public ConfigurableApplicationContext getApplicationContext()
    
    deprecated:
    Deprecated, will be removed in a future version of GORM
  - public ApplicationEventPublisher getApplicationEventPublisher()
    
    Returns:
    The event publisher, or null if this datastore was constructed without an ApplicationContext and no subclass provides its own publisher
  - public Session getCurrentSession()
  - public MappingContext getMappingContext()
  - <T> @java.lang.Override
    public T getService(java.lang.Class<T> interfaceType)
  - <T extends Service> @java.lang.Override
    public java.lang.Iterable<T> getServices()
  - public SessionResolver getSessionResolver()
    
    Returns:
    The session resolver for this datastore: a stateless view over the same SessionHolder/TransactionSynchronizationManager state used elsewhere for this datastore. The same instance is returned on every call.
  - public boolean hasCurrentSession()
    
    Returns:
    Whether getCurrentSession() would return an existing session rather than opening a new one: a validated (still connected) session is bound to the current thread. Delegates to getSessionResolver() so both methods read the same state. Unlike getCurrentSession(), this is non-mutating - it never evicts a stale session or unbinds an empty holder, so it is safe to call for routing/discovery purposes on a datastore whose session state this call has no other reason to touch.
  - protected void initializeConverters(MappingContext mappingContext)
  - protected boolean isIndexed(PersistentProperty property)
  - public boolean isSchemaless()
  - protected static PropertyResolver mapToPropertyResolver(java.util.Map<java.lang.String, java.lang.Object> connectionDetails)
  - public static Session retrieveSession()
    
    Static way to retrieve the session
    throws:
    ConnectionNotFoundException If no session has been created
    
    Returns:
    The session instance
  - public static Session retrieveSession(java.lang.Class datastoreClass)
    
    Static way to retrieve the session
    throws:
    ConnectionNotFoundException If no session has been created
    
    Parameters:
    datastoreClass - The type of datastore
    Returns:
    The session instance
  - public void setApplicationContext(ApplicationContext ctx)
  - <T> @java.lang.Override
    public T withSession(groovy.lang.Closure<T> callable)

Summary:
Field
Constructor
Method

| Detail:
Field
Constructor
Method

[Java] Class AbstractDatastore

Field Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Field Detail

protected static final Logger LOG

protected ApplicationEventPublisher applicationEventPublisher

protected final TPCacheAdapterRepository cacheAdapterRepository

protected final PropertyResolver connectionDetails

protected final MappingContext mappingContext

protected final ServiceRegistry serviceRegistry

Constructor Detail

public AbstractDatastore(MappingContext mappingContext)

public AbstractDatastore(MappingContext mappingContext, java.util.Map<java.lang.String, java.lang.Object> connectionDetails, ConfigurableApplicationContext ctx)

public AbstractDatastore(MappingContext mappingContext, PropertyResolver connectionDetails, ConfigurableApplicationContext ctx)

public AbstractDatastore(MappingContext mappingContext, PropertyResolver connectionDetails, ConfigurableApplicationContext ctx, TPCacheAdapterRepository cacheAdapterRepository)

public AbstractDatastore(MappingContext mappingContext, java.util.Map<java.lang.String, java.lang.Object> connectionDetails, ConfigurableApplicationContext ctx, TPCacheAdapterRepository cacheAdapterRepository)

Method Detail

public Session connect()

public final Session connect(PropertyResolver connDetails)

@java.lang.Overridepublic Session connectStateless()

protected abstract Session createSession(PropertyResolver connectionDetails)

protected Session createStatelessSession(PropertyResolver connectionDetails)

@jakarta.annotation.PreDestroypublic void destroy()

@java.lang.Overridepublic T doInSession(Session session)

@java.lang.Deprecatedpublic ConfigurableApplicationContext getApplicationContext()

public ApplicationEventPublisher getApplicationEventPublisher()

public Session getCurrentSession()

public MappingContext getMappingContext()

<T> @java.lang.Overridepublic T getService(java.lang.Class<T> interfaceType)

<T extends Service> @java.lang.Overridepublic java.lang.Iterable<T> getServices()

public SessionResolver getSessionResolver()

public boolean hasCurrentSession()

protected void initializeConverters(MappingContext mappingContext)

protected boolean isIndexed(PersistentProperty property)

public boolean isSchemaless()

protected static PropertyResolver mapToPropertyResolver(java.util.Map<java.lang.String, java.lang.Object> connectionDetails)

public static Session retrieveSession()

public static Session retrieveSession(java.lang.Class datastoreClass)

public void setApplicationContext(ApplicationContext ctx)

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

@java.lang.Override
public Session connectStateless()

@jakarta.annotation.PreDestroy
public void destroy()

@java.lang.Override
public T doInSession(Session session)

@java.lang.Deprecated
public ConfigurableApplicationContext getApplicationContext()

<T> @java.lang.Override
public T getService(java.lang.Class<T> interfaceType)

<T extends Service> @java.lang.Override
public java.lang.Iterable<T> getServices()

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