Package org.springframework.data.aot

Interface AotContext

All Superinterfaces:

EnvironmentCapable

All Known Subinterfaces:

AotRepositoryContext

All Known Implementing Classes:

AotRepositoryContextSupport

public interface AotContext
extends EnvironmentCapable

The context in which the AOT processing happens. Grants access to the beanFactory and ClassLoader.

Mainly for internal use within the framework.

Since:

3.0

Author:

Christoph Strobl, John Blum, Mark Paluch

See Also:

• BeanFactory

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	AotContext.IntrospectedBeanDefinition	Deprecated, for removal: This API element is subject to removal in a future version. since 4.0 as this isn't widely used and can be easily implemented within user code.
static interface	AotContext.TypeIntrospector	Deprecated, for removal: This API element is subject to removal in a future version. since 4.0 as this isn't widely used and can be easily implemented within user code.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	GENERATED_REPOSITORIES_ENABLED
static final String	GENERATED_REPOSITORIES_JSON_ENABLED

Method Summary

Modifier and Type	Method	Description
void	contributeTypeConfigurations(GenerationContext generationContext)	Contribute type configurations to the given GenerationContext.
static AotContext	from(BeanFactory beanFactory)	Create an AotContext backed by the given BeanFactory.
static AotContext	from(BeanFactory beanFactory, Environment environment)	Create an AotContext backed by the given BeanFactory.
ConfigurableListableBeanFactory	getBeanFactory()	Returns a reference to the ConfigurableListableBeanFactory backing this AotContext.
default @Nullable ClassLoader	getClassLoader()	Returns the ClassLoader used by this AotContext to resolve types.
default ClassLoader	getRequiredClassLoader()	Returns the required ClassLoader used by this AotContext to resolve types.
default TypeScanner	getTypeScanner()	Returns a new TypeScanner used to scan for types that will be contributed to the AOT processing infrastructure.
default AotContext.IntrospectedBeanDefinition	introspectBeanDefinition(String beanName)	Deprecated, for removal: This API element is subject to removal in a future version. since 4.0, use getBeanFactory() and interact with the bean factory directly.
default AotContext.IntrospectedBeanDefinition	introspectBeanDefinition(BeanReference reference)	Deprecated, for removal: This API element is subject to removal in a future version. since 4.0, use getBeanFactory() and interact with the bean factory directly.
default AotContext.TypeIntrospector	introspectType(String typeName)	Deprecated, for removal: This API element is subject to removal in a future version. since 4.0 as this isn't widely used and can be easily implemented within user code.
default boolean	isGeneratedRepositoriesEnabled(@Nullable String moduleName)	Checks if repository code generation is enabled for a given module by checking environment variables for general enablement (GENERATED_REPOSITORIES_ENABLED) and store-specific ones following the pattern spring.aot.<module-name>.repositories.enabled.
default boolean	isGeneratedRepositoriesMetadataEnabled()	Checks if repository metadata file writing is enabled by checking environment variables for general enablement (GENERATED_REPOSITORIES_JSON_ENABLED)
default Set<Class<?>>	scanPackageForTypes(Collection<Class<? extends Annotation>> identifyingAnnotations, Collection<String> packageNames)	Deprecated, for removal: This API element is subject to removal in a future version. since 4.0, use getTypeScanner() directly
void	typeConfiguration(Class<?> type, Consumer<AotTypeConfiguration> configurationConsumer)	Obtain a AotTypeConfiguration for the given ResolvableType to customize the AOT processing for the given type.
default void	typeConfiguration(ResolvableType resolvableType, Consumer<AotTypeConfiguration> configurationConsumer)	Obtain a AotTypeConfiguration for the given ResolvableType to customize the AOT processing for the given type.

Methods inherited from interface org.springframework.core.env.EnvironmentCapable

getEnvironment

Field Details

GENERATED_REPOSITORIES_ENABLED

static final String GENERATED_REPOSITORIES_ENABLED

See Also:

• Constant Field Values

GENERATED_REPOSITORIES_JSON_ENABLED

static final String GENERATED_REPOSITORIES_JSON_ENABLED

See Also:

• Constant Field Values

Method Details

from

static AotContext from(BeanFactory beanFactory)

Create an AotContext backed by the given BeanFactory.

Parameters:

beanFactory - reference to the BeanFactory; must not be null.

Returns:

a new instance of AotContext.

See Also:

• BeanFactory

from

static AotContext from(BeanFactory beanFactory,
 Environment environment)

Create an AotContext backed by the given BeanFactory.

Parameters:

beanFactory - reference to the BeanFactory; must not be null.

environment - reference to the Environment; must not be null.

Returns:

a new instance of AotContext.

See Also:

• BeanFactory

isGeneratedRepositoriesEnabled

default boolean isGeneratedRepositoriesEnabled(@Nullable String moduleName)

Checks if repository code generation is enabled for a given module by checking environment variables for general enablement (GENERATED_REPOSITORIES_ENABLED) and store-specific ones following the pattern spring.aot.<module-name>.repositories.enabled.

GENERATED_REPOSITORIES_ENABLED acts as a main switch, if disabled, store specific flags have no effect.

Unset properties are considered being true.

Parameters:

moduleName - name of the module. Can be null or empty, in which case it will only check the general GENERATED_REPOSITORIES_ENABLED flag.

Returns:

indicator if repository code generation is enabled.

Since:

4.0

isGeneratedRepositoriesMetadataEnabled

default boolean isGeneratedRepositoriesMetadataEnabled()

Checks if repository metadata file writing is enabled by checking environment variables for general enablement (GENERATED_REPOSITORIES_JSON_ENABLED)

Unset properties are considered being true.

Returns:

indicator if repository metadata should be written

Since:

4.0

getBeanFactory

ConfigurableListableBeanFactory getBeanFactory()

Returns a reference to the ConfigurableListableBeanFactory backing this AotContext.

Returns:

a reference to the ConfigurableListableBeanFactory backing this AotContext.

See Also:

• ConfigurableListableBeanFactory

getClassLoader

default @Nullable ClassLoader getClassLoader()

Returns the ClassLoader used by this AotContext to resolve types. By default, this is the same ClassLoader used by the BeanFactory to resolve types declared in bean definitions.

Returns:

the ClassLoader used by this AotContext to resolve types.

See Also:

• ConfigurableBeanFactory.getBeanClassLoader()

getRequiredClassLoader

default ClassLoader getRequiredClassLoader()

Returns the required ClassLoader used by this AotContext to resolve types. By default, this is the same ClassLoader used by the BeanFactory to resolve types declared in bean definitions.

Returns:

the ClassLoader used by this AotContext to resolve types.

Throws:

IllegalStateException - if no ClassLoader is available.

introspectType

@Deprecated(since="4.0",
            forRemoval=true)
default AotContext.TypeIntrospector introspectType(String typeName)

Deprecated, for removal: This API element is subject to removal in a future version.

since 4.0 as this isn't widely used and can be easily implemented within user code.

Returns a AotContext.TypeIntrospector to obtain further detail about a type given its fully-qualified type name

Parameters:

typeName - name of the type to evaluate; must not be null.

Returns:

the type introspector for further type-based introspection.

getTypeScanner

default TypeScanner getTypeScanner()

Returns a new TypeScanner used to scan for types that will be contributed to the AOT processing infrastructure.

Returns:

a TypeScanner used to scan for types that will be contributed to the AOT processing infrastructure.

See Also:

• TypeScanner

scanPackageForTypes

@Deprecated(since="4.0",
            forRemoval=true)
default Set<Class<?>> scanPackageForTypes(Collection<Class<? extends Annotation>> identifyingAnnotations,
 Collection<String> packageNames)

Deprecated, for removal: This API element is subject to removal in a future version.

since 4.0, use getTypeScanner() directly

Scans for types in the given named packages annotated with the store-specific identifying annotations.

Parameters:

identifyingAnnotations - Collection of Annotations identifying store-specific model types; must not be null.

packageNames - Collection of package names to scan.

Returns:

a Set of types found during the scan.

See Also:

• getTypeScanner()

introspectBeanDefinition

@Deprecated(since="4.0",
            forRemoval=true)
default AotContext.IntrospectedBeanDefinition introspectBeanDefinition(BeanReference reference)

Deprecated, for removal: This API element is subject to removal in a future version.

since 4.0, use getBeanFactory() and interact with the bean factory directly.

Returns a AotContext.IntrospectedBeanDefinition to obtain further detail about the underlying bean definition. An introspected bean definition can also point to an absent bean definition.

Parameters:

reference - BeanReference to the managed bean.

Returns:

the introspected bean definition.

introspectBeanDefinition

@Deprecated(since="4.0",
            forRemoval=true)
default AotContext.IntrospectedBeanDefinition introspectBeanDefinition(String beanName)

Deprecated, for removal: This API element is subject to removal in a future version.

since 4.0, use getBeanFactory() and interact with the bean factory directly.

Returns a AotContext.IntrospectedBeanDefinition to obtain further detail about the underlying bean definition. An introspected bean definition can also point to an absent bean definition.

Parameters:

beanName - String containing the name of the bean to evaluate; must not be null.

Returns:

the introspected bean definition.

typeConfiguration

default void typeConfiguration(ResolvableType resolvableType,
 Consumer<AotTypeConfiguration> configurationConsumer)

Obtain a AotTypeConfiguration for the given ResolvableType to customize the AOT processing for the given type. Repeated calls to the same type will result in merging the configuration.

Parameters:

resolvableType - the resolvable type to configure.

configurationConsumer - configuration consumer function.

Since:

4.0

typeConfiguration

void typeConfiguration(Class<?> type,
 Consumer<AotTypeConfiguration> configurationConsumer)

Obtain a AotTypeConfiguration for the given ResolvableType to customize the AOT processing for the given type. Repeated calls to the same type will result in merging the configuration.

Parameters:

type - the type to configure.

configurationConsumer - configuration consumer function.

Since:

4.0

contributeTypeConfigurations

void contributeTypeConfigurations(GenerationContext generationContext)

Contribute type configurations to the given GenerationContext. This method is called once per GenerationContext after all type configurations have been registered.

Parameters:

generationContext - the context to contribute the type configurations to.