Package de.iip_ecosphere.platform.services.environment

Class PythonSyncProcessService

  • All Implemented Interfaces:
    GenericMultiTypeService, ParameterConfigurerProvider, Service, ServiceBase
    public class PythonSyncProcessService
extends AbstractPythonProcessService
    Generic command-line-based Python integration for multiple data types. Conventions:
    • Python is determined by PythonUtils.getPythonExecutable(). The default is "ServiceEnvironment.py" which must run for this integration with "--mode console".
    • A synchronous Python program receives the data including the symbolic type name as last (for "ServiceEnvironment.py" qualified by "--data") command line argument and returns the result on the command line including the symbolic type name.
    • The Python program runs until the input data is processed.
    Author:
    Holger Eichelberger, SSE

    • Field Detail

      • timeout

        private int timeout

      • timeoutUnit

        private java.util.concurrent.TimeUnit timeoutUnit

      • reconfValues

        private java.util.Map<java.lang.String,​java.lang.String> reconfValues

    • Constructor Detail

      • PythonSyncProcessService

        public PythonSyncProcessService​(java.lang.String serviceId,
                                java.io.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

      • PythonSyncProcessService

        public PythonSyncProcessService​(YamlService yaml)
        Creates an abstract service from YAML information.
        Parameters:
        yaml - the service information as read from YAML. By default, the Python executable is "ServiceEnvironment.py", which can be overridden by YamlProcess.getExecutable(). YamlProcess.getHomePath() is set to the home path where the executable was extracted to. Further, YamlProcess.getCmdArg() are taken over if given.

    • Method Detail

      • migrate

        public void migrate​(java.lang.String resourceId)
             throws java.util.concurrent.ExecutionException
        Description copied from interface: Service
        Migrates a service. However, it may be required to migrate/move the containing artifact. [adaptation]
        Parameters:
        resourceId - the target resource id, e.g., a device
        Throws:
        java.util.concurrent.ExecutionException - if migration fails

      • update

        public void update​(java.net.URI location)
            throws java.util.concurrent.ExecutionException
        Description copied from interface: Service
        Updates the service by the service in the given location. This operation is responsible for stopping the running service (if needed), replacing it, starting the new service.
        Parameters:
        location - the location of the new service, e.g., an URL
        Throws:
        java.util.concurrent.ExecutionException - if the given service cannot be updated for some reason, e.g., because the replacement service is not an evolved version of the running service

      • switchTo

        public void switchTo​(java.lang.String targetId)
              throws java.util.concurrent.ExecutionException
        Description copied from interface: Service
        Switches to an interface-compatible service. This method cares for stopping the old service, performing a handover if adequate, starting the target service. [adaptation]
        Parameters:
        targetId - the id of the target service
        Throws:
        java.util.concurrent.ExecutionException - if switching the service cannot be performed for some reason

      • reconfigure

        public void reconfigure​(java.util.Map<java.lang.String,​java.lang.String> values)
                 throws java.util.concurrent.ExecutionException
        Description copied from interface: Service
        Reconfigures the service. [adaptation]
        Specified by:
        reconfigure in interface Service
        Overrides:
        reconfigure in class AbstractService
        Parameters:
        values - the (service-specific) name-value mapping that shall lead to a reconfiguration of the service; values come either as primitive values or as JSON structures complying with the parameter descriptor. The service is responsible for correct JSON de-serialization according to the respective descriptor.
        Throws:
        java.util.concurrent.ExecutionException - if reconfiguration fails

      • getLogger

        protected static org.slf4j.Logger getLogger()
        Returns the logger.
        Returns:
        the logger

      • processImpl

        private <I,​O> O processImpl​(java.lang.String inType,
                                  I data)
                           throws java.util.concurrent.ExecutionException
        Requests processing a data item.
        Type Parameters:
        I - the input data type
        O - the output data type
        Parameters:
        inType - the name of inType in the configuration model
        data - the data item to be processed
        Returns:
        the output, always null in case of asynchronous processing as the result is passed to a registered ingestor
        Throws:
        java.util.concurrent.ExecutionException - if the execution fails for some reason, e.g., because type translators are not registered (@link #registerInputTypeTranslator(Class, Class, TypeTranslator, TypeTranslator)}

      • process

        public <I> void process​(java.lang.String inType,
                        I data)
                 throws java.util.concurrent.ExecutionException
        Description copied from interface: GenericMultiTypeService
        Requests asynchronous processing a data item.
        Type Parameters:
        I - the input data type
        Parameters:
        inType - the name of inType in the configuration model
        data - the data item to be processed
        Throws:
        java.util.concurrent.ExecutionException - if the execution fails for some reason, e.g., because type translators are not registered (@link #registerInputTypeTranslator(Class, Class, TypeTranslator, TypeTranslator)}

      • processSync

        public <I,​O> O processSync​(java.lang.String inType,
                                 I data,
                                 java.lang.String outType)
                          throws java.util.concurrent.ExecutionException
        Description copied from interface: GenericMultiTypeService
        Requests synchronous processing a data item.
        Type Parameters:
        I - the input data type
        O - the output data type
        Parameters:
        inType - the name of inType in the configuration model
        data - the data item to be processed
        outType - the name of outType in the configuration model
        Returns:
        the output, always null in case of asynchronous processing as the result is passed to a registered ingestor
        Throws:
        java.util.concurrent.ExecutionException - if the execution fails for some reason, e.g., because type translators are not registered (@link #registerInputTypeTranslator(Class, Class, TypeTranslator, TypeTranslator)}