io.jooby

Class Environment

java.lang.Object

io.jooby.Environment

public class Environment
extends Object

Application environment contains configuration object and active environment names. The active environment names serve the purpose of allowing loading different configuration files depending on the environment. Also, Extension modules might configure application services differently depending on the environment too. For example: turn on/off caches, reload files, etc. The application.env property controls the active environment names.

Since:

2.0.0

Author:

edgar

Constructor Summary

Constructors

Constructor and Description
Environment(ClassLoader classLoader, com.typesafe.config.Config config, List<String> actives) Creates a new environment.
Environment(ClassLoader classLoader, com.typesafe.config.Config config, String... actives) Creates a new environment.

Method Summary

Modifier and Type	Method and Description
static com.typesafe.config.Config	defaults() Creates a default configuration properties with some common values like: application.tmpdir, application.charset and pid (process ID).
List<String>	getActiveNames() Active environment names.
ClassLoader	getClassLoader() Application class loader.
com.typesafe.config.Config	getConfig() Application configuration.
Map<String,String>	getProperties(String key) List all the properties under the given key.
Map<String,String>	getProperties(String key, String prefix) List all the properties under the given key.
String	getProperty(String key) Get a property under the given key or null when missing.
String	getProperty(String key, String defaults) Get a property under the given key or use the given default value when missing.
boolean	isActive(String name, String... names) Test is the given environment names are active.
Optional<Class>	loadClass(String className) Loaded class or empty.
static Environment	loadEnvironment(EnvironmentOptions options) This method search for an application.conf file in three location (first-listed are higher priority): ${user.dir}/conf: This is a file system location, useful is you want to externalize configuration (outside of jar file). ${user.dir}: This is a file system location, useful is you want to externalize configuration (outside of jar file) classpath:// (root of classpath).
static String	pid() Find JVM process ID.
Environment	setConfig(com.typesafe.config.Config config) Set configuration properties.
static com.typesafe.config.Config	systemEnv() Creates a Config object from System.getenv().
static com.typesafe.config.Config	systemProperties() Creates a Config object from System.getProperties().
String	toString()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Environment

public Environment(@Nonnull
                   ClassLoader classLoader,
                   @Nonnull
                   com.typesafe.config.Config config,
                   @Nonnull
                   String... actives)

Creates a new environment.

Parameters:

classLoader - Class loader.

config - Application configuration.

actives - Active environment names.

Environment

public Environment(@Nonnull
                   ClassLoader classLoader,
                   @Nonnull
                   com.typesafe.config.Config config,
                   @Nonnull
                   List<String> actives)

Creates a new environment.

Parameters:

classLoader - Class loader.

config - Application configuration.

actives - Active environment names.

Method Detail

getProperty

@Nonnull
public String getProperty(@Nonnull
                                   String key,
                                   @Nonnull
                                   String defaults)

Get a property under the given key or use the given default value when missing.

Parameters:

key - Property key.

defaults - Default value.

Returns:

Property or default value.

getProperty

@Nullable
public String getProperty(@Nonnull
                                    String key)

Get a property under the given key or null when missing.

Parameters:

key - Property key.

Returns:

Property value or null when missing.

getProperties

@Nonnull
public Map<String,String> getProperties(@Nonnull
                                                 String key)

List all the properties under the given key. Example:

 user.name = "name"
 user.password = "pass"
 

A call to getProperties("user") give you a map like: {user.name: name, user.password: pass}

Parameters:

key - Key.

Returns:

Properties under that key or empty map.

getProperties

@Nonnull
public Map<String,String> getProperties(@Nonnull
                                                 String key,
                                                 @Nullable
                                                 String prefix)

List all the properties under the given key. Example:

 user.name = "name"
 user.password = "pass"
 

A call to getProperties("user", "u") give you a map like: {u.name: name, u.password: pass}

Parameters:

key - Key.

prefix - Prefix to use or null for none.

Returns:

Properties under that key or empty map.

getConfig

@Nonnull
public com.typesafe.config.Config getConfig()

Application configuration.

Returns:

Application configuration.

setConfig

public Environment setConfig(@Nonnull
                             com.typesafe.config.Config config)

Set configuration properties. Please note setting a configuration object must be done at very early application stage.

Parameters:

config - Configuration properties.

Returns:

This environment.

getActiveNames

@Nonnull
public List<String> getActiveNames()

Active environment names.

Returns:

Active environment names.

isActive

public boolean isActive(@Nonnull
                        String name,
                        String... names)

Test is the given environment names are active.

Parameters:

name - Environment name.

names - Optional environment names.

Returns:

True if any of the given names is active.

getClassLoader

@Nonnull
public ClassLoader getClassLoader()

Application class loader.

Returns:

Application class loader.

loadClass

@Nonnull
public Optional<Class> loadClass(@Nonnull
                                          String className)

Loaded class or empty.

Parameters:

className - Class name.

Returns:

Load a class or get an empty value.

toString

public String toString()

Overrides:

toString in class Object

systemProperties

@Nonnull
public static com.typesafe.config.Config systemProperties()

Creates a Config object from System.getProperties().

Returns:

Configuration object.

systemEnv

@Nonnull
public static com.typesafe.config.Config systemEnv()

Creates a Config object from System.getenv().

Returns:

Configuration object.

loadEnvironment

@Nonnull
public static Environment loadEnvironment(@Nonnull
                                                   EnvironmentOptions options)

This method search for an application.conf file in three location (first-listed are higher priority):

• ${user.dir}/conf: This is a file system location, useful is you want to externalize configuration (outside of jar file).
• ${user.dir}: This is a file system location, useful is you want to externalize configuration (outside of jar file)
• classpath:// (root of classpath). No external configuration, configuration file lives inside the jar file

Property overrides is done in the following order (first-listed are higher priority):

• Program arguments
• System properties
• Environment variables
• Environment property file
• Property file

Parameters:

options - Options like basedir, filename, etc.

Returns:

A new environment.

defaults

@Nonnull
public static com.typesafe.config.Config defaults()

Creates a default configuration properties with some common values like: application.tmpdir, application.charset and pid (process ID).

Returns:

A configuration object.

pid

@Nullable
public static String pid()

Find JVM process ID.

Returns:

JVM process ID or null.