sirius.kernel

Class Setup

java.lang.Object

sirius.kernel.Setup

public class Setup
extends Object

Used to configure the setup of the SIRIUS framework.

An instance of this class is passed into Sirius.start(Setup) to launch the framework. Alternatively createAndStartEnvironment(ClassLoader) can be called which configures and starts SIRIUS based on system properties. This is utilized by the sirius-ipl framework which provides an application container (effectively a main class and some control scripts to make it behave like a daemon or Windows Service).

To further customize settings, subclass and override the appropriate methods.

By default, this class does the following:

• Sets the encoding to UTF-8
• Sets the DNS cache to 10 seconds - by default this would be 'infinite'
• Redirects all Java Logging to Log4J
• Creates either a console or file appender for Log4J (PROD = file, DEV = console)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Setup.Mode Determines the mode in which the framework should run.

Field Summary

Fields

Modifier and Type	Field and Description
protected String	consoleLogFormat
protected org.apache.log4j.Level	defaultLevel
protected String	fileLogFormat
protected ClassLoader	loader
protected boolean	logToConsole
protected boolean	logToFile
protected Setup.Mode	mode

Constructor Summary

Constructors

Constructor and Description
Setup(Setup.Mode mode, ClassLoader loader) Creates a new setup for the given mode and class loader.

Method Summary

Modifier and Type	Method and Description
com.typesafe.config.Config	applyDeveloperConfig(com.typesafe.config.Config config) Applies the developer configuration to the given config object.
com.typesafe.config.Config	applyTestConfig(com.typesafe.config.Config config) Applies the test configuration to the given config object.
com.typesafe.config.Config	applyTestScenarioConfig(String scenarioFile, com.typesafe.config.Config config) Loads the configuration of the current test scenario which will overwrite the settings in test.conf.
void	cleanOldLogFiles(long retentionInMillis) Invoked by Sirius itself on a regular basis to clean old log files.
static void	createAndStartEnvironment(ClassLoader loader) Creates and starts a new setup based on system properties.
long	estimateLogFilesSize() Estimates the total size of all log files.
ClassLoader	getLoader() Returns the loader to use for component discovery.
protected String	getLogFileName() Returns the name of the log file.
protected String	getLogFilePath() Computes the effective name for the log file.
protected String	getLogsDirectory() Returns the name of the log directory.
Setup.Mode	getMode() Returns the mode the framework was started in.
protected static Value	getProperty(String property) Reads the given system property.
void	init() Initializes the Virtual Machine.
com.typesafe.config.Config	loadApplicationConfig() Loads the main application configuration which is shipped with the app.
com.typesafe.config.Config	loadInstanceConfig() Loads the instance configuration which configures the app for the machine it is running on.
static void	main(String[] args) Provides a main method for debugging purposes.
protected void	outputJVMInfo() Outputs the name of the underlying JVM to verify that the correct one was used to start the application
protected void	redirectJavaLoggerToLog4j() Redirects all java.logging output to Log4j
protected void	setupDNSCache() Sets the DNS cache to a sane value.
protected void	setupEncoding() Sets UTF-8 as default encoding
protected void	setupLogging() Initializes log4j as logging framework.
protected boolean	shouldLogToConsole() Determines if a console appender should be installed
protected boolean	shouldLogToFile() Determines if a file appender should be installed
Setup	withConsoleLogFormat(String format) Specifies the pattern used to format log messages in the console.
Setup	withDefaultLogLevel(org.apache.log4j.Level level) Used to set the default log level used by the root logger.
Setup	withFileLogFormat(String format) Specifies the pattern used to format log messages in the log file.
Setup	withLogToConsole(boolean flag) Overwrites the settings for the console appender.
Setup	withLogToFile(boolean flag) Overwrites the settings for the file appender.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

loader

protected ClassLoader loader

mode

protected Setup.Mode mode

logToConsole

protected boolean logToConsole

logToFile

protected boolean logToFile

defaultLevel

protected org.apache.log4j.Level defaultLevel

consoleLogFormat

protected String consoleLogFormat

fileLogFormat

protected String fileLogFormat

Constructor Detail

Setup

public Setup(Setup.Mode mode,
             ClassLoader loader)

Creates a new setup for the given mode and class loader.

Parameters:

mode - the mode to run the framework in

loader - the class loader used for component discovery

Method Detail

withLogToConsole

public Setup withLogToConsole(boolean flag)

Overwrites the settings for the console appender.

Parameters:

flag - determines if logging to the console is enabled or not.

Returns:

the setup itself for fluent method calls

withLogToFile

public Setup withLogToFile(boolean flag)

Overwrites the settings for the file appender.

Parameters:

flag - determines if logging to the log file is enabled or not.

Returns:

the setup itself for fluent method calls

withDefaultLogLevel

public Setup withDefaultLogLevel(org.apache.log4j.Level level)

Used to set the default log level used by the root logger.

Note that each logger can be configured by specifying logging.[NAME] in the system configuration

Parameters:

level - the level to use

Returns:

the setup itself for fluent method calls

withConsoleLogFormat

public Setup withConsoleLogFormat(String format)

Specifies the pattern used to format log messages in the console.

Refer to PatternLayout for available options.

Parameters:

format - the template string to use

Returns:

the setup itself for fluent method calls

withFileLogFormat

public Setup withFileLogFormat(String format)

Specifies the pattern used to format log messages in the log file.

Refer to PatternLayout for available options.

Parameters:

format - the template string to use

Returns:

the setup itself for fluent method calls

createAndStartEnvironment

public static void createAndStartEnvironment(ClassLoader loader)

Creates and starts a new setup based on system properties.

Essentially this is debug which switches from PROD to DEV and console which enables log output to the console even if running in PROD mode.

Parameters:

loader - the class loader to use

main

public static void main(String[] args)

Provides a main method for debugging purposes.

Parameters:

args - the command line arguments (currently ignored)

init

public void init()

Initializes the Virtual Machine.

This modifies the DNS cache, encoding and logging setup...

This method is automatically called by Sirius.start(Setup)

outputJVMInfo

protected void outputJVMInfo()

Outputs the name of the underlying JVM to verify that the correct one was used to start the application

getLoader

public ClassLoader getLoader()

Returns the loader to use for component discovery.

Returns:

the loader to use for component discovery

getMode

public Setup.Mode getMode()

Returns the mode the framework was started in.

Returns:

the mode of the framework

setupEncoding

protected void setupEncoding()

Sets UTF-8 as default encoding

setupDNSCache

protected void setupDNSCache()

Sets the DNS cache to a sane value.

By default java infinitely caches all DNS entries. Will be changed to 10 seconds...

getProperty

protected static Value getProperty(String property)

Reads the given system property.

Parameters:

property - the property to read

Returns:

the contents of the property wrapped as Value

setupLogging

protected void setupLogging()

Initializes log4j as logging framework.

In development mode, we log everything to the console. In production mode, we use a rolling file appender and log into the logs directory.

getLogsDirectory

protected String getLogsDirectory()

Returns the name of the log directory.

Returns:

the name of the log directory

getLogFilePath

protected String getLogFilePath()

Computes the effective name for the log file.

Returns:

computes the log file which is getLogsDirectory() / getLogFileName()

cleanOldLogFiles

public void cleanOldLogFiles(long retentionInMillis)

Invoked by Sirius itself on a regular basis to clean old log files.

Parameters:

retentionInMillis - the desired retention time in milli seconds before a file is deleted.

estimateLogFilesSize

public long estimateLogFilesSize()

Estimates the total size of all log files.

Returns:

the size in bytes of all log files

getLogFileName

protected String getLogFileName()

Returns the name of the log file.

Returns:

the name of the log file

shouldLogToConsole

protected boolean shouldLogToConsole()

Determines if a console appender should be installed

Returns:

true if the framework should log to the console

shouldLogToFile

protected boolean shouldLogToFile()

Determines if a file appender should be installed

Returns:

true if the framework should log into a file

redirectJavaLoggerToLog4j

protected void redirectJavaLoggerToLog4j()

Redirects all java.logging output to Log4j

loadApplicationConfig

@Nonnull
public com.typesafe.config.Config loadApplicationConfig()

Loads the main application configuration which is shipped with the app.

By default this loads "application.conf" from the classpath. Also "application-*.conf are loaded in case it is splitted into several parts.

Returns:

the main application config. This will override all component configs but be overridden by developer, test and instance configs

applyTestConfig

@Nonnull
public com.typesafe.config.Config applyTestConfig(@Nonnull
                                                           com.typesafe.config.Config config)

Applies the test configuration to the given config object.

By default this loads and applies "test.conf" from the classpath.

Parameters:

config - the config to enhance

Returns:

the enhanced config

applyTestScenarioConfig

@Nonnull
public com.typesafe.config.Config applyTestScenarioConfig(@Nullable
                                                                   String scenarioFile,
                                                                   @Nonnull
                                                                   com.typesafe.config.Config config)

Loads the configuration of the current test scenario which will overwrite the settings in test.conf.

Parameters:

scenarioFile - the scenario config file to load

config - the config to enhance

Returns:

the enhanced config

applyDeveloperConfig

@Nonnull
public com.typesafe.config.Config applyDeveloperConfig(@Nonnull
                                                                com.typesafe.config.Config config)

Applies the developer configuration to the given config object.

By default this loads and applies "develop.conf" from the file system.

Parameters:

config - the config to enhance

Returns:

the enhanced config

loadInstanceConfig

@Nullable
public com.typesafe.config.Config loadInstanceConfig()

Loads the instance configuration which configures the app for the machine it is running on.

By default this loads "instance.conf" from the file system

This will later be applied to the overall system configuration and will override all other settings.

Returns:

the instance configuration or null if no config was found.