org.spincast.plugins.config

Class SpincastConfigDefault

java.lang.Object

org.spincast.plugins.config.ConfigFinder

org.spincast.plugins.config.SpincastConfigDefault

All Implemented Interfaces:

SpincastConfig

public class SpincastConfigDefault
extends ConfigFinder
implements SpincastConfig

If you extend this class (which is recommended to implement your configuration), beware that causing circular dependencies is very easy if you inject more dependencies than SpincastConfigPluginConfig! Indeed, most components depend on the config components.

Nested Class Summary

Nested classes/interfaces inherited from class org.spincast.plugins.config.ConfigFinder

ConfigFinder.ConfigFinderBuilder

Field Summary

Fields

Modifier and Type	Field and Description
static String	ENVIRONMENT_NAME_DEFAULT

Fields inherited from class org.spincast.plugins.config.ConfigFinder

configs, logger, rawConfigs

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	SpincastConfigDefault(SpincastConfigPluginConfig spincastConfigPluginConfig) Constructor

Method Summary

Modifier and Type	Method and Description
List<String>	getContentTypesToSkipGziping()
String	getCookieNameFlashMessage()
String	getCookieNameLocale()
String	getCookieNameTimeZoneId()
String	getCookiesValidatorCookieName()
Locale	getDefaultLocale()
int	getDefaultRouteCacheFilterSecondsNbr()
Integer	getDefaultRouteCacheFilterSecondsNbrCdns()
StaticResourceCacheConfig	getDefaultStaticResourceCacheConfig(boolean isDynamicResource)
int	getDefaultTemplateVariablesFilterPosition()
TimeZone	getDefaultTimeZone()
DictionaryEntryNotFoundBehavior	getDictionaryEntryNotFoundBehavior()
String	getEnvironmentName()
protected String	getHostForDefaultPublicServerSchemeHostPort()
int	getHttpServerPort()
String	getHttpsKeyStoreKeyPass()
String	getHttpsKeyStorePath()
String	getHttpsKeyStoreStorePass()
String	getHttpsKeyStoreType()
int	getHttpsServerPort()
int	getJsonPathArrayIndexMax()
int	getKeyMaxLengthWhenConvertingMapToJsonObject()
int	getMaxNumberOfKeysWhenConvertingMapToJsonObject()
String	getPublicServerHost()
int	getPublicServerPort()
String	getPublicServerScheme() Three of the rare "final" methods in Spincast!
protected URI	getPublicURI()
String	getPublicUrlBase() You should override this config!!!!
String	getQueryParamFlashMessageId()
int	getRouteForwardingMaxNumber()
String	getServerHost()
long	getServerMaxRequestBodyBytes()
String	getSpincastModelRootVariableName()
protected String	getSpincastWritableDirPath() The path to the writable directory.
File	getTempDir()
String	getValidationElementDefaultName()
File	getWritableRootDir() Will call getSpincastWritableDirPath() to get the path to use for the writable directory.
protected void	init()
boolean	isAddDefaultTemplateVariablesFilter()
boolean	isDebugEnabled()
boolean	isDefaultRouteCacheFilterPrivate()
boolean	isEnableCookiesValidator()
boolean	isRoutesCaseSensitive()
boolean	isValidateLocalhostHost()
boolean	isWriteToDiskDynamicStaticResource()

Methods inherited from class org.spincast.plugins.config.ConfigFinder

clearPrefixes, configure, expandMap, getAppJarDirectory, getAppRootDirectoryNoJar, getBigDecimal, getBigDecimal, getBigDecimalFromElement, getBigDecimalList, getBigDecimalList, getBoolean, getBoolean, getBooleanFromElement, getBooleanList, getBooleanList, getClasspathFilePath, getConfig, getConfig, getConfigFromMap, getConfigFromMap, getConfigList, getConfigList, getConfigs, getDate, getDate, getDateFromElement, getDateList, getDateList, getEnvironmentVariables, getEnvironmentVariablesConfigs, getEnvironmentVariablesPrefixes, getExternalFilePath, getInteger, getInteger, getIntegerFromElement, getIntegerList, getIntegerList, getLong, getLong, getLongFromElement, getLongList, getLongList, getMap, getMap, getMapList, getMapList, getRawConfig, getRawConfigs, getString, getString, getStringList, getStringList, getSystemPropertiesConfigs, getSystemPropertiesPrefixes, isEnvironmentVariablesStripPrefix, isExternalFileConfigsOverrideEnvironmentVariables, isSystemPropertiesStripPrefix, isThrowExceptionIfSpecifiedClasspathConfigFileIsNotFound, isThrowExceptionIfSpecifiedExternalConfigFileIsNotFound, loadYamlFileConfigs, mergeMaps

Methods inherited from class java.lang.Object

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

Field Detail

ENVIRONMENT_NAME_DEFAULT

public static final String ENVIRONMENT_NAME_DEFAULT

See Also:

Constant Field Values

Constructor Detail

SpincastConfigDefault

@Inject
protected SpincastConfigDefault(SpincastConfigPluginConfig spincastConfigPluginConfig)

Constructor

Method Detail

init

@Inject
protected void init()

getEnvironmentName

public String getEnvironmentName()

Specified by:

getEnvironmentName in interface SpincastConfig

getHttpServerPort

public int getHttpServerPort()

Specified by:

getHttpServerPort in interface SpincastConfig

getHttpsServerPort

public int getHttpsServerPort()

Specified by:

getHttpsServerPort in interface SpincastConfig

getHttpsKeyStorePath

public String getHttpsKeyStorePath()

Specified by:

getHttpsKeyStorePath in interface SpincastConfig

getHttpsKeyStoreType

public String getHttpsKeyStoreType()

Specified by:

getHttpsKeyStoreType in interface SpincastConfig

getHttpsKeyStoreStorePass

public String getHttpsKeyStoreStorePass()

Specified by:

getHttpsKeyStoreStorePass in interface SpincastConfig

getHttpsKeyStoreKeyPass

public String getHttpsKeyStoreKeyPass()

Specified by:

getHttpsKeyStoreKeyPass in interface SpincastConfig

getPublicURI

protected URI getPublicURI()

getPublicServerScheme

public final String getPublicServerScheme()

Three of the rare "final" methods in Spincast!

Specified by:

getPublicServerScheme in interface SpincastConfig

getPublicServerHost

public final String getPublicServerHost()

Specified by:

getPublicServerHost in interface SpincastConfig

getPublicServerPort

public final int getPublicServerPort()

Specified by:

getPublicServerPort in interface SpincastConfig

getPublicUrlBase

public String getPublicUrlBase()

You should override this config!!!!

Specified by:

getPublicUrlBase in interface SpincastConfig

getHostForDefaultPublicServerSchemeHostPort

protected String getHostForDefaultPublicServerSchemeHostPort()

getServerHost

public String getServerHost()

Specified by:

getServerHost in interface SpincastConfig

isDebugEnabled

public boolean isDebugEnabled()

Specified by:

isDebugEnabled in interface SpincastConfig

isRoutesCaseSensitive

public boolean isRoutesCaseSensitive()

Specified by:

isRoutesCaseSensitive in interface SpincastConfig

getServerMaxRequestBodyBytes

public long getServerMaxRequestBodyBytes()

Specified by:

getServerMaxRequestBodyBytes in interface SpincastConfig

getContentTypesToSkipGziping

public List<String> getContentTypesToSkipGziping()

Specified by:

getContentTypesToSkipGziping in interface SpincastConfig

getWritableRootDir

public File getWritableRootDir()

Will call getSpincastWritableDirPath() to get the path to use for the writable directory. If this method returns null, a directory will be created under the java.io.tmpdir directory.

Specified by:

getWritableRootDir in interface SpincastConfig

getTempDir

public File getTempDir()

Specified by:

getTempDir in interface SpincastConfig

getSpincastWritableDirPath

protected String getSpincastWritableDirPath()

The path to the writable directory.

The path can be relative or absolute.

Returns:

the path or null to use the default location (using the "java.io.tmpdir" folder).

getDefaultLocale

public Locale getDefaultLocale()

Specified by:

getDefaultLocale in interface SpincastConfig

getDefaultTimeZone

public TimeZone getDefaultTimeZone()

Specified by:

getDefaultTimeZone in interface SpincastConfig

getRouteForwardingMaxNumber

public int getRouteForwardingMaxNumber()

Specified by:

getRouteForwardingMaxNumber in interface SpincastConfig

getDefaultRouteCacheFilterSecondsNbr

public int getDefaultRouteCacheFilterSecondsNbr()

Specified by:

getDefaultRouteCacheFilterSecondsNbr in interface SpincastConfig

isDefaultRouteCacheFilterPrivate

public boolean isDefaultRouteCacheFilterPrivate()

Specified by:

isDefaultRouteCacheFilterPrivate in interface SpincastConfig

getDefaultRouteCacheFilterSecondsNbrCdns

public Integer getDefaultRouteCacheFilterSecondsNbrCdns()

Specified by:

getDefaultRouteCacheFilterSecondsNbrCdns in interface SpincastConfig

isWriteToDiskDynamicStaticResource

public boolean isWriteToDiskDynamicStaticResource()

Specified by:

isWriteToDiskDynamicStaticResource in interface SpincastConfig

isAddDefaultTemplateVariablesFilter

public boolean isAddDefaultTemplateVariablesFilter()

Specified by:

isAddDefaultTemplateVariablesFilter in interface SpincastConfig

getDefaultTemplateVariablesFilterPosition

public int getDefaultTemplateVariablesFilterPosition()

Specified by:

getDefaultTemplateVariablesFilterPosition in interface SpincastConfig

getDefaultStaticResourceCacheConfig

public StaticResourceCacheConfig getDefaultStaticResourceCacheConfig(boolean isDynamicResource)

Specified by:

getDefaultStaticResourceCacheConfig in interface SpincastConfig

getMaxNumberOfKeysWhenConvertingMapToJsonObject

public int getMaxNumberOfKeysWhenConvertingMapToJsonObject()

Specified by:

getMaxNumberOfKeysWhenConvertingMapToJsonObject in interface SpincastConfig

getKeyMaxLengthWhenConvertingMapToJsonObject

public int getKeyMaxLengthWhenConvertingMapToJsonObject()

Specified by:

getKeyMaxLengthWhenConvertingMapToJsonObject in interface SpincastConfig

getJsonPathArrayIndexMax

public int getJsonPathArrayIndexMax()

Specified by:

getJsonPathArrayIndexMax in interface SpincastConfig

isValidateLocalhostHost

public boolean isValidateLocalhostHost()

Specified by:

isValidateLocalhostHost in interface SpincastConfig

isEnableCookiesValidator

public boolean isEnableCookiesValidator()

Specified by:

isEnableCookiesValidator in interface SpincastConfig

getQueryParamFlashMessageId

public String getQueryParamFlashMessageId()

Specified by:

getQueryParamFlashMessageId in interface SpincastConfig

getCookieNameFlashMessage

public String getCookieNameFlashMessage()

Specified by:

getCookieNameFlashMessage in interface SpincastConfig

getCookieNameLocale

public String getCookieNameLocale()

Specified by:

getCookieNameLocale in interface SpincastConfig

getCookieNameTimeZoneId

public String getCookieNameTimeZoneId()

Specified by:

getCookieNameTimeZoneId in interface SpincastConfig

getCookiesValidatorCookieName

public String getCookiesValidatorCookieName()

Specified by:

getCookiesValidatorCookieName in interface SpincastConfig

getSpincastModelRootVariableName

public String getSpincastModelRootVariableName()

Specified by:

getSpincastModelRootVariableName in interface SpincastConfig

getValidationElementDefaultName

public String getValidationElementDefaultName()

Specified by:

getValidationElementDefaultName in interface SpincastConfig

getDictionaryEntryNotFoundBehavior

public DictionaryEntryNotFoundBehavior getDictionaryEntryNotFoundBehavior()

Specified by:

getDictionaryEntryNotFoundBehavior in interface SpincastConfig