Package de.iip_ecosphere.platform.services.spring

Class SpringCloudServiceDescriptor

java.lang.Object

de.iip_ecosphere.platform.services.AbstractServiceDescriptor<SpringCloudArtifactDescriptor>

de.iip_ecosphere.platform.services.spring.SpringCloudServiceDescriptor

All Implemented Interfaces:

de.iip_ecosphere.platform.services.ServiceDescriptor

public class SpringCloudServiceDescriptor
extends de.iip_ecosphere.platform.services.AbstractServiceDescriptor<SpringCloudArtifactDescriptor>

Specific descriptor implementation for spring cloud streams. [public for testing] Relies on parameter functions from Starter.

Author:

Holger Eichelberger, SSE

Field Summary

Fields

Modifier and Type	Field	Description
private de.iip_ecosphere.platform.support.net.ManagedServerAddress	adminAddr
private java.lang.String	deploymentId
private SpringCloudServiceDescriptor	ensembleLeader
private java.util.List<java.lang.String>	portKeys
private java.lang.Process	process
private java.io.File	processDir
private Server	server
private Service	service
private java.lang.String	serviceProtocol

Constructor Summary

Constructors

Modifier	Constructor	Description
	SpringCloudServiceDescriptor(Service service, TypeResolver resolver)	Creates an instance.
protected	SpringCloudServiceDescriptor(java.lang.String id, java.lang.String applicationId, java.lang.String name, java.lang.String description, de.iip_ecosphere.platform.support.iip_aas.Version version)	Creates an instance.

Method Summary

Modifier and Type	Method	Description
(package private) void	attachStub()	Attaches a service stub to directly interact with the service if adminAddr has been set by createDeploymentRequest(SpringCloudServiceSetup, List) before.
(package private) java.util.List<java.lang.String>	collectCmdArguments(SpringCloudServiceSetup config, int port, java.lang.String protocol)	Collects basic command line arguments.
(package private) org.springframework.cloud.deployer.spi.core.AppDeploymentRequest	createDeploymentRequest(SpringCloudServiceSetup config, java.util.List<java.lang.String> cmdArgs)	Creates the deployment request for the Spring deployer.
(package private) static SpringCloudServiceDescriptor	createFor(Server server)	Creates a temporary descriptor for the given server spec instance.
(package private) void	detachStub()	Detaches an attached service stub.
(package private) java.lang.String	getAasNetmanagerKey()	Returns the NetworkManager key for the AAS command connection to an external process.
protected java.lang.Class<SpringCloudArtifactDescriptor>	getArtifactDescriptorClass()
(package private) java.lang.String	getDeploymentId()	Returns the Spring cloud deployer deployment id.
SpringCloudServiceDescriptor	getEnsembleLeader()
java.lang.String	getGroup()	Returns the deployment group.
de.iip_ecosphere.platform.support.aas.InvocablesCreator	getInvocablesCreator()
(package private) Server	getServer()	If the service represents a server, return the server specification.
private java.lang.String	getStreamingNetmanagerKey()	Returns the NetworkManager key for the streaming connection to an external process.
Service	getSvc()	Returns the YAML descriptor.
private java.lang.String	getTransportHost(SpringCloudServiceSetup setup)	Returns the actual transport host.
private int	getTransportPort(SpringCloudServiceSetup setup)	Returns the actual transport port.
(package private) SpringCloudServiceDescriptor	instantiate(java.lang.String sId)	Instantiates this service as a template to represent an instance service with id serviceId.
private de.iip_ecosphere.platform.support.net.ManagedServerAddress	registerPort(de.iip_ecosphere.platform.support.net.NetworkManager mgr, java.lang.String key)	Obtains a network port and registers it if necessary for release in setState(ServiceState).
private void	release()	Releases the process as well as the ports in portKeys.
(package private) void	setDeploymentId(java.lang.String id)	Sets the Spring cloud deployer deployment id.
(package private) void	setEnsembleLeader(SpringCloudServiceDescriptor ensembleLeader)	Defines the ensemble leader.
void	setState(de.iip_ecosphere.platform.services.environment.ServiceState state)
(package private) int	startProcess(SpringCloudServiceSetup config, ProcessSpec pSpec)	Starts the non-Java execution process if needed.
static java.lang.String	toFunctionDefinition(java.util.Set<de.iip_ecosphere.platform.services.AbstractServiceManager.TypedDataConnection> conn)	Turns typed data connections into a Spring cloud function definition argument.
(package private) void	waitForAdminServer(int waitingTime)	Waits that the server on adminAddr becomes available.

Methods inherited from class de.iip_ecosphere.platform.services.AbstractServiceDescriptor

addInputDataConnector, addOutputDataConnector, addParameter, connectorIds, ensemble, ensembleConnectorNames, getAdditionalArguments, getApplicationId, getArtifact, getDataConnectors, getDescription, getId, getInputDataConnectors, getKind, getName, getOutputDataConnectors, getParameters, getState, getStub, getVersion, instantiateFrom, internalConnectorNames, isDeployable, isTopLevel, setAdditionalArguments, setArtifact, setClassification, setStub

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

getApplicationInstanceId, getServiceId

Field Detail

service

private Service service

ensembleLeader

private SpringCloudServiceDescriptor ensembleLeader

deploymentId

private java.lang.String deploymentId

portKeys

private java.util.List<java.lang.String> portKeys

process

private java.lang.Process process

processDir

private java.io.File processDir

serviceProtocol

private java.lang.String serviceProtocol

adminAddr

private de.iip_ecosphere.platform.support.net.ManagedServerAddress adminAddr

server

private Server server

Constructor Detail

SpringCloudServiceDescriptor

public SpringCloudServiceDescriptor(Service service,
                                    TypeResolver resolver)

Creates an instance.

Parameters:

service - the service deployment specification object

resolver - the (artifact) type resolver

See Also:

AbstractServiceDescriptor.setClassification(de.iip_ecosphere.platform.services.environment.ServiceKind, boolean, boolean)

SpringCloudServiceDescriptor

protected SpringCloudServiceDescriptor(java.lang.String id,
                                       java.lang.String applicationId,
                                       java.lang.String name,
                                       java.lang.String description,
                                       de.iip_ecosphere.platform.support.iip_aas.Version version)

Creates an instance. Call AbstractServiceDescriptor.setClassification(ServiceKind, boolean, boolean) afterwards.

Parameters:

id - the service id

applicationId - the application id, may be empty for default application/legacy

name - the name of this service

description - the description of the service

version - the version

Method Detail

createFor

static SpringCloudServiceDescriptor createFor(Server server)

Creates a temporary descriptor for the given server spec instance.

Parameters:

server - the server spec instance

Returns:

the descriptor

getServer

Server getServer()

If the service represents a server, return the server specification.

Returns:

the server specification, may be null

instantiate

SpringCloudServiceDescriptor instantiate(java.lang.String sId)

Instantiates this service as a template to represent an instance service with id serviceId. Typically, the application instance id changes compared to existing service descriptors.

Parameters:

sId - the service id

Returns:

the instantiated service

getArtifactDescriptorClass

protected java.lang.Class<SpringCloudArtifactDescriptor> getArtifactDescriptorClass()

Specified by:

getArtifactDescriptorClass in class de.iip_ecosphere.platform.services.AbstractServiceDescriptor<SpringCloudArtifactDescriptor>

setState

public void setState(de.iip_ecosphere.platform.services.environment.ServiceState state)
              throws java.util.concurrent.ExecutionException

Specified by:

setState in interface de.iip_ecosphere.platform.services.ServiceDescriptor

Overrides:

setState in class de.iip_ecosphere.platform.services.AbstractServiceDescriptor<SpringCloudArtifactDescriptor>

Throws:

java.util.concurrent.ExecutionException

release

private void release()

Releases the process as well as the ports in portKeys.

registerPort

private de.iip_ecosphere.platform.support.net.ManagedServerAddress registerPort(de.iip_ecosphere.platform.support.net.NetworkManager mgr,
                                                                                java.lang.String key)

Obtains a network port and registers it if necessary for release in setState(ServiceState).

Parameters:

mgr - the network manager instance

key - the key to obtain the network address

Returns:

the obtained address

setEnsembleLeader

void setEnsembleLeader(SpringCloudServiceDescriptor ensembleLeader)

Defines the ensemble leader.

Parameters:

ensembleLeader - optional ensemble leader some information shall be taken from/synchronized with

getGroup

public java.lang.String getGroup()

Returns the deployment group.

Returns:

the deployment group

getEnsembleLeader

public SpringCloudServiceDescriptor getEnsembleLeader()

Specified by:

getEnsembleLeader in interface de.iip_ecosphere.platform.services.ServiceDescriptor

Overrides:

getEnsembleLeader in class de.iip_ecosphere.platform.services.AbstractServiceDescriptor<SpringCloudArtifactDescriptor>

createDeploymentRequest

org.springframework.cloud.deployer.spi.core.AppDeploymentRequest createDeploymentRequest(SpringCloudServiceSetup config,
                                                                                         java.util.List<java.lang.String> cmdArgs)
                                                                                  throws java.util.concurrent.ExecutionException

Creates the deployment request for the Spring deployer.

Parameters:

config - the service manager configuration instance

cmdArgs - further command line arguments to be considered, may be null or empty for none

Returns:

the deployment request, may be null if this service is an ensemble follower and should not be started individually

Throws:

java.util.concurrent.ExecutionException - when preparing the service fails for some reason

collectCmdArguments

java.util.List<java.lang.String> collectCmdArguments(SpringCloudServiceSetup config,
                                                     int port,
                                                     java.lang.String protocol)

Collects basic command line arguments.

Parameters:

config - the configuration

port - the network port to substitute in the service command line arguments

protocol - the protocol, may be empty for none

Returns:

the command line arguments

getTransportHost

private java.lang.String getTransportHost(SpringCloudServiceSetup setup)

Returns the actual transport host. [legacy fallback, due to testing]

Parameters:

setup - the instance to take the information from

Returns:

the host

getTransportPort

private int getTransportPort(SpringCloudServiceSetup setup)

Returns the actual transport port. [legacy fallback, due to testing]

Parameters:

setup - the instance to take the information from

Returns:

the port

attachStub

void attachStub()

Attaches a service stub to directly interact with the service if adminAddr has been set by createDeploymentRequest(SpringCloudServiceSetup, List) before.

waitForAdminServer

void waitForAdminServer(int waitingTime)

Waits that the server on adminAddr becomes available.

Parameters:

waitingTime - maximum waiting time in ms

detachStub

void detachStub()

Detaches an attached service stub.

getInvocablesCreator

public de.iip_ecosphere.platform.support.aas.InvocablesCreator getInvocablesCreator()

startProcess

int startProcess(SpringCloudServiceSetup config,
                 ProcessSpec pSpec)
          throws java.util.concurrent.ExecutionException

Starts the non-Java execution process if needed.

Parameters:

config - the service manager configuration instance

pSpec - the specification of the service to start

Returns:

the process port, valid if positive

Throws:

java.util.concurrent.ExecutionException - when preparing the service fails for some reason

getStreamingNetmanagerKey

private java.lang.String getStreamingNetmanagerKey()

Returns the NetworkManager key for the streaming connection to an external process.

Returns:

the key

getAasNetmanagerKey

java.lang.String getAasNetmanagerKey()

Returns the NetworkManager key for the AAS command connection to an external process.

Returns:

the key

setDeploymentId

void setDeploymentId(java.lang.String id)

Sets the Spring cloud deployer deployment id.

Parameters:

id - the deployment id

getDeploymentId

java.lang.String getDeploymentId()

Returns the Spring cloud deployer deployment id.

Returns:

the deployment id, may be null for not deployed

getSvc

public Service getSvc()

Returns the YAML descriptor. [for testing]

Returns:

the YAML descriptor

toFunctionDefinition

public static java.lang.String toFunctionDefinition(java.util.Set<de.iip_ecosphere.platform.services.AbstractServiceManager.TypedDataConnection> conn)

Turns typed data connections into a Spring cloud function definition argument.

Parameters:

conn - the connections

Returns:

the composed function definition argument