Package io.micronaut.context

Interface ApplicationContext

All Superinterfaces:

io.micronaut.core.annotation.AnnotationMetadataResolver, ApplicationEventPublisher<Object>, io.micronaut.core.attr.AttributeHolder, AutoCloseable, BeanContext, BeanDefinitionRegistry, BeanLocator, Closeable, io.micronaut.core.convert.ConversionServiceProvider, ExecutionHandleLocator, LifeCycle<BeanContext>, io.micronaut.core.attr.MutableAttributeHolder, PropertyPlaceholderResolver, io.micronaut.core.value.PropertyResolver, io.micronaut.core.value.ValueResolver<String>

All Known Subinterfaces:

ConfigurableApplicationContext

All Known Implementing Classes:

DefaultApplicationContext

public interface ApplicationContext
extends BeanContext, io.micronaut.core.value.PropertyResolver, PropertyPlaceholderResolver

An application context extends a BeanContext and adds the concepts of configuration, environments and runtimes.

The ApplicationContext is the main entry point for starting and running Micronaut applications. It can be thought of as a container object for all dependency injected objects.

The ApplicationContext can be started via the run() method. For example:

     ApplicationContext context = ApplicationContext.run();
 

Alternatively, the builder() method can be used to customize the ApplicationContext using the ApplicationContextBuilder interface prior to running. For example:

     ApplicationContext context = ApplicationContext.builder().environments("test").start();
 

The getEnvironment() method can be used to obtain a reference to the application Environment, which contains the loaded configuration and active environment names.

Since:

1.0

See Also:

• ApplicationContextBuilder
• Environment

Field Summary

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

Method Summary

Modifier and Type	Method	Description
static @NonNull ApplicationContextBuilder	builder()	Build a ApplicationContext.
static @NonNull ApplicationContextBuilder	builder(@NonNull Class<?> mainClass, @NonNull String... environments)	Build a ApplicationContext.
static @NonNull ApplicationContextBuilder	builder(@NonNull ClassLoader classLoader, @NonNull String... environments)	Build a ApplicationContext.
static @NonNull ApplicationContextBuilder	builder(@NonNull String... environments)	Build a ApplicationContext.
static @NonNull ApplicationContextBuilder	builder(@NonNull Map<String,Object> properties, @NonNull String... environments)	Build a ApplicationContext.
static @NonNull ApplicationContextBuilder	builder(ClassLoader classLoader)
default @NonNull ApplicationContext	environment(@NonNull Consumer<Environment> consumer)	Allow configuration the Environment.
@NonNull Environment	getEnvironment()
default <T> @NonNull ApplicationContext	registerSingleton(@NonNull Class<T> type, T singleton)	Registers a new singleton bean at runtime.
default <T> @NonNull ApplicationContext	registerSingleton(@NonNull Class<T> type, T singleton, @Nullable Qualifier<T> qualifier)	Registers a new singleton bean at runtime.
<T> @NonNull ApplicationContext	registerSingleton(@NonNull Class<T> type, T singleton, @Nullable Qualifier<T> qualifier, boolean inject)	Registers a new singleton bean at runtime.
default @NonNull ApplicationContext	registerSingleton(@NonNull Object singleton)	Registers a new singleton bean at runtime.
default @NonNull ApplicationContext	registerSingleton(@NonNull Object singleton, boolean inject)	Registers a new singleton bean at runtime.
static @NonNull ApplicationContext	run()	Run the ApplicationContext.
static @NonNull ApplicationContext	run(@NonNull PropertySource properties, @NonNull String... environments)	Run the ApplicationContext with the given type.
static <T extends AutoCloseable> T	run(@NonNull Class<T> type, @NonNull PropertySource propertySource, @NonNull String... environments)	Run the ApplicationContext with the given type.
static <T extends AutoCloseable> T	run(@NonNull Class<T> type, @NonNull String... environments)	Run the ApplicationContext with the given type.
static <T extends AutoCloseable> T	run(@NonNull Class<T> type, @NonNull Map<String,Object> properties, @NonNull String... environments)	Run the ApplicationContext with the given type.
static @NonNull ApplicationContext	run(@NonNull ClassLoader classLoader, @NonNull String... environments)	Run the BeanContext.
static @NonNull ApplicationContext	run(@NonNull String... environments)	Run the ApplicationContext.
static @NonNull ApplicationContext	run(@NonNull Map<String,Object> properties, @NonNull String... environments)	Run the ApplicationContext with the given type.
@NonNull ApplicationContext	start()	Starts the application context.
@NonNull ApplicationContext	stop()	Stops the application context.

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

resolveMetadata, resolveMetadata

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, 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.core.convert.ConversionServiceProvider

getConversionService

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, resolvePlaceholders, resolveRequiredPlaceholder, resolveRequiredPlaceholders, resolveRequiredPlaceholdersObject

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

containsProperties, containsProperty, get, getProperties, getProperties, getProperty, getProperty, getProperty, getProperty, getProperty, getPropertyEntries, getPropertyEntries, getPropertyPathMatches, getRequiredProperty

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

get, get, get

Method Details

getEnvironment

@NonNull
@NonNull Environment getEnvironment()

Returns:

The application environment

start

@NonNull
@NonNull ApplicationContext start()

Starts the application context.

Specified by:

start in interface LifeCycle<BeanContext>

Returns:

The application context

stop

@NonNull
@NonNull ApplicationContext stop()

Stops the application context.

Specified by:

stop in interface LifeCycle<BeanContext>

Returns:

The application context

registerSingleton

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

Specified by:

registerSingleton in interface BeanDefinitionRegistry

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

registerSingleton

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

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 BeanContext

Specified by:

registerSingleton in interface BeanDefinitionRegistry

Type Parameters:

T - The concrete type

Parameters:

type - The bean type

singleton - The singleton bean

qualifier - The bean qualifier

Returns:

This bean context

registerSingleton

@NonNull
default <T> @NonNull ApplicationContext registerSingleton(@NonNull
 @NonNull Class<T> type,
 @NonNull
 T singleton)

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 BeanContext

Specified by:

registerSingleton in interface BeanDefinitionRegistry

Type Parameters:

T - The concrete type

Parameters:

type - the bean type

singleton - The singleton bean

Returns:

This bean context

registerSingleton

@NonNull
default @NonNull ApplicationContext registerSingleton(@NonNull
 @NonNull Object singleton,
 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 BeanContext

Specified by:

registerSingleton in interface BeanDefinitionRegistry

Parameters:

singleton - The singleton bean

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

Returns:

This bean context

environment

@NonNull
default @NonNull ApplicationContext environment(@NonNull
 @NonNull Consumer<Environment> consumer)

Allow configuration the Environment.

Parameters:

consumer - The consumer

Returns:

This context

registerSingleton

@NonNull
default @NonNull ApplicationContext registerSingleton(@NonNull
 @NonNull Object singleton)

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 BeanContext

Specified by:

registerSingleton in interface BeanDefinitionRegistry

Parameters:

singleton - The singleton bean

Returns:

This bean context

run

@NonNull
static @NonNull ApplicationContext run(@NonNull
 @NonNull String... environments)

Run the ApplicationContext. This method will instantiate a new ApplicationContext and call start().

Parameters:

environments - The environments to use

Returns:

The running ApplicationContext

run

@NonNull
static @NonNull ApplicationContext run()

Run the ApplicationContext. This method will instantiate a new ApplicationContext and call start().

Returns:

The running ApplicationContext

run

@NonNull
static @NonNull ApplicationContext run(@NonNull
 @NonNull Map<String,Object> properties,
 @NonNull
 @NonNull String... environments)

Run the ApplicationContext with the given type. Returning an instance of the type. Note this method should not be used. If the ApplicationContext requires graceful shutdown unless the returned bean takes responsibility for shutting down the context.

Parameters:

properties - Additional properties

environments - The environment names

Returns:

The running ApplicationContext

run

@NonNull
static @NonNull ApplicationContext run(@NonNull
 @NonNull PropertySource properties,
 @NonNull
 @NonNull String... environments)

Run the ApplicationContext with the given type. Returning an instance of the type. Note this method should not be used. If the ApplicationContext requires graceful shutdown unless the returned bean takes responsibility for shutting down the context.

Parameters:

properties - Additional properties

environments - The environment names

Returns:

The running ApplicationContext

run

@NonNull
static <T extends AutoCloseable> T run(@NonNull
 @NonNull Class<T> type,
 @NonNull
 @NonNull String... environments)

Run the ApplicationContext with the given type. Returning an instance of the type. Note this method should not be used. If the ApplicationContext requires graceful shutdown unless the returned bean takes responsibility for shutting down the context.

Type Parameters:

T - The type

Parameters:

type - The type of the bean to run

environments - The environments to use

Returns:

The running bean

run

@NonNull
static <T extends AutoCloseable> T run(@NonNull
 @NonNull Class<T> type,
 @NonNull
 @NonNull Map<String,Object> properties,
 @NonNull
 @NonNull String... environments)

Run the ApplicationContext with the given type. Returning an instance of the type. Note this method should not be used. If the ApplicationContext requires graceful shutdown unless the returned bean takes responsibility for shutting down the context.

Type Parameters:

T - The type

Parameters:

type - The type of the bean to run

properties - Additional properties

environments - The environment names

Returns:

The running bean

run

@NonNull
static <T extends AutoCloseable> T run(@NonNull
 @NonNull Class<T> type,
 @NonNull
 @NonNull PropertySource propertySource,
 @NonNull
 @NonNull String... environments)

Run the ApplicationContext with the given type. Returning an instance of the type. Note this method should not be used. If the ApplicationContext requires graceful shutdown unless the returned bean takes responsibility for shutting down the context.

Type Parameters:

T - The type

Parameters:

type - The environment to use

propertySource - Additional properties

environments - The environment names

Returns:

The running BeanContext

builder

@NonNull
static @NonNull ApplicationContextBuilder builder(@NonNull
 @NonNull String... environments)

Build a ApplicationContext.

Parameters:

environments - The environments to use

Returns:

The application context builder

builder

@NonNull
static @NonNull ApplicationContextBuilder builder(@NonNull
 @NonNull Map<String,Object> properties,
 @NonNull
 @NonNull String... environments)

Build a ApplicationContext.

Parameters:

properties - The properties

environments - The environments to use

Returns:

The application context builder

builder

@NonNull
static @NonNull ApplicationContextBuilder builder()

Build a ApplicationContext.

Returns:

The application context builder

builder

@NonNull
static @NonNull ApplicationContextBuilder builder(ClassLoader classLoader)

Parameters:

classLoader - The class loader to use

Returns:

The application context builder

run

@NonNull
static @NonNull ApplicationContext run(@NonNull
 @NonNull ClassLoader classLoader,
 @NonNull
 @NonNull String... environments)

Run the BeanContext. This method will instantiate a new BeanContext and call start()

Parameters:

classLoader - The classloader to use

environments - The environments to use

Returns:

The running ApplicationContext

builder

@NonNull
static @NonNull ApplicationContextBuilder builder(@NonNull
 @NonNull ClassLoader classLoader,
 @NonNull
 @NonNull String... environments)

Build a ApplicationContext.

Parameters:

classLoader - The classloader to use

environments - The environment to use

Returns:

The application context builder

builder

@NonNull
static @NonNull ApplicationContextBuilder builder(@NonNull
 @NonNull Class<?> mainClass,
 @NonNull
 @NonNull String... environments)

Build a ApplicationContext.

Parameters:

mainClass - The main class of the application

environments - The environment to use

Returns:

The application context builder