org.owasp.csrfguard.config.overlay

Class ConfigurationOverlayProvider

java.lang.Object

org.owasp.csrfguard.config.overlay.ConfigPropertiesCascadeBase

org.owasp.csrfguard.config.overlay.ConfigurationOverlayProvider

public class ConfigurationOverlayProvider
extends ConfigPropertiesCascadeBase

Use configuration overlays that use the base properties as a default, and then decorate with an overlay file

Nested Class Summary

Nested classes/interfaces inherited from class org.owasp.csrfguard.config.overlay.ConfigPropertiesCascadeBase

ConfigPropertiesCascadeBase.ConfigFile, ConfigPropertiesCascadeBase.ConfigFileType

Field Summary

Fields

Modifier and Type	Field and Description
static String	META_INF_CSRFGUARD_PROPERTIES
static String	OWASP_CSRF_GUARD_OVERLAY_PROPERTIES ovrlay properties file
static String	OWASP_CSRF_GUARD_PROPERTIES base properties file

Constructor Summary

Constructors

Constructor and Description
ConfigurationOverlayProvider()

Method Summary

Modifier and Type	Method and Description
protected String	getHierarchyConfigKey() config key of the hierarchy value
protected String	getMainConfigClasspath() get the main config classpath, e.g. csrf guard properties
protected String	getMainExampleConfigClasspath() get the example config classpath, e.g. csrf guard base properties
protected String	getSecondsToCheckConfigKey() config key of the time in seconds to check config
static ConfigurationOverlayProvider	retrieveConfig() retrieve a config from the config file or from cache

Methods inherited from class org.owasp.csrfguard.config.overlay.ConfigPropertiesCascadeBase

filesNeedReloadingBasedOnContents, getClassInSiblingJar, getTimeToCheckConfigSeconds, needToCheckIfFilesNeedReloading, properties, propertiesFromResourceName, propertiesHelper, propertiesOverrideMap, propertiesThreadLocalOverrideMap, retrieveConfig, retrieveFromConfigFileOrCache, retrieveFromConfigFiles

Methods inherited from class java.lang.Object

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

Field Detail

META_INF_CSRFGUARD_PROPERTIES

public static final String META_INF_CSRFGUARD_PROPERTIES

See Also:

Constant Field Values

OWASP_CSRF_GUARD_PROPERTIES

public static final String OWASP_CSRF_GUARD_PROPERTIES

base properties file

See Also:

Constant Field Values

OWASP_CSRF_GUARD_OVERLAY_PROPERTIES

public static final String OWASP_CSRF_GUARD_OVERLAY_PROPERTIES

ovrlay properties file

See Also:

Constant Field Values

Constructor Detail

ConfigurationOverlayProvider

public ConfigurationOverlayProvider()

Method Detail

retrieveConfig

public static ConfigurationOverlayProvider retrieveConfig()

retrieve a config from the config file or from cache

Returns:

the config object

getSecondsToCheckConfigKey

protected String getSecondsToCheckConfigKey()

Description copied from class: ConfigPropertiesCascadeBase

config key of the time in seconds to check config. -1 means dont check again

Specified by:

getSecondsToCheckConfigKey in class ConfigPropertiesCascadeBase

Returns:

config key

getMainConfigClasspath

protected String getMainConfigClasspath()

Description copied from class: ConfigPropertiesCascadeBase

get the main config classpath, e.g. csrf guard properties

Specified by:

getMainConfigClasspath in class ConfigPropertiesCascadeBase

Returns:

the classpath of the main config file

getHierarchyConfigKey

protected String getHierarchyConfigKey()

Description copied from class: ConfigPropertiesCascadeBase

config key of the hierarchy value

Specified by:

getHierarchyConfigKey in class ConfigPropertiesCascadeBase

Returns:

the classpath of the main config file

getMainExampleConfigClasspath

protected String getMainExampleConfigClasspath()

Description copied from class: ConfigPropertiesCascadeBase

get the example config classpath, e.g. csrf guard base properties

Specified by:

getMainExampleConfigClasspath in class ConfigPropertiesCascadeBase

Returns:

the classpath of the example config file