Package io.micronaut.runtime

Class Micronaut

java.lang.Object

io.micronaut.context.DefaultApplicationContextBuilder

io.micronaut.runtime.Micronaut

All Implemented Interfaces:

ApplicationContextBuilder, ApplicationContextConfiguration, BeanContextConfiguration

public class Micronaut
extends DefaultApplicationContextBuilder
implements ApplicationContextBuilder

Main entry point for running a Micronaut application.

Since:

1.0

Author:

Graeme Rocher

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Micronaut()	The default constructor.

Method Summary

Modifier and Type	Method	Description
@NonNull Micronaut	args(@Nullable String... args)	Set the command line arguments.
@NonNull Micronaut	banner(boolean isEnabled)	Whether the banner is enabled or not.
Micronaut	beanDefinitions(@NonNull RuntimeBeanDefinition<?>... definitions)	Register additional runtime bean definitions prior to startup.
static Micronaut	build(String... args)	Run the application for the given arguments.
@NonNull Micronaut	classes(@Nullable Class<?>... classes)	Add classes to be included in the initialization of the application.
@NonNull Micronaut	classLoader(ClassLoader classLoader)	The class loader to be used.
@NonNull Micronaut	defaultEnvironments(@Nullable String... environments)	The environments to use if no other environments are specified.
@NonNull Micronaut	environmentPropertySource(boolean environmentPropertySource)	Set whether environment variables should contribute to configuration.
@NonNull Micronaut	environments(@Nullable String... environments)	The environments to use.
@NonNull Micronaut	environmentVariableExcludes(@Nullable String... environmentVariables)	Which environment variables should not contribute to configuration.
@NonNull Micronaut	environmentVariableIncludes(@Nullable String... environmentVariables)	Which environment variables should contribute to configuration.
@NonNull Micronaut	exclude(@Nullable String... configurations)	Allow customizing the configurations that will be loaded.
protected void	handleStartupException(Environment environment, Throwable exception)	Default handling of startup exceptions.
@NonNull Micronaut	include(@Nullable String... configurations)	Allow customizing the configurations that will be loaded.
@NonNull Micronaut	mainClass(Class<?> mainClass)	The main class used by this application.
<T extends Throwable> Micronaut	mapError(Class<T> exception, Function<T,Integer> mapper)	Maps an exception to the given error code.
@NonNull Micronaut	packages(@Nullable String... packages)	The packages to include for package scanning.
@NonNull Micronaut	properties(@Nullable Map<String,Object> properties)	Properties to override from the environment.
@NonNull Micronaut	propertySources(@Nullable PropertySource... propertySources)	Additional property sources.
static ApplicationContext	run(Class<?>[] classes, String... args)	Run the application for the given arguments.
static ApplicationContext	run(Class<?> cls, String... args)	Run the application for the given arguments.
static ApplicationContext	run(String... args)	Run the application for the given arguments.
@NonNull Micronaut	singletons(Object... beans)	Additional singletons to register prior to startup.
@NonNull ApplicationContext	start()	Starts the ApplicationContext.

Methods inherited from class io.micronaut.context.DefaultApplicationContextBuilder

allowEmptyProviders, beanConfigurations, beanResolutionTrace, bootstrapEnvironment, build, deduceCloudEnvironment, deduceEnvironment, eagerInitAnnotated, enableDefaultPropertySources, getClassLoader, getContextConfigurer, getDeduceEnvironments, getDefaultEnvironments, getEagerInitAnnotated, getEnvironments, getEnvironmentVariableExcludes, getEnvironmentVariableIncludes, getOverrideConfigLocations, getResourceLoader, getTraceConfiguration, isAllowEmptyProviders, isBannerEnabled, isBootstrapEnvironmentEnabled, isDeduceCloudEnvironment, isEnableDefaultPropertySources, isEnvironmentPropertySource, newApplicationContext, overrideConfigLocations

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

allowEmptyProviders, beanConfigurations, beanResolutionTrace, beanResolutionTrace, bootstrapEnvironment, build, deduceCloudEnvironment, deduceEnvironment, eagerInitAnnotated, eagerInitConfiguration, eagerInitSingletons, enableDefaultPropertySources, overrideConfigLocations, run

Methods inherited from interface io.micronaut.context.ApplicationContextConfiguration

getConversionService

Methods inherited from interface io.micronaut.context.BeanContextConfiguration

isEagerInitConfiguration, isEagerInitSingletons

Constructor Details

Micronaut

protected Micronaut()

The default constructor.

Method Details

start

@NonNull
public @NonNull ApplicationContext start()

Description copied from interface: ApplicationContextBuilder

Starts the ApplicationContext.

Specified by:

start in interface ApplicationContextBuilder

Returns:

Run this Micronaut

include

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

Description copied from class: DefaultApplicationContextBuilder

Allow customizing the configurations that will be loaded.

Specified by:

include in interface ApplicationContextBuilder

Overrides:

include in class DefaultApplicationContextBuilder

Parameters:

configurations - The configurations to include

Returns:

This application

exclude

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

Description copied from class: DefaultApplicationContextBuilder

Allow customizing the configurations that will be loaded.

Specified by:

exclude in interface ApplicationContextBuilder

Overrides:

exclude in class DefaultApplicationContextBuilder

Parameters:

configurations - The configurations to exclude

Returns:

This application

banner

@NonNull
public @NonNull Micronaut banner(boolean isEnabled)

Description copied from interface: ApplicationContextBuilder

Whether the banner is enabled or not.

Specified by:

banner in interface ApplicationContextBuilder

Overrides:

banner in class DefaultApplicationContextBuilder

Parameters:

isEnabled - Whether the banner is enabled or not

Returns:

This application

classes

@NonNull
public @NonNull Micronaut classes(@Nullable
 @Nullable Class<?>... classes)

Add classes to be included in the initialization of the application.

Parameters:

classes - The application

Returns:

The classes

properties

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

Description copied from interface: ApplicationContextBuilder

Properties to override from the environment.

Specified by:

properties in interface ApplicationContextBuilder

Overrides:

properties in class DefaultApplicationContextBuilder

Parameters:

properties - The properties

Returns:

This builder

singletons

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

Description copied from interface: ApplicationContextBuilder

Additional singletons to register prior to startup.

Specified by:

singletons in interface ApplicationContextBuilder

Overrides:

singletons in class DefaultApplicationContextBuilder

Parameters:

beans - The beans

Returns:

This builder

beanDefinitions

public Micronaut beanDefinitions(@NonNull
 @NonNull RuntimeBeanDefinition<?>... definitions)

Description copied from interface: ApplicationContextBuilder

Register additional runtime bean definitions prior to startup.

Specified by:

beanDefinitions in interface ApplicationContextBuilder

Overrides:

beanDefinitions in class DefaultApplicationContextBuilder

Parameters:

definitions - The definitions.

Returns:

The context builder

propertySources

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

Description copied from interface: ApplicationContextBuilder

Additional property sources.

Specified by:

propertySources in interface ApplicationContextBuilder

Overrides:

propertySources in class DefaultApplicationContextBuilder

Parameters:

propertySources - The property sources to include

Returns:

This builder

environmentPropertySource

@NonNull
public @NonNull Micronaut environmentPropertySource(boolean environmentPropertySource)

Description copied from interface: ApplicationContextBuilder

Set whether environment variables should contribute to configuration.

Specified by:

environmentPropertySource in interface ApplicationContextBuilder

Overrides:

environmentPropertySource in class DefaultApplicationContextBuilder

Parameters:

environmentPropertySource - The boolean

Returns:

This builder

environmentVariableIncludes

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

Description copied from interface: ApplicationContextBuilder

Which environment variables should contribute to configuration.

Specified by:

environmentVariableIncludes in interface ApplicationContextBuilder

Overrides:

environmentVariableIncludes in class DefaultApplicationContextBuilder

Parameters:

environmentVariables - The environment variables

Returns:

This builder

environmentVariableExcludes

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

Description copied from interface: ApplicationContextBuilder

Which environment variables should not contribute to configuration.

Specified by:

environmentVariableExcludes in interface ApplicationContextBuilder

Overrides:

environmentVariableExcludes in class DefaultApplicationContextBuilder

Parameters:

environmentVariables - The environment variables

Returns:

This builder

mainClass

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

Description copied from interface: ApplicationContextBuilder

The main class used by this application.

Specified by:

mainClass in interface ApplicationContextBuilder

Overrides:

mainClass in class DefaultApplicationContextBuilder

Parameters:

mainClass - The main class

Returns:

This builder

classLoader

@NonNull
public @NonNull Micronaut classLoader(ClassLoader classLoader)

Description copied from interface: ApplicationContextBuilder

The class loader to be used.

Specified by:

classLoader in interface ApplicationContextBuilder

Overrides:

classLoader in class DefaultApplicationContextBuilder

Parameters:

classLoader - The classloader

Returns:

This builder

args

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

Description copied from interface: ApplicationContextBuilder

Set the command line arguments.

Specified by:

args in interface ApplicationContextBuilder

Overrides:

args in class DefaultApplicationContextBuilder

Parameters:

args - The arguments

Returns:

This application

environments

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

Description copied from interface: ApplicationContextBuilder

The environments to use.

Specified by:

environments in interface ApplicationContextBuilder

Overrides:

environments in class DefaultApplicationContextBuilder

Parameters:

environments - The environments

Returns:

This builder

defaultEnvironments

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

Overrides:

defaultEnvironments in class DefaultApplicationContextBuilder

Parameters:

environments - The environments

Returns:

This builder

packages

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

Description copied from interface: ApplicationContextBuilder

The packages to include for package scanning.

Specified by:

packages in interface ApplicationContextBuilder

Overrides:

packages in class DefaultApplicationContextBuilder

Parameters:

packages - The packages

Returns:

This builder

mapError

public <T extends Throwable> Micronaut mapError(Class<T> exception,
 Function<T,Integer> mapper)

Maps an exception to the given error code.

Type Parameters:

T - The exception type

Parameters:

exception - The exception

mapper - The mapper

Returns:

This application

build

public static Micronaut build(String... args)

Run the application for the given arguments. Classes for the application will be discovered automatically

Parameters:

args - The arguments

Returns:

The ApplicationContext

run

public static ApplicationContext run(String... args)

Run the application for the given arguments. Classes for the application will be discovered automatically

Parameters:

args - The arguments

Returns:

The ApplicationContext

run

public static ApplicationContext run(Class<?> cls,
 String... args)

Run the application for the given arguments.

Parameters:

cls - The application class

args - The arguments

Returns:

The ApplicationContext

run

public static ApplicationContext run(Class<?>[] classes,
 String... args)

Run the application for the given arguments.

Parameters:

classes - The application classes

args - The arguments

Returns:

The ApplicationContext

handleStartupException

protected void handleStartupException(Environment environment,
 Throwable exception)

Default handling of startup exceptions.

Parameters:

environment - The environment

exception - The exception

Throws:

ApplicationStartupException - If the server cannot be shutdown with an appropriate exist code