Package io.micronaut.context

Class DefaultApplicationContext

java.lang.Object

io.micronaut.context.DefaultBeanContext

io.micronaut.context.DefaultApplicationContext

All Implemented Interfaces:

ApplicationContext, BeanContext, BeanDefinitionRegistry, BeanLocator, ConfigurableApplicationContext, ConfigurableBeanContext, PropertyPlaceholderResolver, ApplicationEventPublisher<Object>, ExecutionHandleLocator, InitializableBeanContext, LifeCycle<BeanContext>, AnnotationMetadataResolver, AttributeHolder, MutableAttributeHolder, ConversionServiceProvider, PropertyResolver, ValueResolver<String>, Closeable, AutoCloseable

public class DefaultApplicationContext
extends DefaultBeanContext
implements ConfigurableApplicationContext

Creates a default implementation of the ApplicationContext interface.

Since:

1.0

Author:

Graeme Rocher

Field Summary

Fields inherited from class io.micronaut.context.DefaultBeanContext

configured, initializing, LOG, LOG_LIFECYCLE, MSG_BEAN_DEFINITION, running, singletonScope, terminating

Fields inherited from interface io.micronaut.core.annotation.AnnotationMetadataResolver

DEFAULT

Fields inherited from interface io.micronaut.context.event.ApplicationEventPublisher

NO_OP

Fields inherited from interface io.micronaut.context.ExecutionHandleLocator

EMPTY

Constructor Summary

Constructors

Constructor	Description
DefaultApplicationContext(@NonNull ApplicationContextConfiguration configuration)	Construct a new ApplicationContext for the given environment name and classloader.
DefaultApplicationContext(@NonNull ClassPathResourceLoader resourceLoader, @NonNull String... environmentNames)	Construct a new ApplicationContext for the given environment name and classloader.
DefaultApplicationContext(@NonNull String... environmentNames)	Construct a new ApplicationContext for the given environment name.

Method Summary

Modifier and Type	Method	Description
protected <T> void	collectIterableBeans(@Nullable BeanResolutionContext resolutionContext, @NonNull BeanDefinition<T> iterableBean, @NonNull Set<BeanDefinition<T>> targetSet, @NonNull Argument<T> beanType)	Collects iterable beans from a given iterable.
boolean	containsProperties(String name)	Whether the given property or any nested properties exist for the key given key within this resolver.
boolean	containsProperty(String name)	Whether the given property is contained within this resolver.
protected @NonNull Environment	createEnvironment(@NonNull ApplicationContextConfiguration configuration)	Creates the default environment for the given environment name.
protected <T> void	destroyLifeCycleBean(LifeCycle<?> cycle, BeanDefinition<T> definition)	Destroy a lifecycle bean.
protected <T> BeanDefinition<T>	findConcreteCandidate(Class<T> beanType, Qualifier<T> qualifier, Collection<BeanDefinition<T>> candidates)	Fall back method to attempt to find a candidate for the given definitions.
@NonNull MutableConversionService	getConversionService()	Provides the conversion service.
@NonNull Environment	getEnvironment()
@NonNull Map<String,Object>	getProperties(@Nullable String name, @Nullable StringConvention keyFormat)	Return all the properties under the given key.
<T> Optional<T>	getProperty(String name, ArgumentConversionContext<T> conversionContext)	Resolve the given property for the given name, type and generic type arguments.
@NonNull Collection<String>	getPropertyEntries(@NonNull String name)	Returns a collection of properties entries under the given key.
@NonNull Collection<String>	getPropertyEntries(@NonNull String name, @NonNull PropertyCatalog propertyCatalog)	Returns a collection of properties entries under the given key, but .
Collection<List<String>>	getPropertyPathMatches(String pathPattern)	Will return for a given pattern such as foo.*.bar.* and array of arrays containing the variable names that match the pattern.
protected void	initializeContext(List<io.micronaut.context.DefaultBeanContext.BeanDefinitionProducer> contextScopeBeans, List<io.micronaut.context.DefaultBeanContext.BeanDefinitionProducer> processedBeans, List<io.micronaut.context.DefaultBeanContext.BeanDefinitionProducer> parallelBeans)	Initialize the context with the given Context scope beans.
protected void	initializeTypeConverters(BeanContext beanContext)
protected <T> NoSuchBeanException	newNoSuchBeanException(@Nullable BeanResolutionContext resolutionContext, Argument<T> beanType, @Nullable Qualifier<T> qualifier, @Nullable String message)	Trigger a no such bean exception.
protected void	registerConfiguration(BeanConfiguration configuration)	Registers an active configuration.
protected void	registerConversionService()	Registers conversion service.
<T> @NonNull ApplicationContext	registerSingleton(@NonNull Class<T> type, T singleton, @Nullable Qualifier<T> qualifier, boolean inject)	Registers a new singleton bean at runtime.
Optional<String>	resolvePlaceholders(String str)	Resolve the placeholders and return an Optional String if it was possible to resolve them.
String	resolveRequiredPlaceholders(String str)	Resolve the placeholders and return a string if it was possible to resolve them.
void	setEnvironment(Environment environment)
@NonNull ApplicationContext	start()	The start method will read all bean definition classes found on the classpath and initialize any pre-required state.
protected void	startEnvironment()	Start the environment.
@NonNull ApplicationContext	stop()	The close method will shut down the context calling PreDestroy hooks on loaded singletons.

Methods inherited from class io.micronaut.context.DefaultBeanContext

configure, containsBean, containsBean, createBean, createBean, createBean, createBean, createCustomScopeRegistry, createExecutionHandle, destroyBean, destroyBean, destroyBean, destroyBean, finalizeConfiguration, findBean, findBean, findBean, findBean, findBeanCandidates, findBeanCandidates, findBeanCandidatesForInstance, findBeanConfiguration, findBeanDefinition, findBeanDefinition, findBeanRegistration, findExecutableMethod, findExecutionHandle, findExecutionHandle, findExecutionHandle, findProxyBeanDefinition, findProxyBeanDefinition, findProxyTargetBeanDefinition, findProxyTargetBeanDefinition, findProxyTargetMethod, findProxyTargetMethod, findProxyTargetMethod, getActiveBeanRegistration, getActiveBeanRegistrations, getActiveBeanRegistrations, getAllBeanDefinitions, getAttribute, getAttribute, getAttributes, getBean, getBean, getBean, getBean, getBean, getBean, getBean, getBean, getBeanDefinition, getBeanDefinitionReferences, getBeanDefinitions, getBeanDefinitions, getBeanDefinitions, getBeanDefinitions, getBeanDefinitions, getBeanRegistration, getBeanRegistration, getBeanRegistration, getBeanRegistration, getBeanRegistrations, getBeanRegistrations, getBeanRegistrations, getBeanRegistrations, getBeansOfType, getBeansOfType, getBeansOfType, getBeansOfType, getBeansOfType, getBeansOfType, getBeanValidator, getClassLoader, getContextConfiguration, getDisabledBeans, getProxyTargetBean, getProxyTargetBean, getProxyTargetBean, getProxyTargetBean, initializeEventListeners, inject, inject, invalidateCaches, isRunning, mapOfType, mapOfType, processParallelBeans, publishEvent, publishEventAsync, refreshBean, refreshBean, registerBeanConfiguration, registerBeanDefinition, removeAttribute, resolveBeanConfigurations, resolveBeanDefinitionReferences, resolveBeanDefinitionReferences, resolveDisabledBeanMessage, resolveMetadata, setAttribute, streamOfType, streamOfType, streamOfType, streamOfType

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface io.micronaut.core.annotation.AnnotationMetadataResolver

resolveMetadata, resolveMetadata

Methods inherited from interface io.micronaut.context.ApplicationContext

environment, registerSingleton, registerSingleton, registerSingleton, registerSingleton

Methods inherited from interface io.micronaut.context.event.ApplicationEventPublisher

isEmpty, publishEvent, publishEventAsync

Methods inherited from interface io.micronaut.core.attr.AttributeHolder

getAttribute, getAttribute

Methods inherited from interface io.micronaut.context.BeanContext

createBean, createBean, createBean, createBean, createBean, createBean, destroyBean, destroyBean, destroyBean, destroyBean, destroyBean, getBeanValidator, getClassLoader, getContextConfiguration, getEventPublisher, inject, refreshBean, refreshBean

Methods inherited from interface io.micronaut.context.BeanDefinitionRegistry

containsBean, containsBean, containsBean, containsBean, findBeanConfiguration, findBeanDefinition, findBeanDefinition, findBeanDefinition, findBeanDefinition, findBeanDefinition, findBeanRegistration, findProxyBeanDefinition, findProxyBeanDefinition, findProxyTargetBeanDefinition, findProxyTargetBeanDefinition, findProxyTargetBeanDefinition, getActiveBeanRegistrations, getActiveBeanRegistrations, getAllBeanDefinitions, getBeanDefinition, getBeanDefinition, getBeanDefinition, getBeanDefinition, getBeanDefinitionReferences, getBeanDefinitions, getBeanDefinitions, getBeanDefinitions, getBeanDefinitions, getBeanDefinitions, getBeanRegistration, getBeanRegistration, getBeanRegistration, getBeanRegistrations, getBeanRegistrations, getBeanRegistrations, getDisabledBeans, getProxyTargetBeanDefinition, getProxyTargetBeanDefinition, registerBeanConfiguration, registerBeanDefinition

Methods inherited from interface io.micronaut.context.BeanLocator

findBean, findBean, findBean, findBean, findOrInstantiateBean, getBean, getBean, getBean, getBean, getBean, getBeansOfType, getBeansOfType, getBeansOfType, getBeansOfType, getProvider, getProvider, getProvider, getProvider, getProxyTargetBean, getProxyTargetBean, mapOfType, mapOfType, mapOfType, mapOfType, streamOfType, streamOfType, streamOfType, streamOfType

Methods inherited from interface io.micronaut.context.ConfigurableBeanContext

configure

Methods inherited from interface io.micronaut.context.ExecutionHandleLocator

createExecutionHandle, findExecutableMethod, findExecutionHandle, findExecutionHandle, findExecutionHandle, findProxyTargetMethod, findProxyTargetMethod, findProxyTargetMethod, getExecutableMethod, getExecutionHandle, getExecutionHandle, getProxyTargetMethod, getProxyTargetMethod, getProxyTargetMethod

Methods inherited from interface io.micronaut.context.LifeCycle

close, isRunning, refresh

Methods inherited from interface io.micronaut.core.attr.MutableAttributeHolder

getAttributes, removeAttribute, setAttribute

Methods inherited from interface io.micronaut.context.env.PropertyPlaceholderResolver

getPrefix, resolveOptionalPlaceholder, resolveRequiredPlaceholder, resolveRequiredPlaceholdersObject

Methods inherited from interface io.micronaut.core.value.PropertyResolver

get, getProperties, getProperty, getProperty, getProperty, getProperty, getRequiredProperty

Methods inherited from interface io.micronaut.core.value.ValueResolver

get, get, get

Constructor Details

DefaultApplicationContext

public DefaultApplicationContext(@NonNull
 @NonNull String... environmentNames)

Construct a new ApplicationContext for the given environment name.

Parameters:

environmentNames - The environment names

DefaultApplicationContext

public DefaultApplicationContext(@NonNull
 @NonNull ClassPathResourceLoader resourceLoader,
 @NonNull
 @NonNull String... environmentNames)

Construct a new ApplicationContext for the given environment name and classloader.

Parameters:

environmentNames - The environment names

resourceLoader - The class loader

DefaultApplicationContext

public DefaultApplicationContext(@NonNull
 @NonNull ApplicationContextConfiguration configuration)

Construct a new ApplicationContext for the given environment name and classloader.

Parameters:

configuration - The application context configuration

Method Details

registerSingleton

@NonNull
public <T> @NonNull ApplicationContext registerSingleton(@NonNull
 @NonNull Class<T> type,
 @NonNull
 T singleton,
 @Nullable
 @Nullable Qualifier<T> qualifier,
 boolean inject)

Description copied from interface: BeanDefinitionRegistry

Registers a new singleton bean at runtime. This method expects that the bean definition data will have been compiled ahead of time.

If bean definition data is found the method will perform dependency injection on the instance followed by invoking any PostConstruct hooks.

If no bean definition data is found the bean is registered as is.

Specified by:

registerSingleton in interface ApplicationContext

Specified by:

registerSingleton in interface BeanContext

Specified by:

registerSingleton in interface BeanDefinitionRegistry

Overrides:

registerSingleton in class DefaultBeanContext

Type Parameters:

T - The concrete type

Parameters:

type - The bean type

singleton - The singleton bean

qualifier - The bean qualifier

inject - Whether the singleton should be injected (defaults to true)

Returns:

This bean context

createEnvironment

@NonNull
protected @NonNull Environment createEnvironment(@NonNull
 @NonNull ApplicationContextConfiguration configuration)

Creates the default environment for the given environment name.

Parameters:

configuration - The application context configuration

Returns:

The environment instance

getConversionService

@NonNull
public @NonNull MutableConversionService getConversionService()

Description copied from interface: ConversionServiceProvider

Provides the conversion service.

Specified by:

getConversionService in interface ConversionServiceProvider

Overrides:

getConversionService in class DefaultBeanContext

Returns:

the conversion service

getEnvironment

@NonNull
public @NonNull Environment getEnvironment()

Specified by:

getEnvironment in interface ApplicationContext

Returns:

The application environment

setEnvironment

@Internal
public void setEnvironment(Environment environment)

Parameters:

environment - The environment

start

@NonNull
public @NonNull ApplicationContext start()

Description copied from class: DefaultBeanContext

The start method will read all bean definition classes found on the classpath and initialize any pre-required state.

Specified by:

start in interface ApplicationContext

Specified by:

start in interface LifeCycle<BeanContext>

Overrides:

start in class DefaultBeanContext

Returns:

This lifecycle component

registerConversionService

protected void registerConversionService()

Description copied from class: DefaultBeanContext

Registers conversion service.

Overrides:

registerConversionService in class DefaultBeanContext

stop

@NonNull
public @NonNull ApplicationContext stop()

Description copied from class: DefaultBeanContext

The close method will shut down the context calling PreDestroy hooks on loaded singletons.

Specified by:

stop in interface ApplicationContext

Specified by:

stop in interface LifeCycle<BeanContext>

Overrides:

stop in class DefaultBeanContext

Returns:

This lifecycle component

containsProperty

public boolean containsProperty(String name)

Description copied from interface: PropertyResolver

Whether the given property is contained within this resolver.

Note that this method will return false for nested properties. In other words given a key of foo.bar this method will return false for: resolver.containsProperty("foo")

To check for nested properties using PropertyResolver.containsProperties(String) instead.

Specified by:

containsProperty in interface PropertyResolver

Parameters:

name - The name of the property

Returns:

True if it is

containsProperties

public boolean containsProperties(String name)

Description copied from interface: PropertyResolver

Whether the given property or any nested properties exist for the key given key within this resolver.

Specified by:

containsProperties in interface PropertyResolver

Parameters:

name - The name of the property

Returns:

True if it is

getProperty

public <T> Optional<T> getProperty(String name,
 ArgumentConversionContext<T> conversionContext)

Description copied from interface: PropertyResolver

Resolve the given property for the given name, type and generic type arguments.

Implementers can choose to implement more intelligent type conversion by analyzing the typeArgument.

Specified by:

getProperty in interface PropertyResolver

Type Parameters:

T - The concrete type

Parameters:

name - The name

conversionContext - The conversion context

Returns:

An optional containing the property value if it exists

getPropertyEntries

@NonNull
public @NonNull Collection<String> getPropertyEntries(@NonNull
 @NonNull String name)

Description copied from interface: PropertyResolver

Returns a collection of properties entries under the given key. For example given the following keys:

 datasource.default.url=localhost
 datasource.another.url=someother
 

Calling getPropertyEntries(String) with a value of datasource will result in a collection containing default and other.

Specified by:

getPropertyEntries in interface PropertyResolver

Parameters:

name - The name to resolve

Returns:

The property entries.

getPropertyEntries

@NonNull
public @NonNull Collection<String> getPropertyEntries(@NonNull
 @NonNull String name,
 @NonNull
 @NonNull PropertyCatalog propertyCatalog)

Description copied from interface: PropertyResolver

Returns a collection of properties entries under the given key, but . For example, if you set PropertyCatalog.RAW then the following keys:

 datasource.MyDs-1.url=localhost
 datasource.MyDs-2.url=someother
 

Calling getPropertyEntries(String) with a value of datasource will result in a collection containing MyDs-1 and MyDs-2 (without normalization).

Specified by:

getPropertyEntries in interface PropertyResolver

Parameters:

name - The name to resolve

propertyCatalog - property catalog to use

Returns:

The property entries.

getProperties

@NonNull
public @NonNull Map<String,Object> getProperties(@Nullable
 @Nullable String name,
 @Nullable
 @Nullable StringConvention keyFormat)

Description copied from interface: PropertyResolver

Return all the properties under the given key. By default, Micronaut stores keys in keb-case, such that normalized lookups are more efficient. You can obtain the raw key values by passing in StringConvention.RAW.

Specified by:

getProperties in interface PropertyResolver

Parameters:

name - The name

keyFormat - The key format to use for the keys. Default is kebab-case.

Returns:

The properties

getPropertyPathMatches

public Collection<List<String>> getPropertyPathMatches(String pathPattern)

Description copied from interface: PropertyResolver

Will return for a given pattern such as foo.*.bar.* and array of arrays containing the variable names that match the pattern.

Specified by:

getPropertyPathMatches in interface PropertyResolver

Parameters:

pathPattern - The path pattern

Returns:

An array of arrays.

registerConfiguration

protected void registerConfiguration(BeanConfiguration configuration)

Description copied from class: DefaultBeanContext

Registers an active configuration.

Overrides:

registerConfiguration in class DefaultBeanContext

Parameters:

configuration - The configuration to register

startEnvironment

protected void startEnvironment()

Start the environment.

initializeContext

protected void initializeContext(List<io.micronaut.context.DefaultBeanContext.BeanDefinitionProducer> contextScopeBeans,
 List<io.micronaut.context.DefaultBeanContext.BeanDefinitionProducer> processedBeans,
 List<io.micronaut.context.DefaultBeanContext.BeanDefinitionProducer> parallelBeans)

Description copied from class: DefaultBeanContext

Initialize the context with the given Context scope beans.

Overrides:

initializeContext in class DefaultBeanContext

Parameters:

contextScopeBeans - The context scope beans

processedBeans - The beans that require ExecutableMethodProcessor handling

parallelBeans - The parallel bean definitions

newNoSuchBeanException

protected <T> NoSuchBeanException newNoSuchBeanException(@Nullable
 @Nullable BeanResolutionContext resolutionContext,
 Argument<T> beanType,
 @Nullable
 @Nullable Qualifier<T> qualifier,
 @Nullable
 @Nullable String message)

Description copied from class: DefaultBeanContext

Trigger a no such bean exception. Subclasses can improve the exception with downstream diagnosis as necessary.

Overrides:

newNoSuchBeanException in class DefaultBeanContext

Type Parameters:

T - The type of the bean

Parameters:

resolutionContext - The resolution context

beanType - The bean type

qualifier - The qualifier

message - A message to use

Returns:

A no such bean exception

collectIterableBeans

protected <T> void collectIterableBeans(@Nullable
 @Nullable BeanResolutionContext resolutionContext,
 @NonNull
 @NonNull BeanDefinition<T> iterableBean,
 @NonNull
 @NonNull Set<BeanDefinition<T>> targetSet,
 @NonNull
 @NonNull Argument<T> beanType)

Description copied from class: DefaultBeanContext

Collects iterable beans from a given iterable.

Overrides:

collectIterableBeans in class DefaultBeanContext

Type Parameters:

T - The bean type

Parameters:

resolutionContext - The resolution context

iterableBean - The iterable

targetSet - The target set

beanType - The bean type

findConcreteCandidate

protected <T> BeanDefinition<T> findConcreteCandidate(Class<T> beanType,
 Qualifier<T> qualifier,
 Collection<BeanDefinition<T>> candidates)

Description copied from class: DefaultBeanContext

Fall back method to attempt to find a candidate for the given definitions.

Overrides:

findConcreteCandidate in class DefaultBeanContext

Type Parameters:

T - The generic time

Parameters:

beanType - The bean type

qualifier - The qualifier

candidates - The candidates, always more than 1

Returns:

The concrete bean definition

resolvePlaceholders

public Optional<String> resolvePlaceholders(String str)

Description copied from interface: PropertyPlaceholderResolver

Resolve the placeholders and return an Optional String if it was possible to resolve them.

Specified by:

resolvePlaceholders in interface PropertyPlaceholderResolver

Parameters:

str - The placeholder to resolve

Returns:

The optional string or Optional.empty() if resolution was not possible

resolveRequiredPlaceholders

public String resolveRequiredPlaceholders(String str)
                                   throws ConfigurationException

Description copied from interface: PropertyPlaceholderResolver

Resolve the placeholders and return a string if it was possible to resolve them.

Specified by:

resolveRequiredPlaceholders in interface PropertyPlaceholderResolver

Parameters:

str - The placeholder to resolve

Returns:

The resolved string

Throws:

ConfigurationException - If the placeholders could not be resolved

destroyLifeCycleBean

protected <T> void destroyLifeCycleBean(LifeCycle<?> cycle,
 BeanDefinition<T> definition)

Description copied from class: DefaultBeanContext

Destroy a lifecycle bean.

Overrides:

destroyLifeCycleBean in class DefaultBeanContext

Type Parameters:

T - The bean type

Parameters:

cycle - The cycle

definition - The definition

initializeTypeConverters

protected void initializeTypeConverters(BeanContext beanContext)

Parameters:

beanContext - The bean context