org.pentaho.reporting.libraries.base.boot

Class AbstractBoot

public abstract class AbstractBoot extends Object implements SubSystem

The common base for all Boot classes.

This initializes the subsystem and all dependent subsystems. Implementors of this class have to provide a public static getInstance() method which returns a singleton instance of the booter implementation.

Further creation of Boot object should be prevented using protected or private constructors in that class, or proper singleton behaviour cannot be guaranteed.

Author: Thomas Morgner

Constructor Summary
protected	AbstractBoot() Default constructor.

Method Summary
protected Configuration	createDefaultHierarchicalConfiguration(String staticConfig, String userConfig, boolean addSysProps, Class source) Creates a default configuration setup, which loads its settings from the static configuration (defaults provided by the developers of the library) and the user configuration (settings provided by the deployer).
Exception	getBootFailureReason() Returns the failure reason for the boot process.
ExtendedConfiguration	getExtendedConfig() Returns the global configuration as extended configuration.
Configuration	getGlobalConfig() Returns the global configuration.
PackageManager	getPackageManager() Returns the packageManager instance of the package manager.
protected abstract ProjectInformation	getProjectInfo() Returns the project info.
boolean	isBootDone() Checks, whether the booting is complete.
boolean	isBootFailed() Checks whether the booting failed.
boolean	isBootInProgress() Checks, whether the booting is in progress.
protected AbstractBoot	loadBooter(String classname) Loads the specified booter implementation.
static AbstractBoot	loadBooter(String classname, Class source)
protected abstract Configuration	loadConfiguration() Loads the configuration.
protected abstract void	performBoot() Performs the boot.
void	start() Starts the boot process.

Constructor Detail

AbstractBoot

protected AbstractBoot()

Default constructor.

Method Detail

createDefaultHierarchicalConfiguration

protected Configuration createDefaultHierarchicalConfiguration(String staticConfig, String userConfig, boolean addSysProps, Class source)

Creates a default configuration setup, which loads its settings from the static configuration (defaults provided by the developers of the library) and the user configuration (settings provided by the deployer). The deployer's settings override the developer's settings.

If the parameter addSysProps is set to true, the system properties will be added as third configuration layer. The system properties configuration allows to override all other settings.

Parameters: staticConfig the resource name of the developers configuration userConfig the resource name of the deployers configuration addSysProps a flag defining whether to include the system properties into the configuration. source the classloader source to load resources from.

Returns: the configured Configuration instance.

getBootFailureReason

public Exception getBootFailureReason()

Returns the failure reason for the boot process. This method returns null, if booting was successful.

Returns: the failure reason.

getExtendedConfig

public ExtendedConfiguration getExtendedConfig()

Returns the global configuration as extended configuration.

Returns: the extended configuration.

getGlobalConfig

public Configuration getGlobalConfig()

Returns the global configuration.

Returns: The global configuration.

getPackageManager

public PackageManager getPackageManager()

Returns the packageManager instance of the package manager.

Returns: The package manager.

getProjectInfo

protected abstract ProjectInformation getProjectInfo()

Returns the project info.

Returns: The project info.

isBootDone

public final boolean isBootDone()

Checks, whether the booting is complete.

Returns: true, if the booting is complete, false otherwise.

isBootFailed

public boolean isBootFailed()

Checks whether the booting failed. If booting failed, the reason for the failure (the Exception that caused the error) is stored as property bootFailureReason.

Returns: true, if booting failed, false otherwise.

isBootInProgress

public final boolean isBootInProgress()

Checks, whether the booting is in progress.

Returns: true, if the booting is in progress, false otherwise.

loadBooter

protected AbstractBoot loadBooter(String classname)

Loads the specified booter implementation.

Parameters: classname the class name.

Returns: The boot class.

loadBooter

public static AbstractBoot loadBooter(String classname, Class source)

loadConfiguration

protected abstract Configuration loadConfiguration()

Loads the configuration. This will be called exactly once.

Returns: The configuration.

performBoot

protected abstract void performBoot()

Performs the boot.

start

public final void start()

Starts the boot process. The boot process is synchronized and will block if parallel booting is not finished yet. Any failure in booting will set the bootFailed property to true. If booting is finished, the bootDone property is set to true.