Package de.iip_ecosphere.platform.deviceMgt

Class DeviceManagementAas

java.lang.Object
de.iip_ecosphere.platform.deviceMgt.DeviceManagementAas
All Implemented Interfaces:
de.iip_ecosphere.platform.support.iip_aas.AasContributor
public class DeviceManagementAas extends Object implements de.iip_ecosphere.platform.support.iip_aas.AasContributor
A Asset Administration Shell for device management functionalities. Mostly called by northbound services. A device should not rely on these functionalities.
Author:
Dennis Pidun, University of Hildesheim

  • Nested Class Summary

    Nested classes/interfaces inherited from interface de.iip_ecosphere.platform.support.iip_aas.AasContributor

    de.iip_ecosphere.platform.support.iip_aas.AasContributor.Kind

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    ECS_UPDATE_URI
     
    static final String
    NAME_COLL_DEVICE_MANAGER
     
    static final String
    NAME_OP_ESTABLISH_SSH
     
    static final String
    NAME_OP_SET_CONFIG
     
    static final String
    NAME_OP_UPDATE_RUNTIME
     
    static final String
    NAME_SUBMODEL
     

  • Constructor Summary

    Constructors
    Constructor
    Description
    DeviceManagementAas()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    de.iip_ecosphere.platform.support.aas.Aas
    contributeTo(de.iip_ecosphere.platform.support.aas.Aas.AasBuilder aasBuilder, de.iip_ecosphere.platform.support.aas.InvocablesCreator iCreator)
    Basically registers the AAS for the device management.
    void
    contributeTo(de.iip_ecosphere.platform.support.aas.ProtocolServerBuilder sBuilder)
    Defines the operations details.
    de.iip_ecosphere.platform.support.iip_aas.AasContributor.Kind
    getKind()
    This aas is a Kind.ACTIVE.
    private String
    getQName(String name)
    Returns a qualified name within this submodel.
    boolean
    isValid()
    In case this code is used as library one doesn't want that the aas is setup.
    static void
    notifySetConfig(String id, String downloadUri, String location)
    Notify the aas if a new config should be set.
    static void
    notifyUpdateRuntime(String id, String downloadUrl)
    Notify if a device needs an update and redirect the request.

    Methods inherited from class java.lang.Object

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

    Methods inherited from interface de.iip_ecosphere.platform.support.iip_aas.AasContributor

    exists, getAasAuthentication, getSubmodelAuthentication

  • Field Details

  • Constructor Details

    • DeviceManagementAas

      public DeviceManagementAas()

  • Method Details

    • contributeTo

      public de.iip_ecosphere.platform.support.aas.Aas contributeTo(de.iip_ecosphere.platform.support.aas.Aas.AasBuilder aasBuilder, de.iip_ecosphere.platform.support.aas.InvocablesCreator iCreator)
      Basically registers the AAS for the device management.
      Specified by:
      contributeTo in interface de.iip_ecosphere.platform.support.iip_aas.AasContributor
      Parameters:
      aasBuilder - the aasBuilder to contributeTo
      iCreator - an InvocablesCreator
      Returns:
      null

    • contributeTo

      public void contributeTo(de.iip_ecosphere.platform.support.aas.ProtocolServerBuilder sBuilder)
      Defines the operations details.
      Specified by:
      contributeTo in interface de.iip_ecosphere.platform.support.iip_aas.AasContributor
      Parameters:
      sBuilder - the ProtocolServerBuilder

    • notifySetConfig

      public static void notifySetConfig(String id, String downloadUri, String location)
      Notify the aas if a new config should be set. This method will redirect the request to the aas of the resource id.
      Parameters:
      id - the device id
      downloadUri - the download uri
      location - the location to put the configuration relative to /

    • notifyUpdateRuntime

      public static void notifyUpdateRuntime(String id, String downloadUrl)
      Notify if a device needs an update and redirect the request.
      Parameters:
      id - the device id
      downloadUrl - the download url

    • getQName

      private String getQName(String name)
      Returns a qualified name within this submodel.
      Parameters:
      name - the name to be turned into a qualified name
      Returns:
      the qualified name

    • getKind

      public de.iip_ecosphere.platform.support.iip_aas.AasContributor.Kind getKind()
      This aas is a Kind.ACTIVE.
      Specified by:
      getKind in interface de.iip_ecosphere.platform.support.iip_aas.AasContributor
      Returns:
      Kind.ACTIVE.

    • isValid

      public boolean isValid()
      In case this code is used as library one doesn't want that the aas is setup.
      Specified by:
      isValid in interface de.iip_ecosphere.platform.support.iip_aas.AasContributor
      Returns:
      true if code based is not used as a library and the aas should be deployed.