sirius.kernel

Class Sirius

java.lang.Object

sirius.kernel.Sirius

public class Sirius
extends Object

Loads and initializes the framework.

This can be considered the stage2 when booting the framework, as it is responsible to discover and initialize all components. Call start(Setup) to initialize the framework.

To make a jar or other classpath-root visible to SIRIUS an empty file called "component.marker" must be placed in its root directory.

Field Summary

Fields

Modifier and Type	Field and Description
static Log	DEBUG This debug logger will be logging all messages when isDev() is true.
protected static Log	LOG

Method Summary

Modifier and Type	Method and Description
static int	compareCustomizations(String configA, String configB) Compares the two given customizations according to the order given in the system config.
static List<String>	getActiveConfigurations() Returns a list of all active customer configurations.
static Classpath	getClasspath() Provides access to the classpath used to load the framework.
static com.typesafe.config.Config	getConfig() Returns the system config based on the current instance.conf (file system), application.conf (classpath) and all component-XXX.conf
static String	getCustomizationName(String resource) Extracts the customization name from a resource.
static Setup	getSetup() Provides access to the setup instance which was used to configure Sirius.
static long	getUptimeInMilliseconds() Returns the up time of the system in milliseconds.
static boolean	isActiveCustomization(String configName) Determines if the given config is active (or null which is considered active)
static boolean	isConfigurationResource(String resource) Determines if the given resource is part of a configuration.
static boolean	isDev() Determines if the framework is running in development or in production mode.
static boolean	isFrameworkEnabled(String framework) Determines if the framework with the given name is enabled.
static boolean	isProd() Determines if the framework is running in development or in production mode.
static boolean	isStartedAsTest() Determines if the framework was started as test run (JUNIT or the like).
static void	start(Setup setup) Initializes the framework.
static void	stop() Stops the framework.

Methods inherited from class java.lang.Object

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

Field Detail

LOG

protected static final Log LOG

DEBUG

public static final Log DEBUG

This debug logger will be logging all messages when isDev() is true. Otherwise, this logger is set to "OFF".

Method Detail

isDev

public static boolean isDev()

Determines if the framework is running in development or in production mode.

Returns:

true is the framework runs in development mode, false otherwise.

isStartedAsTest

public static boolean isStartedAsTest()

Determines if the framework was started as test run (JUNIT or the like).

Returns:

true if the framework was started as test, false otherwise

isProd

public static boolean isProd()

Determines if the framework is running in development or in production mode.

Returns:

true is the framework runs in production mode, false otherwise.

getClasspath

public static Classpath getClasspath()

Provides access to the classpath used to load the framework.

Returns:

the classpath used to load the framework

stop

public static void stop()

Stops the framework.

start

public static void start(Setup setup)

Initializes the framework.

This is called by IPL.main once the class loader is fully populated.

Parameters:

setup - the setup class used to configure the framework

isFrameworkEnabled

public static boolean isFrameworkEnabled(String framework)

Determines if the framework with the given name is enabled.

Frameworks can be enabled or disabled using the config path sirius.framework.[name]. This is intensively used by the app part, as it provides a lot of basic frameworks which can be turned off or on as required.

Parameters:

framework - the framework to check

Returns:

true if the framework is enabled, false otherwise

getActiveConfigurations

public static List<String> getActiveConfigurations()

Returns a list of all active customer configurations.

A customer configuration can be used to override basic functionality with more specialized classes or resources which were adapted based on customer needs.

As often groups of customers share the same requirements, not only a single configuration can be activated but a list. Within this list each configuration may override classes and resources of all former configurations. Therefore the last configuration will always "win".

Note that classes must be placed in the package: configuration.[name] (with arbitrary sub packages). Also resources must be placed in: configuration/[name]/resource-path.

Returns:

a list of all active configurations

isActiveCustomization

public static boolean isActiveCustomization(@Nullable
                                            String configName)

Determines if the given config is active (or null which is considered active)

Parameters:

configName - the name of the config to check. null will be considered as active

Returns:

true if the named customization is active, false otherwise

isConfigurationResource

public static boolean isConfigurationResource(@Nullable
                                              String resource)

Determines if the given resource is part of a configuration.

Parameters:

resource - the resource path to check

Returns:

true if the given resource is part of a configuration, false otherwise

getCustomizationName

@Nullable
public static String getCustomizationName(@Nullable
                                                    String resource)

Extracts the customization name from a resource.

Valid names are paths like "customizations/[name]/..." or classes like "customizations.[name]...".

Parameters:

resource - the name of the resource

Returns:

the name of the customizations or null if no config name is contained

compareCustomizations

public static int compareCustomizations(@Nullable
                                        String configA,
                                        @Nullable
                                        String configB)

Compares the two given customizations according to the order given in the system config.

Parameters:

configA - the name of the first customization

configB - the name of the second customization

Returns:

an int value which can be used to compare the order of the two given configs.

getConfig

public static com.typesafe.config.Config getConfig()

Returns the system config based on the current instance.conf (file system), application.conf (classpath) and all component-XXX.conf

Returns:

the initialized config or null if the framework is not setup yet.

getSetup

public static Setup getSetup()

Provides access to the setup instance which was used to configure Sirius.

Returns:

the setup instance used to configure Sirius.+

getUptimeInMilliseconds

public static long getUptimeInMilliseconds()

Returns the up time of the system in milliseconds.

Returns:

the number of milliseconds the system is running