AbstractDatastoreInitializer (Grace Data

org.grails.datastore.gorm.bootstrap.AbstractDatastoreInitializer

All Implemented Interfaces and Traits:

ResourceLoaderAware
```
@CompileStatic
abstract class AbstractDatastoreInitializer
extends Object
implements ResourceLoaderAware
```
Abstract class for datastore initializers to implement
Authors:
Graeme Rocher
Since:
3.0.3

Nested Class Summary

Nested classes
Modifiers	Name	Description
`static class`	`AbstractDatastoreInitializer.GrailsBeanBuilderInit`
`static class`	`AbstractDatastoreInitializer.GroovyBeanReaderInit`

Field Summary

Fields
Modifiers	Name	Description
`static String`	`ENTITY_CLASS_RESOURCE_PATTERN`
`static String`	`OSIV_CLASS_NAME`
`static String`	`TRANSACTION_MANAGER_BEAN`
`protected ClassLoader`	`classLoader`
`protected boolean`	`secondaryDatastore`

Properties Summary

Properties
Type	Name and description
`PropertyResolver`	`configuration`
`Object`	`originalConfiguration`
`Collection<String>`	`packages`
`Collection<Class>`	`persistentClasses`
`boolean`	`registerApplicationIfNotPresent`
`PathMatchingResourcePatternResolver`	`resourcePatternResolver`

Constructor Summary

Constructors
Constructor and description
`AbstractDatastoreInitializer()`
`AbstractDatastoreInitializer(ClassLoader classLoader, String[] packages)`
`AbstractDatastoreInitializer(String[] packages)`
`AbstractDatastoreInitializer(Collection<Class> persistentClasses)`
`AbstractDatastoreInitializer(Class[] persistentClasses)`
`AbstractDatastoreInitializer(PropertyResolver configuration, Collection<Class> persistentClasses)`
`AbstractDatastoreInitializer(PropertyResolver configuration, Class[] persistentClasses)`
`AbstractDatastoreInitializer(PropertyResolver configuration, String[] packages)`
`AbstractDatastoreInitializer(Map configuration, Collection<Class> persistentClasses)`
`AbstractDatastoreInitializer(Map configuration, Class[] persistentClasses)`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`protected Collection<Class>`	`collectMappedClasses(String datastoreType)`
	`ApplicationContext`	`configure()` Configures for an existing Mongo instance
	`void`	`configureForBeanDefinitionRegistry(BeanDefinitionRegistry beanDefinitionRegistry)` Configures an existing BeanDefinitionRegistry
	`protected boolean`	`containsRegisteredBean(Object builder, BeanDefinitionRegistry registry, String beanName)`
	`ApplicationEventPublisher`	`findEventPublisher(BeanDefinitionRegistry beanDefinitionRegistry)` Finds the event publisher to use
	`MessageSource`	`findMessageSource(BeanDefinitionRegistry beanDefinitionRegistry)` Finds the message source to use
	`Closure`	`getAdditionalBeansConfiguration(BeanDefinitionRegistry registry, String type)` Internal method aiding in datastore configuration.
	`abstract Closure`	`getBeanDefinitions(BeanDefinitionRegistry beanDefinitionRegistry)`
	`Closure`	`getCommonConfiguration(BeanDefinitionRegistry registry, String type)`
	`protected Class`	`getGrailsApplicationClass()`
	`protected Class`	`getGrailsValidatorClass()`
	`protected abstract Class<AbstractDatastorePersistenceContextInterceptor>`	`getPersistenceInterceptorClass()` Returns: The class used to define the persistence interceptor
	`protected boolean`	`isGrailsPresent()`
	`protected boolean`	`isMappedClass(String datastoreType, Class cls)`
	`protected Map<String, Class<?>>`	`loadDataServices(String secondaryDatastore)`
	`protected void`	`scanForPersistentClasses()`
	`void`	`setResourceLoader(ResourceLoader resourceLoader)`
	`void`	`setSecondaryDatastore(boolean secondaryDatastore)` Whether this datastore is secondary to another primary datastore (example the SQL DB)

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class Object`	`equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

- Field Detail
  - public static final String ENTITY_CLASS_RESOURCE_PATTERN
  - public static final String OSIV_CLASS_NAME
  - public static final String TRANSACTION_MANAGER_BEAN
  - protected ClassLoader classLoader
  - protected boolean secondaryDatastore
- Property Detail
  - PropertyResolver configuration
  - Object originalConfiguration
  - Collection<String> packages
  - Collection<Class> persistentClasses
  - boolean registerApplicationIfNotPresent
  - PathMatchingResourcePatternResolver resourcePatternResolver
- Constructor Detail
  - AbstractDatastoreInitializer()
  - AbstractDatastoreInitializer(ClassLoader classLoader, String[] packages)
  - AbstractDatastoreInitializer(String[] packages)
  - AbstractDatastoreInitializer(Collection<Class> persistentClasses)
  - AbstractDatastoreInitializer(Class[] persistentClasses)
  - AbstractDatastoreInitializer(PropertyResolver configuration, Collection<Class> persistentClasses)
  - AbstractDatastoreInitializer(PropertyResolver configuration, Class[] persistentClasses)
  - AbstractDatastoreInitializer(PropertyResolver configuration, String[] packages)
  - AbstractDatastoreInitializer(Map configuration, Collection<Class> persistentClasses)
  - AbstractDatastoreInitializer(Map configuration, Class[] persistentClasses)
- Method Detail
  - protected Collection<Class> collectMappedClasses(String datastoreType)
  - @CompileStatic
    ApplicationContext configure()
    
    Configures for an existing Mongo instance
    Parameters:
    mongo - The instance of Mongo
    Returns:
    The configured ApplicationContext
  - @CompileStatic
    void configureForBeanDefinitionRegistry(BeanDefinitionRegistry beanDefinitionRegistry)
    
    Configures an existing BeanDefinitionRegistry
    Parameters:
    beanDefinitionRegistry - The BeanDefinitionRegistry to configure
  - @CompileDynamic
    protected boolean containsRegisteredBean(Object builder, BeanDefinitionRegistry registry, String beanName)
  - ApplicationEventPublisher findEventPublisher(BeanDefinitionRegistry beanDefinitionRegistry)
    
    Finds the event publisher to use
    Parameters:
    beanDefinitionRegistry - The event publisher
    Returns:
    The event publisher
  - MessageSource findMessageSource(BeanDefinitionRegistry beanDefinitionRegistry)
    
    Finds the message source to use
    Parameters:
    beanDefinitionRegistry - The registry
    Returns:
    The message source
  - @CompileDynamic
    Closure getAdditionalBeansConfiguration(BeanDefinitionRegistry registry, String type)
    
    Internal method aiding in datastore configuration.
    Parameters:
    registry - The BeanDefinitionRegistry
    type - The type of the datastore
    Returns:
    A closure containing bean definitions
  - abstract Closure getBeanDefinitions(BeanDefinitionRegistry beanDefinitionRegistry)
  - @CompileDynamic
    Closure getCommonConfiguration(BeanDefinitionRegistry registry, String type)
  - @CompileStatic
    protected Class getGrailsApplicationClass()
  - @CompileStatic
    protected Class getGrailsValidatorClass()
  - protected abstract Class<AbstractDatastorePersistenceContextInterceptor> getPersistenceInterceptorClass()
    
    Returns:
    The class used to define the persistence interceptor
  - protected boolean isGrailsPresent()
  - protected boolean isMappedClass(String datastoreType, Class cls)
  - @CompileDynamic
    protected Map<String, Class<?>> loadDataServices(String secondaryDatastore)
  - @CompileStatic
    protected void scanForPersistentClasses()
  - @Override
    void setResourceLoader(ResourceLoader resourceLoader)
  - void setSecondaryDatastore(boolean secondaryDatastore)
    
    Whether this datastore is secondary to another primary datastore (example the SQL DB)
    Parameters:
    secondaryDatastore

Groovy Documentation

[Groovy] Class AbstractDatastoreInitializer

Nested Class Summary

Field Summary

Properties Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Field Detail

public static final String ENTITY_CLASS_RESOURCE_PATTERN

public static final String OSIV_CLASS_NAME

public static final String TRANSACTION_MANAGER_BEAN

protected ClassLoader classLoader

protected boolean secondaryDatastore

Property Detail

PropertyResolver configuration

Object originalConfiguration

Collection<String> packages

Collection<Class> persistentClasses

boolean registerApplicationIfNotPresent

PathMatchingResourcePatternResolver resourcePatternResolver

Constructor Detail

AbstractDatastoreInitializer()

AbstractDatastoreInitializer(ClassLoader classLoader, String[] packages)

AbstractDatastoreInitializer(String[] packages)

AbstractDatastoreInitializer(Collection<Class> persistentClasses)

AbstractDatastoreInitializer(Class[] persistentClasses)

AbstractDatastoreInitializer(PropertyResolver configuration, Collection<Class> persistentClasses)

AbstractDatastoreInitializer(PropertyResolver configuration, Class[] persistentClasses)

AbstractDatastoreInitializer(PropertyResolver configuration, String[] packages)

AbstractDatastoreInitializer(Map configuration, Collection<Class> persistentClasses)

AbstractDatastoreInitializer(Map configuration, Class[] persistentClasses)

Method Detail

protected Collection<Class> collectMappedClasses(String datastoreType)

@CompileStaticApplicationContext configure()

@CompileStaticvoid configureForBeanDefinitionRegistry(BeanDefinitionRegistry beanDefinitionRegistry)

@CompileDynamicprotected boolean containsRegisteredBean(Object builder, BeanDefinitionRegistry registry, String beanName)

ApplicationEventPublisher findEventPublisher(BeanDefinitionRegistry beanDefinitionRegistry)

MessageSource findMessageSource(BeanDefinitionRegistry beanDefinitionRegistry)

@CompileDynamicClosure getAdditionalBeansConfiguration(BeanDefinitionRegistry registry, String type)

abstract Closure getBeanDefinitions(BeanDefinitionRegistry beanDefinitionRegistry)

@CompileDynamicClosure getCommonConfiguration(BeanDefinitionRegistry registry, String type)

@CompileStaticprotected Class getGrailsApplicationClass()

@CompileStaticprotected Class getGrailsValidatorClass()

protected abstract Class<AbstractDatastorePersistenceContextInterceptor> getPersistenceInterceptorClass()

protected boolean isGrailsPresent()

protected boolean isMappedClass(String datastoreType, Class cls)

@CompileDynamicprotected Map<String, Class<?>> loadDataServices(String secondaryDatastore)

@CompileStaticprotected void scanForPersistentClasses()

@Overridevoid setResourceLoader(ResourceLoader resourceLoader)

void setSecondaryDatastore(boolean secondaryDatastore)

@CompileStatic
ApplicationContext configure()

@CompileStatic
void configureForBeanDefinitionRegistry(BeanDefinitionRegistry beanDefinitionRegistry)

@CompileDynamic
protected boolean containsRegisteredBean(Object builder, BeanDefinitionRegistry registry, String beanName)

@CompileDynamic
Closure getAdditionalBeansConfiguration(BeanDefinitionRegistry registry, String type)

@CompileDynamic
Closure getCommonConfiguration(BeanDefinitionRegistry registry, String type)

@CompileStatic
protected Class getGrailsApplicationClass()

@CompileStatic
protected Class getGrailsValidatorClass()

@CompileDynamic
protected Map<String, Class<?>> loadDataServices(String secondaryDatastore)

@CompileStatic
protected void scanForPersistentClasses()

@Override
void setResourceLoader(ResourceLoader resourceLoader)