Package dev.galasa.framework

Class Framework

java.lang.Object

dev.galasa.framework.Framework

All Implemented Interfaces:

IFramework, IShuttableFramework

public class Framework
extends Object
implements IFramework, IShuttableFramework

Constructor Summary

Constructors

Modifier	Constructor	Description
	Framework()
protected	Framework(Environment env)

Method Summary

Modifier and Type	Method	Description
void	activate(org.osgi.framework.BundleContext bundleContext)
void	addResultArchiveStoreService(@NotNull IResultArchiveStoreService resultArchiveStoreService)	Add a new Result Archive Store Service to the framework, eventually we will have the ability to have multiples RASs running
void	deactivate()
URL	getApiUrl(Api api)
IAuthStore	getAuthStore()	Retrieve the Auth Store from the framework.
IAuthStoreService	getAuthStoreService()	Retrieve the Auth Store Service which can be used to retrieve users and tokens from the store.
@NotNull ICertificateStoreService	getCertificateStoreService()	Retrieve the Certificate Store Service which can be used to retrieve keystores of certificates or individual certificates from the store.
@NotNull IConfidentialTextService	getConfidentialTextService()	Provide access to the Confidential Text Service
@NotNull IConfigurationPropertyStoreService	getConfigurationPropertyService(@NotNull String namespace)	Retrieve the Configuration Property Store service from the framework.
protected IConfigurationPropertyStore	getConfigurationPropertyStore()	Retrieve the active CPS Service
@NotNull ICredentialsService	getCredentialsService()
protected ICredentialsStore	getCredentialsStore()
protected IDynamicStatusStore	getDynamicStatusStore()	Retrieve the active DSS Service
@NotNull IDynamicStatusStoreService	getDynamicStatusStoreService(@NotNull String namespace)	Retrieve the Dynamic Status Store service from the framework.
IEventsService	getEventsService()
IFrameworkRuns	getFrameworkRuns()
Random	getRandom()	Get a predefined Random object for sharing across all managers and servers
RBACService	getRBACService()
Properties	getRecordProperties()
@NotNull IResourcePoolingService	getResourcePoolingService()	Provide access to the Resource Pooling Service
@NotNull IResultArchiveStore	getResultArchiveStore()	Retrieve the Result Archive Store from the framework.
protected IResultArchiveStoreService	getResultArchiveStoreService()
SharedEnvironmentRunType	getSharedEnvironmentRunType()	If this is a shared environment run, return the run type
@NotNull IStreamsService	getStreamsService()
IRun	getTestRun()
String	getTestRunName()	Retrieve the test run name.
void	installLogCapture()
boolean	isInitialised()
boolean	isShutdown()
void	setAuthStore(@NotNull IAuthStore authStore)
void	setConfidentialTextService(@NotNull IConfidentialTextService confidentialTextService)
protected void	setConfigurationPropertyStore(@NotNull IConfigurationPropertyStore cpsStore)	Set the new Configuration Property Store Service
void	setCredentialsStore(@NotNull ICredentialsStore credsStore)
void	setDynamicStatusStore(@NotNull IDynamicStatusStore dssStore)
void	setEventsService(@NotNull IEventsService eventsService)
void	setFrameworkProperties(Properties overridesProperties)
void	setTestRunName(String runName)	Set the run name if it is a test run
void	shutdown()
void	shutdown(org.apache.commons.logging.Log shutdownLogger)

Methods inherited from class java.lang.Object

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

Constructor Details

Framework

public Framework()

Framework

protected Framework(Environment env)

Method Details

activate

public void activate(org.osgi.framework.BundleContext bundleContext)

deactivate

public void deactivate()

setFrameworkProperties

public void setFrameworkProperties(Properties overridesProperties)

Specified by:

setFrameworkProperties in interface IFramework

isInitialised

public boolean isInitialised()

Specified by:

isInitialised in interface IFramework

isShutdown

public boolean isShutdown()

getConfigurationPropertyService

@NotNull
public @NotNull IConfigurationPropertyStoreService getConfigurationPropertyService(@NotNull
 @NotNull String namespace)
                                                                            throws ConfigurationPropertyStoreException

Description copied from interface: IFramework

Retrieve the Configuration Property Store service from the framework. This will allow you to access the configuration properties.

The namespace is used to departmentalise the configuration properties to prevent managers from directly accessing another manager's properties.

the namespace can be alphanumeric, but no '.', cannot be an empty string and cannot be null

As an example, the zOS Batch Manager would have a namespace of 'zosbatch'. The zOS Manager with be 'zos'.

Specified by:

getConfigurationPropertyService in interface IFramework

Parameters:

namespace - - The string used to identify the manager/service to the configuration store

Returns:

A IConfigurationPropertyStore, cannot be null

Throws:

ConfigurationPropertyStoreException - - If an invalid namespace is given

getDynamicStatusStoreService

@NotNull
public @NotNull IDynamicStatusStoreService getDynamicStatusStoreService(@NotNull
 @NotNull String namespace)
                                                                 throws DynamicStatusStoreException

Description copied from interface: IFramework

Retrieve the Dynamic Status Store service from the framework. This will allow you to access the dynamic status store.

The namespace is used to departmentalise the status properties to prevent managers from directly accessing another manager's properties.

the namespace can be alphanumeric, but no '.', cannot be an empty string and cannot be null

As an example, the zOS Batch Manager would have a namespace of 'zosbatch'. The zOS Manager with be 'zos'.

Specified by:

getDynamicStatusStoreService in interface IFramework

Parameters:

namespace - - The string used to identify the manager/service to the dynamic status store

Returns:

The dynamic status store service for the specified namespace

Throws:

DynamicStatusStoreException

getResultArchiveStore

@NotNull
public @NotNull IResultArchiveStore getResultArchiveStore()

Description copied from interface: IFramework

Retrieve the Result Archive Store from the framework.

Specified by:

getResultArchiveStore in interface IFramework

Returns:

A IResultArchiveStore, cannot be null

getResultArchiveStoreService

protected IResultArchiveStoreService getResultArchiveStoreService()

getResourcePoolingService

@NotNull
public @NotNull IResourcePoolingService getResourcePoolingService()

Description copied from interface: IFramework

Provide access to the Resource Pooling Service

Specified by:

getResourcePoolingService in interface IFramework

Returns:

IResourcePoolingService The Resource Pooling Service

getConfidentialTextService

@NotNull
public @NotNull IConfidentialTextService getConfidentialTextService()

Description copied from interface: IFramework

Provide access to the Confidential Text Service

Specified by:

getConfidentialTextService in interface IFramework

Returns:

The Confidential Text Service

getCredentialsService

@NotNull
public @NotNull ICredentialsService getCredentialsService()
                                                   throws CredentialsException

Specified by:

getCredentialsService in interface IFramework

Throws:

CredentialsException

getEventsService

public IEventsService getEventsService()

Specified by:

getEventsService in interface IFramework

setConfigurationPropertyStore

protected void setConfigurationPropertyStore(@NotNull
 @NotNull IConfigurationPropertyStore cpsStore)
                                      throws ConfigurationPropertyStoreException

Set the new Configuration Property Store Service

Parameters:

cpsStore - - The new CPS

Throws:

ConfigurationPropertyStoreException - - If a CPS has already be registered

setDynamicStatusStore

public void setDynamicStatusStore(@NotNull
 @NotNull IDynamicStatusStore dssStore)
                           throws DynamicStatusStoreException

Throws:

DynamicStatusStoreException

setAuthStore

public void setAuthStore(@NotNull
 @NotNull IAuthStore authStore)
                  throws AuthStoreException

Throws:

AuthStoreException

addResultArchiveStoreService

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

Add a new Result Archive Store Service to the framework, eventually we will have the ability to have multiples RASs running

Parameters:

resultArchiveStoreService - - a new result archive store service

Throws:

ResultArchiveStoreException

setEventsService

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

Throws:

EventsException

setConfidentialTextService

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

Throws:

ConfidentialTextException

setCredentialsStore

public void setCredentialsStore(@NotNull
 @NotNull ICredentialsStore credsStore)
                         throws CredentialsException

Throws:

CredentialsException

getConfigurationPropertyStore

protected IConfigurationPropertyStore getConfigurationPropertyStore()

Retrieve the active CPS Service

Returns:

The CPS Service

getDynamicStatusStore

protected IDynamicStatusStore getDynamicStatusStore()

Retrieve the active DSS Service

Returns:

The DSS service

getCredentialsStore

protected ICredentialsStore getCredentialsStore()

getAuthStore

public IAuthStore getAuthStore()

Description copied from interface: IFramework

Retrieve the Auth Store from the framework.

Specified by:

getAuthStore in interface IFramework

Returns:

An IAuthStore, cannot be null

getAuthStoreService

public IAuthStoreService getAuthStoreService()

Description copied from interface: IFramework

Retrieve the Auth Store Service which can be used to retrieve users and tokens from the store.

Specified by:

getAuthStoreService in interface IFramework

Returns:

An IAuthStoreService, cannot be null

getRandom

public Random getRandom()

Description copied from interface: IFramework

Get a predefined Random object for sharing across all managers and servers

Specified by:

getRandom in interface IFramework

Returns:

a random object

getTestRunName

public String getTestRunName()

Description copied from interface: IFramework

Retrieve the test run name. Will be null for non test runs

Specified by:

getTestRunName in interface IFramework

Returns:

- The test run name, null if not a test run

setTestRunName

public void setTestRunName(String runName)
                    throws FrameworkException

Set the run name if it is a test run

Parameters:

runName - The run name

Throws:

FrameworkException

getTestRun

public IRun getTestRun()

Specified by:

getTestRun in interface IFramework

getFrameworkRuns

public IFrameworkRuns getFrameworkRuns()
                                throws FrameworkException

Specified by:

getFrameworkRuns in interface IFramework

Throws:

FrameworkException

getRecordProperties

public Properties getRecordProperties()

Specified by:

getRecordProperties in interface IFramework

installLogCapture

public void installLogCapture()

shutdown

public void shutdown()
              throws FrameworkException

Specified by:

shutdown in interface IShuttableFramework

Throws:

FrameworkException

shutdown

public void shutdown(org.apache.commons.logging.Log shutdownLogger)
              throws FrameworkException

Throws:

FrameworkException

getApiUrl

public URL getApiUrl(Api api)
              throws FrameworkException

Specified by:

getApiUrl in interface IFramework

Throws:

FrameworkException

getSharedEnvironmentRunType

public SharedEnvironmentRunType getSharedEnvironmentRunType()
                                                     throws ConfigurationPropertyStoreException

Description copied from interface: IFramework

If this is a shared environment run, return the run type

Specified by:

getSharedEnvironmentRunType in interface IFramework

Returns:

returns the shared environment run type, or null if it is not

Throws:

ConfigurationPropertyStoreException - if there is a problem accessing the CPS

getCertificateStoreService

@NotNull
public @NotNull ICertificateStoreService getCertificateStoreService()

Description copied from interface: IFramework

Retrieve the Certificate Store Service which can be used to retrieve keystores of certificates or individual certificates from the store.

Specified by:

getCertificateStoreService in interface IFramework

Returns:

A ICertificateStoreService, cannot be null

getRBACService

public RBACService getRBACService()
                           throws RBACException

Specified by:

getRBACService in interface IFramework

Throws:

RBACException

getStreamsService

@NotNull
public @NotNull IStreamsService getStreamsService()
                                           throws StreamsException

Specified by:

getStreamsService in interface IFramework

Throws:

StreamsException