SpincastConfig (org.spincast:spincast-framework 0.9.31 API)

All Known Subinterfaces:

SpincastConfigTesting

All Known Implementing Classes:

SpincastConfigDefault, SpincastConfigPropsFileBased, SpincastConfigTestingDefault
```
public interface SpincastConfig
```
The configurations required by Spincast.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`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.
`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()` The public scheme
`String`	`getPublicServerSchemeHostPort()` The application can't know by itself on which scheme/host/port it is served publicly.
`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.
`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 `getPublicServerHost()` returns `"localhost"`, `getEnvironmentName()` is not `"local"` and `isDebugEnabled()` is false, an exception is thrown when the application starts.

- Method Detail
  - isDebugEnabled
```
boolean isDebugEnabled()
```
    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.
    
    Returns:
    
    true if debug mode is enabled.
  - getPublicServerSchemeHostPort
```
String getPublicServerSchemeHostPort()
```
    The application can't know by itself on which scheme/host/port it is served publicly.
    For example, the server can be started using host "0.0.0.0", but the public URL to reach the application will be http://www.example.com. The port can also be different, for example if a reverse-proxy is used.
    
    We need the public informations, for example :
    - To build absolute URLs
    - To create a cookie with an approriate domain, when none is specified.
    - ...
  - getPublicServerScheme
```
String getPublicServerScheme()
```
    The public scheme
  - getPublicServerHost
```
String getPublicServerHost()
```
    The public host
  - getPublicServerPort
```
int getPublicServerPort()
```
    The public port
  - getServerHost
```
String getServerHost()
```
    The host/IP on which the server will listen to. The default value is 0.0.0.0.
    
    Returns:
    
    the host/IP
  - getHttpServerPort
```
int getHttpServerPort()
```
    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.
    
    Returns:
    
    the HTTP port
  - getHttpsServerPort
```
int getHttpsServerPort()
```
    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.
    
    Returns:
    
    the HTTPS port
  - getHttpsKeyStorePath
```
String getHttpsKeyStorePath()
```
    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.
    
    Returns:
    
    the path to the KeyStore
  - getHttpsKeyStoreType
```
String getHttpsKeyStoreType()
```
    The type of the KeyStore, for SSL. For example: "JKS". Only used if getHttpsServerPort() returns a port > 0. The default value is null.
    
    Returns:
    
    the type of the KeyStore
  - getHttpsKeyStoreStorePass
```
String getHttpsKeyStoreStorePass()
```
    The "storepass" of the KeyStore, for SSL. Only used if getHttpsServerPort() returns a port > 0. The default value is null.
    
    Returns:
    
    the "storepass" of the KeyStore
  - getHttpsKeyStoreKeypass
```
String getHttpsKeyStoreKeypass()
```
    The "keypass" of the KeyStore, for SSL. Only used if getHttpsServerPort() returns a port > 0. The default value is null.
    
    Returns:
    
    the "keypass" of the KeyStore
  - isRoutesCaseSensitive
```
boolean isRoutesCaseSensitive()
```
    Are the URLS case-sensitive or not, during the route matching process? The default value is false.
    
    Returns:
    
    if they are case-sensitive
    
    See Also:
    
    Should URL be case sensitive?
  - getEnvironmentName
```
String getEnvironmentName()
```
    Returns the name of the environment. The default value is local.
    
    Returns:
    
    the name of the environment
  - getServerMaxRequestBodyBytes
```
long getServerMaxRequestBodyBytes()
```
    Maximum number of bytes a request's body can have. "-1" means no limit. The default value is 104857600 (100MB).
    
    Returns:
    
    the maximum number of bytes
  - getContentTypesToSkipGziping
```
List<String> getContentTypesToSkipGziping()
```
    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 ";".
    
    Returns:
    
    the Content-Types that shouldn't be gzipped.
  - getSpincastWritableDir
```
File getSpincastWritableDir()
```
    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.
    
    Returns:
    
    a directory with write permissions for Spincast.
  - getDefaultLocale
```
Locale getDefaultLocale()
```
    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.
    
    Returns:
    
    the default Locale
  - getRouteForwardingMaxNumber
```
int getRouteForwardingMaxNumber()
```
    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.
    
    Returns:
    
    the maximum number of time
  - getDefaultRouteCacheFilterSecondsNbr
```
int getDefaultRouteCacheFilterSecondsNbr()
```
    When using the .cache() method on a route builder, this is the default number of seconds to use.
  - isDefaultRouteCacheFilterPrivate
```
boolean isDefaultRouteCacheFilterPrivate()
```
    When using the .cache() method on a route builder, is the cache private by default?
  - getDefaultRouteCacheFilterSecondsNbrCdns
```
Integer getDefaultRouteCacheFilterSecondsNbrCdns()
```
    When using the .cache() method on a route builder, this is the default number of seconds to use by the CDNs.
  - getDefaultStaticResourceCacheConfig
```
StaticResourceCacheConfig getDefaultStaticResourceCacheConfig(boolean isDynamicResource)
```
    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.
    
    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.
  - isDisableWriteToDiskDynamicStaticResource
```
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. THhis means that the generator will always be called, so chnages during development will be picked up.
  - isAddDefaultTemplateVariablesFilter
```
boolean isAddDefaultTemplateVariablesFilter()
```
    Should the GlobalTemplateVariablesAdderFilter be automatically added to all routes?
    This filter bind some default variables to be used by the templating engine.
  - getDefaultTemplateVariablesFilterPosition
```
int getDefaultTemplateVariablesFilterPosition()
```
    If addGlobalTemplateVariablesAdderFilter erturns true, then this is the position at which the filter will be added.
  - getMaxNumberOfKeysWhenConvertingMapToJsonObject
```
int getMaxNumberOfKeysWhenConvertingMapToJsonObject()
```
    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.
  - getKeyMaxLengthWhenConvertingMapToJsonObject
```
int getKeyMaxLengthWhenConvertingMapToJsonObject()
```
    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.
  - getJsonPathArrayIndexMax
```
int getJsonPathArrayIndexMax()
```
    Gets the maximum index of an element of an array, when parsing a JsonPath.
  - isValidateLocalhostHost
```
boolean isValidateLocalhostHost()
```
    By default, if getPublicServerHost() returns "localhost", getEnvironmentName() is not "local" and 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 getPublicServerSchemeHostPort() method when they release to a non local environment.
    You can disable this validation if you want.
  - isEnableCookiesValidator
```
boolean isEnableCookiesValidator()
```
    If true, Spincast will always try to set a cookie to validate if cookies are enabled on the client.
    This is enabled by default
  - getCookiesValidatorCookieName
```
String getCookiesValidatorCookieName()
```
    Name of the Cookie to use to validate if cookies are enabled.
    The default is "spincast_cookies_enabled".
  - getCookieNameFlashMessage
```
String getCookieNameFlashMessage()
```
    Name of the Cookie to to use save a Flash Message id.
  - getQueryParamFlashMessageId
```
String getQueryParamFlashMessageId()
```
    The name of the queryString parameter to use for a Flash Message id, when cookies are not available.
  - getCookieNameLocale
```
String getCookieNameLocale()
```
    Name of the Cookie to use to save the user Locale.
    The default is "spincast_locale"
  - getSpincastModelRootVariableName
```
String getSpincastModelRootVariableName()
```
    Name of the root variables reserved for Spincast in the response's model.

Interface SpincastConfig

Method Summary

Method Detail

isDebugEnabled

getPublicServerSchemeHostPort

getPublicServerScheme

getPublicServerHost

getPublicServerPort

getServerHost

getHttpServerPort

getHttpsServerPort

getHttpsKeyStorePath

getHttpsKeyStoreType

getHttpsKeyStoreStorePass

getHttpsKeyStoreKeypass

isRoutesCaseSensitive

getEnvironmentName

getServerMaxRequestBodyBytes

getContentTypesToSkipGziping

getSpincastWritableDir

getDefaultLocale

getRouteForwardingMaxNumber

getDefaultRouteCacheFilterSecondsNbr

isDefaultRouteCacheFilterPrivate

getDefaultRouteCacheFilterSecondsNbrCdns

getDefaultStaticResourceCacheConfig

isDisableWriteToDiskDynamicStaticResource

isAddDefaultTemplateVariablesFilter

getDefaultTemplateVariablesFilterPosition

getMaxNumberOfKeysWhenConvertingMapToJsonObject

getKeyMaxLengthWhenConvertingMapToJsonObject

getJsonPathArrayIndexMax

isValidateLocalhostHost

isEnableCookiesValidator

getCookiesValidatorCookieName

getCookieNameFlashMessage

getQueryParamFlashMessageId

getCookieNameLocale

getSpincastModelRootVariableName