io.micronaut.context.env

Class DefaultEnvironment

java.lang.Object

io.micronaut.context.env.PropertySourcePropertyResolver

io.micronaut.context.env.DefaultEnvironment

All Implemented Interfaces:

Environment, LifeCycle<Environment>, ConversionService<Environment>, ResourceLoader, PropertyResolver, ValueResolver<String>, Closeable, AutoCloseable

public class DefaultEnvironment
extends PropertySourcePropertyResolver
implements Environment

The default implementation of the Environment interface. Configures a named environment.

Since:

1.0

Author:

Graeme Rocher, rvanderwerf

Field Summary

Fields

Modifier and Type	Field and Description
protected ClassPathResourceLoader	resourceLoader

Fields inherited from class io.micronaut.context.env.PropertySourcePropertyResolver

catalog, conversionService, propertyPlaceholderResolver, propertySources

Fields inherited from interface io.micronaut.context.env.Environment

AMAZON_EC2, ANDROID, AZURE, BARE_METAL, BOOTSTRAP_CONTEXT_PROPERTY, BOOTSTRAP_NAME, BOOTSTRAP_NAME_PROPERTY, CLI, CLOUD, CLOUD_FOUNDRY, CLOUD_PLATFORM_PROPERTY, DEDUCE_ENVIRONMENT_ENV, DEDUCE_ENVIRONMENT_PROPERTY, DEFAULT_NAME, DEVELOPMENT, DIGITAL_OCEAN, ENVIRONMENTS_ENV, ENVIRONMENTS_PROPERTY, FUNCTION, GAE, GOOGLE_COMPUTE, HEROKU, HOSTNAME, IBM, KUBERNETES, MICRONAUT, PROPERTY_SOURCES_KEY, TEST

Fields inherited from interface io.micronaut.core.convert.ConversionService

SHARED

Constructor Summary

Constructors

Constructor and Description
DefaultEnvironment(ApplicationContextConfiguration configuration) Construct a new environment for the given configuration.
DefaultEnvironment(ClassLoader classLoader, ConversionService conversionService, String... names) Deprecated. Use DefaultEnvironment(ApplicationContextConfiguration) instead
DefaultEnvironment(ClassLoader classLoader, String... names) Deprecated. Use DefaultEnvironment(ApplicationContextConfiguration) instead
DefaultEnvironment(ClassPathResourceLoader resourceLoader, ConversionService conversionService, Boolean deduceEnvironments, String... names) Deprecated. Use DefaultEnvironment(ApplicationContextConfiguration) instead.
DefaultEnvironment(ClassPathResourceLoader resourceLoader, ConversionService conversionService, String... names) Deprecated. Use DefaultEnvironment(ApplicationContextConfiguration) instead
DefaultEnvironment(String... names) Deprecated. Use DefaultEnvironment(ApplicationContextConfiguration) instead

Method Summary

Modifier and Type	Method and Description
Environment	addConfigurationExcludes(String... names) Exclude configurations by name.
Environment	addConfigurationIncludes(String... names) Exclude configurations by name.
<S,T> Environment	addConverter(Class<S> sourceType, Class<T> targetType, Function<S,T> typeConverter) Adds a type converter.
<S,T> Environment	addConverter(Class<S> sourceType, Class<T> targetType, TypeConverter<S,T> typeConverter) Adds a type converter.
Environment	addPackage(String pkg) Add an application package.
DefaultEnvironment	addPropertySource(PropertySource propertySource) Add a PropertySource to this resolver.
DefaultEnvironment	addPropertySource(String name, Map<String,? super Object> values) Add a property source for the given map.
<S,T> boolean	canConvert(Class<S> sourceType, Class<T> targetType) Return whether the given source type is convertible to the given target type.
<T> Optional<T>	convert(Object object, Class<T> targetType, ConversionContext context) Attempts to convert the given object to the given target type.
protected ClassPathAnnotationScanner	createAnnotationScanner(ClassLoader classLoader) Creates the default annotation scanner.
ResourceLoader	forBase(String basePath) Constructs a new resource loader designed to load resources from the given path.
Set<String>	getActiveNames() Should respect the order as provided.
ClassLoader	getClassLoader()
Collection<String>	getPackages()
PropertyPlaceholderResolver	getPlaceholderResolver()
Collection<PropertySourceLoader>	getPropertySourceLoaders() Obtains the PropertySourceLoader instances.
protected String	getPropertySourceRootName()
Collection<PropertySource>	getPropertySources()
Optional<URL>	getResource(String path) Obtains the URL to a given resource.
Optional<InputStream>	getResourceAsStream(String path) Obtains a resource as a stream.
Stream<URL>	getResources(String path) Obtains all resources with the given name.
boolean	isActive(BeanConfiguration configuration) Whether the current environment includes the given configuration.
boolean	isPresent(String className) Check whether the given class is present within this environment.
boolean	isRunning()
protected List<PropertySource>	readPropertySourceList(String name)
protected List<PropertySource>	readPropertySourceListFromFiles(String files) Resolve the property sources for files passed via system property and system env.
protected String	readPropertySourceListKeyFromEnvironment() Reads the value of MICRONAUT_CONFIG_FILES environment variable.
protected SoftServiceLoader<PropertySourceLoader>	readPropertySourceLoaders()
protected void	readPropertySources(String name)
Map<String,Object>	refreshAndDiff() Refresh the environment from the list of PropertySource instances and return a diff of the changes.
Stream<Class>	scan(Class<? extends Annotation> annotation) Scan the current environment for classes annotated with the given annotation.
Stream<Class>	scan(Class<? extends Annotation> annotation, String... packages) Scan the current environment for classes annotated with the given annotation.
protected boolean	shouldDeduceEnvironments()
Environment	start() Starts the lifecyle component.
Environment	stop() Stops the life cycle component.
boolean	supportsPrefix(String path)

Methods inherited from class io.micronaut.context.env.PropertySourcePropertyResolver

containsProperties, containsProperty, getAllProperties, getProperties, getProperty, processPropertySource, resetCaches, resolveEntriesForKey, resolveSubMap, resolveSubMap, resolveSubProperties

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.env.Environment

addPackage

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

containsProperties, containsProperty, get, getProperties, getProperties, getProperty, 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.LifeCycle

close, refresh

Methods inherited from interface io.micronaut.core.convert.ConversionService

convert, convert, convert, convertRequired, convertRequired

Field Detail

resourceLoader

protected final ClassPathResourceLoader resourceLoader

Constructor Detail

DefaultEnvironment

@Deprecated
public DefaultEnvironment(ClassLoader classLoader,
                                      String... names)

Deprecated. Use DefaultEnvironment(ApplicationContextConfiguration) instead

Parameters:

classLoader - The class loader

names - The names

DefaultEnvironment

@Deprecated
public DefaultEnvironment(String... names)

Deprecated. Use DefaultEnvironment(ApplicationContextConfiguration) instead

Parameters:

names - The names

DefaultEnvironment

@Deprecated
public DefaultEnvironment(ClassLoader classLoader,
                                      ConversionService conversionService,
                                      String... names)

Deprecated. Use DefaultEnvironment(ApplicationContextConfiguration) instead

Parameters:

classLoader - The class loader

conversionService - The conversion service

names - The names

DefaultEnvironment

@Deprecated
public DefaultEnvironment(ClassPathResourceLoader resourceLoader,
                                      ConversionService conversionService,
                                      String... names)

Deprecated. Use DefaultEnvironment(ApplicationContextConfiguration) instead

Parameters:

resourceLoader - The resource loader

conversionService - The conversion service

names - The names

DefaultEnvironment

@Deprecated
public DefaultEnvironment(ClassPathResourceLoader resourceLoader,
                                      ConversionService conversionService,
                                      @Nullable
                                      Boolean deduceEnvironments,
                                      String... names)

Deprecated. Use DefaultEnvironment(ApplicationContextConfiguration) instead.

Parameters:

resourceLoader - The resource loader

conversionService - The conversion service

deduceEnvironments - Option to deduce environments

names - The names

DefaultEnvironment

public DefaultEnvironment(@Nonnull
                          ApplicationContextConfiguration configuration)

Construct a new environment for the given configuration.

Parameters:

configuration - The configuration

Method Detail

isPresent

public boolean isPresent(String className)

Description copied from interface: Environment

Check whether the given class is present within this environment.

Specified by:

isPresent in interface Environment

Parameters:

className - The class name

Returns:

True if it is

getPlaceholderResolver

public PropertyPlaceholderResolver getPlaceholderResolver()

Specified by:

getPlaceholderResolver in interface Environment

Returns:

The placeholder resolver

scan

public Stream<Class> scan(Class<? extends Annotation> annotation)

Description copied from interface: Environment

Scan the current environment for classes annotated with the given annotation. Use with care, repeated invocations should be avoided for performance reasons.

Specified by:

scan in interface Environment

Parameters:

annotation - The annotation to scan

Returns:

The classes

scan

public Stream<Class> scan(Class<? extends Annotation> annotation,
                          String... packages)

Description copied from interface: Environment

Scan the current environment for classes annotated with the given annotation. Use with care, repeated invocations should be avoided for performance reasons.

Specified by:

scan in interface Environment

Parameters:

annotation - The annotation to scan

packages - The packages to scan

Returns:

The classes

getClassLoader

public ClassLoader getClassLoader()

Specified by:

getClassLoader in interface Environment

Returns:

The class loader for the environment

isActive

public boolean isActive(BeanConfiguration configuration)

Description copied from interface: Environment

Whether the current environment includes the given configuration.

Specified by:

isActive in interface Environment

Parameters:

configuration - The configuration

Returns:

True if it does

addPropertySource

public DefaultEnvironment addPropertySource(PropertySource propertySource)

Description copied from class: PropertySourcePropertyResolver

Add a PropertySource to this resolver.

Specified by:

addPropertySource in interface Environment

Overrides:

addPropertySource in class PropertySourcePropertyResolver

Parameters:

propertySource - The PropertySource to add

Returns:

This PropertySourcePropertyResolver

addPropertySource

public DefaultEnvironment addPropertySource(String name,
                                            Map<String,? super Object> values)

Description copied from class: PropertySourcePropertyResolver

Add a property source for the given map.

Specified by:

addPropertySource in interface Environment

Overrides:

addPropertySource in class PropertySourcePropertyResolver

Parameters:

name - The name of the property source

values - The values

Returns:

This environment

addPackage

public Environment addPackage(String pkg)

Description copied from interface: Environment

Add an application package. Application packages are candidates for scanning for tools that need it (such as JPA or GORM).

Specified by:

addPackage in interface Environment

Parameters:

pkg - The package to add

Returns:

This environment

addConfigurationExcludes

public Environment addConfigurationExcludes(@Nullable
                                            String... names)

Description copied from interface: Environment

Exclude configurations by name.

Specified by:

addConfigurationExcludes in interface Environment

Parameters:

names - The names of the configuration

Returns:

This environment

addConfigurationIncludes

public Environment addConfigurationIncludes(String... names)

Description copied from interface: Environment

Exclude configurations by name.

Specified by:

addConfigurationIncludes in interface Environment

Parameters:

names - The names of the configuration

Returns:

This environment

getPackages

public Collection<String> getPackages()

Specified by:

getPackages in interface Environment

Returns:

The application packages

getActiveNames

public Set<String> getActiveNames()

Description copied from interface: Environment

Should respect the order as provided.

Specified by:

getActiveNames in interface Environment

Returns:

The active environment names

getPropertySources

public Collection<PropertySource> getPropertySources()

Specified by:

getPropertySources in interface Environment

Returns:

The active property sources

start

public Environment start()

Description copied from interface: LifeCycle

Starts the lifecyle component.

Specified by:

start in interface LifeCycle<Environment>

Returns:

This lifecycle component

isRunning

public boolean isRunning()

Specified by:

isRunning in interface LifeCycle<Environment>

Returns:

Whether the component is running

stop

public Environment stop()

Description copied from interface: LifeCycle

Stops the life cycle component.

Specified by:

stop in interface LifeCycle<Environment>

Returns:

This lifecycle component

refreshAndDiff

public Map<String,Object> refreshAndDiff()

Description copied from interface: Environment

Refresh the environment from the list of PropertySource instances and return a diff of the changes.

Specified by:

refreshAndDiff in interface Environment

Returns:

The values that changed

convert

public <T> Optional<T> convert(Object object,
                               Class<T> targetType,
                               ConversionContext context)

Description copied from interface: ConversionService

Attempts to convert the given object to the given target type. If conversion fails or is not possible an empty Optional is returned.

Specified by:

convert in interface ConversionService<Environment>

Type Parameters:

T - The generic type

Parameters:

object - The object to convert

targetType - The target type

context - The conversion context

Returns:

The optional

canConvert

public <S,T> boolean canConvert(Class<S> sourceType,
                                Class<T> targetType)

Description copied from interface: ConversionService

Return whether the given source type is convertible to the given target type.

Specified by:

canConvert in interface ConversionService<Environment>

Type Parameters:

S - The generic source type

T - The target source type

Parameters:

sourceType - The source type

targetType - The target type

Returns:

True if it can be converted

addConverter

public <S,T> Environment addConverter(Class<S> sourceType,
                                      Class<T> targetType,
                                      TypeConverter<S,T> typeConverter)

Description copied from interface: ConversionService

Adds a type converter.

Specified by:

addConverter in interface ConversionService<Environment>

Type Parameters:

S - The source generic type

T - The target generic type

Parameters:

sourceType - The source type

targetType - The target type

typeConverter - The type converter

Returns:

This conversion service

addConverter

public <S,T> Environment addConverter(Class<S> sourceType,
                                      Class<T> targetType,
                                      Function<S,T> typeConverter)

Description copied from interface: ConversionService

Adds a type converter.

Specified by:

addConverter in interface ConversionService<Environment>

Type Parameters:

S - The source generic type

T - The target generic type

Parameters:

sourceType - The source type

targetType - The target type

typeConverter - The type converter

Returns:

This conversion service

getResourceAsStream

public Optional<InputStream> getResourceAsStream(String path)

Description copied from interface: ResourceLoader

Obtains a resource as a stream.

Specified by:

getResourceAsStream in interface ResourceLoader

Parameters:

path - The path

Returns:

An optional resource

getResource

public Optional<URL> getResource(String path)

Description copied from interface: ResourceLoader

Obtains the URL to a given resource.

Specified by:

getResource in interface ResourceLoader

Parameters:

path - The path

Returns:

An optional resource

getResources

public Stream<URL> getResources(String path)

Description copied from interface: ResourceLoader

Obtains all resources with the given name.

Specified by:

getResources in interface ResourceLoader

Parameters:

path - The name of the resource

Returns:

A stream of URLs

supportsPrefix

public boolean supportsPrefix(String path)

Specified by:

supportsPrefix in interface ResourceLoader

Parameters:

path - The path to a resource including a prefix appended by a colon. Ex (classpath:, file:)

Returns:

Whether the given resource loader supports the prefix

forBase

public ResourceLoader forBase(String basePath)

Description copied from interface: ResourceLoader

Constructs a new resource loader designed to load resources from the given path. Requested resources will be loaded within the context of the given path.

Specified by:

forBase in interface ResourceLoader

Parameters:

basePath - The path to load resources

Returns:

The new ResourceLoader

shouldDeduceEnvironments

protected boolean shouldDeduceEnvironments()

Returns:

Whether environment names and packages should be deduced

createAnnotationScanner

protected ClassPathAnnotationScanner createAnnotationScanner(ClassLoader classLoader)

Creates the default annotation scanner.

Parameters:

classLoader - The class loader

Returns:

The scanner

getPropertySourceRootName

protected String getPropertySourceRootName()

Returns:

The property source root name

readPropertySources

protected void readPropertySources(String name)

Parameters:

name - The name to read property sources

readPropertySourceListKeyFromEnvironment

protected String readPropertySourceListKeyFromEnvironment()

Reads the value of MICRONAUT_CONFIG_FILES environment variable.

Returns:

The comma-separated list of files

readPropertySourceListFromFiles

protected List<PropertySource> readPropertySourceListFromFiles(String files)

Resolve the property sources for files passed via system property and system env.

Parameters:

files - The comma separated list of files

Returns:

The list of property sources for each file

readPropertySourceList

protected List<PropertySource> readPropertySourceList(String name)

Parameters:

name - The name to resolver property sources

Returns:

The list of property sources

readPropertySourceLoaders

protected SoftServiceLoader<PropertySourceLoader> readPropertySourceLoaders()

Returns:

Loaded properties as a SoftServiceLoader

getPropertySourceLoaders

public Collection<PropertySourceLoader> getPropertySourceLoaders()

Obtains the PropertySourceLoader instances.

Specified by:

getPropertySourceLoaders in interface Environment

Returns:

A collection of PropertySourceLoader