Settings (stallion-core 1.0.0-SNAPSHOT API)

java.lang.Object
- io.stallion.settings.Settings

All Implemented Interfaces:: ISettings

public class Settings
extends Object
implements ISettings

Constructor Summary

Constructors
Constructor and Description

Settings()

Constructors
Constructor and Description
`Settings()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`assignDefaults()`
`protected List`	`convertMapListToObjects(List maps, Class targetClass)`
`String`	`getAntiSpamSecret()` A random token used for preventing spam in form submissions and comments.
`Long`	`getAppCreatedMillis()`
`List<AssetPreprocessorConfig>`	`getAssetPreprocessors()`
`String`	`getAuthorName()` Get the name of the author of the site
`Boolean`	`getBundleDebug()` True by default if in debug mode, false on production.
`String`	`getCdnUrl()` The base URL for CDN (Content Delivery Network) that will pass through to your site.
`CloudStorageSettings`	`getCloudStorage()` Configuration for integration with a cloud file storage, such as S3.
`CorsSettings`	`getCors()` Cross-Origin Request configuration -- allow endpoints to respond to cross-origin requests.
`CustomSettings`	`getCustom()` A hashtable of arbitrary user defined settings.
`DbConfig`	`getDatabase()` The database configuration
`String`	`getDataDirectory()` Where all data stored to flat-file by the Controllers and Persisters will actually live in the file system.
`Boolean`	`getDebug()` Run in debug mode.
`String`	`getDefaultTitle()` The default title of your site, will be used in the HTML title tag in the default base template if no other title for a page is defined.
`Boolean`	`getDevMode()` Usually set by the command line options, rather than the stallion.toml file.
`Boolean`	`getDisableFormSubmissions()` If true, the default form submission endpoint will be disabled.
`EmailSettings`	`getEmail()` Email configuration for Stallion sending emails via SMTP
`Boolean`	`getEmailErrors()` If true, exceptions will emailed to the admin defined in the email configuration.
`String`	`getEnv()` The current environment name, set by command line options.
`Long`	`getFilterCacheSize()`
`List<ContentFolder>`	`getFolders()` ContentFolders are folders in your local site directory that are to be registered with the data access controller.
`List<String[]>`	`getHealthCheckEndpoints()` A list of paths that will be checked for a 200 response when the health check is run.
`String`	`getHealthCheckSecret()` A secret token that must be passed in when accessing the health endpoints.
`String`	`getIpHeaderName()` If there is a proxy server in front of Stallion, that proxy server will set the IP address of the original requester and put it in a header.
`Boolean`	`getLocalMode()` True if this is a developer running locally, false if this is running deployed on a server.
`String`	`getLogFile()` The path to the log file when file-based logging is on.
`String`	`getLogLevel()` Set the log level - INFO, FINE, FINER, FINEST
`Boolean`	`getLogToConsole()` If true, log to the console instead of file.
`Boolean`	`getLogToFile()`
`String`	`getMetaDescription()` The default meta tag description value.
`String`	`getMetaGenerator()` The meta tag value for generator.
`String`	`getNginxClientMaxBodySize()`
`String`	`getNginxProxyReadTimeout()`
`Integer`	`getNodeNumber()` For deployed sites using stablehand, which node this is.
`OAuthSettings`	`getoAuth()` Configuration for enabling users to give out OAuth access
`Map<String,String>`	`getPackageLogLevels()`
`String`	`getPageTemplate()` The default template to use to render pages
`Integer`	`getPort()` The port the server should run on.
`Map<String,String>`	`getRedirects()` A map of 301 redirects in the form of original URL or path to destination URL or path.
`List<Map.Entry<Pattern,String>>`	`getRewriteCompiledPatterns()`
`List<String[]>`	`getRewritePatterns()` A list of arrays, each array has two values, a source regular expression and a destination path.
`Map<String,String>`	`getRewrites()` A mapping of internal rewrites, from source path to destintion path.
`List<RouteDefinition>`	`getRoutes()`
`String`	`getSchemeForSecondaryDomain(String domain)` Gets the scheme (https or http) for a given secondary domain
`SecondaryDomain`	`getSecondaryDomainByDomain(String domain)`
`List<SecondaryDomain>`	`getSecondaryDomains()` A list of domains that content is also accesible at, and their mapping to URL paths.
`SecretsSettings`	`getSecrets()`
`String`	`getSiteName()` The name of your site, accessible in templates via {{ site.name }}
`String`	`getSiteUrl()` The base URL at which the site lives.
`String`	`getSiteUrlScheme()` Get siteUrl scheme
`StrictnessLevel`	`getStrictnessLevel()`
`StyleSettings`	`getStyles()` Default CSS styles and colors that will be used in the default templates for log in, password reset emails, etc.
`String`	`getSupportEmail()` Included in the templates for error pages.
`String`	`getTargetFolder()` The root site folder that contains the conf directory and the conf/stallion.toml files.
`String`	`getTimeZone()` Should be a time zone parseable by ZoneId.of() Used by the DateUtils.renderLocalDate() method when there is no time zone for the particular user.
`ZoneId`	`getTimeZoneId()`
`UserSettings`	`getUsers()` The user configuration
`String`	`getxFrameOptions()`
`static Settings`	`init(String env, CommandOptionsBase options)`
`static Settings`	`instance()`
`static boolean`	`isNull()`
`boolean`	`isStrict()` In strict mode, more errors will be exceptions that stop all processing.
`Settings`	`setAntiSpamSecret(String antiSpamSecret)`
`Settings`	`setAppCreatedMillis(Long appCreatedMillis)`
`Settings`	`setAssetPreprocessors(List assetPreProcessors)`
`void`	`setAuthorName(String authorName)`
`void`	`setBundleDebug(Boolean bundleDebug)`
`void`	`setCdnUrl(String cdnUrl)`
`void`	`setCloudStorage(CloudStorageSettings cloudStorage)`
`Settings`	`setCors(CorsSettings cors)`
`void`	`setCustom(CustomSettings custom)`
`void`	`setDatabase(DbConfig database)`
`void`	`setDataDirectory(String dataDirectory)`
`void`	`setDebug(Boolean debug)`
`void`	`setDefaultTitle(String defaultTitle)`
`void`	`setDevMode(Boolean devMode)`
`Settings`	`setDisableFormSubmissions(Boolean disableFormSubmissions)`
`void`	`setEmail(EmailSettings email)`
`void`	`setEmailErrors(Boolean emailErrors)`
`void`	`setEnv(String env)`
`Settings`	`setFilterCacheSize(Long filterCacheSize)`
`void`	`setFolders(List<ContentFolder> folders)`
`void`	`setHealthCheckEndpoints(List<String[]> healthCheckEndpoints)`
`void`	`setHealthCheckSecret(String healthCheckSecret)`
`Settings`	`setIpHeaderName(String ipHeaderName)`
`void`	`setLocalMode(Boolean localMode)`
`void`	`setLogFile(String logFile)`
`void`	`setLogLevel(String logLevel)`
`void`	`setLogToConsole(Boolean logToConsole)`
`void`	`setLogToFile(Boolean logToFile)`
`void`	`setMetaDescription(String metaDescription)`
`void`	`setMetaGenerator(String metaGenerator)`
`Settings`	`setNginxClientMaxBodySize(String nginxClientMaxBodySize)`
`Settings`	`setNginxProxyReadTimeout(String nginxProxyReadTimeout)`
`Settings`	`setNodeNumber(Integer nodeNumber)`
`Settings`	`setoAuth(OAuthSettings oAuth)`
`void`	`setPackageLogLevels(Map<String,String> packageLogLevels)`
`void`	`setPageTemplate(String pageTemplate)`
`void`	`setPort(Integer port)`
`void`	`setRedirects(Map<String,String> redirects)`
`void`	`setRewriteCompiledPatterns(List<Map.Entry<Pattern,String>> rewriteCompiledPatterns)`
`void`	`setRewritePatterns(List<String[]> rewritePatterns)`
`void`	`setRewrites(Map<String,String> rewrites)`
`void`	`setRoutes(List<RouteDefinition> routes)`
`Settings`	`setSecondaryDomains(List<SecondaryDomain> secondaryDomains)`
`Settings`	`setSecrets(SecretsSettings secrets)`
`void`	`setSiteName(String siteName)`
`void`	`setSiteUrl(String siteUrl)`
`void`	`setStrictnessLevel(StrictnessLevel strictnessLevel)`
`void`	`setStyles(StyleSettings style)`
`Settings`	`setSupportEmail(String supportEmail)`
`void`	`setTargetFolder(String targetFolder)`
`void`	`setTimeZone(String timeZone)`
`void`	`setTimeZoneId(ZoneId timeZoneId)`
`void`	`setUsers(UserSettings users)`
`Settings`	`setxFrameOptions(String xFrameOptions)`
`static void`	`shutdown()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Settings
```
public Settings()
```
- Method Detail
  - isNull
```
public static boolean isNull()
```
  - shutdown
```
public static void shutdown()
```
  - instance
```
public static Settings instance()
```
  - init
```
public static Settings init(String env,
                            CommandOptionsBase options)
```
  - assignDefaults
```
public void assignDefaults()
```
    Specified by:
    
    assignDefaults in interface ISettings
  - getSchemeForSecondaryDomain
```
public String getSchemeForSecondaryDomain(String domain)
```
    Gets the scheme (https or http) for a given secondary domain
    
    Returns:
  - getSiteUrlScheme
```
public String getSiteUrlScheme()
```
    Get siteUrl scheme
    
    Returns:
  - getSecondaryDomainByDomain
```
public SecondaryDomain getSecondaryDomainByDomain(String domain)
```
  - isStrict
```
public boolean isStrict()
```
    In strict mode, more errors will be exceptions that stop all processing. For instance, missing template variables will cause exceptions rather than being ignored.
    
    Returns:
  - getFolders
```
public List<ContentFolder> getFolders()
```
    ContentFolders are folders in your local site directory that are to be registered with the data access controller. The .txt will be converted into accessible web pages in your site.
    
    Returns:
  - setFolders
```
public void setFolders(List<ContentFolder> folders)
```
  - getDatabase
```
public DbConfig getDatabase()
```
    The database configuration
    
    Returns:
  - setDatabase
```
public void setDatabase(DbConfig database)
```
  - getUsers
```
public UserSettings getUsers()
```
    The user configuration
    
    Returns:
  - setUsers
```
public void setUsers(UserSettings users)
```
  - getEmail
```
public EmailSettings getEmail()
```
    Email configuration for Stallion sending emails via SMTP
    
    Returns:
  - setEmail
```
public void setEmail(EmailSettings email)
```
  - getCors
```
public CorsSettings getCors()
```
    Cross-Origin Request configuration -- allow endpoints to respond to cross-origin requests.
    
    Returns:
  - setCors
```
public Settings setCors(CorsSettings cors)
```
  - getDataDirectory
```
public String getDataDirectory()
```
    Where all data stored to flat-file by the Controllers and Persisters will actually live in the file system. This will be "app-data" under the site directory by default.
    
    Returns:
  - setDataDirectory
```
public void setDataDirectory(String dataDirectory)
```
  - getCustom
```
public CustomSettings getCustom()
```
    A hashtable of arbitrary user defined settings.
    
    Returns:
  - setCustom
```
public void setCustom(CustomSettings custom)
```
  - getPageTemplate
```
public String getPageTemplate()
```
    The default template to use to render pages
    
    Returns:
  - setPageTemplate
```
public void setPageTemplate(String pageTemplate)
```
  - getCdnUrl
```
public String getCdnUrl()
```
    The base URL for CDN (Content Delivery Network) that will pass through to your site. This is used by AssetsController.url() or AssetsController.bundle() to build URL's to your assets. If empty, will use the site URL instead. Using a CDN can improve performance as it will cache requested assets in data centers nearer to the end user.
    
    Returns:
  - setCdnUrl
```
public void setCdnUrl(String cdnUrl)
```
  - getSiteUrl
```
public String getSiteUrl()
```
    The base URL at which the site lives. Used to build links internally, also used for checking cross-origin requests.
    
    Returns:
  - setSiteUrl
```
public void setSiteUrl(String siteUrl)
```
  - getRoutes
```
public List<RouteDefinition> getRoutes()
```
  - setRoutes
```
public void setRoutes(List<RouteDefinition> routes)
```
  - getDebug
```
public Boolean getDebug()
```
    Run in debug mode. True by default when env=local. In debug mode, the full stack trace of exceptions will be rendered to the HTML output.
    
    Returns:
  - setDebug
```
public void setDebug(Boolean debug)
```
  - getTimeZone
```
public String getTimeZone()
```
    Should be a time zone parseable by ZoneId.of() Used by the DateUtils.renderLocalDate() method when there is no time zone for the particular user.
    
    Returns:
  - setTimeZone
```
public void setTimeZone(String timeZone)
```
  - getTimeZoneId
```
public ZoneId getTimeZoneId()
```
  - setTimeZoneId
```
public void setTimeZoneId(ZoneId timeZoneId)
```
  - getDevMode
```
public Boolean getDevMode()
```
    Usually set by the command line options, rather than the stallion.toml file. If true, templates and assets will automatically be checked for changes from the original source and re-compiled if they have changed.
    
    Returns:
  - setDevMode
```
public void setDevMode(Boolean devMode)
```
  - getLogLevel
```
public String getLogLevel()
```
    Set the log level - INFO, FINE, FINER, FINEST
    
    Returns:
  - setLogLevel
```
public void setLogLevel(String logLevel)
```
  - getPackageLogLevels
```
public Map<String,String> getPackageLogLevels()
```
  - setPackageLogLevels
```
public void setPackageLogLevels(Map<String,String> packageLogLevels)
```
  - getEnv
```
public String getEnv()
```
    The current environment name, set by command line options.
    
    Returns:
  - setEnv
```
public void setEnv(String env)
```
  - getBundleDebug
```
public Boolean getBundleDebug()
```
    True by default if in debug mode, false on production. If true, bundle files will be included on the page as individual source files, rather than as a concatenated, minified file.
    
    Returns:
  - setBundleDebug
```
public void setBundleDebug(Boolean bundleDebug)
```
  - getSiteName
```
public String getSiteName()
```
    The name of your site, accessible in templates via {{ site.name }}
    
    Returns:
  - setSiteName
```
public void setSiteName(String siteName)
```
  - getDefaultTitle
```
public String getDefaultTitle()
```
    The default title of your site, will be used in the HTML title tag in the default base template if no other title for a page is defined.
    
    Returns:
  - setDefaultTitle
```
public void setDefaultTitle(String defaultTitle)
```
  - getMetaDescription
```
public String getMetaDescription()
```
    The default meta tag description value. Used if there is no override for the particular page or endpoint.
    
    Returns:
  - setMetaDescription
```
public void setMetaDescription(String metaDescription)
```
  - getAuthorName
```
public String getAuthorName()
```
    Get the name of the author of the site
    
    Returns:
  - setAuthorName
```
public void setAuthorName(String authorName)
```
  - getPort
```
public Integer getPort()
```
    The port the server should run on. Usually set by the command line options.
    
    Returns:
  - setPort
```
public void setPort(Integer port)
```
  - getTargetFolder
```
public String getTargetFolder()
```
    The root site folder that contains the conf directory and the conf/stallion.toml files. This is always set via the command line options, or defaults to the current working directory.
    
    Returns:
  - setTargetFolder
```
public void setTargetFolder(String targetFolder)
```
  - getStrictnessLevel
```
public StrictnessLevel getStrictnessLevel()
```
  - setStrictnessLevel
```
public void setStrictnessLevel(StrictnessLevel strictnessLevel)
```
  - getHealthCheckEndpoints
```
public List<String[]> getHealthCheckEndpoints()
```
    A list of paths that will be checked for a 200 response when the health check is run.
    
    Returns:
  - setHealthCheckEndpoints
```
public void setHealthCheckEndpoints(List<String[]> healthCheckEndpoints)
```
  - getHealthCheckSecret
```
public String getHealthCheckSecret()
```
    A secret token that must be passed in when accessing the health endpoints.
    
    Returns:
  - setHealthCheckSecret
```
public void setHealthCheckSecret(String healthCheckSecret)
```
  - getEmailErrors
```
public Boolean getEmailErrors()
```
    If true, exceptions will emailed to the admin defined in the email configuration.
    
    Returns:
  - setEmailErrors
```
public void setEmailErrors(Boolean emailErrors)
```
  - getRedirects
```
public Map<String,String> getRedirects()
```
    A map of 301 redirects in the form of original URL or path to destination URL or path.
    
    Returns:
  - setRedirects
```
public void setRedirects(Map<String,String> redirects)
```
  - getMetaGenerator
```
public String getMetaGenerator()
```
    The meta tag value for generator. "Stallion" by default.
    
    Returns:
  - setMetaGenerator
```
public void setMetaGenerator(String metaGenerator)
```
  - getLogFile
```
public String getLogFile()
```
    The path to the log file when file-based logging is on.
    
    Returns:
  - setLogFile
```
public void setLogFile(String logFile)
```
  - getLogToConsole
```
public Boolean getLogToConsole()
```
    If true, log to the console instead of file. This defaults to true in local mode.
    
    Returns:
  - setLogToConsole
```
public void setLogToConsole(Boolean logToConsole)
```
  - getLogToFile
```
public Boolean getLogToFile()
```
  - setLogToFile
```
public void setLogToFile(Boolean logToFile)
```
  - getLocalMode
```
public Boolean getLocalMode()
```
    True if this is a developer running locally, false if this is running deployed on a server. If localMode is true, production jobs and tasks will not be run and logging will go to the console.
    
    Returns:
  - setLocalMode
```
public void setLocalMode(Boolean localMode)
```
  - getRewrites
```
public Map<String,String> getRewrites()
```
    A mapping of internal rewrites, from source path to destintion path.
    
    Returns:
  - setRewrites
```
public void setRewrites(Map<String,String> rewrites)
```
  - getSecondaryDomains
```
public List<SecondaryDomain> getSecondaryDomains()
```
    A list of domains that content is also accesible at, and their mapping to URL paths.
    
    Returns:
  - setSecondaryDomains
```
public Settings setSecondaryDomains(List<SecondaryDomain> secondaryDomains)
```
  - getRewriteCompiledPatterns
```
public List<Map.Entry<Pattern,String>> getRewriteCompiledPatterns()
```
  - setRewriteCompiledPatterns
```
public void setRewriteCompiledPatterns(List<Map.Entry<Pattern,String>> rewriteCompiledPatterns)
```
  - getRewritePatterns
```
public List<String[]> getRewritePatterns()
```
    A list of arrays, each array has two values, a source regular expression and a destination path.
    
    Returns:
  - setRewritePatterns
```
public void setRewritePatterns(List<String[]> rewritePatterns)
```
  - getCloudStorage
```
public CloudStorageSettings getCloudStorage()
```
    Configuration for integration with a cloud file storage, such as S3.
    
    Returns:
  - setCloudStorage
```
public void setCloudStorage(CloudStorageSettings cloudStorage)
```
  - getStyles
```
public StyleSettings getStyles()
```
    Default CSS styles and colors that will be used in the default templates for log in, password reset emails, etc.
    
    Returns:
  - setStyles
```
public void setStyles(StyleSettings style)
```
  - getNodeNumber
```
public Integer getNodeNumber()
```
    For deployed sites using stablehand, which node this is.
    
    Returns:
  - setNodeNumber
```
public Settings setNodeNumber(Integer nodeNumber)
```
  - getAntiSpamSecret
```
public String getAntiSpamSecret()
```
    A random token used for preventing spam in form submissions and comments.
    
    Returns:
  - setAntiSpamSecret
```
public Settings setAntiSpamSecret(String antiSpamSecret)
```
  - getDisableFormSubmissions
```
public Boolean getDisableFormSubmissions()
```
    If true, the default form submission endpoint will be disabled.
    
    Returns:
  - setDisableFormSubmissions
```
public Settings setDisableFormSubmissions(Boolean disableFormSubmissions)
```
  - getIpHeaderName
```
public String getIpHeaderName()
```
    If there is a proxy server in front of Stallion, that proxy server will set the IP address of the original requester and put it in a header. Add that header name here so that Stallion can know the IP of the original requester.
    
    Returns:
  - setIpHeaderName
```
public Settings setIpHeaderName(String ipHeaderName)
```
  - getoAuth
```
public OAuthSettings getoAuth()
```
    Configuration for enabling users to give out OAuth access
    
    Returns:
  - setoAuth
```
public Settings setoAuth(OAuthSettings oAuth)
```
  - getFilterCacheSize
```
public Long getFilterCacheSize()
```
  - setFilterCacheSize
```
public Settings setFilterCacheSize(Long filterCacheSize)
```
  - getSecrets
```
public SecretsSettings getSecrets()
```
  - setSecrets
```
public Settings setSecrets(SecretsSettings secrets)
```
  - getSupportEmail
```
public String getSupportEmail()
```
    Included in the templates for error pages.
    
    Returns:
  - setSupportEmail
```
public Settings setSupportEmail(String supportEmail)
```
  - getAppCreatedMillis
```
public Long getAppCreatedMillis()
```
  - setAppCreatedMillis
```
public Settings setAppCreatedMillis(Long appCreatedMillis)
```
  - getAssetPreprocessors
```
public List<AssetPreprocessorConfig> getAssetPreprocessors()
```
  - setAssetPreprocessors
```
public Settings setAssetPreprocessors(List assetPreProcessors)
```
  - convertMapListToObjects
```
protected List convertMapListToObjects(List maps,
                                       Class targetClass)
```
  - getxFrameOptions
```
public String getxFrameOptions()
```
  - setxFrameOptions
```
public Settings setxFrameOptions(String xFrameOptions)
```
  - getNginxClientMaxBodySize
```
public String getNginxClientMaxBodySize()
```
  - setNginxClientMaxBodySize
```
public Settings setNginxClientMaxBodySize(String nginxClientMaxBodySize)
```
  - getNginxProxyReadTimeout
```
public String getNginxProxyReadTimeout()
```
  - setNginxProxyReadTimeout
```
public Settings setNginxProxyReadTimeout(String nginxProxyReadTimeout)
```

Class Settings

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Settings

Method Detail

isNull

shutdown

instance

init

assignDefaults

getSchemeForSecondaryDomain

getSiteUrlScheme

getSecondaryDomainByDomain

isStrict

getFolders

setFolders

getDatabase

setDatabase

getUsers

setUsers

getEmail

setEmail

getCors

setCors

getDataDirectory

setDataDirectory

getCustom

setCustom

getPageTemplate

setPageTemplate

getCdnUrl

setCdnUrl

getSiteUrl

setSiteUrl

getRoutes

setRoutes

getDebug

setDebug

getTimeZone

setTimeZone

getTimeZoneId

setTimeZoneId

getDevMode

setDevMode

getLogLevel

setLogLevel

getPackageLogLevels

setPackageLogLevels

getEnv

setEnv

getBundleDebug

setBundleDebug

getSiteName

setSiteName

getDefaultTitle

setDefaultTitle

getMetaDescription

setMetaDescription

getAuthorName

setAuthorName

getPort

setPort

getTargetFolder

setTargetFolder

getStrictnessLevel

setStrictnessLevel

getHealthCheckEndpoints

setHealthCheckEndpoints

getHealthCheckSecret

setHealthCheckSecret

getEmailErrors

setEmailErrors

getRedirects

setRedirects

getMetaGenerator

setMetaGenerator

getLogFile

setLogFile