Package de.iip_ecosphere.platform.ecsRuntime

Interface EcsClient

All Superinterfaces:
ContainerOperations, DeviceManagementOperations
All Known Implementing Classes:
EcsAasClient
public interface EcsClient extends ContainerOperations, DeviceManagementOperations
ECS client operations interface.
Author:
Holger Eichelberger, SSE

  • Method Details

    • getContainers

      de.iip_ecosphere.platform.support.aas.SubmodelElementCollection getContainers()
      Returns the collection with all containers of the resources this client was created for.
      Returns:
      the containers collection, may be null

    • addContainerAsTask

      String addContainerAsTask(String taskId, URI location) throws ExecutionException
      Like ContainerOperations.addContainer(URI) but tracked by a taskId.
      Parameters:
      taskId - the task id to report on
      location - the location from where to download the container, e.g., an URL
      Returns:
      the id of the container
      Throws:
      ExecutionException - in case that adding the container fails for some reason

    • startContainerAsTask

      void startContainerAsTask(String taskId, String id) throws ExecutionException
      Like ContainerOperations.startContainer(String) but tracked by a taskId.
      Parameters:
      taskId - the task id to report on
      id - the id of the container
      Throws:
      ExecutionException - in case that starting the container fails for some reason

    • stopContainerAsTask

      void stopContainerAsTask(String taskId, String id) throws ExecutionException
      Like ContainerOperations.stopContainer(String) but tracked by a taskId.
      Parameters:
      taskId - the task id to report on
      id - the id of the container to stop, or as fallback the canonical URI of the container descriptor used for adding
      Throws:
      ExecutionException - if stopping the container fails