Package de.iip_ecosphere.platform.services.spring.yaml

Class YamlServer

  • All Implemented Interfaces:
    de.iip_ecosphere.platform.services.environment.ProcessSpec, ProcessSpec, Server
    public class YamlServer
extends de.iip_ecosphere.platform.services.environment.YamlServer
implements Server
    Server process specification of servers to be started/stopped with an application.
    Author:
    Holger Eichelberger, SSE

    • Constructor Summary

      Constructors 
      Constructor Description
      YamlServer()  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      Endpoint getAasEndpoint()
      Returns AAS endpoint (port/host) the service shall communicate with for commands.
      java.util.List<java.lang.String> getCmdArg​(int port, java.lang.String protocol)
      Returns additional/optional command line arguments required to start the service.
      Endpoint getServiceStreamEndpoint()
      Returns streaming endpoint (port/host) on the service side the process shall communicate with.
      Endpoint getStreamEndpoint()
      Returns streaming endpoint (port/host) on the process side the service shall communicate with.
      int getWaitTime()
      Returns the time to wait for the process before going on with starting other services.

      • Methods inherited from class de.iip_ecosphere.platform.services.environment.YamlServer

        getCls, getDescription, getHost, getId, getPort, getTransportChannel, getVersion, setCls, setDescription, setHost, setId, setPort, setTransportChannel, setVersion, toService

      • Methods inherited from class de.iip_ecosphere.platform.services.environment.YamlProcess

        getArtifacts, getCmdArg, getExecutable, getExecutablePath, getHomePath, getLocationKey, getSubstCmdArg, isStarted, setArtifacts, setCmdArg, setExecutable, setExecutablePath, setExecutablePath, setHomePath, setHomePath, setLocationKey, setStarted, toSubstFileName, toSubstFilePath

      • 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.services.environment.ProcessSpec

        getArtifacts, getCmdArg, getExecutable, getExecutablePath, getHomePath, isStarted

    • Constructor Detail

      • YamlServer

        public YamlServer()

    • Method Detail

      • getCmdArg

        public java.util.List<java.lang.String> getCmdArg​(int port,
                                                  java.lang.String protocol)
        Description copied from interface: ProcessSpec
        Returns additional/optional command line arguments required to start the service. The port placeholder Endpoint.PORT_PLACEHOLDER will be replaced with the command port the platform is using to send administrative commands to the service (see Service).
        Specified by:
        getCmdArg in interface ProcessSpec
        Parameters:
        port - the port used for the command communication
        protocol - the protocol used for the command communication
        Returns:
        the resolved command line arguments (may be empty for none)

      • getAasEndpoint

        public Endpoint getAasEndpoint()
        Description copied from interface: ProcessSpec
        Returns AAS endpoint (port/host) the service shall communicate with for commands.
        Specified by:
        getAasEndpoint in interface ProcessSpec
        Returns:
        the AAS endpoint

      • getWaitTime

        public int getWaitTime()
        Description copied from interface: ProcessSpec
        Returns the time to wait for the process before going on with starting other services.
        Specified by:
        getWaitTime in interface ProcessSpec
        Returns:
        the wait time in ms, ignored if not positive