de.aristaflow.adept2.core.registry.twophase

Class TwoPhasePlatform<T extends ADEPT2Service>

java.lang.Object

de.aristaflow.adept2.core.registry.AristaFlowPlatform

de.aristaflow.adept2.core.registry.twophase.TwoPhasePlatform<T>

Type Parameters:

T - The type of the initial service which is provided after the first phase of bootstrapping.

Direct Known Subclasses:

ClusterPlatform

public class TwoPhasePlatform<T extends ADEPT2Service>
extends AristaFlowPlatform

A platform that bootstraps and shuts down in two phases. First the registry is only bootstrapped to retrieve the initial service provided in the constructor. After the first phase, the initial service may be used before bootstrapping is continued. Make sure to call this method, without it, the platform cannot be used properly!

If no initial service is provided, the platform will be completely started after the first phase. In this case the method will return null.

If you bootstrapped in two phases, you can also terminate in two reverse phases: terminateToInitialService() will shut down all services started after the initial service and AristaFlowPlatform.terminate() will afterwards terminate the remaining services and the platform itself. Make sure (using finally) to call AristaFlowPlatform.terminate()! If you just call AristaFlowPlatform.terminate() without terminateToInitialService(), the platform will be terminated completely in one step.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.Class<T>	initialServiceCls The class of the initial service.
protected java.lang.String	initialServiceType The type name of the initial service.
protected static boolean	TEST_SINGLETON Whether to start as singleton or to allow multiple instances.

Fields inherited from class de.aristaflow.adept2.core.registry.AristaFlowPlatform

confMgr

Constructor Summary

Constructors

Modifier	Constructor and Description
	TwoPhasePlatform(java.lang.Class<T> initialServiceCls, java.lang.String initialServiceType) Creates a new TwoPhasePlatform.
	TwoPhasePlatform(java.lang.Class<T> initialServiceCls, java.lang.String initialServiceType, boolean eager) Creates a new TwoPhasePlatform.
	TwoPhasePlatform(java.lang.Class<T> initialServiceCls, java.lang.String initialServiceType, boolean eager, Configuration conf) Creates a new TwoPhasePlatform.
	TwoPhasePlatform(java.lang.Class<T> initialServiceCls, java.lang.String initialServiceType, boolean eager, Configuration conf, ConfigurationPropertyProvider provider) Creates a new TwoPhasePlatform.
	TwoPhasePlatform(java.lang.Class<T> initialServiceCls, java.lang.String initialServiceType, boolean eager, ConfigurationPropertyProvider provider) Creates a new TwoPhasePlatform.
	TwoPhasePlatform(java.lang.Class<T> initialServiceCls, java.lang.String initialServiceType, Configuration conf) Creates a new TwoPhasePlatform.
	TwoPhasePlatform(java.lang.Class<T> initialServiceCls, java.lang.String initialServiceType, Configuration conf, ConfigurationPropertyProvider provider) Creates a new TwoPhasePlatform.
	TwoPhasePlatform(java.lang.Class<T> initialServiceCls, java.lang.String initialServiceType, ConfigurationPropertyProvider provider) Creates a new TwoPhasePlatform.
protected	TwoPhasePlatform(java.lang.Class<T> initialServiceCls, java.lang.String initialServiceType, java.lang.String rootConfFileName, Configuration providedConfiguration, boolean eager, ConfigurationPropertyProvider provider) Creates a new TwoPhasePlatform.

Method Summary

Modifier and Type	Method and Description
GlobalRegistry	continueBootstrap() Continues the bootstrap.
protected BootstrapRegistry	createBootstrapRegistry(UrlConfigurationManager confMgr) Creates a new bootstrap registry having the designated configuration manager.
protected GlobalRegistry	globalRegistryChanged(SessionToken session, java.net.URI globRegUri) Notifies the bootstrap registry that the URI of the global registry has changed to the designated URI.
T	startBootstrap() Bootstraps the platform partially, that is, just for retrieving the initial service.
T	terminateToInitialService() Terminates all services until the initial service.

Methods inherited from class de.aristaflow.adept2.core.registry.AristaFlowPlatform

bootstrap, bootstrap, createConfigurationManager, getBootstrapRegistry, getClientService, getRegistry, getRootConfiguration, terminate, terminateSafely

Methods inherited from class java.lang.Object

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

Field Detail

TEST_SINGLETON

protected static boolean TEST_SINGLETON

Whether to start as singleton or to allow multiple instances.

This is only for testing purpose! Always reset it in a finally-clause.

initialServiceCls

protected final java.lang.Class<T extends ADEPT2Service> initialServiceCls

The class of the initial service.

initialServiceType

protected final java.lang.String initialServiceType

The type name of the initial service.

Constructor Detail

TwoPhasePlatform

public TwoPhasePlatform(java.lang.Class<T> initialServiceCls,
                        java.lang.String initialServiceType)
                 throws AbortServiceException

Creates a new TwoPhasePlatform.

Parameters:

initialServiceCls - The class of the initial service. If this is null, this registry will act like the normal BootstrapRegistry.

initialServiceType - The type name of the initial service. If this is null or the empty string, this registry will act like the normal BootstrapRegistry.

Throws:

AbortServiceException - If the platform has already been bootstrapped or the initialisation or starting of the registry fails, an AbortServiceException will be thrown.

See Also:

AristaFlowPlatform.AristaFlowPlatform()

TwoPhasePlatform

public TwoPhasePlatform(java.lang.Class<T> initialServiceCls,
                        java.lang.String initialServiceType,
                        ConfigurationPropertyProvider provider)
                 throws AbortServiceException

Creates a new TwoPhasePlatform.

Parameters:

initialServiceCls - The class of the initial service. If this is null, this registry will act like the normal BootstrapRegistry.

initialServiceType - The type name of the initial service. If this is null or the empty string, this registry will act like the normal BootstrapRegistry.

provider - The provider for the global properties including the configuration directories to load additional configurations for the root configuration from. This must not be null.

Throws:

AbortServiceException - If the platform has already been bootstrapped or the initialisation or starting of the registry fails, an AbortServiceException will be thrown.

See Also:

AristaFlowPlatform.AristaFlowPlatform(ConfigurationPropertyProvider)

TwoPhasePlatform

public TwoPhasePlatform(java.lang.Class<T> initialServiceCls,
                        java.lang.String initialServiceType,
                        Configuration conf)
                 throws AbortServiceException

Creates a new TwoPhasePlatform.

Parameters:

initialServiceCls - The class of the initial service. If this is null, this registry will act like the normal BootstrapRegistry.

initialServiceType - The type name of the initial service. If this is null or the empty string, this registry will act like the normal BootstrapRegistry.

conf - The configuration provided when bootstrapping. This may either be a complete root configuration (without additional configuration directories), a delta configuration complementing or overriding the configurations from the configuration directories or even null. If this is null, only configurations from the configuration directories will be used but this requires a valid rootConfFileName.

Throws:

AbortServiceException - If the platform has already been bootstrapped or the initialisation or starting of the registry fails, an AbortServiceException will be thrown.

See Also:

AristaFlowPlatform.AristaFlowPlatform(Configuration)

TwoPhasePlatform

public TwoPhasePlatform(java.lang.Class<T> initialServiceCls,
                        java.lang.String initialServiceType,
                        Configuration conf,
                        ConfigurationPropertyProvider provider)
                 throws AbortServiceException

Creates a new TwoPhasePlatform.

Parameters:

initialServiceCls - The class of the initial service. If this is null, this registry will act like the normal BootstrapRegistry.

initialServiceType - The type name of the initial service. If this is null or the empty string, this registry will act like the normal BootstrapRegistry.

conf - The configuration provided when bootstrapping. This may either be a complete root configuration (without additional configuration directories), a delta configuration complementing or overriding the configurations from the configuration directories or even null. If this is null, only configurations from the configuration directories will be used but this requires a valid rootConfFileName.

provider - The provider for the global properties including the configuration directories to load additional configurations for the root configuration from. This must not be null.

Throws:

AbortServiceException - If the platform has already been bootstrapped or the initialisation or starting of the registry fails, an AbortServiceException will be thrown.

See Also:

AristaFlowPlatform.AristaFlowPlatform(Configuration, ConfigurationPropertyProvider)

TwoPhasePlatform

public TwoPhasePlatform(java.lang.Class<T> initialServiceCls,
                        java.lang.String initialServiceType,
                        boolean eager)
                 throws ConfigurationException

Creates a new TwoPhasePlatform.

Parameters:

initialServiceCls - The class of the initial service. If this is null, this registry will act like the normal BootstrapRegistry.

initialServiceType - The type name of the initial service. If this is null or the empty string, this registry will act like the normal BootstrapRegistry.

eager - Whether to (transitively) load all referenced configuration files for the root configuration.

Throws:

ConfigurationException - If

• there are problems initialising the global properties,
• there is no root configuration file name and no valid provided configuration,
• there is no valid provided configuration and no configuration directory has been set,
• one of the configuration directories cannot be accessed,
• the configuration bundle order is not defined,
• the designated root configuration file name could not be found in any of the searched configuration directories,
• the directory for storing the logs can not be created or it is a file, or
• there are problems eagerly loading the externally referenced configuration files,

a ConfigurationException will be thrown.

See Also:

AristaFlowPlatform.AristaFlowPlatform(boolean)

TwoPhasePlatform

public TwoPhasePlatform(java.lang.Class<T> initialServiceCls,
                        java.lang.String initialServiceType,
                        boolean eager,
                        ConfigurationPropertyProvider provider)
                 throws ConfigurationException

Creates a new TwoPhasePlatform.

Parameters:

initialServiceCls - The class of the initial service. If this is null, this registry will act like the normal BootstrapRegistry.

initialServiceType - The type name of the initial service. If this is null or the empty string, this registry will act like the normal BootstrapRegistry.

eager - Whether to (transitively) load all referenced configuration files for the root configuration.

provider - The provider for the global properties including the configuration directories to load additional configurations for the root configuration from. This must not be null.

Throws:

ConfigurationException - If

• there are problems initialising the global properties,
• there is no root configuration file name and no valid provided configuration,
• there is no valid provided configuration and no configuration directory has been set,
• one of the configuration directories cannot be accessed,
• the configuration bundle order is not defined,
• the designated root configuration file name could not be found in any of the searched configuration directories,
• the directory for storing the logs can not be created or it is a file, or
• there are problems eagerly loading the externally referenced configuration files,

a ConfigurationException will be thrown.

See Also:

AristaFlowPlatform.AristaFlowPlatform(boolean, ConfigurationPropertyProvider)

TwoPhasePlatform

public TwoPhasePlatform(java.lang.Class<T> initialServiceCls,
                        java.lang.String initialServiceType,
                        boolean eager,
                        Configuration conf)
                 throws ConfigurationException

Creates a new TwoPhasePlatform.

Parameters:

initialServiceCls - The class of the initial service. If this is null, this registry will act like the normal BootstrapRegistry.

initialServiceType - The type name of the initial service. If this is null or the empty string, this registry will act like the normal BootstrapRegistry.

eager - Whether to (transitively) load all referenced configuration files for the root configuration.

conf - The configuration provided when bootstrapping. This may either be a complete root configuration (without additional configuration directories), a delta configuration complementing or overriding the configurations from the configuration directories or even null. If this is null, only configurations from the configuration directories will be used but this requires a valid rootConfFileName.

Throws:

ConfigurationException - If

• there are problems initialising the global properties,
• there is no root configuration file name and no valid provided configuration,
• there is no valid provided configuration and no configuration directory has been set,
• one of the configuration directories cannot be accessed,
• the configuration bundle order is not defined,
• the designated root configuration file name could not be found in any of the searched configuration directories,
• the directory for storing the logs can not be created or it is a file, or
• there are problems eagerly loading the externally referenced configuration files,

a ConfigurationException will be thrown.

See Also:

AristaFlowPlatform.AristaFlowPlatform(boolean, Configuration)

TwoPhasePlatform

public TwoPhasePlatform(java.lang.Class<T> initialServiceCls,
                        java.lang.String initialServiceType,
                        boolean eager,
                        Configuration conf,
                        ConfigurationPropertyProvider provider)
                 throws ConfigurationException

Creates a new TwoPhasePlatform.

Parameters:

initialServiceCls - The class of the initial service. If this is null, this registry will act like the normal BootstrapRegistry.

initialServiceType - The type name of the initial service. If this is null or the empty string, this registry will act like the normal BootstrapRegistry.

eager - Whether to (transitively) load all referenced configuration files for the root configuration.

conf - The configuration provided when bootstrapping. This may either be a complete root configuration (without additional configuration directories), a delta configuration complementing or overriding the configurations from the configuration directories or even null. If this is null, only configurations from the configuration directories will be used but this requires a valid rootConfFileName.

provider - The provider for the global properties including the configuration directories to load additional configurations for the root configuration from. This must not be null.

Throws:

ConfigurationException - If

• there are problems initialising the global properties,
• there is no root configuration file name and no valid provided configuration,
• there is no valid provided configuration and no configuration directory has been set,
• one of the configuration directories cannot be accessed,
• the configuration bundle order is not defined,
• the designated root configuration file name could not be found in any of the searched configuration directories,
• the directory for storing the logs can not be created or it is a file, or
• there are problems eagerly loading the externally referenced configuration files,

a ConfigurationException will be thrown.

See Also:

AristaFlowPlatform.AristaFlowPlatform(boolean, Configuration, ConfigurationPropertyProvider)

TwoPhasePlatform

protected TwoPhasePlatform(java.lang.Class<T> initialServiceCls,
                           java.lang.String initialServiceType,
                           java.lang.String rootConfFileName,
                           Configuration providedConfiguration,
                           boolean eager,
                           ConfigurationPropertyProvider provider)
                    throws ConfigurationException

Creates a new TwoPhasePlatform.

Parameters:

initialServiceCls - The class of the initial service. If this is null, this registry will act like the normal BootstrapRegistry.

initialServiceType - The type name of the initial service. If this is null or the empty string, this registry will act like the normal BootstrapRegistry.

rootConfFileName - The name of the file (relative to the configuration directory/directories) containing the root configuration that is searched for in the configuration directories specified by the designated provider. This may be null but then the designated configuration has to be a complete root configuration.

providedConfiguration - The configuration provided when bootstrapping. This may either be a complete root configuration (without additional configuration directories), a delta configuration complementing or overriding the configurations from the configuration directories or even null. If this is null, only configurations from the configuration directories will be used but this requires a valid rootConfFileName.

eager - Whether to (transitively) load all referenced configuration files for the root configuration.

provider - The provider for the global properties including the configuration directories to load additional configurations for the root configuration from. This must not be null.

Throws:

ConfigurationException - If

• there are problems initialising the global properties,
• there is no root configuration file name and no valid provided configuration,
• there is no valid provided configuration and no configuration directory has been set,
• one of the configuration directories cannot be accessed,
• the configuration bundle order is not defined,
• the designated root configuration file name could not be found in any of the searched configuration directories,
• the directory for storing the logs can not be created or it is a file, or
• there are problems eagerly loading the externally referenced configuration files,

a ConfigurationException will be thrown.

See Also:

AristaFlowPlatform.AristaFlowPlatform(Configuration, ConfigurationPropertyProvider)

Method Detail

createBootstrapRegistry

protected BootstrapRegistry createBootstrapRegistry(UrlConfigurationManager confMgr)
                                             throws AbortServiceException

Description copied from class: AristaFlowPlatform

Creates a new bootstrap registry having the designated configuration manager. This is just a factory method.

Overrides:

createBootstrapRegistry in class AristaFlowPlatform

Parameters:

confMgr - The initial configuration manager that provides the root configuration and configurations for the loaded component instances.

Returns:

The created bootstrap registry.

Throws:

ConfigurationException - If the registry configuration is invalid, a ConfigurationExceptionwill be thrown.

AbortServiceException - If the initialisation or starting of the registry fails, an AbortServiceException will be thrown.

startBootstrap

public T startBootstrap()
                 throws AbortServiceException

Bootstraps the platform partially, that is, just for retrieving the initial service.

Returns:

The initial service from the bootstrap registry or null if no initial service is specified.

Throws:

AbortServiceException - If the platform has already been bootstrapped or the initialisation or starting of the registry fails, an AbortServiceException will be thrown.

See Also:

AristaFlowPlatform.bootstrap()

continueBootstrap

public GlobalRegistry continueBootstrap()
                                 throws AbortServiceException

Continues the bootstrap.

Returns:

The global registry which provides access to public services.

Throws:

AbortServiceException - If there are problems preparing the security manager or starting one of the services to be automatically started, an AbortServiceException will be thrown.

See Also:

TwoPhaseBootstrap.continueBootstrap()

terminateToInitialService

public T terminateToInitialService()

Terminates all services until the initial service. This can then be used before terminating completely. If no initial service is specified, this will terminate completely.

Returns:

The initial service from the bootstrap registry or null if no initial service is specified or bootstrapping has not proceeded to the initial service.

globalRegistryChanged

protected GlobalRegistry globalRegistryChanged(SessionToken session,
                                               java.net.URI globRegUri)
                                        throws ServiceNotKnownException

Notifies the bootstrap registry that the URI of the global registry has changed to the designated URI. This allows for changing the global registry (usually due to the server in a cluster node) while the platform keeps on running.

Parameters:

session - The session which is used to check for access rights on this method.

globRegUri - The new URI of the global registry.

Returns:

The default instance of the global registry with the designated new URI.

Throws:

ServiceNotKnownException - If the default instance of the global registry cannot be retrieved with the new URI, a ServiceNotKnownException will be thrown.