Index

A B C E G I L M O P R S T
All Classes and Interfaces|All Packages|Constant Field Values

A

apply(Module) - Method in class org.spincast.plugins.config.SpincastConfigPlugin

B

build() - Method in class org.spincast.plugins.config.ConfigFinder.ConfigFinderBuilder

C

classpathFile(String) - Method in class org.spincast.plugins.config.ConfigFinder.ConfigFinderBuilder

A .yaml config file to search on the classpath.

clearPrefixes(List<String>) - Method in class org.spincast.plugins.config.ConfigFinder

CONFIG_FILE_NAME_DEFAULT - Static variable in class org.spincast.plugins.config.SpincastConfigPluginConfigDefault

ConfigFinder - Class in org.spincast.plugins.config

ConfigFinder(String, String, List<String>, boolean, List<String>, boolean, boolean, boolean, boolean) - Constructor for class org.spincast.plugins.config.ConfigFinder

This component is not part of the Guice context because you can very easily created circular dependencies with configurations since they are used everywhere.

ConfigFinder.ConfigFinderBuilder - Class in org.spincast.plugins.config

ConfigFinderBuilder() - Constructor for class org.spincast.plugins.config.ConfigFinder.ConfigFinderBuilder

configs - Variable in class org.spincast.plugins.config.ConfigFinder

configure() - Static method in class org.spincast.plugins.config.ConfigFinder

configure() - Method in class org.spincast.plugins.config.SpincastConfigPluginModule

E

ENVIRONMENT_NAME_DEFAULT - Static variable in class org.spincast.plugins.config.SpincastConfigDefault

environmentVariablesPrefixes(List<String>) - Method in class org.spincast.plugins.config.ConfigFinder.ConfigFinderBuilder

The allowed prefixes an environment variable can have to be used as a configuration.

environmentVariablesStripPrefix(boolean) - Method in class org.spincast.plugins.config.ConfigFinder.ConfigFinderBuilder

Should the prefix of an environment variable be stripped? For example, if ConfigFinder.ConfigFinderBuilder.environmentVariablesPrefixes indicate that "app." is an environment variable prefix, then "app.admin.email" would result in a "admin.email" key.

expandMap(Map<String, Object>) - Method in class org.spincast.plugins.config.ConfigFinder

Parses the keys of the map as "dotted paths" and created an expanded Map from them.

externalFile(String) - Method in class org.spincast.plugins.config.ConfigFinder.ConfigFinderBuilder

A .yaml config file to search to be found outside the application.

externalFile(String, boolean) - Method in class org.spincast.plugins.config.ConfigFinder.ConfigFinderBuilder

A .yaml config file to search to be found outside the application.

G

getAppJarDirectory() - Method in class org.spincast.plugins.config.ConfigFinder

If the project is running from an executable .jar file, this will return the directory containing this .jar file.

getAppRootDirectoryNoJar() - Method in class org.spincast.plugins.config.ConfigFinder

If the project is not running from an executable .jar file, this will return the root directory of the project on the file system.

getBigDecimal(String) - Method in class org.spincast.plugins.config.ConfigFinder

getBigDecimal(String, BigDecimal) - Method in class org.spincast.plugins.config.ConfigFinder

getBigDecimalFromElement(Object) - Method in class org.spincast.plugins.config.ConfigFinder

getBigDecimalList(String) - Method in class org.spincast.plugins.config.ConfigFinder

getBigDecimalList(String, List<BigDecimal>) - Method in class org.spincast.plugins.config.ConfigFinder

getBoolean(String) - Method in class org.spincast.plugins.config.ConfigFinder

getBoolean(String, Boolean) - Method in class org.spincast.plugins.config.ConfigFinder

getBooleanFromElement(Object) - Method in class org.spincast.plugins.config.ConfigFinder

getBooleanList(String) - Method in class org.spincast.plugins.config.ConfigFinder

getBooleanList(String, List<Boolean>) - Method in class org.spincast.plugins.config.ConfigFinder

getClasspathFilePath() - Method in class org.spincast.plugins.config.ConfigFinder

getClasspathFilePath() - Method in interface org.spincast.plugins.config.SpincastConfigPluginConfig

The path to a configuration file to load from the classpath.

getClasspathFilePath() - Method in class org.spincast.plugins.config.SpincastConfigPluginConfigDefault

getConfig(String) - Method in class org.spincast.plugins.config.ConfigFinder

getConfig(String, Object) - Method in class org.spincast.plugins.config.ConfigFinder

Gets an untype config from the config map.

getConfigFromMap(Map<String, Object>, String) - Method in class org.spincast.plugins.config.ConfigFinder

Gets a config from the given Map.

getConfigFromMap(Map<String, Object>, String, Object) - Method in class org.spincast.plugins.config.ConfigFinder

Gets a config from the given Map.

getConfigImplClass() - Method in class org.spincast.plugins.config.SpincastConfigPluginModule

getConfigList(String) - Method in class org.spincast.plugins.config.ConfigFinder

getConfigList(String, List<?>) - Method in class org.spincast.plugins.config.ConfigFinder

getConfigs() - Method in class org.spincast.plugins.config.ConfigFinder

getContentTypesToSkipGziping() - Method in class org.spincast.plugins.config.SpincastConfigDefault

getCookieNameFlashMessage() - Method in class org.spincast.plugins.config.SpincastConfigDefault

getCookieNameLocale() - Method in class org.spincast.plugins.config.SpincastConfigDefault

getCookieNameTimeZoneId() - Method in class org.spincast.plugins.config.SpincastConfigDefault

getCookiesValidatorCookieName() - Method in class org.spincast.plugins.config.SpincastConfigDefault

getDate(String) - Method in class org.spincast.plugins.config.ConfigFinder

getDate(String, Date) - Method in class org.spincast.plugins.config.ConfigFinder

getDateFromElement(Object) - Method in class org.spincast.plugins.config.ConfigFinder

getDateList(String) - Method in class org.spincast.plugins.config.ConfigFinder

getDateList(String, List<Date>) - Method in class org.spincast.plugins.config.ConfigFinder

getDefaultConfigImplClass() - Method in class org.spincast.plugins.config.SpincastConfigPluginModule

getDefaultLocale() - Method in class org.spincast.plugins.config.SpincastConfigDefault

getDefaultRouteCacheFilterSecondsNbr() - Method in class org.spincast.plugins.config.SpincastConfigDefault

getDefaultRouteCacheFilterSecondsNbrCdns() - Method in class org.spincast.plugins.config.SpincastConfigDefault

getDefaultStaticResourceCacheConfig(boolean) - Method in class org.spincast.plugins.config.SpincastConfigDefault

getDefaultTemplateVariablesFilterPosition() - Method in class org.spincast.plugins.config.SpincastConfigDefault

getDefaultTimeZone() - Method in class org.spincast.plugins.config.SpincastConfigDefault

getDictionaryEntryNotFoundBehavior() - Method in class org.spincast.plugins.config.SpincastConfigDefault

getEnvironmentName() - Method in class org.spincast.plugins.config.SpincastConfigDefault

getEnvironmentVariables() - Method in class org.spincast.plugins.config.ConfigFinder

getEnvironmentVariablesConfigs() - Method in class org.spincast.plugins.config.ConfigFinder

getEnvironmentVariablesPrefixes() - Method in class org.spincast.plugins.config.ConfigFinder

getEnvironmentVariablesPrefixes() - Method in interface org.spincast.plugins.config.SpincastConfigPluginConfig

The allowed prefixes an environment variable can have to be used as a configuration.

getEnvironmentVariablesPrefixes() - Method in class org.spincast.plugins.config.SpincastConfigPluginConfigDefault

getExternalFilePath() - Method in class org.spincast.plugins.config.ConfigFinder

getExternalFilePath() - Method in interface org.spincast.plugins.config.SpincastConfigPluginConfig

The path to a configuration file to load from the file system.

getExternalFilePath() - Method in class org.spincast.plugins.config.SpincastConfigPluginConfigDefault

getHostForDefaultPublicServerSchemeHostPort() - Method in class org.spincast.plugins.config.SpincastConfigDefault

getHttpServerPort() - Method in class org.spincast.plugins.config.SpincastConfigDefault

getHttpsKeyStoreKeyPass() - Method in class org.spincast.plugins.config.SpincastConfigDefault

getHttpsKeyStorePath() - Method in class org.spincast.plugins.config.SpincastConfigDefault

getHttpsKeyStoreStorePass() - Method in class org.spincast.plugins.config.SpincastConfigDefault

getHttpsKeyStoreType() - Method in class org.spincast.plugins.config.SpincastConfigDefault

getHttpsServerPort() - Method in class org.spincast.plugins.config.SpincastConfigDefault

getId() - Method in class org.spincast.plugins.config.SpincastConfigPlugin

getInteger(String) - Method in class org.spincast.plugins.config.ConfigFinder

getInteger(String, Integer) - Method in class org.spincast.plugins.config.ConfigFinder

getIntegerFromElement(Object) - Method in class org.spincast.plugins.config.ConfigFinder

getIntegerList(String) - Method in class org.spincast.plugins.config.ConfigFinder

getIntegerList(String, List<Integer>) - Method in class org.spincast.plugins.config.ConfigFinder

getJsonPathArrayIndexMax() - Method in class org.spincast.plugins.config.SpincastConfigDefault

getKeyMaxLengthWhenConvertingMapToJsonObject() - Method in class org.spincast.plugins.config.SpincastConfigDefault

getLong(String) - Method in class org.spincast.plugins.config.ConfigFinder

getLong(String, Long) - Method in class org.spincast.plugins.config.ConfigFinder

getLongFromElement(Object) - Method in class org.spincast.plugins.config.ConfigFinder

getLongList(String) - Method in class org.spincast.plugins.config.ConfigFinder

getLongList(String, List<Long>) - Method in class org.spincast.plugins.config.ConfigFinder

getMap(String) - Method in class org.spincast.plugins.config.ConfigFinder

getMap(String, Map<String, Object>) - Method in class org.spincast.plugins.config.ConfigFinder

getMapList(String) - Method in class org.spincast.plugins.config.ConfigFinder

getMapList(String, List<Map<String, Object>>) - Method in class org.spincast.plugins.config.ConfigFinder

getMaxNumberOfKeysWhenConvertingMapToJsonObject() - Method in class org.spincast.plugins.config.SpincastConfigDefault

getPluginModule(Class<? extends SpincastConfig>) - Method in class org.spincast.plugins.config.SpincastConfigPlugin

getPublicServerHost() - Method in class org.spincast.plugins.config.SpincastConfigDefault

getPublicServerPort() - Method in class org.spincast.plugins.config.SpincastConfigDefault

getPublicServerScheme() - Method in class org.spincast.plugins.config.SpincastConfigDefault

Three of the rare "final" methods in Spincast!

getPublicURI() - Method in class org.spincast.plugins.config.SpincastConfigDefault

getPublicUrlBase() - Method in class org.spincast.plugins.config.SpincastConfigDefault

You should override this config!!!!

getQueryParamFlashMessageId() - Method in class org.spincast.plugins.config.SpincastConfigDefault

getRawConfig(String) - Method in class org.spincast.plugins.config.ConfigFinder

Gets a config from the raw Map.

getRawConfigs() - Method in class org.spincast.plugins.config.ConfigFinder

Get raw configs, as a Map

getRouteForwardingMaxNumber() - Method in class org.spincast.plugins.config.SpincastConfigDefault

getServerHost() - Method in class org.spincast.plugins.config.SpincastConfigDefault

getServerMaxRequestBodyBytes() - Method in class org.spincast.plugins.config.SpincastConfigDefault

getSpecificConfigImplClass() - Method in class org.spincast.plugins.config.SpincastConfigPluginModule

getSpincastModelRootVariableName() - Method in class org.spincast.plugins.config.SpincastConfigDefault

getSpincastWritableDirPath() - Method in class org.spincast.plugins.config.SpincastConfigDefault

The path to the writable directory.

getString(String) - Method in class org.spincast.plugins.config.ConfigFinder

getString(String, String) - Method in class org.spincast.plugins.config.ConfigFinder

getStringList(String) - Method in class org.spincast.plugins.config.ConfigFinder

getStringList(String, List<String>) - Method in class org.spincast.plugins.config.ConfigFinder

getSystemPropertiesConfigs() - Method in class org.spincast.plugins.config.ConfigFinder

getSystemPropertiesPrefixes() - Method in class org.spincast.plugins.config.ConfigFinder

getSystemPropertiesPrefixes() - Method in interface org.spincast.plugins.config.SpincastConfigPluginConfig

The allowed prefixes a system property can have to be used as a configuration.

getSystemPropertiesPrefixes() - Method in class org.spincast.plugins.config.SpincastConfigPluginConfigDefault

getTempDir() - Method in class org.spincast.plugins.config.SpincastConfigDefault

getValidationElementDefaultName() - Method in class org.spincast.plugins.config.SpincastConfigDefault

getWritableRootDir() - Method in class org.spincast.plugins.config.SpincastConfigDefault

Will call SpincastConfigDefault.getSpincastWritableDirPath() to get the path to use for the writable directory.

I

init() - Method in class org.spincast.plugins.config.SpincastConfigDefault

isAddDefaultTemplateVariablesFilter() - Method in class org.spincast.plugins.config.SpincastConfigDefault

isDefaultRouteCacheFilterPrivate() - Method in class org.spincast.plugins.config.SpincastConfigDefault

isDevelopmentMode() - Method in class org.spincast.plugins.config.SpincastConfigDefault

isEnableCookiesValidator() - Method in class org.spincast.plugins.config.SpincastConfigDefault

isEnableHttp2() - Method in class org.spincast.plugins.config.SpincastConfigDefault

isEnvironmentVariablesStripPrefix() - Method in class org.spincast.plugins.config.ConfigFinder

isEnvironmentVariablesStripPrefix() - Method in interface org.spincast.plugins.config.SpincastConfigPluginConfig

Should the prefix of an environment variable be stripped? For example, if #environmentVariablesPrefixes indicates that "app." is an environment variable prefix, then "app.admin.email" will result in a "admin.email" key.

isEnvironmentVariablesStripPrefix() - Method in class org.spincast.plugins.config.SpincastConfigPluginConfigDefault

isExternalFileConfigsOverrideEnvironmentVariables() - Method in class org.spincast.plugins.config.ConfigFinder

isExternalFileConfigsOverrideEnvironmentVariables() - Method in interface org.spincast.plugins.config.SpincastConfigPluginConfig

If an external configuration file is used and environment variables too, should configurations from the file override those from environment variables?

isExternalFileConfigsOverrideEnvironmentVariables() - Method in class org.spincast.plugins.config.SpincastConfigPluginConfigDefault

isRoutesCaseSensitive() - Method in class org.spincast.plugins.config.SpincastConfigDefault

isSystemPropertiesStripPrefix() - Method in class org.spincast.plugins.config.ConfigFinder

isSystemPropertiesStripPrefix() - Method in interface org.spincast.plugins.config.SpincastConfigPluginConfig

Should the prefix of an system property be stripped? For example, if #systemPropertiesPrefixes indicates that "app." is an system property prefix, then "app.admin.email" will result in a "admin.email" key.

isSystemPropertiesStripPrefix() - Method in class org.spincast.plugins.config.SpincastConfigPluginConfigDefault

isTestingMode() - Method in class org.spincast.plugins.config.SpincastConfigDefault

isThrowExceptionIfSpecifiedClasspathConfigFileIsNotFound() - Method in class org.spincast.plugins.config.ConfigFinder

isThrowExceptionIfSpecifiedClasspathConfigFileIsNotFound() - Method in interface org.spincast.plugins.config.SpincastConfigPluginConfig

Should an exception be thrown if a classpath config file is specified (is not null) but is not found.

isThrowExceptionIfSpecifiedClasspathConfigFileIsNotFound() - Method in class org.spincast.plugins.config.SpincastConfigPluginConfigDefault

isThrowExceptionIfSpecifiedExternalConfigFileIsNotFound() - Method in class org.spincast.plugins.config.ConfigFinder

isThrowExceptionIfSpecifiedExternalConfigFileIsNotFound() - Method in interface org.spincast.plugins.config.SpincastConfigPluginConfig

Should an exception be thrown if an external config file is specified (is not null) but is not found.

isThrowExceptionIfSpecifiedExternalConfigFileIsNotFound() - Method in class org.spincast.plugins.config.SpincastConfigPluginConfigDefault

isValidateLocalhostHost() - Method in class org.spincast.plugins.config.SpincastConfigDefault

isWriteToDiskDynamicStaticResource() - Method in class org.spincast.plugins.config.SpincastConfigDefault

L

loadYamlFileConfigs(File, Yaml) - Method in class org.spincast.plugins.config.ConfigFinder

logger - Static variable in class org.spincast.plugins.config.ConfigFinder

M

mergeMaps(Map<String, Object>, Map<String, Object>) - Method in class org.spincast.plugins.config.ConfigFinder

Merges two maps : The elements from the second map override the elements of the first map of the same path, except for Map elements which are merged.

O

org.spincast.plugins.config - package org.spincast.plugins.config

P

PLUGIN_ID - Static variable in class org.spincast.plugins.config.SpincastConfigPlugin

PREFIX_DEFAULT - Static variable in class org.spincast.plugins.config.SpincastConfigPluginConfigDefault

R

rawConfigs - Variable in class org.spincast.plugins.config.ConfigFinder

S

SpincastConfigDefault - Class in org.spincast.plugins.config

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.

SpincastConfigDefault(SpincastConfigPluginConfig, boolean) - Constructor for class org.spincast.plugins.config.SpincastConfigDefault

Constructor

SpincastConfigPlugin - Class in org.spincast.plugins.config

SpincastConfigPlugin() - Constructor for class org.spincast.plugins.config.SpincastConfigPlugin

SpincastConfigPluginConfig - Interface in org.spincast.plugins.config

Configurations for the Spincast Config plugin.

SpincastConfigPluginConfigDefault - Class in org.spincast.plugins.config

Default configuration for the Spincast Config plugin.

SpincastConfigPluginConfigDefault() - Constructor for class org.spincast.plugins.config.SpincastConfigPluginConfigDefault

SpincastConfigPluginModule - Class in org.spincast.plugins.config

Guice module for the Spincast Config Plugin.

SpincastConfigPluginModule() - Constructor for class org.spincast.plugins.config.SpincastConfigPluginModule

SpincastConfigPluginModule(Class<? extends SpincastConfig>) - Constructor for class org.spincast.plugins.config.SpincastConfigPluginModule

SpincastConfigPluginModule(Class<? extends RequestContext<?>>, Class<? extends WebsocketContext<?>>) - Constructor for class org.spincast.plugins.config.SpincastConfigPluginModule

SpincastConfigPluginModule(Class<? extends RequestContext<?>>, Class<? extends WebsocketContext<?>>, Class<? extends SpincastConfig>) - Constructor for class org.spincast.plugins.config.SpincastConfigPluginModule

systemPropertiesPrefixes(List<String>) - Method in class org.spincast.plugins.config.ConfigFinder.ConfigFinderBuilder

The allowed prefixes a system property can have to be used as a configuration.

systemPropertiesStripPrefix(boolean) - Method in class org.spincast.plugins.config.ConfigFinder.ConfigFinderBuilder

Should the prefix of an system property be stripped? For example, if ConfigFinder.ConfigFinderBuilder.systemPropertiesPrefixes indicate that "app." is an system property prefix, then "app.admin.email" would result in a "admin.email" key.

T

throwExceptionIfSpecifiedClasspathConfigFileIsNotFound(boolean) - Method in class org.spincast.plugins.config.ConfigFinder.ConfigFinderBuilder

Should an exception be thrown if a classpath config file is specified (is not null) but is not found.

throwExceptionIfSpecifiedExternalConfigFileIsNotFound(boolean) - Method in class org.spincast.plugins.config.ConfigFinder.ConfigFinderBuilder

Should an exception be thrown if an external config file is specified (is not null) but is not found.

A B C E G I L M O P R S T
All Classes and Interfaces|All Packages|Constant Field Values