Package io.micronaut.context

Class DefaultApplicationContextBuilder

java.lang.Object

io.micronaut.context.DefaultApplicationContextBuilder

All Implemented Interfaces:

ApplicationContextBuilder, ApplicationContextConfiguration, BeanContextConfiguration

Direct Known Subclasses:

Micronaut

public class DefaultApplicationContextBuilder
extends Object
implements ApplicationContextBuilder, ApplicationContextConfiguration

Implementation of ApplicationContextBuilder.

Since:

1.0

Author:

graemerocher

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	DefaultApplicationContextBuilder()	Default constructor.

Method Summary

Modifier and Type	Method	Description
@NonNull ApplicationContextBuilder	allowEmptyProviders(boolean shouldAllow)	Whether to error on an empty bean provider.
@NonNull ApplicationContextBuilder	args(@Nullable String... args)	Set the command line arguments.
@NonNull ApplicationContextBuilder	banner(boolean isEnabled)	Whether the banner is enabled or not.
@NonNull ApplicationContextBuilder	bootstrapEnvironment(boolean bootstrapEnv)	Sets whether the bootstrap environment should be initialized.
@NonNull ApplicationContext	build()	Builds the ApplicationContext, but does not start it.
@NonNull ApplicationContextBuilder	classLoader(ClassLoader classLoader)	The class loader to be used.
ApplicationContextBuilder	deduceCloudEnvironment(boolean deduceEnvironment)	If set to true (the default value is false) Micronaut will attempt to automatically deduce the Cloud environment it is running within.
@NonNull ApplicationContextBuilder	deduceEnvironment(@Nullable Boolean deduceEnvironments)	If set to true (the default is true) Micronaut will attempt to automatically deduce the environment it is running in using environment variables and/or stack trace inspection.
@NonNull ApplicationContextBuilder	defaultEnvironments(@Nullable String... environments)	The environments to use if no other environments are specified.
@NonNull ApplicationContextBuilder	eagerInitAnnotated(Class<? extends Annotation>... annotations)	Specifies to eager init the given annotated types.
@NonNull ApplicationContextBuilder	enableDefaultPropertySources(boolean areEnabled)	Specify whether the default set of property sources should be enabled (default is true).
@NonNull ApplicationContextBuilder	environmentPropertySource(boolean environmentPropertySource)	Set whether environment variables should contribute to configuration.
@NonNull ApplicationContextBuilder	environments(@Nullable String... environments)	The environments to use.
@NonNull ApplicationContextBuilder	environmentVariableExcludes(@Nullable String... environmentVariables)	Which environment variables should not contribute to configuration.
@NonNull ApplicationContextBuilder	environmentVariableIncludes(@Nullable String... environmentVariables)	Which environment variables should contribute to configuration.
@NonNull ApplicationContextBuilder	exclude(@Nullable String... configurations)	Allow customizing the configurations that will be loaded.
@NonNull ClassLoader	getClassLoader()	The class loader to use.
Optional<Boolean>	getDeduceEnvironments()	If set to true (the default is true) Micronaut will attempt to automatically deduce the environment it is running in using environment variables and/or stack trace inspection.
@NonNull List<String>	getDefaultEnvironments()
Set<Class<? extends Annotation>>	getEagerInitAnnotated()
@NonNull List<String>	getEnvironments()
@Nullable List<String>	getEnvironmentVariableExcludes()
@Nullable List<String>	getEnvironmentVariableIncludes()
@Nullable List<String>	getOverrideConfigLocations()	The config locations.
@NonNull ClassPathResourceLoader	getResourceLoader()	The class path resource loader to use.
@NonNull ApplicationContextBuilder	include(@Nullable String... configurations)	Allow customizing the configurations that will be loaded.
boolean	isAllowEmptyProviders()
boolean	isBannerEnabled()	The banner is enabled by default.
@Nullable Boolean	isBootstrapEnvironmentEnabled()
boolean	isDeduceCloudEnvironment()	If set to true Micronaut will attempt to deduce the environment using safe methods like environment variables and the stack trace.
boolean	isEnableDefaultPropertySources()	Whether to load the default set of property sources.
boolean	isEnvironmentPropertySource()
@NonNull ApplicationContextBuilder	mainClass(Class<?> mainClass)	The main class used by this application.
protected @NonNull ApplicationContext	newApplicationContext()	Creates the ApplicationContext instance.
@NonNull ApplicationContextBuilder	overrideConfigLocations(String... configLocations)	Override default config locations.
@NonNull ApplicationContextBuilder	packages(@Nullable String... packages)	The packages to include for package scanning.
@NonNull ApplicationContextBuilder	properties(@Nullable Map<String,Object> properties)	Properties to override from the environment.
@NonNull ApplicationContextBuilder	propertySources(@Nullable PropertySource... propertySources)	Additional property sources.
@NonNull ApplicationContextBuilder	singletons(Object... beans)	Additional singletons to register prior to startup.

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.ApplicationContextBuilder

eagerInitConfiguration, eagerInitSingletons, run, start

Methods inherited from interface io.micronaut.context.ApplicationContextConfiguration

getConversionService

Methods inherited from interface io.micronaut.context.BeanContextConfiguration

isEagerInitConfiguration, isEagerInitSingletons

Constructor Details

DefaultApplicationContextBuilder

protected DefaultApplicationContextBuilder()

Default constructor.

Method Details

isAllowEmptyProviders

public boolean isAllowEmptyProviders()

Specified by:

isAllowEmptyProviders in interface BeanContextConfiguration

Returns:

If a NoSuchBeanException should be thrown on a missing BeanProvider or Provider

enableDefaultPropertySources

@NonNull
public @NonNull ApplicationContextBuilder enableDefaultPropertySources(boolean areEnabled)

Description copied from interface: ApplicationContextBuilder

Specify whether the default set of property sources should be enabled (default is true).

Specified by:

enableDefaultPropertySources in interface ApplicationContextBuilder

Parameters:

areEnabled - Whether the default property sources are enabled

Returns:

This builder

isEnableDefaultPropertySources

public boolean isEnableDefaultPropertySources()

Description copied from interface: ApplicationContextConfiguration

Whether to load the default set of property sources.

Specified by:

isEnableDefaultPropertySources in interface ApplicationContextConfiguration

Returns:

Returns true if the default set of property sources should be loaded.

eagerInitAnnotated

@NonNull
public @NonNull ApplicationContextBuilder eagerInitAnnotated(Class<? extends Annotation>... annotations)

Description copied from interface: ApplicationContextBuilder

Specifies to eager init the given annotated types.

Specified by:

eagerInitAnnotated in interface ApplicationContextBuilder

Parameters:

annotations - The annotation stereotypes

Returns:

The context builder

overrideConfigLocations

@NonNull
public @NonNull ApplicationContextBuilder overrideConfigLocations(String... configLocations)

Description copied from interface: ApplicationContextBuilder

Override default config locations.

Specified by:

overrideConfigLocations in interface ApplicationContextBuilder

Parameters:

configLocations - The config locations

Returns:

This environment

getOverrideConfigLocations

@Nullable
public @Nullable List<String> getOverrideConfigLocations()

Description copied from interface: ApplicationContextConfiguration

The config locations.

Specified by:

getOverrideConfigLocations in interface ApplicationContextConfiguration

Returns:

The config locations

isBannerEnabled

public boolean isBannerEnabled()

Description copied from interface: ApplicationContextConfiguration

The banner is enabled by default.

Specified by:

isBannerEnabled in interface ApplicationContextConfiguration

Returns:

The banner is enabled by default

isBootstrapEnvironmentEnabled

@Nullable
public @Nullable Boolean isBootstrapEnvironmentEnabled()

Specified by:

isBootstrapEnvironmentEnabled in interface ApplicationContextConfiguration

getEagerInitAnnotated

public Set<Class<? extends Annotation>> getEagerInitAnnotated()

Specified by:

getEagerInitAnnotated in interface BeanContextConfiguration

Returns:

A set of annotated classes that should be eagerly initialized

singletons

@NonNull
public @NonNull ApplicationContextBuilder singletons(Object... beans)

Description copied from interface: ApplicationContextBuilder

Additional singletons to register prior to startup.

Specified by:

singletons in interface ApplicationContextBuilder

Parameters:

beans - The beans

Returns:

This builder

getResourceLoader

@NonNull
public @NonNull ClassPathResourceLoader getResourceLoader()

Description copied from interface: ApplicationContextConfiguration

The class path resource loader to use.

Specified by:

getResourceLoader in interface ApplicationContextConfiguration

Returns:

The classpath resource loader

getClassLoader

@NonNull
public @NonNull ClassLoader getClassLoader()

Description copied from interface: BeanContextConfiguration

The class loader to use.

Specified by:

getClassLoader in interface BeanContextConfiguration

Returns:

The class loader.

deduceEnvironment

@NonNull
public @NonNull ApplicationContextBuilder deduceEnvironment(@Nullable
 @Nullable Boolean deduceEnvironments)

Description copied from interface: ApplicationContextBuilder

If set to true (the default is true) Micronaut will attempt to automatically deduce the environment it is running in using environment variables and/or stack trace inspection.

This method differs from ApplicationContextBuilder.deduceCloudEnvironment(boolean) which performs extended network and/or disk probes to try and automatically establish the Cloud environment.

This behaviour controls the automatic activation of, for example, the Environment.TEST when running tests.

Specified by:

deduceEnvironment in interface ApplicationContextBuilder

Parameters:

deduceEnvironments - The boolean

Returns:

This builder

deduceCloudEnvironment

public ApplicationContextBuilder deduceCloudEnvironment(boolean deduceEnvironment)

Description copied from interface: ApplicationContextBuilder

If set to true (the default value is false) Micronaut will attempt to automatically deduce the Cloud environment it is running within.

Enabling this should be done with caution since network probes are required to figure out whether the application is running in certain clouds like GCP.

Specified by:

deduceCloudEnvironment in interface ApplicationContextBuilder

Parameters:

deduceEnvironment - The boolean

Returns:

This builder

environments

@NonNull
public @NonNull ApplicationContextBuilder environments(@Nullable
 @Nullable String... environments)

Description copied from interface: ApplicationContextBuilder

The environments to use.

Specified by:

environments in interface ApplicationContextBuilder

Parameters:

environments - The environments

Returns:

This builder

defaultEnvironments

@NonNull
public @NonNull ApplicationContextBuilder defaultEnvironments(@Nullable
 @Nullable String... environments)

Description copied from interface: ApplicationContextBuilder

The environments to use if no other environments are specified.

Specified by:

defaultEnvironments in interface ApplicationContextBuilder

Parameters:

environments - The environments

Returns:

This builder

packages

@NonNull
public @NonNull ApplicationContextBuilder packages(@Nullable
 @Nullable String... packages)

Description copied from interface: ApplicationContextBuilder

The packages to include for package scanning.

Specified by:

packages in interface ApplicationContextBuilder

Parameters:

packages - The packages

Returns:

This builder

properties

@NonNull
public @NonNull ApplicationContextBuilder properties(@Nullable
 @Nullable Map<String,Object> properties)

Description copied from interface: ApplicationContextBuilder

Properties to override from the environment.

Specified by:

properties in interface ApplicationContextBuilder

Parameters:

properties - The properties

Returns:

This builder

propertySources

@NonNull
public @NonNull ApplicationContextBuilder propertySources(@Nullable
 @Nullable PropertySource... propertySources)

Description copied from interface: ApplicationContextBuilder

Additional property sources.

Specified by:

propertySources in interface ApplicationContextBuilder

Parameters:

propertySources - The property sources to include

Returns:

This builder

environmentPropertySource

@NonNull
public @NonNull ApplicationContextBuilder environmentPropertySource(boolean environmentPropertySource)

Description copied from interface: ApplicationContextBuilder

Set whether environment variables should contribute to configuration.

Specified by:

environmentPropertySource in interface ApplicationContextBuilder

Parameters:

environmentPropertySource - The boolean

Returns:

This builder

environmentVariableIncludes

@NonNull
public @NonNull ApplicationContextBuilder environmentVariableIncludes(@Nullable
 @Nullable String... environmentVariables)

Description copied from interface: ApplicationContextBuilder

Which environment variables should contribute to configuration.

Specified by:

environmentVariableIncludes in interface ApplicationContextBuilder

Parameters:

environmentVariables - The environment variables

Returns:

This builder

environmentVariableExcludes

@NonNull
public @NonNull ApplicationContextBuilder environmentVariableExcludes(@Nullable
 @Nullable String... environmentVariables)

Description copied from interface: ApplicationContextBuilder

Which environment variables should not contribute to configuration.

Specified by:

environmentVariableExcludes in interface ApplicationContextBuilder

Parameters:

environmentVariables - The environment variables

Returns:

This builder

getDeduceEnvironments

public Optional<Boolean> getDeduceEnvironments()

Description copied from interface: ApplicationContextConfiguration

If set to true (the default is true) Micronaut will attempt to automatically deduce the environment it is running in using environment variables and/or stack trace inspection.

This method differs from ApplicationContextConfiguration.isDeduceCloudEnvironment() which controls whether network and/or disk probes are performed to try and automatically establish the Cloud environment.

This behaviour controls the automatic activation of, for example, the Environment.TEST when running tests.

Specified by:

getDeduceEnvironments in interface ApplicationContextConfiguration

Returns:

True if the environments should be deduced

isDeduceCloudEnvironment

public boolean isDeduceCloudEnvironment()

Description copied from interface: ApplicationContextConfiguration

If set to true Micronaut will attempt to deduce the environment using safe methods like environment variables and the stack trace.

Enabling this should be done with caution since network probes are required to figure out whether the application is running in certain clouds like GCP.

Specified by:

isDeduceCloudEnvironment in interface ApplicationContextConfiguration

Returns:

True if the environments should be deduced

getEnvironments

@NonNull
public @NonNull List<String> getEnvironments()

Specified by:

getEnvironments in interface ApplicationContextConfiguration

Returns:

The environment names

getDefaultEnvironments

@NonNull
public @NonNull List<String> getDefaultEnvironments()

Specified by:

getDefaultEnvironments in interface ApplicationContextConfiguration

Returns:

The default environments to be applied if no other environments are explicitly specified or deduced.

isEnvironmentPropertySource

public boolean isEnvironmentPropertySource()

Specified by:

isEnvironmentPropertySource in interface ApplicationContextConfiguration

Returns:

True if environment variables should contribute to configuration

getEnvironmentVariableIncludes

@Nullable
public @Nullable List<String> getEnvironmentVariableIncludes()

Specified by:

getEnvironmentVariableIncludes in interface ApplicationContextConfiguration

Returns:

The environment variables to include in configuration

getEnvironmentVariableExcludes

@Nullable
public @Nullable List<String> getEnvironmentVariableExcludes()

Specified by:

getEnvironmentVariableExcludes in interface ApplicationContextConfiguration

Returns:

The environment variables to exclude from configuration

mainClass

@NonNull
public @NonNull ApplicationContextBuilder mainClass(Class<?> mainClass)

Description copied from interface: ApplicationContextBuilder

The main class used by this application.

Specified by:

mainClass in interface ApplicationContextBuilder

Parameters:

mainClass - The main class

Returns:

This builder

classLoader

@NonNull
public @NonNull ApplicationContextBuilder classLoader(ClassLoader classLoader)

Description copied from interface: ApplicationContextBuilder

The class loader to be used.

Specified by:

classLoader in interface ApplicationContextBuilder

Parameters:

classLoader - The classloader

Returns:

This builder

args

@NonNull
public @NonNull ApplicationContextBuilder args(@Nullable
 @Nullable String... args)

Description copied from interface: ApplicationContextBuilder

Set the command line arguments.

Specified by:

args in interface ApplicationContextBuilder

Parameters:

args - The arguments

Returns:

This application

bootstrapEnvironment

@NonNull
public @NonNull ApplicationContextBuilder bootstrapEnvironment(boolean bootstrapEnv)

Description copied from interface: ApplicationContextBuilder

Sets whether the bootstrap environment should be initialized.

Specified by:

bootstrapEnvironment in interface ApplicationContextBuilder

Parameters:

bootstrapEnv - True if it should be initialized. Default true

Returns:

This application

build

@NonNull
public @NonNull ApplicationContext build()

Description copied from interface: ApplicationContextBuilder

Builds the ApplicationContext, but does not start it.

Specified by:

build in interface ApplicationContextBuilder

Returns:

The built, but not running ApplicationContext

newApplicationContext

@NonNull
protected @NonNull ApplicationContext newApplicationContext()

Creates the ApplicationContext instance.

Returns:

The application context

Since:

2.0

include

@NonNull
public @NonNull ApplicationContextBuilder include(@Nullable
 @Nullable String... configurations)

Allow customizing the configurations that will be loaded.

Specified by:

include in interface ApplicationContextBuilder

Parameters:

configurations - The configurations to include

Returns:

This application

exclude

@NonNull
public @NonNull ApplicationContextBuilder exclude(@Nullable
 @Nullable String... configurations)

Allow customizing the configurations that will be loaded.

Specified by:

exclude in interface ApplicationContextBuilder

Parameters:

configurations - The configurations to exclude

Returns:

This application

banner

@NonNull
public @NonNull ApplicationContextBuilder banner(boolean isEnabled)

Description copied from interface: ApplicationContextBuilder

Whether the banner is enabled or not.

Specified by:

banner in interface ApplicationContextBuilder

Parameters:

isEnabled - Whether the banner is enabled or not

Returns:

This application

allowEmptyProviders

@NonNull
public @NonNull ApplicationContextBuilder allowEmptyProviders(boolean shouldAllow)

Description copied from interface: ApplicationContextBuilder

Whether to error on an empty bean provider. Defaults to false.

Specified by:

allowEmptyProviders in interface ApplicationContextBuilder

Parameters:

shouldAllow - True if empty Provider instances are allowed

Returns:

This application