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

Class YamlServer

java.lang.Object
de.iip_ecosphere.platform.services.environment.YamlProcess
de.iip_ecosphere.platform.services.environment.YamlServer
de.iip_ecosphere.platform.services.spring.yaml.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

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    private long
    memory
     

  • Constructor Summary

    Constructors
    Constructor
    Description
    YamlServer()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    Endpoint
    getAasEndpoint()
    Returns AAS endpoint (port/host) the service shall communicate with for commands.
    List<String>
    getCmdArg(int port, String protocol)
    Returns additional/optional command line arguments required to start the service.
    long
    getMemory()
    Returns the desired memory for instances of this server.
    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.
    void
    setMemory(long memory)
    Defines the desired memory for instances of this service.

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

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

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

    getArtifacts, getCmdArg, getExecArg, getExecutable, getExecutablePath, getHomePath, getLocationKey, getSubstCmdArg, isStarted, setArtifacts, setCmdArg, setExecArg, 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, getExecArg, getExecutable, getExecutablePath, getHomePath, isStarted

    Methods inherited from interface de.iip_ecosphere.platform.services.spring.descriptor.Server

    getAsProcess, getCls, getDescription, getHost, getId, getPort, getVersion, toService

  • Field Details

    • memory

      private long memory

  • Constructor Details

    • YamlServer

      public YamlServer()

  • Method Details

    • getCmdArg

      public List<String> getCmdArg(int port, 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)

    • getServiceStreamEndpoint

      public Endpoint getServiceStreamEndpoint()
      Description copied from interface: ProcessSpec
      Returns streaming endpoint (port/host) on the service side the process shall communicate with. Counterpart of ProcessSpec.getStreamEndpoint().
      Specified by:
      getServiceStreamEndpoint in interface ProcessSpec
      Returns:
      the streaming endpoint

    • getStreamEndpoint

      public Endpoint getStreamEndpoint()
      Description copied from interface: ProcessSpec
      Returns streaming endpoint (port/host) on the process side the service shall communicate with. Counterpart of ProcessSpec.getServiceStreamEndpoint().
      Specified by:
      getStreamEndpoint in interface ProcessSpec
      Returns:
      the streaming endpoint

    • 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

    • getMemory

      public long getMemory()
      Description copied from interface: Server
      Returns the desired memory for instances of this server.
      Specified by:
      getMemory in interface Server
      Returns:
      the desired memory in Mebibytes (i.e., "m"), ignored if not positive

    • setMemory

      public void setMemory(long memory)
      Defines the desired memory for instances of this service.
      Parameters:
      memory - the desired memory in Mebibytes (i.e., "m"), ignored if not positive