io.micronaut.context

Interface ApplicationContext

All Superinterfaces:

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

All Known Implementing Classes:

DefaultApplicationContext

public interface ApplicationContext
extends BeanContext, 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

Author:

Graeme Rocher

See Also:

ApplicationContextBuilder, Environment

Field Summary

Fields inherited from interface io.micronaut.context.ExecutionHandleLocator

EMPTY

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

DEFAULT

Method Summary

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

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

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

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

get, get, get

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

getPrefix, resolvePlaceholders, resolveRequiredPlaceholder, resolveRequiredPlaceholders

Method Detail

getConversionService

@NonNull
ConversionService<?> getConversionService()

Returns:

The default conversion service

getEnvironment

@NonNull
Environment getEnvironment()

Returns:

The application environment

start

@NonNull
ApplicationContext start()

Starts the application context.

Specified by:

start in interface LifeCycle<BeanContext>

Returns:

The application context

stop

@NonNull
ApplicationContext stop()

Stops the application context.

Specified by:

stop in interface LifeCycle<BeanContext>

Returns:

The application context

registerSingleton

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

@NotNull
 @NonNull
default @NotNull ApplicationContext registerSingleton(@NotNull
                                                                         @NotNull java.lang.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 ApplicationContext environment(@NonNull
                                                java.util.function.Consumer<Environment> consumer)

Allow configuration the Environment.

Parameters:

consumer - The consumer

Returns:

This context

registerSingleton

@NonNull
default ApplicationContext registerSingleton(@NonNull
                                                      java.lang.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 ApplicationContext run(@NonNull
                                       java.lang.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 ApplicationContext run()

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

Specified by:

run in interface BeanContext

Returns:

The running ApplicationContext

run

@NonNull
static ApplicationContext run(@NonNull
                                       java.util.Map<java.lang.String,java.lang.Object> properties,
                                       @NonNull
                                       java.lang.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 ApplicationContext run(@NonNull
                                       PropertySource properties,
                                       @NonNull
                                       java.lang.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 java.lang.AutoCloseable> T run(@NonNull
                                                          java.lang.Class<T> type,
                                                          @NonNull
                                                          java.lang.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 java.lang.AutoCloseable> T run(@NonNull
                                                          java.lang.Class<T> type,
                                                          @NonNull
                                                          java.util.Map<java.lang.String,java.lang.Object> properties,
                                                          @NonNull
                                                          java.lang.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 java.lang.AutoCloseable> T run(@NonNull
                                                          java.lang.Class<T> type,
                                                          @NonNull
                                                          PropertySource propertySource,
                                                          @NonNull
                                                          java.lang.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

build

@NonNull
static ApplicationContextBuilder build(@NonNull
                                                java.lang.String... environments)

Build a ApplicationContext.

Parameters:

environments - The environments to use

Returns:

The built, but not yet running ApplicationContext

build

@NonNull
static ApplicationContextBuilder build(@NonNull
                                                java.util.Map<java.lang.String,java.lang.Object> properties,
                                                @NonNull
                                                java.lang.String... environments)

Build a ApplicationContext.

Parameters:

properties - The properties

environments - The environments to use

Returns:

The built, but not yet running ApplicationContext

builder

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

Build a ApplicationContext.

Parameters:

environments - The environments to use

Returns:

The built, but not yet running ApplicationContext

builder

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

Build a ApplicationContext.

Parameters:

properties - The properties

environments - The environments to use

Returns:

The built, but not yet running ApplicationContext

build

@NonNull
static ApplicationContextBuilder build()

Build a ApplicationContext.

Specified by:

build in interface BeanContext

Returns:

The built, but not yet running ApplicationContext

builder

@NonNull
static ApplicationContextBuilder builder()

Build a ApplicationContext.

Returns:

The built, but not yet running ApplicationContext

run

@NonNull
static ApplicationContext run(@NonNull
                                       java.lang.ClassLoader classLoader,
                                       @NonNull
                                       java.lang.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

build

@NonNull
static ApplicationContextBuilder build(@NonNull
                                                java.lang.ClassLoader classLoader,
                                                @NonNull
                                                java.lang.String... environments)

Build a ApplicationContext.

Parameters:

classLoader - The classloader to use

environments - The environment to use

Returns:

The built, but not yet running ApplicationContext

build

@NonNull
static ApplicationContextBuilder build(@NonNull
                                                java.lang.Class mainClass,
                                                @NonNull
                                                java.lang.String... environments)

Build a ApplicationContext.

Parameters:

mainClass - The main class of the application

environments - The environment to use

Returns:

The built, but not yet running ApplicationContext

builder

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

Build a ApplicationContext.

Parameters:

classLoader - The classloader to use

environments - The environment to use

Returns:

The built, but not yet running ApplicationContext

builder

@NonNull
static ApplicationContextBuilder builder(@NonNull
                                                  java.lang.Class mainClass,
                                                  @NonNull
                                                  java.lang.String... environments)

Build a ApplicationContext.

Parameters:

mainClass - The main class of the application

environments - The environment to use

Returns:

The built, but not yet running ApplicationContext