Package dev.galasa.framework.spi

Interface IFrameworkInitialisation

All Known Subinterfaces:
IApiServerInitialisation
All Known Implementing Classes:
FrameworkInitialisation
public interface IFrameworkInitialisation

IFrameworkInitialisation provides access to the framework routines that should only be called during test run and server initialisation.

  • Method Details

    • getBootstrapConfigurationPropertyStore

      @NotNull @NotNull URI getBootstrapConfigurationPropertyStore()
      Retrieves the Configuration Property Store that was set in the bootstrap
      Returns:
      URI

    • getDynamicStatusStoreUri

      URI getDynamicStatusStoreUri()

    • getCredentialsStoreUri

      URI getCredentialsStoreUri()

    • getResultArchiveStoreUris

      @NotNull @NotNull List<URI> getResultArchiveStoreUris()
      Retrieves a list of Result Archive URIs that need to be initialised
      Returns:
      A list of URIs describing the RASs to be activated

    • registerConfigurationPropertyStore

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

      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.

      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

      void registerDynamicStatusStore(@NotNull @NotNull IDynamicStatusStore dynamicStatusStore) throws DynamicStatusStoreException
      Throws:
      DynamicStatusStoreException

    • registerResultArchiveStoreService

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

      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.

      Parameters:
      resultArchiveStoreService - - the result archive store service to be registered
      Throws:
      ResultArchiveStoreException - If there is a problem registering the service

    • registerCertificateStoreService

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

      Register a Certificate Store Service.

      Parameters:
      certificateStoreService - - the certificate store service to be registered
      Throws:
      CertificateStoreException - If there is a problem registering the service

    • registerConfidentialTextService

      void registerConfidentialTextService(@NotNull @NotNull IConfidentialTextService confidentialTextService) throws ConfidentialTextException
      Throws:
      ConfidentialTextException

    • registerCredentialsStore

      void registerCredentialsStore(@NotNull @NotNull ICredentialsStore credentialsStore) throws CredentialsException
      Throws:
      CredentialsException

    • registerEventsService

      void registerEventsService(@NotNull @NotNull IEventsService eventsService) throws EventsException
      Throws:
      EventsException

    • getFramework

      @NotNull @NotNull IFramework getFramework()

      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

      Returns:
      IFramework