Package dev.galasa.framework.spi

Interface IResourceManagementProvider

public interface IResourceManagementProvider

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    initialise(IFramework framework, IResourceManagement resourceManagement)
    Initialises the resource management provider.
    void
    runFinishedOrDeleted(String runName)
    Run resource cleanup when a run has been marked as finished or has been deleted from Galasa's Dynamic Status Store (DSS).
    default void
    runOnce()
    Runs resource cleanup for this resource management provider once.
    void
    shutdown()
    Shuts down this resource management provider.
    void
    start()
    Schedule and starts resource cleanup jobs that are intended to run indefinitely for this resource management provider This is called by Galasa's resource management process when running in a Galasa service.

  • Method Details

    • initialise

      boolean initialise(IFramework framework, IResourceManagement resourceManagement) throws ResourceManagerException
      Initialises the resource management provider.
      Parameters:
      framework - the framework instance that the provider is running within
      resourceManagement - the resource management instance that is running the provider
      Returns:
      true if the provider has been initialised successfully, false otherwise
      Throws:
      ResourceManagerException - if there was an issue initialising the resource management provider

    • start

      void start()
      Schedule and starts resource cleanup jobs that are intended to run indefinitely for this resource management provider This is called by Galasa's resource management process when running in a Galasa service.

    • runOnce

      default void runOnce()
      Runs resource cleanup for this resource management provider once. This is called by Galasa's resource management when running locally.

    • shutdown

      void shutdown()
      Shuts down this resource management provider.

    • runFinishedOrDeleted

      void runFinishedOrDeleted(String runName)
      Run resource cleanup when a run has been marked as finished or has been deleted from Galasa's Dynamic Status Store (DSS).
      Parameters:
      runName - the name of the run that has just finished or has been deleted from the DSS