Package de.iip_ecosphere.platform.ecsRuntime

Class EcsAasClient

java.lang.Object

de.iip_ecosphere.platform.support.iip_aas.SubmodelClient

de.iip_ecosphere.platform.support.iip_aas.SubmodelElementsCollectionClient

de.iip_ecosphere.platform.ecsRuntime.EcsAasClient

All Implemented Interfaces:

ContainerOperations, DeviceManagementOperations, EcsClient

public class EcsAasClient
extends de.iip_ecosphere.platform.support.iip_aas.SubmodelElementsCollectionClient
implements EcsClient

A client for EcsAas for accessing the operations provided by a certain resource.

Author:

Holger Eichelberger, SSE

Field Summary

Fields inherited from interface de.iip_ecosphere.platform.ecsRuntime.ContainerOperations

EXC_ALREADY_KNOWN

Constructor Summary

Constructors

Constructor	Description
EcsAasClient(String resourceId)	Creates a client instance based on a deployed IIP-AAS from AasPartRegistry based on a submodel with resources.

Method Summary

Modifier and Type	Method	Description
String	addContainer(URI location)	Adds a container to the management domain of this instance, e.g., by downloading it from a container registry.
String	addContainerAsTask(String taskId, URI location)	Like ContainerOperations.addContainer(URI) but tracked by a taskId.
de.iip_ecosphere.platform.deviceMgt.Credentials	createRemoteConnectionCredentials()	Creates connection details (Credentials), a pair of username and a password for the active remote access server.
de.iip_ecosphere.platform.support.aas.SubmodelElementCollection	getContainers()	Returns the collection with all containers of the resources this client was created for.
String	getContainerSystemName()	Returns the name of the underlying container system, e.g.
String	getContainerSystemVersion()	Returns the version of the underlying container system.
String	getId(URI location)	Returns the container id for a given container location as used in ContainerOperations.addContainer(URI).
String	getRuntimeName()	Gets the runtimeName of the device.
Integer	getRuntimeVersion()	Gets the runtimeVersion of the device.
ContainerState	getState(String id)	Returns the state of the container.
void	migrateContainer(String id, String resourceId)	Migrates the container.
void	startContainer(String id)	Starts a container.
void	startContainerAsTask(String taskId, String id)	Like ContainerOperations.startContainer(String) but tracked by a taskId.
void	stopContainer(String id)	Stops the container.
void	stopContainerAsTask(String taskId, String id)	Like ContainerOperations.stopContainer(String) but tracked by a taskId.
void	undeployContainer(String id)	Removes the container from the management domain of this instance.
void	updateContainer(String id, URI location)	Updates the container by the container in the given location.

Methods inherited from class de.iip_ecosphere.platform.support.iip_aas.SubmodelElementsCollectionClient

getLogger, getOperation, getProperty, getSubmodelElementCollection

Methods inherited from class de.iip_ecosphere.platform.support.iip_aas.SubmodelClient

checkNotNull, checkString, clear, getOperation, getProperty, getPropertyStringValue, getSubmodel, requestRefresh

Methods inherited from class java.lang.Object

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

Constructor Details

EcsAasClient

public EcsAasClient(String resourceId)
             throws IOException

Creates a client instance based on a deployed IIP-AAS from AasPartRegistry based on a submodel with resources.

Parameters:

resourceId - the id used as key in EcsAas.NAME_SUBMODEL to denote the resource to operate on

Throws:

IOException - if retrieving the IIP-AAS or the respective submodel fails

Method Details

addContainer

public String addContainer(URI location)
                    throws ExecutionException

Description copied from interface: ContainerOperations

Adds a container to the management domain of this instance, e.g., by downloading it from a container registry. This defines the id of the container within the management domain of this instance. After a successful execution, the container id is returned and shall be available and the container shall be in state ContainerState.AVAILABLE.

Specified by:

addContainer in interface ContainerOperations

Parameters:

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

startContainer

public void startContainer(String id)
                    throws ExecutionException

Description copied from interface: ContainerOperations

Starts a container. The container must be already within the management domain of this instance by ContainerOperations.addContainer(URI). The container shall after some time be in state ContainerState.DEPLOYING, ContainerState.DEPLOYED or ContainerState.FAILED.

Specified by:

startContainer in interface ContainerOperations

Parameters:

id - the id of the container

Throws:

ExecutionException - in case that starting the container fails for some reason

stopContainer

public void stopContainer(String id)
                   throws ExecutionException

Description copied from interface: ContainerOperations

Stops the container. The container shall afterwards be in state ContainerState.STOPPED.

Specified by:

stopContainer in interface ContainerOperations

Parameters:

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

migrateContainer

public void migrateContainer(String id,
 String resourceId)
                      throws ExecutionException

Description copied from interface: ContainerOperations

Migrates the container.

Specified by:

migrateContainer in interface ContainerOperations

Parameters:

id - the id of the container

resourceId - the target resource id, e.g., a device

Throws:

ExecutionException - if migration fails

undeployContainer

public void undeployContainer(String id)
                       throws ExecutionException

Description copied from interface: ContainerOperations

Removes the container from the management domain of this instance. This operation shall only remove the implementation of a non-operational container and, thus, perform a state transition to ContainerState.UNDEPLOYING and ultimately the container shall be removed and its descriptor shall not be available anymore.

Specified by:

undeployContainer in interface ContainerOperations

Parameters:

id - the id of the container to remove, or as fallback the canonical URI of the container descriptor used for adding

Throws:

ExecutionException - if undeploying the container fails, e.g., because it is still running

createRemoteConnectionCredentials

public de.iip_ecosphere.platform.deviceMgt.Credentials createRemoteConnectionCredentials()
                                                                                  throws ExecutionException

Description copied from interface: DeviceManagementOperations

Creates connection details (Credentials), a pair of username and a password for the active remote access server.

Specified by:

createRemoteConnectionCredentials in interface DeviceManagementOperations

Returns:

credentials for the remote access server

Throws:

ExecutionException - if the execution fails

getRuntimeName

public String getRuntimeName()
                      throws ExecutionException

Description copied from interface: DeviceManagementOperations

Gets the runtimeName of the device.

Specified by:

getRuntimeName in interface DeviceManagementOperations

Returns:

the runtimeName

Throws:

ExecutionException - if the execution fails

getRuntimeVersion

public Integer getRuntimeVersion()
                          throws ExecutionException

Description copied from interface: DeviceManagementOperations

Gets the runtimeVersion of the device.

Specified by:

getRuntimeVersion in interface DeviceManagementOperations

Returns:

the runtimeVersion

Throws:

ExecutionException - if the execution fails

updateContainer

public void updateContainer(String id,
 URI location)
                     throws ExecutionException

Description copied from interface: ContainerOperations

Updates the container by the container in the given location. This operation is responsible for stopping the running container (if needed), replacing it, starting the new container.

Specified by:

updateContainer in interface ContainerOperations

Parameters:

id - the id of the container to be updated

location - the location of the new container, e.g., an URL

Throws:

ExecutionException - if the given container cannot be updated for some reason

getState

public ContainerState getState(String id)

Description copied from interface: ContainerOperations

Returns the state of the container.

Specified by:

getState in interface ContainerOperations

Parameters:

id - the id/URI of the container

Returns:

the state of the container

getContainerSystemName

public String getContainerSystemName()

Description copied from interface: ContainerOperations

Returns the name of the underlying container system, e.g. Docker.

Specified by:

getContainerSystemName in interface ContainerOperations

Returns:

the name

getContainerSystemVersion

public String getContainerSystemVersion()

Description copied from interface: ContainerOperations

Returns the version of the underlying container system. As this version may differ from the syntax conventions of Version, we just return here a string.

Specified by:

getContainerSystemVersion in interface ContainerOperations

Returns:

the version

getContainers

public de.iip_ecosphere.platform.support.aas.SubmodelElementCollection getContainers()

Description copied from interface: EcsClient

Returns the collection with all containers of the resources this client was created for.

Specified by:

getContainers in interface EcsClient

Returns:

the containers collection, may be null

addContainerAsTask

public String addContainerAsTask(String taskId,
 URI location)
                          throws ExecutionException

Description copied from interface: EcsClient

Like ContainerOperations.addContainer(URI) but tracked by a taskId.

Specified by:

addContainerAsTask in interface EcsClient

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

public void startContainerAsTask(String taskId,
 String id)
                          throws ExecutionException

Description copied from interface: EcsClient

Like ContainerOperations.startContainer(String) but tracked by a taskId.

Specified by:

startContainerAsTask in interface EcsClient

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

public void stopContainerAsTask(String taskId,
 String id)
                         throws ExecutionException

Description copied from interface: EcsClient

Like ContainerOperations.stopContainer(String) but tracked by a taskId.

Specified by:

stopContainerAsTask in interface EcsClient

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

getId

public String getId(URI location)

Description copied from interface: ContainerOperations

Returns the container id for a given container location as used in ContainerOperations.addContainer(URI).

Specified by:

getId in interface ContainerOperations

Parameters:

location - the location

Returns:

the id of the container, may be empty or nullnull if there is none