Package de.iip_ecosphere.platform.services.spring.descriptor

Interface ProcessSpec

All Superinterfaces:
de.iip_ecosphere.platform.services.environment.ProcessSpec
All Known Subinterfaces:
Server
All Known Implementing Classes:
YamlProcess, YamlServer
public interface ProcessSpec extends de.iip_ecosphere.platform.services.environment.ProcessSpec
If the service is not completely implemented rather than delegates functionality to an additional process that must be started and managed along with the service. The process implementation (whatever it is) will be extracted from ProcessSpec.getHomePath(). For the execution in a shell, the home directory will be set to the folder where the files in ProcessSpec.getHomePath() are located. ProcessSpec.getHomePath() must not be empty, ProcessSpec.getCmdArg() may be empty, getStreamEndpoint() and getAasEndpoint() must be given.
Author:
Holger Eichelberger, SSE

  • 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.
    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 interface de.iip_ecosphere.platform.services.environment.ProcessSpec

    getArtifacts, getCmdArg, getExecArg, getExecutable, getExecutablePath, getHomePath, isStarted

  • Method Details

    • getCmdArg

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

      Endpoint getServiceStreamEndpoint()
      Returns streaming endpoint (port/host) on the service side the process shall communicate with. Counterpart of getStreamEndpoint().
      Returns:
      the streaming endpoint

    • getStreamEndpoint

      Endpoint getStreamEndpoint()
      Returns streaming endpoint (port/host) on the process side the service shall communicate with. Counterpart of getServiceStreamEndpoint().
      Returns:
      the streaming endpoint

    • getAasEndpoint

      Endpoint getAasEndpoint()
      Returns AAS endpoint (port/host) the service shall communicate with for commands.
      Returns:
      the AAS endpoint

    • getWaitTime

      int getWaitTime()
      Returns the time to wait for the process before going on with starting other services.
      Returns:
      the wait time in ms, ignored if not positive