io.micronaut.context

Class DefaultApplicationContext

java.lang.Object

io.micronaut.context.DefaultBeanContext

io.micronaut.context.DefaultApplicationContext

All Implemented Interfaces:

ApplicationContext, BeanContext, BeanDefinitionRegistry, BeanLocator, PropertyPlaceholderResolver, ApplicationEventPublisher, ExecutionHandleLocator, LifeCycle<BeanContext>, AnnotationMetadataResolver, AttributeHolder, MutableAttributeHolder, PropertyResolver, ValueResolver<java.lang.String>, java.io.Closeable, java.lang.AutoCloseable

public class DefaultApplicationContext
extends DefaultBeanContext
implements ApplicationContext

Creates a default implementation of the ApplicationContext interface.

Since:

1.0

Author:

Graeme Rocher

Field Summary

Fields inherited from class io.micronaut.context.DefaultBeanContext

initializing, LOG, LOG_LIFECYCLE, running, terminating

Fields inherited from interface io.micronaut.context.ExecutionHandleLocator

EMPTY

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

DEFAULT

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
boolean	containsProperties(java.lang.String name) Whether the given property or any nested properties exist for the key given key within this resolver.
boolean	containsProperty(java.lang.String name) Whether the given property is contained within this resolver.
protected ConversionService	createConversionService() Creates the default conversion service.
protected Environment	createEnvironment(ApplicationContextConfiguration configuration) Creates the default environment for the given environment name.
protected <T> java.util.Collection<BeanDefinition<T>>	findBeanCandidates(BeanResolutionContext resolutionContext, java.lang.Class<T> beanType, BeanDefinition<?> filter, boolean filterProxied) Find bean candidates for the given type.
protected <T> BeanDefinition<T>	findConcreteCandidate(java.lang.Class<T> beanType, Qualifier<T> qualifier, java.util.Collection<BeanDefinition<T>> candidates) Fall back method to attempt to find a candidate for the given definitions.
ConversionService<?>	getConversionService()
Environment	getEnvironment()
java.util.Map<java.lang.String,java.lang.Object>	getProperties(java.lang.String name, StringConvention keyFormat) Return all the properties under the given key.
<T> java.util.Optional<T>	getProperty(java.lang.String name, ArgumentConversionContext<T> conversionContext) Resolve the given property for the given name, type and generic type arguments.
java.util.Collection<java.lang.String>	getPropertyEntries(java.lang.String name) Returns a collection of properties entries under the given key.
protected void	initializeContext(java.util.List<BeanDefinitionReference> contextScopeBeans, java.util.List<BeanDefinitionReference> processedBeans, java.util.List<BeanDefinitionReference> parallelBeans) Initialize the context with the given Context scope beans.
protected void	initializeTypeConverters(BeanContext beanContext)
protected void	registerConfiguration(BeanConfiguration configuration) Registers an active configuration.
<T> ApplicationContext	registerSingleton(java.lang.Class<T> type, T singleton, Qualifier<T> qualifier, boolean inject) Registers a new singleton bean at runtime.
protected java.lang.Iterable<BeanConfiguration>	resolveBeanConfigurations() Resolves the BeanConfiguration class instances.
protected java.util.List<BeanDefinitionReference>	resolveBeanDefinitionReferences() Resolves the BeanDefinitionReference class instances.
java.util.Optional<java.lang.String>	resolvePlaceholders(java.lang.String str) Resolve the placeholders and return an Optional String if it was possible to resolve them.
java.lang.String	resolveRequiredPlaceholders(java.lang.String str) Resolve the placeholders and return an Optional String if it was possible to resolve them.
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.
ApplicationContext	stop() The close method will shut down the context calling PreDestroy hooks on loaded singletons.
protected <T> java.util.Collection<BeanDefinition<T>>	transformIterables(BeanResolutionContext resolutionContext, java.util.Collection<BeanDefinition<T>> candidates, boolean filterProxied) Method that transforms iterable candidates if possible.

Methods inherited from class io.micronaut.context.DefaultBeanContext

containsBean, createBean, createBean, createBean, createBean, createExecutionHandle, destroyBean, doCreateBean, doCreateBean, findBean, findBean, findBeanCandidates, findBeanCandidatesForInstance, findBeanConfiguration, findBeanDefinition, findBeanRegistration, findExecutableMethod, findExecutionHandle, findExecutionHandle, findExecutionHandle, findProxyBeanDefinition, findProxyTargetBeanDefinition, findProxyTargetMethod, findProxyTargetMethod, getActiveBeanRegistration, getActiveBeanRegistrations, getActiveBeanRegistrations, getAllBeanDefinitions, getAttribute, getAttribute, getAttributes, getBean, getBean, getBean, getBean, getBean, getBeanDefinitionReferences, getBeanDefinitions, getBeanDefinitions, getBeanDefinitions, getBeanProvider, getBeanProvider, getBeanRegistrations, getBeansOfType, getBeansOfType, getBeansOfType, getBeansOfType, getBeanValidator, getClassLoader, getProxyTargetBean, initializeEventListeners, inject, inject, invalidateCaches, isRunning, processParallelBeans, publishEvent, publishEventAsync, refreshBean, removeAttribute, resolveMetadata, setAttribute, 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.context.ApplicationContext

build, build, build, build, build, builder, builder, builder, builder, builder, environment, registerSingleton, registerSingleton, registerSingleton, registerSingleton, run, run, run, run, run, run, run, run

Methods inherited from interface io.micronaut.context.BeanContext

build, createBean, createBean, createBean, createBean, createBean, createBean, destroyBean, getBeanValidator, getClassLoader, inject, refreshBean, run

Methods inherited from interface io.micronaut.context.LifeCycle

close, isRunning, refresh

Methods inherited from interface io.micronaut.context.ExecutionHandleLocator

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

Methods inherited from interface io.micronaut.context.BeanLocator

findBean, findBean, findOrInstantiateBean, getBean, getBean, getBean, getBeansOfType, getBeansOfType, getProxyTargetBean, streamOfType, streamOfType

Methods inherited from interface io.micronaut.context.BeanDefinitionRegistry

containsBean, containsBean, findBeanConfiguration, findBeanDefinition, findBeanDefinition, findBeanRegistration, findProxyBeanDefinition, findProxyTargetBeanDefinition, getActiveBeanRegistrations, getActiveBeanRegistrations, getAllBeanDefinitions, getBeanDefinition, getBeanDefinition, getBeanDefinitionReferences, getBeanDefinitions, getBeanDefinitions, getBeanDefinitions, getBeanRegistrations, getProxyTargetBeanDefinition

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

publishEvent, publishEventAsync

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

resolveMetadata, resolveMetadata

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

getAttributes, removeAttribute, setAttribute

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

getAttribute, getAttribute

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

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

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

get, get, get

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

getPrefix, resolveRequiredPlaceholder

Constructor Detail

DefaultApplicationContext

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

Construct a new ApplicationContext for the given environment name.

Parameters:

environmentNames - The environment names

DefaultApplicationContext

public DefaultApplicationContext(@NonNull
                                 ClassPathResourceLoader resourceLoader,
                                 @NonNull
                                 java.lang.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
                                 ApplicationContextConfiguration configuration)

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

Parameters:

configuration - The application context configuration

Method Detail

registerSingleton

@NonNull
public <T> ApplicationContext registerSingleton(@NonNull
                                                         java.lang.Class<T> type,
                                                         @NonNull
                                                         T singleton,
                                                         @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

resolveBeanConfigurations

@NonNull
protected java.lang.Iterable<BeanConfiguration> resolveBeanConfigurations()

Description copied from class: DefaultBeanContext

Resolves the BeanConfiguration class instances. Default implementation uses ServiceLoader pattern.

Overrides:

resolveBeanConfigurations in class DefaultBeanContext

Returns:

The bean definition classes

resolveBeanDefinitionReferences

@NonNull
protected java.util.List<BeanDefinitionReference> resolveBeanDefinitionReferences()

Description copied from class: DefaultBeanContext

Resolves the BeanDefinitionReference class instances. Default implementation uses ServiceLoader pattern.

Overrides:

resolveBeanDefinitionReferences in class DefaultBeanContext

Returns:

The bean definition classes

createEnvironment

@NonNull
protected Environment createEnvironment(@NonNull
                                                 ApplicationContextConfiguration configuration)

Creates the default environment for the given environment name.

Parameters:

configuration - The application context configuration

Returns:

The environment instance

createConversionService

@NonNull
protected ConversionService createConversionService()

Creates the default conversion service.

Returns:

The conversion service

getConversionService

@NonNull
public ConversionService<?> getConversionService()

Specified by:

getConversionService in interface ApplicationContext

Returns:

The default conversion service

getEnvironment

@NonNull
public Environment getEnvironment()

Specified by:

getEnvironment in interface ApplicationContext

Returns:

The application environment

start

@NonNull
public 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

stop

@NonNull
public 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(java.lang.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(java.lang.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> java.util.Optional<T> getProperty(java.lang.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 java.util.Collection<java.lang.String> getPropertyEntries(@NonNull
                                                                          java.lang.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.

getProperties

@NonNull
public java.util.Map<java.lang.String,java.lang.Object> getProperties(@Nullable
                                                                               java.lang.String name,
                                                                               @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

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(java.util.List<BeanDefinitionReference> contextScopeBeans,
                                 java.util.List<BeanDefinitionReference> processedBeans,
                                 java.util.List<BeanDefinitionReference> 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

findBeanCandidates

protected <T> java.util.Collection<BeanDefinition<T>> findBeanCandidates(BeanResolutionContext resolutionContext,
                                                                         java.lang.Class<T> beanType,
                                                                         BeanDefinition<?> filter,
                                                                         boolean filterProxied)

Description copied from class: DefaultBeanContext

Find bean candidates for the given type.

Overrides:

findBeanCandidates in class DefaultBeanContext

Type Parameters:

T - The bean generic type

Parameters:

resolutionContext - The current resolution context

beanType - The bean type

filter - A bean definition to filter out

filterProxied - Whether to filter out bean proxy targets

Returns:

The candidates

transformIterables

protected <T> java.util.Collection<BeanDefinition<T>> transformIterables(BeanResolutionContext resolutionContext,
                                                                         java.util.Collection<BeanDefinition<T>> candidates,
                                                                         boolean filterProxied)

Description copied from class: DefaultBeanContext

Method that transforms iterable candidates if possible.

Overrides:

transformIterables in class DefaultBeanContext

Type Parameters:

T - The bean type

Parameters:

resolutionContext - The resolution context

candidates - The candidates.

filterProxied - Whether to filter proxied.

Returns:

The candidates

findConcreteCandidate

protected <T> BeanDefinition<T> findConcreteCandidate(java.lang.Class<T> beanType,
                                                      Qualifier<T> qualifier,
                                                      java.util.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

Returns:

The concrete bean definition

resolvePlaceholders

public java.util.Optional<java.lang.String> resolvePlaceholders(java.lang.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 java.lang.String resolveRequiredPlaceholders(java.lang.String str)
                                             throws ConfigurationException

Description copied from interface: PropertyPlaceholderResolver

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

Specified by:

resolveRequiredPlaceholders in interface PropertyPlaceholderResolver

Parameters:

str - The placeholder to resolve

Returns:

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

Throws:

ConfigurationException - If the placeholders could not be resolved

initializeTypeConverters

protected void initializeTypeConverters(BeanContext beanContext)

Parameters:

beanContext - The bean context