org.spincast.core.config

Interface ISpincastConfig

All Known Implementing Classes:

SpincastConfig, SpincastConfigPropsFileBased, SpincastTestConfig

public interface ISpincastConfig

The configurations required by Spincast.

Method Summary

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.
Locale	getDefaultLocale() The default Locale to use if no other Locale can be found as a "best match", for the current request.
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	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.
File	getSpincastWritableDir() A directory where generated files and temporary files can be written by Spincast.
boolean	isDebugEnabled() Let this to true on development environment, where errors can be publicly displayed, where cache can be disabled, etc.
boolean	isRoutesCaseSensitive() Are the URLS case-sensitive or not, during the route matching process? The default value is false.

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.

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 generated files and temporary files can be written by Spincast. The default value uses System.getProperty("java.io.tmpdir") to create a temporary 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