Package de.iip_ecosphere.platform.services.environment

Class YamlServer

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

  • Field Details

    • id

      private String id

    • version

      private de.iip_ecosphere.platform.support.Version version

    • description

      private String description

    • port

      private int port

    • host

      private String host

    • cls

      private String cls

    • transportChannel

      private String transportChannel

    • asProcess

      private boolean asProcess

  • Constructor Details

    • YamlServer

      public YamlServer()

  • Method Details

    • getId

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

    • getVersion

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

    • getDescription

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

    • getPort

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

    • getHost

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

    • getCls

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

    • getTransportChannel

      public String getTransportChannel()
      Returns the transport channel for client-server communication.
      Returns:
      the transport channel, may be empty or null for none if the service uses an own mechanism (discouraged)

    • getAsProcess

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

    • setId

      public void setId(String id)
      Returns the id of the server, also to be used as network management key. [required by SnakeYaml]
      Parameters:
      id - the id of the server

    • setVersion

      public void setVersion(de.iip_ecosphere.platform.support.Version version)
      Defines the version of the service. [required by SnakeYaml]
      Parameters:
      version - the version

    • setDescription

      public void setDescription(String description)
      Defines the description of the service. [required by SnakeYaml]
      Parameters:
      description - the description (null is ignored, default is empty)

    • setPort

      public void setPort(int port)
      Defines the network port of this server instance. [required by SnakeYaml]
      Parameters:
      port - the network port

    • setHost

      public void setHost(String host)
      Defined the host the server instance (may be superseded through a deployment plan). [required by SnakeYaml]
      Parameters:
      host - the host name

    • setCls

      public void setCls(String cls)
      Defines the class to be started as server. Must implement Server.
      Parameters:
      cls - the class name

    • setTransportChannel

      public void setTransportChannel(String transportChannel)
      Defines the transport channel for client-server communication.
      Parameters:
      transportChannel - the transport channel, may be empty or null for none if the service uses an own mechanism (discouraged)

    • setAsProcess

      public void setAsProcess(boolean asProcess)
      Changes whether the the server shall be executed as an own process.
      Parameters:
      asProcess - true for process, false for in-service-manager execution

    • toService

      public YamlService toService()
      Turns this server into a temporary service instance.
      Returns:
      the service instance