Package org.bonitasoft.engine.connector

Class ConnectorServiceDecorator

java.lang.Object

org.bonitasoft.engine.connector.ConnectorServiceDecorator

All Implemented Interfaces:

ConnectorService

public class ConnectorServiceDecorator
extends java.lang.Object
implements ConnectorService

This service wraps the connector service and add engine variables like apiAccessor, engineExecutionContext.

Author:

Matthieu Chaffotte, Elias Ricken de Medeiros, Celine Souchet

Field Summary

Fields inherited from interface org.bonitasoft.engine.core.connector.ConnectorService

DONE, FAILED, SKIPPED, TO_BE_EXECUTED, TO_RE_EXECUTE

Constructor Summary

Constructors

Constructor	Description
ConnectorServiceDecorator(ConnectorService connectorService)

Method Summary

Modifier and Type	Method	Description
void	addConnectorImplementation(java.lang.Long processDefinitionId, java.lang.String name, byte[] content)
void	disconnect(ConnectorResult result)
java.util.Map<java.lang.String,java.lang.Object>	evaluateInputParameters(java.lang.String connectorId, java.util.Map<java.lang.String,SExpression> parameters, SExpressionContext sExpressionContext, java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.io.Serializable>> inputValues)
java.util.concurrent.CompletableFuture<ConnectorResult>	executeConnector(long processDefinitionId, SConnectorInstance sConnectorInstance, org.bonitasoft.engine.core.connector.parser.SConnectorImplementationDescriptor connectorImplementationDescriptor, java.lang.ClassLoader classLoader, java.util.Map<java.lang.String,java.lang.Object> inputParameters)
ConnectorResult	executeMultipleEvaluation(long processDefinitionId, java.lang.String connectorDefinitionId, java.lang.String connectorDefinitionVersion, java.util.Map<java.lang.String,SExpression> connectorInputParameters, java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.io.Serializable>> inputValues, java.lang.ClassLoader classLoader, SExpressionContext sexpContext)	Execute a connector instance by given connectorDefinitionId and connectorDefinitionVersion
void	executeOutputOperation(java.util.List<SOperation> outputs, SExpressionContext expressionContext, ConnectorResult connectorOutput)
org.bonitasoft.engine.core.connector.parser.SConnectorImplementationDescriptor	getConnectorImplementation(long processDefinitionId, java.lang.String connectorId, java.lang.String connectorVersion)	Get connector implementation descriptor for specified connector in a process definition.
org.bonitasoft.engine.core.connector.parser.SConnectorImplementationDescriptor	getConnectorImplementationDescriptor(long processDefinitionId, java.lang.String connectorId, java.lang.String version)
java.util.List<SBARResource>	getConnectorImplementations(long processDefinitionId, int from, int numberOfElements)
java.util.List<org.bonitasoft.engine.core.connector.parser.SConnectorImplementationDescriptor>	getConnectorImplementations(long processDefinitionId, int fromIndex, int numberPerPage, java.lang.String field, OrderByType order)	Get a list of connector implementation descriptors for id specified process definition, the returned list is paginated
java.lang.Long	getNumberOfConnectorImplementations(long processDefinitionId)
boolean	loadConnectors(SProcessDefinition sDefinition)	Load connectors for given process definition and tenant, connectors will be stored in cache after loading
void	removeConnectorImplementations(long processDefinitionId)
void	setConnectorImplementation(SProcessDefinition sProcessDefinition, java.lang.String connectorId, java.lang.String connectorVersion, byte[] connectorImplementationArchive)	Set connector implementation for id and version specified connector.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ConnectorServiceDecorator

public ConnectorServiceDecorator(ConnectorService connectorService)

Method Detail

executeMultipleEvaluation

public ConnectorResult executeMultipleEvaluation(long processDefinitionId,
                                                 java.lang.String connectorDefinitionId,
                                                 java.lang.String connectorDefinitionVersion,
                                                 java.util.Map<java.lang.String,SExpression> connectorInputParameters,
                                                 java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.io.Serializable>> inputValues,
                                                 java.lang.ClassLoader classLoader,
                                                 SExpressionContext sexpContext)
                                          throws SConnectorException

Description copied from interface: ConnectorService

Execute a connector instance by given connectorDefinitionId and connectorDefinitionVersion

Specified by:

executeMultipleEvaluation in interface ConnectorService

Parameters:

processDefinitionId - The identifier of process definition

connectorDefinitionId - The identifier of connector definition

connectorDefinitionVersion - The version of connector definition

connectorInputParameters - The input of connector

inputValues - The input values of connector

classLoader - The class loader used to load and run connector

sexpContext - The expression context

Returns:

The output after connector executing

Throws:

SConnectorException - Error thrown if has exceptions during the connector executing

loadConnectors

public boolean loadConnectors(SProcessDefinition sDefinition)
                       throws SConnectorException

Description copied from interface: ConnectorService

Load connectors for given process definition and tenant, connectors will be stored in cache after loading

Specified by:

loadConnectors in interface ConnectorService

Parameters:

sDefinition - The process definition

Returns:

true if all connectors found have all them dependencies resolved and are correctly loaded

Throws:

SConnectorException - Error thrown if has exceptions during the connector loading

setConnectorImplementation

public void setConnectorImplementation(SProcessDefinition sProcessDefinition,
                                       java.lang.String connectorId,
                                       java.lang.String connectorVersion,
                                       byte[] connectorImplementationArchive)
                                throws SConnectorException,
                                       SInvalidConnectorImplementationException

Description copied from interface: ConnectorService

Set connector implementation for id and version specified connector. Store all connector related files if they are not existed and replace the old implementation with the new one in file system. Delete former and load current connectors in cache.

Specified by:

setConnectorImplementation in interface ConnectorService

Parameters:

sProcessDefinition - The process definition which the connector belongs to

connectorId - Id of connector definition.

connectorVersion - Version of connector definition

connectorImplementationArchive - zip byte array containing the connector implementation information

Throws:

SConnectorException - Error thrown if has exceptions during the connector implementation setting

SInvalidConnectorImplementationException

getConnectorImplementations

public java.util.List<org.bonitasoft.engine.core.connector.parser.SConnectorImplementationDescriptor> getConnectorImplementations(long processDefinitionId,
                                                                                                                                  int fromIndex,
                                                                                                                                  int numberPerPage,
                                                                                                                                  java.lang.String field,
                                                                                                                                  OrderByType order)
                                                                                                                           throws SConnectorException

Description copied from interface: ConnectorService

Get a list of connector implementation descriptors for id specified process definition, the returned list is paginated

Specified by:

getConnectorImplementations in interface ConnectorService

Parameters:

processDefinitionId - Identifier of process definition

fromIndex - Start index of connector record

numberPerPage - Number of connectors we want to get. Maximum number of connectors returned.

field - The field that the result ordered by

order - The order, ACS or DESC

Returns:

A list of all satisfied connector implementation descriptor objects

Throws:

SConnectorException - Error thrown if has exceptions during the connector implementations retrieve

getConnectorImplementation

public org.bonitasoft.engine.core.connector.parser.SConnectorImplementationDescriptor getConnectorImplementation(long processDefinitionId,
                                                                                                                 java.lang.String connectorId,
                                                                                                                 java.lang.String connectorVersion)
                                                                                                          throws SConnectorException

Description copied from interface: ConnectorService

Get connector implementation descriptor for specified connector in a process definition.

Specified by:

getConnectorImplementation in interface ConnectorService

Parameters:

processDefinitionId - Identifier of process definition

connectorId - id of connector definition

connectorVersion - version of connector definition

Returns:

connector implementation descriptor object

Throws:

SConnectorException - Error thrown if has exceptions during the connector implementation get

evaluateInputParameters

public java.util.Map<java.lang.String,java.lang.Object> evaluateInputParameters(java.lang.String connectorId,
                                                                                      java.util.Map<java.lang.String,SExpression> parameters,
                                                                                      SExpressionContext sExpressionContext,
                                                                                      java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.io.Serializable>> inputValues)
                                                                               throws SExpressionTypeUnknownException,
                                                                                      SExpressionEvaluationException,
                                                                                      SExpressionDependencyMissingException,
                                                                                      SInvalidExpressionException

Specified by:

evaluateInputParameters in interface ConnectorService

Returns:

Throws:

SExpressionTypeUnknownException

SExpressionEvaluationException

SExpressionDependencyMissingException

SInvalidExpressionException

executeOutputOperation

public void executeOutputOperation(java.util.List<SOperation> outputs,
                                   SExpressionContext expressionContext,
                                   ConnectorResult connectorOutput)
                            throws SConnectorException

Specified by:

executeOutputOperation in interface ConnectorService

Throws:

SConnectorException

executeConnector

public java.util.concurrent.CompletableFuture<ConnectorResult> executeConnector(long processDefinitionId,
                                                                                SConnectorInstance sConnectorInstance,
                                                                                org.bonitasoft.engine.core.connector.parser.SConnectorImplementationDescriptor connectorImplementationDescriptor,
                                                                                java.lang.ClassLoader classLoader,
                                                                                java.util.Map<java.lang.String,java.lang.Object> inputParameters)
                                                                         throws SConnectorException

Specified by:

executeConnector in interface ConnectorService

Returns:

the result of the connector execution

Throws:

SConnectorException

disconnect

public void disconnect(ConnectorResult result)
                throws SConnectorException

Specified by:

disconnect in interface ConnectorService

Throws:

SConnectorException

getNumberOfConnectorImplementations

public java.lang.Long getNumberOfConnectorImplementations(long processDefinitionId)
                                                   throws SConnectorException

Specified by:

getNumberOfConnectorImplementations in interface ConnectorService

Parameters:

processDefinitionId - the id of the process definition

Returns:

the number of connector implementation for this process definition

Throws:

SConnectorException

getConnectorImplementations

public java.util.List<SBARResource> getConnectorImplementations(long processDefinitionId,
                                                                int from,
                                                                int numberOfElements)
                                                         throws SBonitaReadException

Specified by:

getConnectorImplementations in interface ConnectorService

Throws:

SBonitaReadException

addConnectorImplementation

public void addConnectorImplementation(java.lang.Long processDefinitionId,
                                       java.lang.String name,
                                       byte[] content)
                                throws SRecorderException

Specified by:

addConnectorImplementation in interface ConnectorService

Throws:

SRecorderException

removeConnectorImplementations

public void removeConnectorImplementations(long processDefinitionId)
                                    throws SBonitaReadException,
                                           SRecorderException

Specified by:

removeConnectorImplementations in interface ConnectorService

Throws:

SBonitaReadException

SRecorderException

getConnectorImplementationDescriptor

public org.bonitasoft.engine.core.connector.parser.SConnectorImplementationDescriptor getConnectorImplementationDescriptor(long processDefinitionId,
                                                                                                                           java.lang.String connectorId,
                                                                                                                           java.lang.String version)
                                                                                                                    throws SConnectorException

Specified by:

getConnectorImplementationDescriptor in interface ConnectorService

Throws:

SConnectorException