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

Interface Server

All Superinterfaces:
de.iip_ecosphere.platform.services.environment.ProcessSpec, ProcessSpec
All Known Implementing Classes:
YamlServer
public interface Server extends ProcessSpec
Server process specification of servers to be started/stopped with an application.
Author:
Holger Eichelberger, SSE

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    getAsProcess()
    Execute the server as an own process.
    String
    getCls()
    Returns the class to be started as server.
    String
    getDescription()
    Returns the description of the server.
    String
    getHost()
    Returns the host the server instance (may be superseded through a deployment plan).
    String
    getId()
    Returns the id of the server, also to be used as network management key.
    long
    getMemory()
    Returns the desired memory for instances of this server.
    int
    getPort()
    Returns the network port of this server instance.
    de.iip_ecosphere.platform.support.Version
    getVersion()
    Returns the version of the server.
    de.iip_ecosphere.platform.services.environment.YamlService
    toService()
    Turns this server into a temporary (partially default filled) service instance.

    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.ProcessSpec

    getAasEndpoint, getCmdArg, getServiceStreamEndpoint, getStreamEndpoint, getWaitTime

  • Method Details

    • getId

      String getId()
      Returns the id of the server, also to be used as network management key.
      Returns:
      the id of the server

    • getVersion

      de.iip_ecosphere.platform.support.Version getVersion()
      Returns the version of the server.
      Returns:
      the version

    • getDescription

      String getDescription()
      Returns the description of the server.
      Returns:
      the description

    • getPort

      int getPort()
      Returns the network port of this server instance.
      Returns:
      the network port

    • getHost

      String getHost()
      Returns the host the server instance (may be superseded through a deployment plan).
      Returns:
      the host name

    • getCls

      String getCls()
      Returns the class to be started as server. Must implement Server.
      Returns:
      the class name

    • getAsProcess

      boolean getAsProcess()
      Execute the server as an own process.
      Returns:
      true for process, false for in-service-manager execution

    • toService

      de.iip_ecosphere.platform.services.environment.YamlService toService()
      Turns this server into a temporary (partially default filled) service instance.
      Returns:
      the service instance

    • getMemory

      long getMemory()
      Returns the desired memory for instances of this server.
      Returns:
      the desired memory in Mebibytes (i.e., "m"), ignored if not positive