org.appng.core.service

Class InitializerService

java.lang.Object

org.appng.core.service.InitializerService

public class InitializerService
extends Object

A service responsible for initializing the appNG platform with all active Sites.

Author:

Matthias Müller

Field Summary

Fields

Modifier and Type	Field and Description
static String	APPNG_GROUP
static String	APPNG_USER

Constructor Summary

Constructors

Constructor and Description
InitializerService()

Method Summary

Modifier and Type	Method and Description
CoreService	getCoreService()
protected PropertySourcesPlaceholderConfigurer	getPlaceholderConfigurer(Properties props)
void	initPlatform(Properties defaultOverrides, Environment env, DatabaseConnection rootConnection, ServletContext ctx, ExecutorService executor) Initializes and loads the platform, which includes logging some environment settings.
Properties	initPlatformConfig(Properties defaultOverrides, String rootPath, Boolean devMode) Initialized and returns the platform configuration represented by a Properties object.
void	loadPlatform(Properties defaultOverrides, Environment env, String siteName, String target, ExecutorService executor) Loads the platform by loading every active Site.
void	loadSite(Environment env, SiteImpl siteToLoad, boolean sendReloadEvent, FieldProcessor fp) Loads the given Site.
void	loadSite(Environment env, SiteImpl siteToLoad, FieldProcessor fp) Loads the given Site.
void	loadSite(SiteImpl siteToLoad, ServletContext servletContext, boolean sendReloadEvent, FieldProcessor fp) Loads the given Site.
void	loadSite(SiteImpl siteToLoad, ServletContext servletContext, FieldProcessor fp) Loads the given Site.
void	reloadPlatform(Properties config, Environment env, String siteName, String target, ExecutorService executor) Reloads the platform with all of it's Sites.
void	setCoreService(CoreService coreService)
void	shutdownPlatform(ServletContext ctx) Shuts down the whole platform by shutting down every active Site.
void	shutDownSite(ServletContext servletContext, Site site) Shuts down the given Site.
protected boolean	startApplication(Environment env, SiteImpl site, ApplicationProvider application)

Methods inherited from class java.lang.Object

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

Field Detail

APPNG_USER

public static final String APPNG_USER

See Also:

Constant Field Values

APPNG_GROUP

public static final String APPNG_GROUP

See Also:

Constant Field Values

Constructor Detail

InitializerService

public InitializerService()

Method Detail

initPlatform

public void initPlatform(Properties defaultOverrides,
                         Environment env,
                         DatabaseConnection rootConnection,
                         ServletContext ctx,
                         ExecutorService executor)
                  throws InvalidConfigurationException

Initializes and loads the platform, which includes logging some environment settings.

Parameters:

env - the current Environment

rootConnection - the root DatabaseConnection

ctx - the current ServletContext

executor - an ExecutorService used by the cluster messaging

Throws:

InvalidConfigurationException - if an configuration error occurred

See Also:

loadPlatform(java.util.Properties, Environment, String, String, ExecutorService)

reloadPlatform

public void reloadPlatform(Properties config,
                           Environment env,
                           String siteName,
                           String target,
                           ExecutorService executor)
                    throws InvalidConfigurationException

Reloads the platform with all of it's Sites.

Parameters:

env - the current Environment

siteName - the (optional) name of the Site that caused the platform reload

target - an (optional) target to redirect to after platform reload

Throws:

InvalidConfigurationException - if an configuration error occurred

loadPlatform

public void loadPlatform(Properties defaultOverrides,
                         Environment env,
                         String siteName,
                         String target,
                         ExecutorService executor)
                  throws InvalidConfigurationException

Loads the platform by loading every active Site.

Parameters:

env - the current Environment

siteName - the (optional) name of the Site that caused the platform reload

target - an (optional) target to redirect to after platform reload

Throws:

InvalidConfigurationException - if an configuration error occurred

initPlatformConfig

public Properties initPlatformConfig(Properties defaultOverrides,
                                     String rootPath,
                                     Boolean devMode)

Initialized and returns the platform configuration represented by a Properties object.

Parameters:

rootPath - the root path of the platform (see Platform.Property.PLATFORM_ROOT_PATH)

devMode - value for the Platform.Property.DEV_MODE property to set

Returns:

the platform configuration

loadSite

public void loadSite(Environment env,
                     SiteImpl siteToLoad,
                     FieldProcessor fp)
              throws InvalidConfigurationException

Loads the given Site.

Parameters:

env - the current Environment

siteToLoad - the Site to load

Throws:

InvalidConfigurationException - if an configuration error occurred

loadSite

public void loadSite(Environment env,
                     SiteImpl siteToLoad,
                     boolean sendReloadEvent,
                     FieldProcessor fp)
              throws InvalidConfigurationException

Loads the given Site.

Parameters:

env - the current Environment

siteToLoad - the Site to load

Throws:

InvalidConfigurationException - if an configuration error occurred

loadSite

public void loadSite(SiteImpl siteToLoad,
                     ServletContext servletContext,
                     FieldProcessor fp)
              throws InvalidConfigurationException

Loads the given Site.

Parameters:

siteToLoad - the Site to load

servletContext - the current ServletContext

Throws:

InvalidConfigurationException - if an configuration error occurred

loadSite

public void loadSite(SiteImpl siteToLoad,
                     ServletContext servletContext,
                     boolean sendReloadEvent,
                     FieldProcessor fp)
              throws InvalidConfigurationException

Loads the given Site.

Parameters:

siteToLoad - the Site to load

servletContext - the current ServletContext

Throws:

InvalidConfigurationException - if an configuration error occurred

startApplication

protected boolean startApplication(Environment env,
                                   SiteImpl site,
                                   ApplicationProvider application)

getPlaceholderConfigurer

protected PropertySourcesPlaceholderConfigurer getPlaceholderConfigurer(Properties props)

shutdownPlatform

public void shutdownPlatform(ServletContext ctx)

Shuts down the whole platform by shutting down every active Site.

Parameters:

ctx - the current ServletContext

See Also:

shutDownSite(ServletContext, Site)

shutDownSite

public void shutDownSite(ServletContext servletContext,
                         Site site)

Shuts down the given Site.

Parameters:

servletContext - the current ServletContext.

site - the Site to shut down

getCoreService

public CoreService getCoreService()

setCoreService

public void setCoreService(CoreService coreService)