SpincastConfigDefault (org.spincast:spincast-framework 0.9.29 API)

java.lang.Object
- org.spincast.plugins.config.SpincastConfigDefault

All Implemented Interfaces:

SpincastConfig

Direct Known Subclasses:

SpincastConfigPropsFileBased, SpincastTestConfig
```
public class SpincastConfigDefault
extends Object
implements SpincastConfig
```

Field Summary

Fields
Modifier and Type Field and Description

static String ENVIRONMENT_NAME_DEFAULT

Fields
Modifier and Type	Field and Description
`static String`	`ENVIRONMENT_NAME_DEFAULT`

Constructor Summary

Constructors
Constructor and Description

SpincastConfigDefault()

Constructors
Constructor and Description
`SpincastConfigDefault()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`cleanWritableSpincastDir(File spincastTempDir)`
`List<String>`	`getContentTypesToSkipGziping()` Even if gziping of the response is enabled, those Content-Types still won't be gzipped.
`String`	`getCookieNameFlashMessage()` Name of the Cookie to to use save a Flash Message id.
`String`	`getCookieNameLocale()` Name of the Cookie to use to save the user `Locale`.
`String`	`getCookiesValidatorCookieName()` Name of the Cookie to use to validate if cookies are enabled.
`Locale`	`getDefaultLocale()` The default Locale to use if no other Locale can be found as a "best match", for the current request.
`int`	`getDefaultRouteCacheFilterSecondsNbr()` When using the `.cache()` method on a route builder, this is the default number of seconds to use.
`Integer`	`getDefaultRouteCacheFilterSecondsNbrCdns()` When using the `.cache()` method on a route builder, this is the default number of seconds to use by the CDNs.
`StaticResourceCacheConfig`	`getDefaultStaticResourceCacheConfig(boolean isDynamicResource)` The default cache configurations for the static resource.
`int`	`getDefaultTemplateVariablesFilterPosition()` If `addGlobalTemplateVariablesAdderFilter` erturns `true`, then this is the position at which the filter will be added.
`String`	`getEnvironmentName()` Returns the name of the environment.
`protected String`	`getHostForDefaultPublicServerSchemeHostPort()`
`int`	`getHttpServerPort()` The HTTP (unsecure) port on which the server will listen on.
`String`	`getHttpsKeyStoreKeypass()` The "keypass" of the `KeyStore`, for SSL.
`String`	`getHttpsKeyStorePath()` The path to the `KeyStore`, for SSL.
`String`	`getHttpsKeyStoreStorePass()` The "storepass" of the `KeyStore`, for SSL.
`String`	`getHttpsKeyStoreType()` The type of the `KeyStore`, for SSL.
`int`	`getHttpsServerPort()` The HTTPS (secure) port on which the server will listen on.
`int`	`getJsonPathArrayIndexMax()` Gets the maximum index of an element of an array, when parsing a `JsonPath`.
`int`	`getKeyMaxLengthWhenConvertingMapToJsonObject()` Gets the maximum length of a `key` in a Map that can be parsed as `JsonPaths` using the `create` method.
`int`	`getMaxNumberOfKeysWhenConvertingMapToJsonObject()` Gets the maximum number of `keys` in a Map that can be parsed as `JsonPaths` to create a `JsonObject`.
`String`	`getPublicServerHost()` The public host
`int`	`getPublicServerPort()` The public port
`String`	`getPublicServerScheme()` Three of the rare "final" methods in Spincast!
`String`	`getPublicServerSchemeHostPort()` You should override this config!!!!
`protected URI`	`getPubliURI()`
`String`	`getQueryParamFlashMessageId()` The name of the queryString parameter to use for a Flash Message id, when cookies are not available.
`int`	`getRouteForwardingMaxNumber()` The maximum number of time a request can be forwarded to another route.
`String`	`getServerHost()` The host/IP on which the server will listen to.
`long`	`getServerMaxRequestBodyBytes()` Maximum number of bytes a request's body can have.
`String`	`getSpincastModelRootVariableName()` Name of the root variables reserved for Spincast in the response's model.
`protected String`	`getSpincastTempDirName()`
`File`	`getSpincastWritableDir()` A directory where temporary generated files can be written by Spincast.
`boolean`	`isAddDefaultTemplateVariablesFilter()` Should the GlobalTemplateVariablesAdderFilter be automatically added to all routes?
`boolean`	`isDebugEnabled()` Let this to `true` on development environment, where errors can be publicly displayed, where cache can be disabled, etc.
`boolean`	`isDefaultRouteCacheFilterPrivate()` When using the `.cache()` method on a route builder, is the cache private by default?
`boolean`	`isDisableWriteToDiskDynamicStaticResource()` If `true`, the dynamic resources (static resource which have a generator in case they don't exist) won't be saved to disk.
`boolean`	`isEnableCookiesValidator()` If `true`, Spincast will always try to set a cookie to validate if cookies are enabled on the client.
`boolean`	`isRoutesCaseSensitive()` Are the URLS case-sensitive or not, during the route matching process? The default value is `false`.
`boolean`	`isValidateLocalhostHost()` By default, if `SpincastConfig.getPublicServerHost()` returns `"localhost"`, `SpincastConfig.getEnvironmentName()` is not `"local"` and `SpincastConfig.isDebugEnabled()` is false, an exception is thrown when the application starts.

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
```
public SpincastConfigDefault()
```
- Method Detail
  - getEnvironmentName
```
public String getEnvironmentName()
```
    Description copied from interface: SpincastConfig
    
    Returns the name of the environment. The default value is local.
    
    Specified by:
    
    getEnvironmentName in interface SpincastConfig
    
    Returns:
    
    the name of the environment
  - getHttpServerPort
```
public int getHttpServerPort()
```
    Description copied from interface: SpincastConfig
    
    The HTTP (unsecure) port on which the server will listen on. If <= 0, it won't be used. The default value is 44419 so HTTP is enabled by default.
    
    Specified by:
    
    getHttpServerPort in interface SpincastConfig
    
    Returns:
    
    the HTTP port
  - getHttpsServerPort
```
public int getHttpsServerPort()
```
    Description copied from interface: SpincastConfig
    
    The HTTPS (secure) port on which the server will listen on. If <= 0, it won't be used. The default value is -1 so HTTPS is not enabled by default.
    
    Specified by:
    
    getHttpsServerPort in interface SpincastConfig
    
    Returns:
    
    the HTTPS port
  - getHttpsKeyStorePath
```
public String getHttpsKeyStorePath()
```
    Description copied from interface: SpincastConfig
    
    The path to the KeyStore, for SSL. Can be a classpath path or and absolute path. The classpath will be checked first. Only used if getHttpsServerPort() returns a port > 0. The default value is null.
    
    Specified by:
    
    getHttpsKeyStorePath in interface SpincastConfig
    
    Returns:
    
    the path to the KeyStore
  - getHttpsKeyStoreType
```
public String getHttpsKeyStoreType()
```
    Description copied from interface: SpincastConfig
    
    The type of the KeyStore, for SSL. For example: "JKS". Only used if getHttpsServerPort() returns a port > 0. The default value is null.
    
    Specified by:
    
    getHttpsKeyStoreType in interface SpincastConfig
    
    Returns:
    
    the type of the KeyStore
  - getHttpsKeyStoreStorePass
```
public String getHttpsKeyStoreStorePass()
```
    Description copied from interface: SpincastConfig
    
    The "storepass" of the KeyStore, for SSL. Only used if getHttpsServerPort() returns a port > 0. The default value is null.
    
    Specified by:
    
    getHttpsKeyStoreStorePass in interface SpincastConfig
    
    Returns:
    
    the "storepass" of the KeyStore
  - getHttpsKeyStoreKeypass
```
public String getHttpsKeyStoreKeypass()
```
    Description copied from interface: SpincastConfig
    
    The "keypass" of the KeyStore, for SSL. Only used if getHttpsServerPort() returns a port > 0. The default value is null.
    
    Specified by:
    
    getHttpsKeyStoreKeypass in interface SpincastConfig
    
    Returns:
    
    the "keypass" of the KeyStore
  - getPubliURI
```
protected URI getPubliURI()
```
  - getPublicServerScheme
```
public final String getPublicServerScheme()
```
    Three of the rare "final" methods in Spincast!
    
    Specified by:
    
    getPublicServerScheme in interface SpincastConfig
  - getPublicServerHost
```
public final String getPublicServerHost()
```
    Description copied from interface: SpincastConfig
    
    The public host
    
    Specified by:
    
    getPublicServerHost in interface SpincastConfig
  - getPublicServerPort
```
public final int getPublicServerPort()
```
    Description copied from interface: SpincastConfig
    
    The public port
    
    Specified by:
    
    getPublicServerPort in interface SpincastConfig
  - getPublicServerSchemeHostPort
```
public String getPublicServerSchemeHostPort()
```
    You should override this config!!!!
    
    Specified by:
    
    getPublicServerSchemeHostPort in interface SpincastConfig
  - getHostForDefaultPublicServerSchemeHostPort
```
protected String getHostForDefaultPublicServerSchemeHostPort()
```
  - getServerHost
```
public String getServerHost()
```
    Description copied from interface: SpincastConfig
    
    The host/IP on which the server will listen to. The default value is 0.0.0.0.
    
    Specified by:
    
    getServerHost in interface SpincastConfig
    
    Returns:
    
    the host/IP
  - isDebugEnabled
```
public boolean isDebugEnabled()
```
    Description copied from interface: SpincastConfig
    
    Let this to true on development environment, where errors can be publicly displayed, where cache can be disabled, etc. In production set it to false The default value is true.
    
    Specified by:
    
    isDebugEnabled in interface SpincastConfig
    
    Returns:
    
    true if debug mode is enabled.
  - isRoutesCaseSensitive
```
public boolean isRoutesCaseSensitive()
```
    Description copied from interface: SpincastConfig
    
    Are the URLS case-sensitive or not, during the route matching process? The default value is false.
    
    Specified by:
    
    isRoutesCaseSensitive in interface SpincastConfig
    
    Returns:
    
    if they are case-sensitive
    
    See Also:
    
    Should URL be case sensitive?
  - getServerMaxRequestBodyBytes
```
public long getServerMaxRequestBodyBytes()
```
    Description copied from interface: SpincastConfig
    
    Maximum number of bytes a request's body can have. "-1" means no limit. The default value is 104857600 (100MB).
    
    Specified by:
    
    getServerMaxRequestBodyBytes in interface SpincastConfig
    
    Returns:
    
    the maximum number of bytes
  - getContentTypesToSkipGziping
```
public List<String> getContentTypesToSkipGziping()
```
    Description copied from interface: SpincastConfig
    
    Even if gziping of the response is enabled, those Content-Types still won't be gzipped. If an entry ends with "*", it will be considered as a prefix (ex: "image/*" will match all Content-Types starting with "image/"). Otherwise, the current response Content-Type will have to exactly match the entry (case insensitive), or being followed by a " " or a ";".
    
    Specified by:
    
    getContentTypesToSkipGziping in interface SpincastConfig
    
    Returns:
    
    the Content-Types that shouldn't be gzipped.
  - getSpincastWritableDir
```
public File getSpincastWritableDir()
```
    Description copied from interface: SpincastConfig
    
    A directory where temporary generated files can be written by Spincast.
    This directory will be emptied each time the application starts.
    
    The default value uses System.getProperty("java.io.tmpdir") to create the directory.
    
    Specified by:
    
    getSpincastWritableDir in interface SpincastConfig
    
    Returns:
    
    a directory with write permissions for Spincast.
  - getSpincastTempDirName
```
protected String getSpincastTempDirName()
```
  - cleanWritableSpincastDir
```
protected void cleanWritableSpincastDir(File spincastTempDir)
```
  - getDefaultLocale
```
public Locale getDefaultLocale()
```
    Description copied from interface: SpincastConfig
    
    The default Locale to use if no other Locale can be found as a "best match", for the current request. The default value is Locale.US.
    
    Specified by:
    
    getDefaultLocale in interface SpincastConfig
    
    Returns:
    
    the default Locale
  - getRouteForwardingMaxNumber
```
public int getRouteForwardingMaxNumber()
```
    Description copied from interface: SpincastConfig
    
    The maximum number of time a request can be forwarded to another route. After this number, an exception will be thrown. The default value is 2.
    
    Specified by:
    
    getRouteForwardingMaxNumber in interface SpincastConfig
    
    Returns:
    
    the maximum number of time
  - getDefaultRouteCacheFilterSecondsNbr
```
public int getDefaultRouteCacheFilterSecondsNbr()
```
    Description copied from interface: SpincastConfig
    
    When using the .cache() method on a route builder, this is the default number of seconds to use.
    
    Specified by:
    
    getDefaultRouteCacheFilterSecondsNbr in interface SpincastConfig
  - isDefaultRouteCacheFilterPrivate
```
public boolean isDefaultRouteCacheFilterPrivate()
```
    Description copied from interface: SpincastConfig
    
    When using the .cache() method on a route builder, is the cache private by default?
    
    Specified by:
    
    isDefaultRouteCacheFilterPrivate in interface SpincastConfig
  - getDefaultRouteCacheFilterSecondsNbrCdns
```
public Integer getDefaultRouteCacheFilterSecondsNbrCdns()
```
    Description copied from interface: SpincastConfig
    
    When using the .cache() method on a route builder, this is the default number of seconds to use by the CDNs.
    
    Specified by:
    
    getDefaultRouteCacheFilterSecondsNbrCdns in interface SpincastConfig
  - isDisableWriteToDiskDynamicStaticResource
```
public boolean isDisableWriteToDiskDynamicStaticResource()
```
    Description copied from interface: SpincastConfig
    
    If true, the dynamic resources (static resource which have a generator in case they don't exist) won't be saved to disk. THhis means that the generator will always be called, so chnages during development will be picked up.
    
    Specified by:
    
    isDisableWriteToDiskDynamicStaticResource in interface SpincastConfig
  - isAddDefaultTemplateVariablesFilter
```
public boolean isAddDefaultTemplateVariablesFilter()
```
    Description copied from interface: SpincastConfig
    
    Should the GlobalTemplateVariablesAdderFilter be automatically added to all routes?
    This filter bind some default variables to be used by the templating engine.
    
    Specified by:
    
    isAddDefaultTemplateVariablesFilter in interface SpincastConfig
  - getDefaultTemplateVariablesFilterPosition
```
public int getDefaultTemplateVariablesFilterPosition()
```
    Description copied from interface: SpincastConfig
    
    If addGlobalTemplateVariablesAdderFilter erturns true, then this is the position at which the filter will be added.
    
    Specified by:
    
    getDefaultTemplateVariablesFilterPosition in interface SpincastConfig
  - getDefaultStaticResourceCacheConfig
```
public StaticResourceCacheConfig getDefaultStaticResourceCacheConfig(boolean isDynamicResource)
```
    Description copied from interface: SpincastConfig
    
    The default cache configurations for the static resource.
    This will be used if no cache(...) method is used when building the static resource's route.
    
    Specified by:
    
    getDefaultStaticResourceCacheConfig in interface SpincastConfig
    
    Parameters:
    
    isDynamicResource - if true, a generator is use when the resource doesn't exist. Those kind of generated resources may be modified more often then trully static resources, so we may want to use a different caching period.
    
    Returns:
    
    the default cache configuration to use or null so no cache headers are sent at all.
  - getMaxNumberOfKeysWhenConvertingMapToJsonObject
```
public int getMaxNumberOfKeysWhenConvertingMapToJsonObject()
```
    Description copied from interface: SpincastConfig
    
    Gets the maximum number of keys in a Map that can be parsed as JsonPaths to create a JsonObject.
    This maximum is to prevent malicious user to POST a very big number of keys and harm the server.
    
    Specified by:
    
    getMaxNumberOfKeysWhenConvertingMapToJsonObject in interface SpincastConfig
  - getKeyMaxLengthWhenConvertingMapToJsonObject
```
public int getKeyMaxLengthWhenConvertingMapToJsonObject()
```
    Description copied from interface: SpincastConfig
    
    Gets the maximum length of a key in a Map that can be parsed as JsonPaths using the create method.
    This maximum is to prevent malicious user to POST very long and complex keys and harm the server.
    
    Specified by:
    
    getKeyMaxLengthWhenConvertingMapToJsonObject in interface SpincastConfig
  - getJsonPathArrayIndexMax
```
public int getJsonPathArrayIndexMax()
```
    Description copied from interface: SpincastConfig
    
    Gets the maximum index of an element of an array, when parsing a JsonPath.
    
    Specified by:
    
    getJsonPathArrayIndexMax in interface SpincastConfig
  - isValidateLocalhostHost
```
public boolean isValidateLocalhostHost()
```
    Description copied from interface: SpincastConfig
    
    By default, if SpincastConfig.getPublicServerHost() returns "localhost", SpincastConfig.getEnvironmentName() is not "local" and SpincastConfig.isDebugEnabled() is false, an exception is thrown when the application starts.
    This validation is to make sure the developers didn't forget to override the SpincastConfig.getPublicServerSchemeHostPort() method when they release to a non local environment.
    You can disable this validation if you want.
    
    Specified by:
    
    isValidateLocalhostHost in interface SpincastConfig
  - isEnableCookiesValidator
```
public boolean isEnableCookiesValidator()
```
    Description copied from interface: SpincastConfig
    
    If true, Spincast will always try to set a cookie to validate if cookies are enabled on the client.
    
    Specified by:
    
    isEnableCookiesValidator in interface SpincastConfig
  - getQueryParamFlashMessageId
```
public String getQueryParamFlashMessageId()
```
    Description copied from interface: SpincastConfig
    
    The name of the queryString parameter to use for a Flash Message id, when cookies are not available.
    
    Specified by:
    
    getQueryParamFlashMessageId in interface SpincastConfig
  - getCookieNameFlashMessage
```
public String getCookieNameFlashMessage()
```
    Description copied from interface: SpincastConfig
    
    Name of the Cookie to to use save a Flash Message id.
    
    Specified by:
    
    getCookieNameFlashMessage in interface SpincastConfig
  - getCookieNameLocale
```
public String getCookieNameLocale()
```
    Description copied from interface: SpincastConfig
    
    Name of the Cookie to use to save the user Locale.
    
    Specified by:
    
    getCookieNameLocale in interface SpincastConfig
  - getCookiesValidatorCookieName
```
public String getCookiesValidatorCookieName()
```
    Description copied from interface: SpincastConfig
    
    Name of the Cookie to use to validate if cookies are enabled.
    
    Specified by:
    
    getCookiesValidatorCookieName in interface SpincastConfig
  - getSpincastModelRootVariableName
```
public String getSpincastModelRootVariableName()
```
    Description copied from interface: SpincastConfig
    
    Name of the root variables reserved for Spincast in the response's model.
    
    Specified by:
    
    getSpincastModelRootVariableName in interface SpincastConfig

Class SpincastConfigDefault

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

ENVIRONMENT_NAME_DEFAULT

Constructor Detail

SpincastConfigDefault

Method Detail

getEnvironmentName

getHttpServerPort

getHttpsServerPort

getHttpsKeyStorePath

getHttpsKeyStoreType

getHttpsKeyStoreStorePass

getHttpsKeyStoreKeypass

getPubliURI

getPublicServerScheme

getPublicServerHost

getPublicServerPort

getPublicServerSchemeHostPort

getHostForDefaultPublicServerSchemeHostPort

getServerHost

isDebugEnabled

isRoutesCaseSensitive

getServerMaxRequestBodyBytes

getContentTypesToSkipGziping

getSpincastWritableDir

getSpincastTempDirName

cleanWritableSpincastDir

getDefaultLocale

getRouteForwardingMaxNumber

getDefaultRouteCacheFilterSecondsNbr

isDefaultRouteCacheFilterPrivate

getDefaultRouteCacheFilterSecondsNbrCdns

isDisableWriteToDiskDynamicStaticResource

isAddDefaultTemplateVariablesFilter

getDefaultTemplateVariablesFilterPosition

getDefaultStaticResourceCacheConfig

getMaxNumberOfKeysWhenConvertingMapToJsonObject

getKeyMaxLengthWhenConvertingMapToJsonObject

getJsonPathArrayIndexMax

isValidateLocalhostHost

isEnableCookiesValidator

getQueryParamFlashMessageId

getCookieNameFlashMessage

getCookieNameLocale

getCookiesValidatorCookieName

getSpincastModelRootVariableName