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 Summary

Fields

Modifier and Type	Field	Description
private java.lang.String	cls
private java.lang.String	description
private java.lang.String	host
private java.lang.String	id
private int	port
private java.lang.String	transportChannel
private de.iip_ecosphere.platform.support.iip_aas.Version	version

Constructor Summary

Constructors

Constructor	Description
YamlServer()

Method Summary

Modifier and Type	Method	Description
java.lang.String	getCls()	Returns the class to be started as server.
java.lang.String	getDescription()	Returns the description of the server.
java.lang.String	getHost()	Returns the host the server instance (may be superseded through a deployment plan).
java.lang.String	getId()	Returns the id of the server, also to be used as network management key.
int	getPort()	Returns the network port of this server instance.
java.lang.String	getTransportChannel()	Returns the transport channel for client-server communication.
de.iip_ecosphere.platform.support.iip_aas.Version	getVersion()	Returns the version of the server.
void	setCls(java.lang.String cls)	Defines the class to be started as server.
void	setDescription(java.lang.String description)	Defines the description of the service.
void	setHost(java.lang.String host)	Defined the host the server instance (may be superseded through a deployment plan).
void	setId(java.lang.String id)	Returns the id of the server, also to be used as network management key.
void	setPort(int port)	Defines the network port of this server instance.
void	setTransportChannel(java.lang.String transportChannel)	Defines the transport channel for client-server communication.
void	setVersion(de.iip_ecosphere.platform.support.iip_aas.Version version)	Defines the version of the service.
YamlService	toService()	Turns this server into a temporary service instance.

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

Field Detail

id

private java.lang.String id

version

private de.iip_ecosphere.platform.support.iip_aas.Version version

description

private java.lang.String description

port

private int port

host

private java.lang.String host

cls

private java.lang.String cls

transportChannel

private java.lang.String transportChannel

Constructor Detail

YamlServer

public YamlServer()

Method Detail

getId

public java.lang.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.iip_aas.Version getVersion()

Returns the version of the server.

Returns:

the version

getDescription

public java.lang.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 java.lang.String getHost()

Returns the host the server instance (may be superseded through a deployment plan).

Returns:

the host name

getCls

public java.lang.String getCls()

Returns the class to be started as server. Must implement Server.

Returns:

the class name

getTransportChannel

public java.lang.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)

setId

public void setId(java.lang.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.iip_aas.Version version)

Defines the version of the service. [required by SnakeYaml]

Parameters:

version - the version

setDescription

public void setDescription(java.lang.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(java.lang.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(java.lang.String cls)

Defines the class to be started as server. Must implement Server.

Parameters:

cls - the class name

setTransportChannel

public void setTransportChannel(java.lang.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)

toService

public YamlService toService()

Turns this server into a temporary service instance.

Returns:

the service instance