com.communote.server.api.core.application

Interface Runtime

All Known Implementing Classes:

DefaultRuntime

public interface Runtime

Communote runtime environment.

Author:

Communote GmbH - http://www.communote.com/

Method Summary

Modifier and Type	Method and Description
void	addCustomInitializer(CustomInitializer customInitializer) Add an initializer to do custom initializations during startup.
void	addInitializationCompleteListener(InitializationCompleteListener listener) Add a listener that is informed after the application was completely initialized.
void	addInitializationCondition(String conditionId) Add a condition which needs to be fulfilled before the application is considered as completely initialized.
void	fulfillInitializationCondition(String conditionId) Mark a condition that was previously added with addInitializationCondition(String) as fulfilled.
ApplicationInformation	getApplicationInformation()
ConfigurationManager	getConfigurationManager()
InitializationStatus	getInitializationStatus()
CommunoteInstaller	getInstaller()
boolean	isCoreInitialized()
boolean	isInitialized()
void	start() Starts the bootstrapping.
void	stop() Stop the runtime and free any resources held.

Method Detail

addCustomInitializer

void addCustomInitializer(CustomInitializer customInitializer)

Add an initializer to do custom initializations during startup. The added initializer will be called after the core components were initialized. Initializers which are added after the application was initialized are ignored.

Parameters:

customInitializer - the additional initializer

addInitializationCompleteListener

void addInitializationCompleteListener(InitializationCompleteListener listener)

Add a listener that is informed after the application was completely initialized.

Parameters:

listener - the listener to add

addInitializationCondition

void addInitializationCondition(String conditionId)

Add a condition which needs to be fulfilled before the application is considered as completely initialized. Adding a condition after the application was initialized has no effect.

Parameters:

conditionId - the ID of the condition

fulfillInitializationCondition

void fulfillInitializationCondition(String conditionId)

Mark a condition that was previously added with addInitializationCondition(String) as fulfilled. If this was the last unfulfilled init condition and the core is already initialized the application will be considered as completely initialized and the initialization complete listeners will be called. If the provided condition was not added the call is ignored.

Parameters:

conditionId - the ID of the condition to fulfill.

getApplicationInformation

ApplicationInformation getApplicationInformation()

Returns:

information about the running Communote

getConfigurationManager

ConfigurationManager getConfigurationManager()

Returns:

manager for accessing and modifying configuration

getInitializationStatus

InitializationStatus getInitializationStatus()

Returns:

the current status of the initialization

getInstaller

CommunoteInstaller getInstaller()

Returns:

the installer to install Communote or null if Communote is already installed.

isCoreInitialized

boolean isCoreInitialized()

Returns:

whether the core application is initialized. This will be true if Communote is installed and the core application with all components is initialized. Some init conditions might not be fulfilled yet.

isInitialized

boolean isInitialized()

Returns:

whether the application is completely initialized. This will be true if isCoreInitialized() returns true and all conditions are fulfilled.

start

void start()

Starts the bootstrapping. If the bootstrapping fails a BootstrapException will be thrown.

stop

void stop()

Stop the runtime and free any resources held.