Package dev.galasa.framework

Class FrameworkInitialisation

java.lang.Object

dev.galasa.framework.FrameworkInitialisation

All Implemented Interfaces:

IFrameworkInitialisation

public class FrameworkInitialisation
extends Object
implements IFrameworkInitialisation

Field Summary

Fields

Modifier and Type	Field	Description
protected Framework	framework

Constructor Summary

Constructors

Constructor	Description
FrameworkInitialisation(Properties bootstrapProperties, Properties overrideProperties)
FrameworkInitialisation(Properties bootstrapProperties, Properties overrideProperties, boolean isTestRun)	Deprecated, for removal: This API element is subject to removal in a future version. Use one of the other constructors.
FrameworkInitialisation(Properties bootstrapProperties, Properties overrideProperties, boolean isTestRun, org.apache.commons.logging.Log initLogger)	Deprecated, for removal: This API element is subject to removal in a future version. Use one of the other constructors.
FrameworkInitialisation(Properties bootstrapProperties, Properties overrideProperties, boolean isTestRun, org.apache.commons.logging.Log initLogger, org.osgi.framework.BundleContext bundleContext, IFileSystem fileSystem, Environment env)	Deprecated, for removal: This API element is subject to removal in a future version. Use one of the other constructors.
FrameworkInitialisation(Properties bootstrapProperties, Properties overrideProperties, IFrameworkInitialisationStrategy initStrategy)
FrameworkInitialisation(Properties bootstrapProperties, Properties overrideProperties, org.apache.commons.logging.Log initLogger, org.osgi.framework.BundleContext bundleContext, IFileSystem fileSystem, Environment env, IFrameworkInitialisationStrategy initStrategy)

Method Summary

Modifier and Type	Method	Description
@NotNull URI	getBootstrapConfigurationPropertyStore()	Retrieves the Configuration Property Store that was set in the bootstrap
URI	getCredentialsStoreUri()
URI	getDynamicStatusStoreUri()
@NotNull IFramework	getFramework()	Retrieve the IFramework object.
String	getGalasaHome(Environment env)	Obtain the location of the galasa home directory
List<URI>	getResultArchiveStoreUris()	Retrieves a list of Result Archive URIs that need to be initialised
@NotNull IShuttableFramework	getShutableFramework()
void	registerCertificateStoreService(@NotNull ICertificateStoreService certificateStoreService)	Register a Certificate Store Service.
void	registerConfidentialTextService(@NotNull IConfidentialTextService confidentialTextService)
void	registerConfigurationPropertyStore(@NotNull IConfigurationPropertyStore configurationPropertyStore)	Register the active Configuration Property StoreService.
void	registerCredentialsStore(@NotNull ICredentialsStore credentialsStore)
void	registerDynamicStatusStore(@NotNull IDynamicStatusStore dynamicStatusStore)
void	registerEventsService(@NotNull IEventsService eventsService)
void	registerResultArchiveStoreService(@NotNull IResultArchiveStoreService resultArchiveStoreService)	Register a Result Archive Store Service.
void	shutdownFramework()

Methods inherited from class java.lang.Object

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

Field Details

framework

protected Framework framework

Constructor Details

FrameworkInitialisation

public FrameworkInitialisation(Properties bootstrapProperties,
 Properties overrideProperties)
                        throws URISyntaxException,
org.osgi.framework.InvalidSyntaxException,
FrameworkException

Throws:

URISyntaxException

org.osgi.framework.InvalidSyntaxException

FrameworkException

FrameworkInitialisation

@Deprecated(since="0.40.0",
            forRemoval=true)
public FrameworkInitialisation(Properties bootstrapProperties,
 Properties overrideProperties,
 boolean isTestRun)
                        throws URISyntaxException,
org.osgi.framework.InvalidSyntaxException,
FrameworkException

Deprecated, for removal: This API element is subject to removal in a future version.

Use one of the other constructors.

Throws:

URISyntaxException

org.osgi.framework.InvalidSyntaxException

FrameworkException

FrameworkInitialisation

public FrameworkInitialisation(Properties bootstrapProperties,
 Properties overrideProperties,
 IFrameworkInitialisationStrategy initStrategy)
                        throws URISyntaxException,
org.osgi.framework.InvalidSyntaxException,
FrameworkException

Throws:

URISyntaxException

org.osgi.framework.InvalidSyntaxException

FrameworkException

FrameworkInitialisation

@Deprecated(since="0.40.0",
            forRemoval=true)
public FrameworkInitialisation(Properties bootstrapProperties,
 Properties overrideProperties,
 boolean isTestRun,
 org.apache.commons.logging.Log initLogger)
                        throws URISyntaxException,
org.osgi.framework.InvalidSyntaxException,
FrameworkException

Deprecated, for removal: This API element is subject to removal in a future version.

Use one of the other constructors.

Throws:

URISyntaxException

org.osgi.framework.InvalidSyntaxException

FrameworkException

FrameworkInitialisation

@Deprecated(since="0.40.0",
            forRemoval=true)
public FrameworkInitialisation(Properties bootstrapProperties,
 Properties overrideProperties,
 boolean isTestRun,
 org.apache.commons.logging.Log initLogger,
 org.osgi.framework.BundleContext bundleContext,
 IFileSystem fileSystem,
 Environment env)
                        throws URISyntaxException,
org.osgi.framework.InvalidSyntaxException,
FrameworkException

Deprecated, for removal: This API element is subject to removal in a future version.

Use one of the other constructors.

Throws:

URISyntaxException

org.osgi.framework.InvalidSyntaxException

FrameworkException

FrameworkInitialisation

public FrameworkInitialisation(Properties bootstrapProperties,
 Properties overrideProperties,
 org.apache.commons.logging.Log initLogger,
 org.osgi.framework.BundleContext bundleContext,
 IFileSystem fileSystem,
 Environment env,
 IFrameworkInitialisationStrategy initStrategy)
                        throws URISyntaxException,
org.osgi.framework.InvalidSyntaxException,
FrameworkException

Parameters:

bootstrapProperties -

overrideProperties -

initLogger -

bundleContext -

fileSystem -

env -

initStrategy - One of the initialisation strategies, depending on what you want to use the Framework for. See `GalasaFactory.getInstance().newDefaultInitStrategy()` or one of the other `newXXXStrategy` methods.

Throws:

URISyntaxException

org.osgi.framework.InvalidSyntaxException

FrameworkException

Method Details

getGalasaHome

public String getGalasaHome(Environment env)

Obtain the location of the galasa home directory

Returns:

a String representing the location of the users Galasa home directory

getBootstrapConfigurationPropertyStore

@NotNull
public @NotNull URI getBootstrapConfigurationPropertyStore()

Description copied from interface: IFrameworkInitialisation

Retrieves the Configuration Property Store that was set in the bootstrap

Specified by:

getBootstrapConfigurationPropertyStore in interface IFrameworkInitialisation

Returns:

URI

getDynamicStatusStoreUri

public URI getDynamicStatusStoreUri()

Specified by:

getDynamicStatusStoreUri in interface IFrameworkInitialisation

getCredentialsStoreUri

public URI getCredentialsStoreUri()

Specified by:

getCredentialsStoreUri in interface IFrameworkInitialisation

getResultArchiveStoreUris

public List<URI> getResultArchiveStoreUris()

Description copied from interface: IFrameworkInitialisation

Retrieves a list of Result Archive URIs that need to be initialised

Specified by:

getResultArchiveStoreUris in interface IFrameworkInitialisation

Returns:

A list of URIs describing the RASs to be activated

registerConfigurationPropertyStore

public void registerConfigurationPropertyStore(@NotNull
 @NotNull IConfigurationPropertyStore configurationPropertyStore)
                                        throws ConfigurationPropertyStoreException

Description copied from interface: IFrameworkInitialisation

Register the active Configuration Property StoreService. This can only be called once per test run or service instance and will be one of the very first things done during initialisation. If a second CPS attempts register itself, ConfigurationPropertyStoreException will be thrown.

Specified by:

registerConfigurationPropertyStore in interface IFrameworkInitialisation

Parameters:

configurationPropertyStore - - the configuration property store service chosen to be active

Throws:

ConfigurationPropertyStoreException - - Only if a 2nd attempt to register a CPS was performed

registerDynamicStatusStore

public void registerDynamicStatusStore(@NotNull
 @NotNull IDynamicStatusStore dynamicStatusStore)
                                throws DynamicStatusStoreException

Specified by:

registerDynamicStatusStore in interface IFrameworkInitialisation

Throws:

DynamicStatusStoreException

registerResultArchiveStoreService

public void registerResultArchiveStoreService(@NotNull
 @NotNull IResultArchiveStoreService resultArchiveStoreService)
                                       throws ResultArchiveStoreException

Description copied from interface: IFrameworkInitialisation

Register a Result Archive Store Service. Multiple Result Archive stores can be registered per test run or service instance and will be one of the first things done during initialisation.

Specified by:

registerResultArchiveStoreService in interface IFrameworkInitialisation

Parameters:

resultArchiveStoreService - - the result archive store service to be registered

Throws:

ResultArchiveStoreException - If there is a problem registering the service

registerConfidentialTextService

public void registerConfidentialTextService(@NotNull
 @NotNull IConfidentialTextService confidentialTextService)
                                     throws ConfidentialTextException

Specified by:

registerConfidentialTextService in interface IFrameworkInitialisation

Throws:

ConfidentialTextException

registerCredentialsStore

public void registerCredentialsStore(@NotNull
 @NotNull ICredentialsStore credentialsStore)
                              throws CredentialsException

Specified by:

registerCredentialsStore in interface IFrameworkInitialisation

Throws:

CredentialsException

registerEventsService

public void registerEventsService(@NotNull
 @NotNull IEventsService eventsService)
                           throws EventsException

Specified by:

registerEventsService in interface IFrameworkInitialisation

Throws:

EventsException

getFramework

@NotNull
public @NotNull IFramework getFramework()

Description copied from interface: IFrameworkInitialisation

Retrieve the IFramework object. Not all the methods will be valid during the initialisation period. Review the Framework Lifecycle to determine when parts of the Framework is initialised

Specified by:

getFramework in interface IFrameworkInitialisation

Returns:

IFramework

getShutableFramework

@NotNull
public @NotNull IShuttableFramework getShutableFramework()

shutdownFramework

public void shutdownFramework()

registerCertificateStoreService

public void registerCertificateStoreService(@NotNull
 @NotNull ICertificateStoreService certificateStoreService)
                                     throws CertificateStoreException

Description copied from interface: IFrameworkInitialisation

Register a Certificate Store Service.

Specified by:

registerCertificateStoreService in interface IFrameworkInitialisation

Parameters:

certificateStoreService - - the certificate store service to be registered

Throws:

CertificateStoreException - If there is a problem registering the service