Package de.iip_ecosphere.platform.services.environment

Class PythonWsProcessService

java.lang.Object

de.iip_ecosphere.platform.services.environment.AbstractService

de.iip_ecosphere.platform.services.environment.AbstractRunnablesService

de.iip_ecosphere.platform.services.environment.AbstractPythonProcessService

de.iip_ecosphere.platform.services.environment.PythonAsyncProcessService

de.iip_ecosphere.platform.services.environment.PythonWsProcessService

All Implemented Interfaces:

GenericMultiTypeService, ParameterConfigurerProvider, Service, ServiceBase

public class PythonWsProcessService
extends PythonAsyncProcessService

Generic WebSocket-based Python integration for asynchronous processing of multiple data types. Conventions:

• Python is determined by PythonUtils.getPythonExecutable(). The default is "ServiceEnvironment.py" which must run for this integration with "--mode WS" and given port.
• The Python program runs endless until stopped by this class.
• An asynchronous Python program receives the data via command line input streams based on the input serializer and the symbolic type name.

Author:

Holger Eichelberger, SSE

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private class	PythonWsProcessService.PyWebSocket	Websocket client implementation.

Nested classes/interfaces inherited from class de.iip_ecosphere.platform.services.environment.AbstractPythonProcessService

AbstractPythonProcessService.InputHandler, AbstractPythonProcessService.SyncDataIngestor<D>

Field Summary

Fields

Modifier and Type	Field	Description
private long	averageResponseTime
private int	instancePort
private String	networkPortKey
private PythonWsProcessService.PyWebSocket	socket

Fields inherited from class de.iip_ecosphere.platform.services.environment.AbstractPythonProcessService

TYPE_SEPARATOR_CHAR

Fields inherited from interface de.iip_ecosphere.platform.services.environment.switching.ServiceBase

APPLICATION_SEPARATOR, DEFAULT_APPLICATION_INSTANCE_ID

Constructor Summary

Constructors

Constructor	Description
PythonWsProcessService(YamlService yaml)	Creates an instance of the service.
PythonWsProcessService(String serviceId, InputStream ymlFile)	Creates an instance from a service id and a YAML artifact.

Method Summary

Modifier and Type	Method	Description
protected void	createScanInputThread(Process proc)	Creates the input scanning thread.
protected void	customizePythonArgs(List<String> pythonArgs)	Allows to customize the Python command line arguments taken from the yaml spec.
long	getAvgResponseTime()	Returns the average response time for the execution in Python (without transport).
protected static de.iip_ecosphere.platform.support.logging.Logger	getLogger()	Returns the logger.
protected void	initializeFrom(YamlService yaml)	Does further initialization of this instance from the given YAML information.
protected void	sendToService(String type, Object data)	Sends text as input to the service process.
protected ServiceState	stop()	Stops the service and the background process.

Methods inherited from class de.iip_ecosphere.platform.services.environment.PythonAsyncProcessService

activate, migrate, passivate, process, processSync, reconfigure, setState, start, switchTo, update

Methods inherited from class de.iip_ecosphere.platform.services.environment.AbstractPythonProcessService

addParameterConfigurer, attachIngestor, compose, createAndCustomizeProcess, createScanInputThread, enableFileDeletion, getHome, getInTypeInfo, getLocationKey, getOutTypeInfo, getOutTypeName, getParameterConfigurer, getParameterNames, getPythonExecutable, getTypeSubstitutionsJson, handleErrorStream, handleResult, isFileDeletionEnabled, registerInOutRelation, registerInputTypeTranslator, registerOutputTypeTranslator, scanInputStream, startExecutableByName, toJson, unbuffer

Methods inherited from class de.iip_ecosphere.platform.services.environment.AbstractRunnablesService

register

Methods inherited from class de.iip_ecosphere.platform.services.environment.AbstractService

addConfigurer, addConfigurer, addConfigurer, addTypeSubstitution, createGenericInstance, createGenericInstance, createGenericInstanceByPlugin, createGenericMultiInstance, createGenericMultiInstance, createGenericMultiInstanceByPlugin, createInstance, createInstance, createInstance, createInstanceByPlugin, getArg, getDescription, getId, getKind, getName, getNetMgtKeyAddress, getResourceAsStream, getState, getStringArg, getSubstitutedType, getTypeCreator, getTypeSubstitutions, getVersion, isDeployable, isTopLevel, notifyReconfigured, reconf, reconfigure, rollbackReconfigurationOnFailure, setLibJars, transferData

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.environment.GenericMultiTypeService

processQuiet, processSyncQuiet

Methods inherited from interface de.iip_ecosphere.platform.services.environment.Service

addTypeSubstitution, createType, createType, getDescription, getKind, getName, getNetMgtKeyAddress, getSubstitutedType, getTypeCreator, getTypeSubstitutions, getVersion, isDeployable, isTopLevel

Methods inherited from interface de.iip_ecosphere.platform.services.environment.switching.ServiceBase

getId, getState

Field Details

instancePort

private int instancePort

averageResponseTime

private long averageResponseTime

socket

private PythonWsProcessService.PyWebSocket socket

networkPortKey

private String networkPortKey

Constructor Details

PythonWsProcessService

public PythonWsProcessService(String serviceId,
 InputStream ymlFile)

Creates an instance from a service id and a YAML artifact.

Parameters:

serviceId - the service id

ymlFile - the YML file containing the YAML artifact with the service descriptor

PythonWsProcessService

public PythonWsProcessService(YamlService yaml)

Creates an instance of the service.

Parameters:

yaml - the service description

Method Details

initializeFrom

protected void initializeFrom(YamlService yaml)

Description copied from class: AbstractService

Does further initialization of this instance from the given YAML information.

Overrides:

initializeFrom in class AbstractPythonProcessService

Parameters:

yaml - the service information as read from YAML

customizePythonArgs

protected void customizePythonArgs(List<String> pythonArgs)

Description copied from class: AbstractPythonProcessService

Allows to customize the Python command line arguments taken from the yaml spec.

Overrides:

customizePythonArgs in class AbstractPythonProcessService

Parameters:

pythonArgs - the arguments to customize

createScanInputThread

protected void createScanInputThread(Process proc)

Description copied from class: PythonAsyncProcessService

Creates the input scanning thread.

Overrides:

createScanInputThread in class PythonAsyncProcessService

Parameters:

proc - the process instance to observe

stop

protected ServiceState stop()

Description copied from class: AbstractService

Stops the service and the background process.

Overrides:

stop in class PythonAsyncProcessService

Returns:

the state to transition to, may be null for none

sendToService

protected void sendToService(String type,
 Object data)
                      throws ExecutionException

Description copied from class: PythonAsyncProcessService

Sends text as input to the service process.

Overrides:

sendToService in class PythonAsyncProcessService

Parameters:

type - the type of the data to be sent

data - the data to be sent

Throws:

ExecutionException - if sending fails for some reason

getLogger

protected static de.iip_ecosphere.platform.support.logging.Logger getLogger()

Returns the logger.

Returns:

the logger

getAvgResponseTime

public long getAvgResponseTime()

Description copied from class: AbstractPythonProcessService

Returns the average response time for the execution in Python (without transport).

Overrides:

getAvgResponseTime in class AbstractPythonProcessService

Returns:

the average response time (in nanoseconds)