Package de.iip_ecosphere.platform.configuration.cfg

Class ConfigurationSetup

java.lang.Object
de.iip_ecosphere.platform.support.setup.AbstractSetup
de.iip_ecosphere.platform.configuration.cfg.ConfigurationSetup
All Implemented Interfaces:
de.iip_ecosphere.platform.support.setup.PluginsSetup
public class ConfigurationSetup extends de.iip_ecosphere.platform.support.setup.AbstractSetup
The setup for the configuration component. As there are also EASy-Producer configuration classes with different meaning, we did not call this class "Configuration" or "ConfigurationConfiguration".
Author:
Holger Eichelberger, SSE

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    private de.iip_ecosphere.platform.support.iip_aas.AasPartRegistry.AasSetup
    aas
     
    private File
    artifactsFolder
     
    private String
    artifactsUriPrefix
     
    private de.iip_ecosphere.platform.deviceMgt.storage.PackageStorageSetup
    containerImageStorage
     
    private boolean
    instantiateAsProcess
     
    private de.iip_ecosphere.platform.deviceMgt.storage.PackageStorageSetup
    serviceArtifactStorage
     
    private de.iip_ecosphere.platform.transport.connectors.TransportSetup
    transport
     
    private File
    uploadFolder
     

    Fields inherited from class de.iip_ecosphere.platform.support.setup.AbstractSetup

    DEFAULT_FNAME, DEFAULT_NAME, DEFAULT_OVERRIDE_FNAME, PARAM_PLUGINS

  • Constructor Summary

    Constructors
    Constructor
    Description
    ConfigurationSetup()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    de.iip_ecosphere.platform.support.iip_aas.AasPartRegistry.AasSetup
    getAas()
    Returns the AAS setup.
    File
    getArtifactsFolder()
    Returns the folder containing installable artifacts.
    String
    getArtifactsUriPrefix()
    Returns the artifacts URI prefix.
    de.iip_ecosphere.platform.deviceMgt.storage.PackageStorageSetup
    getContainerImageStorage()
    Returns the container image storage.
    boolean
    getInstantiateAsProcess()
    Returns whether instantiation shall run in an own process.
    de.iip_ecosphere.platform.deviceMgt.storage.PackageStorageSetup
    getServiceArtifactStorage()
    Returns the EASy-Producer setup.
    de.iip_ecosphere.platform.transport.connectors.TransportSetup
    getTransport()
    Returns the transport setup.
    File
    getUploadFolder()
    Returns the folder containing uploaded artifacts.
    void
    setAas(de.iip_ecosphere.platform.support.iip_aas.AasPartRegistry.AasSetup aas)
    Defines the AAS setup.
    void
    setArtifactsFolder(File artifactsFolder)
    Changes the folder containing installable artifacts.
    void
    setArtifactsUriPrefix(String artifactsUriPrefix)
    Changes the artifacts URI prefix.
    void
    setContainerImageStorage(de.iip_ecosphere.platform.deviceMgt.storage.PackageStorageSetup containerImageStorage)
    Returns the setup for the global container image storage.
    void
    setInstantiateAsProcess(boolean instantiateAsProcess)
    Changes whether instantiation shall run in an own process.
    void
    setServiceArtifactStorage(de.iip_ecosphere.platform.deviceMgt.storage.PackageStorageSetup serviceArtifactStorage)
    Returns the EASy-Producer setup.
    void
    setTransport(de.iip_ecosphere.platform.transport.connectors.TransportSetup transport)
    Defines the transport setup.
    void
    setUploadFolder(File uploadFolder)
    Changes the folder containing uploaded artifacts.

    Methods inherited from class de.iip_ecosphere.platform.support.setup.AbstractSetup

    getDefaultFileName, getPluginsFolder, isNotEmpty, readFromYaml, readFromYaml, readFromYaml, readFromYaml, readFromYaml, readFromYamlWithPath, readFromYamlWithPath, readFromYamlWithPath, readFromYamlWithPath, readMappingFromYaml, readMappingFromYaml, setDefaultFileName, setPluginsFolder, setPluginsFolderFile

    Methods inherited from class java.lang.Object

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

  • Field Details

    • serviceArtifactStorage

      private de.iip_ecosphere.platform.deviceMgt.storage.PackageStorageSetup serviceArtifactStorage

    • containerImageStorage

      private de.iip_ecosphere.platform.deviceMgt.storage.PackageStorageSetup containerImageStorage

    • artifactsFolder

      private File artifactsFolder

    • artifactsUriPrefix

      private String artifactsUriPrefix

    • uploadFolder

      private File uploadFolder

    • instantiateAsProcess

      private boolean instantiateAsProcess

    • aas

      private de.iip_ecosphere.platform.support.iip_aas.AasPartRegistry.AasSetup aas

    • transport

      private de.iip_ecosphere.platform.transport.connectors.TransportSetup transport

  • Constructor Details

    • ConfigurationSetup

      public ConfigurationSetup()

  • Method Details

    • getServiceArtifactStorage

      public de.iip_ecosphere.platform.deviceMgt.storage.PackageStorageSetup getServiceArtifactStorage()
      Returns the EASy-Producer setup.
      Returns:
      the setup

    • setServiceArtifactStorage

      public void setServiceArtifactStorage(de.iip_ecosphere.platform.deviceMgt.storage.PackageStorageSetup serviceArtifactStorage)
      Returns the EASy-Producer setup. [snakyaml]
      Parameters:
      serviceArtifactStorage - the storage setup

    • getContainerImageStorage

      public de.iip_ecosphere.platform.deviceMgt.storage.PackageStorageSetup getContainerImageStorage()
      Returns the container image storage.
      Returns:
      the setup

    • setContainerImageStorage

      public void setContainerImageStorage(de.iip_ecosphere.platform.deviceMgt.storage.PackageStorageSetup containerImageStorage)
      Returns the setup for the global container image storage. [snakyaml]
      Parameters:
      containerImageStorage - the setup

    • getArtifactsFolder

      public File getArtifactsFolder()
      Returns the folder containing installable artifacts.
      Returns:
      the folder

    • setArtifactsFolder

      public void setArtifactsFolder(File artifactsFolder)
      Changes the folder containing installable artifacts. [snakeyaml]
      Parameters:
      artifactsFolder - the folder

    • getArtifactsUriPrefix

      public String getArtifactsUriPrefix()
      Returns the artifacts URI prefix.
      Returns:
      the prefix with protocol, may be empty for none

    • setArtifactsUriPrefix

      public void setArtifactsUriPrefix(String artifactsUriPrefix)
      Changes the artifacts URI prefix. [snakeyaml]
      Parameters:
      artifactsUriPrefix - the prefix with protocol, may be empty for none

    • getUploadFolder

      public File getUploadFolder()
      Returns the folder containing uploaded artifacts.
      Returns:
      the folder

    • setUploadFolder

      public void setUploadFolder(File uploadFolder)
      Changes the folder containing uploaded artifacts. [snakeyaml]
      Parameters:
      uploadFolder - the folder

    • getInstantiateAsProcess

      public boolean getInstantiateAsProcess()
      Returns whether instantiation shall run in an own process.
      Returns:
      whether instantiation shall run in an own process (default is false)

    • setInstantiateAsProcess

      public void setInstantiateAsProcess(boolean instantiateAsProcess)
      Changes whether instantiation shall run in an own process. The implementation may ignore this setting. [yaml]
      Parameters:
      instantiateAsProcess - whether instantiation shall run in an own process

    • getTransport

      public de.iip_ecosphere.platform.transport.connectors.TransportSetup getTransport()
      Returns the transport setup.
      Returns:
      the transport setup

    • setTransport

      public void setTransport(de.iip_ecosphere.platform.transport.connectors.TransportSetup transport)
      Defines the transport setup. [yaml]
      Parameters:
      transport - the transport setup

    • getAas

      public de.iip_ecosphere.platform.support.iip_aas.AasPartRegistry.AasSetup getAas()
      Returns the AAS setup.
      Returns:
      the AAs setup

    • setAas

      public void setAas(de.iip_ecosphere.platform.support.iip_aas.AasPartRegistry.AasSetup aas)
      Defines the AAS setup. [required by yaml]
      Parameters:
      aas - the AAS setup