Index

A B C D E F G I L M N O P R S T U V Y 
All Classes and Interfaces|All Packages|Constant Field Values

A

aasAddress - Variable in class de.iip_ecosphere.platform.ecsRuntime.deviceAas.AasxDeviceAasProvider
 
aasAddress - Variable in class de.iip_ecosphere.platform.ecsRuntime.deviceAas.YamlDeviceAasProvider
 
AasxDeviceAasProvider - Class in de.iip_ecosphere.platform.ecsRuntime.deviceAas
Creates an AAS for this device, deploys it to the platform AAS server and returns the address of the AAS.
AasxDeviceAasProvider() - Constructor for class de.iip_ecosphere.platform.ecsRuntime.deviceAas.AasxDeviceAasProvider
 
AasxDeviceAasProvider.Descriptor - Class in de.iip_ecosphere.platform.ecsRuntime.deviceAas
Implements the JSL descriptor.
AbstractContainerManager<C> - Class in de.iip_ecosphere.platform.ecsRuntime
A basic re-usable implementation of the container manager.
AbstractContainerManager() - Constructor for class de.iip_ecosphere.platform.ecsRuntime.AbstractContainerManager
 
AbstractManagerSetup() - Constructor for class de.iip_ecosphere.platform.ecsRuntime.EcsSetup.AbstractManagerSetup
 
addContainer(Submodel.SubmodelBuilder, ContainerDescriptor) - Static method in class de.iip_ecosphere.platform.ecsRuntime.EcsAas
Adds a container to the given submodel builder.
addContainer(String, C) - Method in class de.iip_ecosphere.platform.ecsRuntime.AbstractContainerManager
Adds a container.
addContainer(URI) - Method in interface de.iip_ecosphere.platform.ecsRuntime.ContainerOperations
Adds a container to the management domain of this instance, e.g., by downloading it from a container registry.
addContainer(URI) - Method in class de.iip_ecosphere.platform.ecsRuntime.EcsAasClient
 
addContainerAsTask(String, URI) - Method in class de.iip_ecosphere.platform.ecsRuntime.EcsAasClient
 
addContainerAsTask(String, URI) - Method in interface de.iip_ecosphere.platform.ecsRuntime.EcsClient
Like ContainerOperations.addContainer(URI) but tracked by a taskId.
addCredentials(Credentials) - Method in class de.iip_ecosphere.platform.ecsRuntime.ssh.RemoteAccessServer.CredentialsManager
Adds credentails to the credentials manager.
addDevice(boolean) - Static method in class de.iip_ecosphere.platform.ecsRuntime.DeviceManagement
Routine for device registration.
addGeneratedCredentials() - Method in class de.iip_ecosphere.platform.ecsRuntime.ssh.RemoteAccessServer.CredentialsManager
Add and generate some credentials.
address - Variable in class de.iip_ecosphere.platform.ecsRuntime.deviceAas.FirstMatchingDeviceAasProvider
 
addValidTransition(ContainerState, ContainerState...) - Static method in enum class de.iip_ecosphere.platform.ecsRuntime.ContainerState
Adds a valid transition.
artifactInfixes - Variable in class de.iip_ecosphere.platform.ecsRuntime.EcsSetup
 
authenticate(String, String) - Method in class de.iip_ecosphere.platform.ecsRuntime.ssh.RemoteAccessServer.CredentialsManager
Checks if the given key and secret combination is stored in the credentials list.
authenticationKey - Variable in class de.iip_ecosphere.platform.ecsRuntime.EcsSetup.AbstractManagerSetup
 
autoOnOffboarding - Variable in class de.iip_ecosphere.platform.ecsRuntime.EcsSetup
 
AVAILABLE - Enum constant in enum class de.iip_ecosphere.platform.ecsRuntime.ContainerState
The container is on the device and ready to be deployed.

B

BasicContainerDescriptor - Class in de.iip_ecosphere.platform.ecsRuntime
Basic ContainerDescriptor implementation, e.g., including a representation of the ServiceState statemachine.
BasicContainerDescriptor() - Constructor for class de.iip_ecosphere.platform.ecsRuntime.BasicContainerDescriptor
Creates a container descriptor instance.
BasicContainerDescriptor(String, String, Version, URI) - Constructor for class de.iip_ecosphere.platform.ecsRuntime.BasicContainerDescriptor
Creates a container descriptor instance.

C

checkId(String, String) - Method in class de.iip_ecosphere.platform.ecsRuntime.AbstractContainerManager
Checks the given id for basic validity.
conf - Static variable in class de.iip_ecosphere.platform.ecsRuntime.EcsFactory
 
ContainerDescriptor - Interface in de.iip_ecosphere.platform.ecsRuntime
Describes a container.
ContainerManager - Interface in de.iip_ecosphere.platform.ecsRuntime
A service provider interface for managing containers in the IIP-Ecosphere platform.
ContainerOperations - Interface in de.iip_ecosphere.platform.ecsRuntime
Basic container operations that a container manager as well as an AAS client shall provide.
containers - Variable in class de.iip_ecosphere.platform.ecsRuntime.AbstractContainerManager
 
ContainerState - Enum Class in de.iip_ecosphere.platform.ecsRuntime
Defines container states.
ContainerState() - Constructor for enum class de.iip_ecosphere.platform.ecsRuntime.ContainerState
 
continueWaiting - Variable in class de.iip_ecosphere.platform.ecsRuntime.EcsLifecycleDescriptor
 
continueWaiting() - Method in class de.iip_ecosphere.platform.ecsRuntime.EcsLifecycleDescriptor
 
contributeTo(Aas.AasBuilder, InvocablesCreator) - Method in class de.iip_ecosphere.platform.ecsRuntime.EcsAas
 
contributeTo(ProtocolServerBuilder) - Method in class de.iip_ecosphere.platform.ecsRuntime.EcsAas
 
contributeToImpl(ProtocolServerBuilder) - Method in class de.iip_ecosphere.platform.ecsRuntime.EcsAas
Implements the contribution to the implementation server.
create() - Static method in class de.iip_ecosphere.platform.ecsRuntime.ssh.RemoteAccessServerFactory
Create a remote access server.
createContainerManagerInstance() - Method in interface de.iip_ecosphere.platform.ecsRuntime.EcsFactoryDescriptor
Creates the container manager instance.
createIdOp(SubmodelElementCollection.SubmodelElementCollectionBuilder, String, InvocablesCreator, String...) - Method in class de.iip_ecosphere.platform.ecsRuntime.EcsAas
Creates an operation with a String parameter "id" and optional string parameters and a result of type string.
createInstance() - Method in class de.iip_ecosphere.platform.ecsRuntime.deviceAas.AasxDeviceAasProvider.Descriptor
 
createInstance() - Method in interface de.iip_ecosphere.platform.ecsRuntime.deviceAas.DeviceAasProviderDescriptor
Creates a provider instance.
createInstance() - Method in class de.iip_ecosphere.platform.ecsRuntime.deviceAas.FirstMatchingDeviceAasProvider.Descriptor
 
createInstance() - Method in class de.iip_ecosphere.platform.ecsRuntime.deviceAas.YamlDeviceAasProvider.Descriptor
 
createRemoteConnectionCredentials() - Method in interface de.iip_ecosphere.platform.ecsRuntime.DeviceManagementOperations
Creates connection details (Credentials), a pair of username and a password for the active remote access server.
createRemoteConnectionCredentials() - Method in class de.iip_ecosphere.platform.ecsRuntime.EcsAasClient
 
createsMultiProvider() - Method in class de.iip_ecosphere.platform.ecsRuntime.deviceAas.AasxDeviceAasProvider.Descriptor
 
createsMultiProvider() - Method in interface de.iip_ecosphere.platform.ecsRuntime.deviceAas.DeviceAasProviderDescriptor
Whether this descriptor creates a provider that itself handles the results of further ("nested") providers.
createsMultiProvider() - Method in class de.iip_ecosphere.platform.ecsRuntime.deviceAas.FirstMatchingDeviceAasProvider.Descriptor
 
createsMultiProvider() - Method in class de.iip_ecosphere.platform.ecsRuntime.deviceAas.YamlDeviceAasProvider.Descriptor
 
credentials - Variable in class de.iip_ecosphere.platform.ecsRuntime.ssh.RemoteAccessServer.CredentialsManager
 
credentialsManager - Variable in class de.iip_ecosphere.platform.ecsRuntime.ssh.RemoteAccessServer
 
CredentialsManager() - Constructor for class de.iip_ecosphere.platform.ecsRuntime.ssh.RemoteAccessServer.CredentialsManager
 

D

de.iip_ecosphere.platform.ecsRuntime - package de.iip_ecosphere.platform.ecsRuntime
Interfaces and basic implementation of the ECS runtime.
de.iip_ecosphere.platform.ecsRuntime.deviceAas - package de.iip_ecosphere.platform.ecsRuntime.deviceAas
Default Device AAS providers.
de.iip_ecosphere.platform.ecsRuntime.ssh - package de.iip_ecosphere.platform.ecsRuntime.ssh
SSH-server frontend for interactive remote device management operations.
DEPLOYED - Enum constant in enum class de.iip_ecosphere.platform.ecsRuntime.ContainerState
The container is running.
DEPLOYING - Enum constant in enum class de.iip_ecosphere.platform.ecsRuntime.ContainerState
The container is brought to life.
desc - Static variable in class de.iip_ecosphere.platform.ecsRuntime.EcsFactory
 
Descriptor() - Constructor for class de.iip_ecosphere.platform.ecsRuntime.deviceAas.AasxDeviceAasProvider.Descriptor
 
Descriptor() - Constructor for class de.iip_ecosphere.platform.ecsRuntime.deviceAas.FirstMatchingDeviceAasProvider.Descriptor
 
Descriptor() - Constructor for class de.iip_ecosphere.platform.ecsRuntime.deviceAas.YamlDeviceAasProvider.Descriptor
 
DeviceAasProvider - Class in de.iip_ecosphere.platform.ecsRuntime.deviceAas
Describes a device AAS provider.
DeviceAasProvider() - Constructor for class de.iip_ecosphere.platform.ecsRuntime.deviceAas.DeviceAasProvider
 
DeviceAasProviderDescriptor - Interface in de.iip_ecosphere.platform.ecsRuntime.deviceAas
JSL descriptor for DeviceAasProvider.
DeviceManagement - Class in de.iip_ecosphere.platform.ecsRuntime
DeviceManagement lifecycle methods.
DeviceManagement() - Constructor for class de.iip_ecosphere.platform.ecsRuntime.DeviceManagement
 
DeviceManagementOperations - Interface in de.iip_ecosphere.platform.ecsRuntime
Aas operations needed for device management.

E

EcsAas - Class in de.iip_ecosphere.platform.ecsRuntime
Implements the AAS for the ECS runtime.
EcsAas() - Constructor for class de.iip_ecosphere.platform.ecsRuntime.EcsAas
 
EcsAasClient - Class in de.iip_ecosphere.platform.ecsRuntime
A client for EcsAas for accessing the operations provided by a certain resource.
EcsAasClient(String) - Constructor for class de.iip_ecosphere.platform.ecsRuntime.EcsAasClient
Creates a client instance based on a deployed IIP-AAS from AasPartRegistry based on a submodel with resources.
EcsClient - Interface in de.iip_ecosphere.platform.ecsRuntime
ECS client operations interface.
EcsCmdLineLifecycleDescriptor - Class in de.iip_ecosphere.platform.ecsRuntime
Handle onboarding/offboarding command line arguments.
EcsCmdLineLifecycleDescriptor() - Constructor for class de.iip_ecosphere.platform.ecsRuntime.EcsCmdLineLifecycleDescriptor
 
EcsFactory - Class in de.iip_ecosphere.platform.ecsRuntime
Provides access to the ECS instances.
EcsFactory() - Constructor for class de.iip_ecosphere.platform.ecsRuntime.EcsFactory
 
EcsFactoryDescriptor - Interface in de.iip_ecosphere.platform.ecsRuntime
A factory descriptor for Java Service loading.
EcsLifecycleDescriptor - Class in de.iip_ecosphere.platform.ecsRuntime
The basic ECS lifecycle descriptor for powering up the AAS.
EcsLifecycleDescriptor() - Constructor for class de.iip_ecosphere.platform.ecsRuntime.EcsLifecycleDescriptor
Creates an instance for the service manager.
EcsSetup - Class in de.iip_ecosphere.platform.ecsRuntime
ECS runtime setup (poor man's spring approach).
EcsSetup() - Constructor for class de.iip_ecosphere.platform.ecsRuntime.EcsSetup
 
EcsSetup.AbstractManagerSetup - Class in de.iip_ecosphere.platform.ecsRuntime
Common settings for a container manager setup.
enable() - Static method in class de.iip_ecosphere.platform.ecsRuntime.EcsAas
Explicitly enables this AAS.
enabled - Static variable in class de.iip_ecosphere.platform.ecsRuntime.EcsAas
 
EXC_ALREADY_KNOWN - Static variable in interface de.iip_ecosphere.platform.ecsRuntime.ContainerOperations
 

F

FAILED - Enum constant in enum class de.iip_ecosphere.platform.ecsRuntime.ContainerState
The container failed for some reason.
FirstMatchingDeviceAasProvider - Class in de.iip_ecosphere.platform.ecsRuntime.deviceAas
Implements a device AAS provider that queries all JSL-specified DeviceAasProviderDescriptor instances and takes the first non-null result from a non-multi-provider.
FirstMatchingDeviceAasProvider() - Constructor for class de.iip_ecosphere.platform.ecsRuntime.deviceAas.FirstMatchingDeviceAasProvider
 
FirstMatchingDeviceAasProvider.Descriptor - Class in de.iip_ecosphere.platform.ecsRuntime.deviceAas
Implements the JSL descriptor.

G

getArtifactInfixes() - Method in class de.iip_ecosphere.platform.ecsRuntime.EcsSetup
Returns artifact file name infixes that shall be tried before loading a non-infixed default artifact, e.g., a container.
getAuthenticationKey() - Method in class de.iip_ecosphere.platform.ecsRuntime.EcsSetup.AbstractManagerSetup
Returns the authentication key.
getAutoOnOffboarding() - Method in class de.iip_ecosphere.platform.ecsRuntime.EcsSetup
Returns whether automatic on/offboarding is enabled.
getConfiguration() - Method in interface de.iip_ecosphere.platform.ecsRuntime.EcsFactoryDescriptor
Returns the configuration instance.
getContainer(String) - Method in class de.iip_ecosphere.platform.ecsRuntime.AbstractContainerManager
 
getContainer(String) - Method in interface de.iip_ecosphere.platform.ecsRuntime.ContainerManager
Returns a container descriptor.
getContainer(String, String, String) - Method in class de.iip_ecosphere.platform.ecsRuntime.AbstractContainerManager
Returns a service descriptor.
getContainerManager() - Static method in class de.iip_ecosphere.platform.ecsRuntime.EcsFactory
Returns the service manager.
getContainers() - Method in class de.iip_ecosphere.platform.ecsRuntime.AbstractContainerManager
 
getContainers() - Method in interface de.iip_ecosphere.platform.ecsRuntime.ContainerManager
Returns the available (installed) containers independent of their state.
getContainers() - Method in class de.iip_ecosphere.platform.ecsRuntime.EcsAasClient
 
getContainers() - Method in interface de.iip_ecosphere.platform.ecsRuntime.EcsClient
Returns the collection with all containers of the resources this client was created for.
getContainerSystemName() - Method in interface de.iip_ecosphere.platform.ecsRuntime.ContainerOperations
Returns the name of the underlying container system, e.g.
getContainerSystemName() - Method in class de.iip_ecosphere.platform.ecsRuntime.EcsAasClient
 
getContainerSystemVersion() - Method in interface de.iip_ecosphere.platform.ecsRuntime.ContainerOperations
Returns the version of the underlying container system.
getContainerSystemVersion() - Method in class de.iip_ecosphere.platform.ecsRuntime.EcsAasClient
 
getCredentials() - Method in class de.iip_ecosphere.platform.ecsRuntime.ssh.RemoteAccessServer.CredentialsManager
Gets all currently saved credentials.
getCredentials(String) - Method in class de.iip_ecosphere.platform.ecsRuntime.ssh.RemoteAccessServer.CredentialsManager
Get specific credentials for a key.
getCredentialsManager() - Method in class de.iip_ecosphere.platform.ecsRuntime.ssh.RemoteAccessServer
The credentials manager connected to the server.
getDeviceAasAddress() - Method in class de.iip_ecosphere.platform.ecsRuntime.deviceAas.AasxDeviceAasProvider
 
getDeviceAasAddress() - Method in class de.iip_ecosphere.platform.ecsRuntime.deviceAas.DeviceAasProvider
Returns the device AAS address for this device.
getDeviceAasAddress() - Method in class de.iip_ecosphere.platform.ecsRuntime.deviceAas.FirstMatchingDeviceAasProvider
 
getDeviceAasAddress() - Method in class de.iip_ecosphere.platform.ecsRuntime.deviceAas.YamlDeviceAasProvider
 
getDockerImageZipfile() - Method in class de.iip_ecosphere.platform.ecsRuntime.BasicContainerDescriptor
Returns the name of the compressed file with the Docker image.
getId() - Method in class de.iip_ecosphere.platform.ecsRuntime.BasicContainerDescriptor
 
getId() - Method in interface de.iip_ecosphere.platform.ecsRuntime.ContainerDescriptor
Returns the container id.
getId(URI) - Method in class de.iip_ecosphere.platform.ecsRuntime.AbstractContainerManager
 
getId(URI) - Method in interface de.iip_ecosphere.platform.ecsRuntime.ContainerOperations
Returns the container id for a given container location as used in ContainerOperations.addContainer(URI).
getId(URI) - Method in class de.iip_ecosphere.platform.ecsRuntime.EcsAasClient
 
getIds() - Method in class de.iip_ecosphere.platform.ecsRuntime.AbstractContainerManager
 
getIds() - Method in interface de.iip_ecosphere.platform.ecsRuntime.ContainerManager
Returns the ids of all available containers.
getIdShort() - Method in class de.iip_ecosphere.platform.ecsRuntime.deviceAas.AasxDeviceAasProvider
 
getIdShort() - Method in class de.iip_ecosphere.platform.ecsRuntime.deviceAas.DeviceAasProvider
Returns the short ID of the device AAS.
getIdShort() - Method in class de.iip_ecosphere.platform.ecsRuntime.deviceAas.FirstMatchingDeviceAasProvider
 
getIdShort() - Method in class de.iip_ecosphere.platform.ecsRuntime.deviceAas.YamlDeviceAasProvider
 
getImageFile() - Method in class de.iip_ecosphere.platform.ecsRuntime.BasicContainerDescriptor
Returns the name of the (compressed) image file of the container.
getInstance() - Static method in class de.iip_ecosphere.platform.ecsRuntime.deviceAas.DeviceAasProvider
Returns the actual provider instance.
getKind() - Method in class de.iip_ecosphere.platform.ecsRuntime.EcsAas
 
getLogger() - Static method in class de.iip_ecosphere.platform.ecsRuntime.EcsAas
Returns the logger instance.
getMetricsProvider() - Static method in class de.iip_ecosphere.platform.ecsRuntime.Monitor
Returns the metrics provider.
getMonitoringUpdatePeriod() - Method in class de.iip_ecosphere.platform.ecsRuntime.EcsSetup
Returns the monitoring update period.
getName() - Method in class de.iip_ecosphere.platform.ecsRuntime.BasicContainerDescriptor
 
getName() - Method in interface de.iip_ecosphere.platform.ecsRuntime.ContainerDescriptor
The name of the container.
getNetMgr() - Method in class de.iip_ecosphere.platform.ecsRuntime.EcsSetup
Returns the network manager setup.
getPidFileName() - Method in class de.iip_ecosphere.platform.ecsRuntime.EcsLifecycleDescriptor
 
getQName(String) - Static method in class de.iip_ecosphere.platform.ecsRuntime.EcsAas
Returns the qualified name for an operation/property implementation.
getRegistryClient() - Static method in class de.iip_ecosphere.platform.ecsRuntime.DeviceManagement
Get the DeviceRegistryClient.
getRemoteAccessServer() - Static method in class de.iip_ecosphere.platform.ecsRuntime.DeviceManagement
Get the RemoteAccessServer singleton.
getResources() - Method in interface de.iip_ecosphere.platform.ecsRuntime.ResourcesClient
Returns the resources submodel of the platform.
getRuntimeName() - Method in interface de.iip_ecosphere.platform.ecsRuntime.ContainerManager
Returns the descriptive name of this ECS runtime.
getRuntimeName() - Method in interface de.iip_ecosphere.platform.ecsRuntime.DeviceManagementOperations
Gets the runtimeName of the device.
getRuntimeName() - Method in class de.iip_ecosphere.platform.ecsRuntime.EcsAasClient
 
getRuntimeVersion() - Method in interface de.iip_ecosphere.platform.ecsRuntime.DeviceManagementOperations
Gets the runtimeVersion of the device.
getRuntimeVersion() - Method in class de.iip_ecosphere.platform.ecsRuntime.EcsAasClient
 
getSetup() - Static method in class de.iip_ecosphere.platform.ecsRuntime.EcsFactory
Returns the actual setup instance for the implementing container manager.
getShutdownHook() - Method in class de.iip_ecosphere.platform.ecsRuntime.EcsCmdLineLifecycleDescriptor
 
getState() - Method in class de.iip_ecosphere.platform.ecsRuntime.BasicContainerDescriptor
 
getState() - Method in interface de.iip_ecosphere.platform.ecsRuntime.ContainerDescriptor
Returns the state the container is currently in.
getState(String) - Method in class de.iip_ecosphere.platform.ecsRuntime.AbstractContainerManager
 
getState(String) - Method in interface de.iip_ecosphere.platform.ecsRuntime.ContainerOperations
Returns the state of the container.
getState(String) - Method in class de.iip_ecosphere.platform.ecsRuntime.EcsAasClient
 
getTransport() - Method in class de.iip_ecosphere.platform.ecsRuntime.EcsSetup
Returns the transport setup.
getUri() - Method in class de.iip_ecosphere.platform.ecsRuntime.BasicContainerDescriptor
 
getUri() - Method in interface de.iip_ecosphere.platform.ecsRuntime.ContainerDescriptor
Returns the canonical URI the descriptor was loaded from.
getURN() - Method in class de.iip_ecosphere.platform.ecsRuntime.deviceAas.AasxDeviceAasProvider
 
getURN() - Method in class de.iip_ecosphere.platform.ecsRuntime.deviceAas.DeviceAasProvider
Returns the URN of the device AAS.
getURN() - Method in class de.iip_ecosphere.platform.ecsRuntime.deviceAas.FirstMatchingDeviceAasProvider
 
getURN() - Method in class de.iip_ecosphere.platform.ecsRuntime.deviceAas.YamlDeviceAasProvider
 
getVersion() - Method in class de.iip_ecosphere.platform.ecsRuntime.BasicContainerDescriptor
 
getVersion() - Method in interface de.iip_ecosphere.platform.ecsRuntime.ContainerDescriptor
The version of the container.
getVersion() - Method in interface de.iip_ecosphere.platform.ecsRuntime.ContainerManager
Returns the version of this ECS runtime.

I

id - Variable in class de.iip_ecosphere.platform.ecsRuntime.BasicContainerDescriptor
 
identifier - Variable in class de.iip_ecosphere.platform.ecsRuntime.deviceAas.AasxDeviceAasProvider
 
idShort - Variable in class de.iip_ecosphere.platform.ecsRuntime.deviceAas.AasxDeviceAasProvider
 
imageFile - Variable in class de.iip_ecosphere.platform.ecsRuntime.BasicContainerDescriptor
 
init() - Static method in class de.iip_ecosphere.platform.ecsRuntime.EcsFactory
Initializes this factory.
instance - Static variable in class de.iip_ecosphere.platform.ecsRuntime.deviceAas.DeviceAasProvider
 
isStarted() - Method in class de.iip_ecosphere.platform.ecsRuntime.ssh.RemoteAccessServer
Gets the started status.
isValid() - Method in class de.iip_ecosphere.platform.ecsRuntime.EcsAas
 
isValidTransition(ContainerState) - Method in enum class de.iip_ecosphere.platform.ecsRuntime.ContainerState
Returns whether a transition from this state to target is valid.

L

LOGGER - Static variable in class de.iip_ecosphere.platform.ecsRuntime.EcsFactory
 
LOGGER - Static variable in class de.iip_ecosphere.platform.ecsRuntime.EcsLifecycleDescriptor
 

M

manager - Static variable in class de.iip_ecosphere.platform.ecsRuntime.EcsFactory
 
match - Variable in class de.iip_ecosphere.platform.ecsRuntime.deviceAas.FirstMatchingDeviceAasProvider
 
migrateContainer(String, String) - Method in class de.iip_ecosphere.platform.ecsRuntime.AbstractContainerManager
 
migrateContainer(String, String) - Method in interface de.iip_ecosphere.platform.ecsRuntime.ContainerOperations
Migrates the container.
migrateContainer(String, String) - Method in class de.iip_ecosphere.platform.ecsRuntime.EcsAasClient
 
MIGRATING - Enum constant in enum class de.iip_ecosphere.platform.ecsRuntime.ContainerState
The container is not operating as it is about or in the process of being migrated.
Monitor - Class in de.iip_ecosphere.platform.ecsRuntime
Does OS/JVM level monitoring.
Monitor() - Constructor for class de.iip_ecosphere.platform.ecsRuntime.Monitor
 
monitoringUpdatePeriod - Variable in class de.iip_ecosphere.platform.ecsRuntime.EcsSetup
 

N

name - Variable in class de.iip_ecosphere.platform.ecsRuntime.BasicContainerDescriptor
 
NAME_COLL_CONTAINERS - Static variable in class de.iip_ecosphere.platform.ecsRuntime.EcsAas
 
NAME_OP_CONTAINER_ADD - Static variable in class de.iip_ecosphere.platform.ecsRuntime.EcsAas
 
NAME_OP_CONTAINER_ADD_TASK - Static variable in class de.iip_ecosphere.platform.ecsRuntime.EcsAas
 
NAME_OP_CONTAINER_GETID - Static variable in class de.iip_ecosphere.platform.ecsRuntime.EcsAas
 
NAME_OP_CONTAINER_MIGRATE - Static variable in class de.iip_ecosphere.platform.ecsRuntime.EcsAas
 
NAME_OP_CONTAINER_START - Static variable in class de.iip_ecosphere.platform.ecsRuntime.EcsAas
 
NAME_OP_CONTAINER_START_TASK - Static variable in class de.iip_ecosphere.platform.ecsRuntime.EcsAas
 
NAME_OP_CONTAINER_STOP - Static variable in class de.iip_ecosphere.platform.ecsRuntime.EcsAas
 
NAME_OP_CONTAINER_STOP_TASK - Static variable in class de.iip_ecosphere.platform.ecsRuntime.EcsAas
 
NAME_OP_CONTAINER_UNDEPLOY - Static variable in class de.iip_ecosphere.platform.ecsRuntime.EcsAas
 
NAME_OP_CONTAINER_UPDATE - Static variable in class de.iip_ecosphere.platform.ecsRuntime.EcsAas
 
NAME_OP_CREATE_REMOTE_CONNECTION_CREDENTIALS - Static variable in class de.iip_ecosphere.platform.ecsRuntime.EcsAas
 
NAME_OP_GET_STATE - Static variable in class de.iip_ecosphere.platform.ecsRuntime.EcsAas
 
NAME_PROP_CPU_ARCHITECTURE - Static variable in class de.iip_ecosphere.platform.ecsRuntime.EcsAas
 
NAME_PROP_CPU_CAPACITY - Static variable in class de.iip_ecosphere.platform.ecsRuntime.EcsAas
 
NAME_PROP_CSYS_NAME - Static variable in class de.iip_ecosphere.platform.ecsRuntime.EcsAas
 
NAME_PROP_CSYS_VERSION - Static variable in class de.iip_ecosphere.platform.ecsRuntime.EcsAas
 
NAME_PROP_DEVICE_AAS - Static variable in class de.iip_ecosphere.platform.ecsRuntime.EcsAas
 
NAME_PROP_GPU_CAPACITY - Static variable in class de.iip_ecosphere.platform.ecsRuntime.EcsAas
 
NAME_PROP_ID - Static variable in class de.iip_ecosphere.platform.ecsRuntime.EcsAas
 
NAME_PROP_NAME - Static variable in class de.iip_ecosphere.platform.ecsRuntime.EcsAas
 
NAME_PROP_OPERATING_SYSTEM - Static variable in class de.iip_ecosphere.platform.ecsRuntime.EcsAas
 
NAME_PROP_RESOURCE - Static variable in class de.iip_ecosphere.platform.ecsRuntime.EcsAas
 
NAME_PROP_RUNTIME_NAME - Static variable in class de.iip_ecosphere.platform.ecsRuntime.EcsAas
 
NAME_PROP_RUNTIME_VERSION - Static variable in class de.iip_ecosphere.platform.ecsRuntime.EcsAas
 
NAME_PROP_STATE - Static variable in class de.iip_ecosphere.platform.ecsRuntime.EcsAas
 
NAME_PROP_VERSION - Static variable in class de.iip_ecosphere.platform.ecsRuntime.EcsAas
 
NAME_PROPERTY_PRODUCTIMAGE - Static variable in class de.iip_ecosphere.platform.ecsRuntime.deviceAas.YamlDeviceAasProvider
 
NAME_SUBMODEL - Static variable in class de.iip_ecosphere.platform.ecsRuntime.EcsAas
 
netMgr - Variable in class de.iip_ecosphere.platform.ecsRuntime.EcsSetup
 
notifyContainerAdded(ContainerDescriptor) - Static method in class de.iip_ecosphere.platform.ecsRuntime.EcsAas
Is called when a container is added.
notifyContainerRemoved(ContainerDescriptor) - Static method in class de.iip_ecosphere.platform.ecsRuntime.EcsAas
Is called when a container is removed.
notifyContainerStateChanged(ContainerDescriptor) - Static method in class de.iip_ecosphere.platform.ecsRuntime.EcsAas
Is called when a container state changed.
notifyResourceRemoved() - Static method in class de.iip_ecosphere.platform.ecsRuntime.EcsAas
Is called when the entire resource is removed.

O

obtainAas() - Static method in class de.iip_ecosphere.platform.ecsRuntime.deviceAas.AasxDeviceAasProvider
Preliminary way to find an AASX file for the nameplate.
obtainNameplateSetup() - Static method in class de.iip_ecosphere.platform.ecsRuntime.deviceAas.YamlDeviceAasProvider
Preliminary way to find the nameplate YML.

P

PLUGIN_ID - Static variable in interface de.iip_ecosphere.platform.ecsRuntime.EcsFactoryDescriptor
 
priority() - Method in class de.iip_ecosphere.platform.ecsRuntime.EcsCmdLineLifecycleDescriptor
 
provider - Static variable in class de.iip_ecosphere.platform.ecsRuntime.Monitor
 

R

readConfiguration() - Static method in class de.iip_ecosphere.platform.ecsRuntime.EcsSetup
Reads a EcsSetup instance from AbstractSetup.DEFAULT_FNAME in the root folder of the jar/classpath.
readConfiguration(Class<C>) - Static method in class de.iip_ecosphere.platform.ecsRuntime.EcsSetup
Reads a EcsSetup instance from AbstractSetup.DEFAULT_FNAME in the root folder of the jar/classpath.
readFromYaml(InputStream, URI) - Static method in class de.iip_ecosphere.platform.ecsRuntime.BasicContainerDescriptor
Returns a DockerContainerDescriptor with a information from a yaml file.
readFromYamlFile(File) - Static method in class de.iip_ecosphere.platform.ecsRuntime.BasicContainerDescriptor
Returns a DockerContainerDescriptor with a information from a yaml file.
registered - Variable in class de.iip_ecosphere.platform.ecsRuntime.EcsLifecycleDescriptor
 
remoteAccessServer - Static variable in class de.iip_ecosphere.platform.ecsRuntime.DeviceManagement
 
RemoteAccessServer - Class in de.iip_ecosphere.platform.ecsRuntime.ssh
A RemoteAccessServer grants access to the local terminal through a remote connection.
RemoteAccessServer() - Constructor for class de.iip_ecosphere.platform.ecsRuntime.ssh.RemoteAccessServer
Default constructor, restricts creation to package only.
RemoteAccessServer.CredentialsManager - Class in de.iip_ecosphere.platform.ecsRuntime.ssh
A CredentialsManager stores credentials for the underlying ssh server.
RemoteAccessServerFactory - Class in de.iip_ecosphere.platform.ecsRuntime.ssh
Provides access to the RemoteAccessServer instances.
RemoteAccessServerFactory() - Constructor for class de.iip_ecosphere.platform.ecsRuntime.ssh.RemoteAccessServerFactory
 
removeDevice(boolean) - Static method in class de.iip_ecosphere.platform.ecsRuntime.DeviceManagement
Method for device removal.
removeDevice(String, Consumer<Submodel>, Consumer<Submodel>) - Static method in class de.iip_ecosphere.platform.ecsRuntime.EcsAas
Removes a specific device.
resolveUri(URI, File) - Method in class de.iip_ecosphere.platform.ecsRuntime.AbstractContainerManager
Resolves an URI taking EcsSetup.getArtifactInfixes() into account.
ResourcesClient - Interface in de.iip_ecosphere.platform.ecsRuntime
Defines the interface of a platform resources client.

S

scheduleMonitoringTask() - Static method in class de.iip_ecosphere.platform.ecsRuntime.Monitor
Schedules the monitoring task an in case of interruption during send tries to re-schedule the task.
server - Variable in class de.iip_ecosphere.platform.ecsRuntime.ssh.RemoteAccessServer
 
server - Static variable in class de.iip_ecosphere.platform.ecsRuntime.ssh.RemoteAccessServerFactory
 
setArtifactInfixes(List<String>) - Method in class de.iip_ecosphere.platform.ecsRuntime.EcsSetup
Defines artifact file name infixes that shall be tried before loading a non-infixed default artifact, e.g., a container.
setAuthenticationKey(String) - Method in class de.iip_ecosphere.platform.ecsRuntime.EcsSetup.AbstractManagerSetup
Defines the docker host.
setAutoOnOffboarding(boolean) - Method in class de.iip_ecosphere.platform.ecsRuntime.EcsSetup
Changes the automatic on/offboarding behavior.
setDockerImageZipfile(String) - Method in class de.iip_ecosphere.platform.ecsRuntime.BasicContainerDescriptor
Defines the name of the compressed file with the Docker image.
setId(String) - Method in class de.iip_ecosphere.platform.ecsRuntime.BasicContainerDescriptor
Defines the container's id.
setImageFile(String) - Method in class de.iip_ecosphere.platform.ecsRuntime.BasicContainerDescriptor
Defines the name of the (compressed) image file of the container.
setMonitoringUpdatePeriod(int) - Method in class de.iip_ecosphere.platform.ecsRuntime.EcsSetup
Changes the monitoring update period.
setName(String) - Method in class de.iip_ecosphere.platform.ecsRuntime.BasicContainerDescriptor
Defines the container's name.
setNetMgr(NetworkManagerSetup) - Method in class de.iip_ecosphere.platform.ecsRuntime.EcsSetup
Defines the network manager setup.
setState(BasicContainerDescriptor, ContainerState) - Method in class de.iip_ecosphere.platform.ecsRuntime.AbstractContainerManager
Changes the container state and notifies EcsAas.
setState(ContainerState) - Method in class de.iip_ecosphere.platform.ecsRuntime.BasicContainerDescriptor
Changes the container state.
setTransport(TransportSetup) - Method in class de.iip_ecosphere.platform.ecsRuntime.EcsSetup
Defines the transport setup.
setUri(URI) - Method in class de.iip_ecosphere.platform.ecsRuntime.BasicContainerDescriptor
Sets the URI where the container was loaded from.
setVersion(Version) - Method in class de.iip_ecosphere.platform.ecsRuntime.BasicContainerDescriptor
Defines the container's version.
shutdown() - Method in class de.iip_ecosphere.platform.ecsRuntime.EcsCmdLineLifecycleDescriptor
 
shutdown() - Method in class de.iip_ecosphere.platform.ecsRuntime.EcsLifecycleDescriptor
 
SSH_HOST - Static variable in class de.iip_ecosphere.platform.ecsRuntime.ssh.RemoteAccessServer
 
SSH_PORT - Static variable in class de.iip_ecosphere.platform.ecsRuntime.ssh.RemoteAccessServer
 
start() - Method in class de.iip_ecosphere.platform.ecsRuntime.ssh.RemoteAccessServer
 
startContainer(String) - Method in interface de.iip_ecosphere.platform.ecsRuntime.ContainerOperations
Starts a container.
startContainer(String) - Method in class de.iip_ecosphere.platform.ecsRuntime.EcsAasClient
 
startContainerAsTask(String, String) - Method in class de.iip_ecosphere.platform.ecsRuntime.EcsAasClient
 
startContainerAsTask(String, String) - Method in interface de.iip_ecosphere.platform.ecsRuntime.EcsClient
Like ContainerOperations.startContainer(String) but tracked by a taskId.
started - Variable in class de.iip_ecosphere.platform.ecsRuntime.ssh.RemoteAccessServer
 
startScheduling() - Static method in class de.iip_ecosphere.platform.ecsRuntime.Monitor
Starts metrics scheduling.
startup(String[]) - Method in class de.iip_ecosphere.platform.ecsRuntime.EcsCmdLineLifecycleDescriptor
 
startup(String[]) - Method in class de.iip_ecosphere.platform.ecsRuntime.EcsLifecycleDescriptor
 
state - Variable in class de.iip_ecosphere.platform.ecsRuntime.BasicContainerDescriptor
 
stop(boolean) - Method in class de.iip_ecosphere.platform.ecsRuntime.ssh.RemoteAccessServer
 
stopContainer(String) - Method in interface de.iip_ecosphere.platform.ecsRuntime.ContainerOperations
Stops the container.
stopContainer(String) - Method in class de.iip_ecosphere.platform.ecsRuntime.EcsAasClient
 
stopContainerAsTask(String, String) - Method in class de.iip_ecosphere.platform.ecsRuntime.EcsAasClient
 
stopContainerAsTask(String, String) - Method in interface de.iip_ecosphere.platform.ecsRuntime.EcsClient
Like ContainerOperations.stopContainer(String) but tracked by a taskId.
STOPPED - Enum constant in enum class de.iip_ecosphere.platform.ecsRuntime.ContainerState
The container was stopped and may be disposed or started again.
STOPPING - Enum constant in enum class de.iip_ecosphere.platform.ecsRuntime.ContainerState
The container is going out of operation.
stopScheduling() - Static method in class de.iip_ecosphere.platform.ecsRuntime.Monitor
Stops metrics scheduling.
SUBMODEL_NAMEPLATE - Static variable in class de.iip_ecosphere.platform.ecsRuntime.deviceAas.YamlDeviceAasProvider
 

T

throwExecutionException(String, String) - Method in class de.iip_ecosphere.platform.ecsRuntime.AbstractContainerManager
Throws an execution exception for the given message.
throwExecutionException(String, Throwable) - Method in class de.iip_ecosphere.platform.ecsRuntime.AbstractContainerManager
Throws an execution exception for the given throwable.
timer - Static variable in class de.iip_ecosphere.platform.ecsRuntime.Monitor
 
transport - Variable in class de.iip_ecosphere.platform.ecsRuntime.EcsSetup
 
TRANSPORT_METRICS_CHANNEL - Static variable in class de.iip_ecosphere.platform.ecsRuntime.Monitor
 

U

undeployContainer(String) - Method in class de.iip_ecosphere.platform.ecsRuntime.AbstractContainerManager
 
undeployContainer(String) - Method in interface de.iip_ecosphere.platform.ecsRuntime.ContainerOperations
Removes the container from the management domain of this instance.
undeployContainer(String) - Method in class de.iip_ecosphere.platform.ecsRuntime.EcsAasClient
 
UNDEPLOYING - Enum constant in enum class de.iip_ecosphere.platform.ecsRuntime.ContainerState
The container is about to be removed from this resource.
UNKNOWN - Enum constant in enum class de.iip_ecosphere.platform.ecsRuntime.ContainerState
The state of the container is not known.
update - Static variable in class de.iip_ecosphere.platform.ecsRuntime.Monitor
 
updateContainer(String, URI) - Method in interface de.iip_ecosphere.platform.ecsRuntime.ContainerOperations
Updates the container by the container in the given location.
updateContainer(String, URI) - Method in class de.iip_ecosphere.platform.ecsRuntime.EcsAasClient
 
UPDATING - Enum constant in enum class de.iip_ecosphere.platform.ecsRuntime.ContainerState
The container is not operating as it is being updated with a more recent version.
uri - Variable in class de.iip_ecosphere.platform.ecsRuntime.BasicContainerDescriptor
 

V

validateTransition(ContainerState, ContainerState) - Static method in enum class de.iip_ecosphere.platform.ecsRuntime.ContainerState
Validates a container state transition and throws an exception if the transition is invalid.
validTransitions - Static variable in enum class de.iip_ecosphere.platform.ecsRuntime.ContainerState
 
valueOf(String) - Static method in enum class de.iip_ecosphere.platform.ecsRuntime.ContainerState
Returns the enum constant of this class with the specified name.
values() - Static method in enum class de.iip_ecosphere.platform.ecsRuntime.ContainerState
Returns an array containing the constants of this enum class, in the order they are declared.
version - Variable in class de.iip_ecosphere.platform.ecsRuntime.BasicContainerDescriptor
 

Y

YamlDeviceAasProvider - Class in de.iip_ecosphere.platform.ecsRuntime.deviceAas
Creates an AAS for this device, deploys it to the platform AAS server and returns the address of the AAS.
YamlDeviceAasProvider() - Constructor for class de.iip_ecosphere.platform.ecsRuntime.deviceAas.YamlDeviceAasProvider
 
YamlDeviceAasProvider.Descriptor - Class in de.iip_ecosphere.platform.ecsRuntime.deviceAas
Implements the JSL descriptor.
A B C D E F G I L M N O P R S T U V Y 
All Classes and Interfaces|All Packages|Constant Field Values