Package com.networknt.config

Class Config

java.lang.Object

com.networknt.config.Config

public abstract class Config
extends Object

A injectable singleton config that has default implementation based on FileSystem json files. It can be extended to other sources (database, distributed cache etc.) by providing another jar in the classpath to replace the default implementation.

Config files are loaded in the following sequence: 1. resource/config folder for the default 2. externalized directory specified by light-4j-config-dir

In docker, the config files should be in volume and any update will be picked up the next day morning.

Field Summary

Fields

Modifier and Type	Field	Description
static String	LIGHT_4J_CONFIG_DIR

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Config()

Method Summary

Modifier and Type	Method	Description
abstract void	clear()
abstract Map<String,Object>	getDefaultJsonMapConfig(String configName)
abstract Map<String,Object>	getDefaultJsonMapConfig(String configName, String path)
abstract Map<String,Object>	getDefaultJsonMapConfigNoCache(String configName)
abstract Map<String,Object>	getDefaultJsonMapConfigNoCache(String configName, String path)
abstract Object	getDefaultJsonObjectConfig(String configName, Class clazz)
abstract Object	getDefaultJsonObjectConfig(String configName, Class clazz, String path)
abstract InputStream	getInputStreamFromFile(String filename)
static Config	getInstance()
abstract Map<String,Object>	getJsonMapConfig(String configName)
abstract Map<String,Object>	getJsonMapConfig(String configName, String path)
abstract Map<String,Object>	getJsonMapConfigNoCache(String configName)
abstract Map<String,Object>	getJsonMapConfigNoCache(String configName, String path)
abstract Object	getJsonObjectConfig(String configName, Class clazz)
abstract Object	getJsonObjectConfig(String configName, Class clazz, String path)
abstract com.fasterxml.jackson.databind.ObjectMapper	getMapper()
abstract String	getStringFromFile(String filename)
abstract String	getStringFromFile(String filename, String path)
abstract org.yaml.snakeyaml.Yaml	getYaml()
abstract void	putInConfigCache(String configName, Object config)
abstract void	setClassLoader(ClassLoader urlClassLoader)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

LIGHT_4J_CONFIG_DIR

public static final String LIGHT_4J_CONFIG_DIR

See Also:

Constant Field Values

Constructor Detail

Config

protected Config()

Method Detail

getJsonMapConfig

public abstract Map<String,Object> getJsonMapConfig(String configName)

getDefaultJsonMapConfig

public abstract Map<String,Object> getDefaultJsonMapConfig(String configName)

getJsonMapConfig

public abstract Map<String,Object> getJsonMapConfig(String configName,
                                                          String path)

getDefaultJsonMapConfig

public abstract Map<String,Object> getDefaultJsonMapConfig(String configName,
                                                                 String path)

getJsonMapConfigNoCache

public abstract Map<String,Object> getJsonMapConfigNoCache(String configName)

getDefaultJsonMapConfigNoCache

public abstract Map<String,Object> getDefaultJsonMapConfigNoCache(String configName)

getJsonMapConfigNoCache

public abstract Map<String,Object> getJsonMapConfigNoCache(String configName,
                                                                 String path)

getDefaultJsonMapConfigNoCache

public abstract Map<String,Object> getDefaultJsonMapConfigNoCache(String configName,
                                                                        String path)

getJsonObjectConfig

public abstract Object getJsonObjectConfig(String configName,
                                           Class clazz)

getDefaultJsonObjectConfig

public abstract Object getDefaultJsonObjectConfig(String configName,
                                                  Class clazz)

getJsonObjectConfig

public abstract Object getJsonObjectConfig(String configName,
                                           Class clazz,
                                           String path)

getDefaultJsonObjectConfig

public abstract Object getDefaultJsonObjectConfig(String configName,
                                                  Class clazz,
                                                  String path)

getStringFromFile

public abstract String getStringFromFile(String filename)

getStringFromFile

public abstract String getStringFromFile(String filename,
                                         String path)

getInputStreamFromFile

public abstract InputStream getInputStreamFromFile(String filename)

getMapper

public abstract com.fasterxml.jackson.databind.ObjectMapper getMapper()

getYaml

public abstract org.yaml.snakeyaml.Yaml getYaml()

clear

public abstract void clear()

setClassLoader

public abstract void setClassLoader(ClassLoader urlClassLoader)

putInConfigCache

public abstract void putInConfigCache(String configName,
                                      Object config)

getInstance

public static Config getInstance()