org.bonitasoft.engine.core.connector

Interface ConnectorService

All Known Implementing Classes:

ConnectorServiceDecorator, ConnectorServiceImpl

public interface ConnectorService

Since:

6.0

Author:

Baptiste Mesta, Matthieu Chaffotte, Elias Ricken de Medeiros

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DONE
static java.lang.String	FAILED
static java.lang.String	SKIPPED
static java.lang.String	TO_BE_EXECUTED
static java.lang.String	TO_RE_EXECUTE

Method Summary

Modifier and Type	Method and 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, 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 result)
SConnectorImplementationDescriptor	getConnectorImplementation(long processDefinitionId, java.lang.String connectorId, java.lang.String connectorVersion) Get connector implementation descriptor for specified connector in a process definition.
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<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.

Field Detail

TO_BE_EXECUTED

static final java.lang.String TO_BE_EXECUTED

See Also:

Constant Field Values

DONE

static final java.lang.String DONE

See Also:

Constant Field Values

FAILED

static final java.lang.String FAILED

See Also:

Constant Field Values

SKIPPED

static final java.lang.String SKIPPED

See Also:

Constant Field Values

TO_RE_EXECUTE

static final java.lang.String TO_RE_EXECUTE

See Also:

Constant Field Values

Method Detail

executeMultipleEvaluation

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

Execute a connector instance by given connectorDefinitionId and connectorDefinitionVersion

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

boolean loadConnectors(SProcessDefinition sDefinition)
                throws SConnectorException

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

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

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

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.

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

java.util.List<SConnectorImplementationDescriptor> getConnectorImplementations(long processDefinitionId,
                                                                               int fromIndex,
                                                                               int numberPerPage,
                                                                               java.lang.String field,
                                                                               OrderByType order)
                                                                        throws SConnectorException

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

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

SConnectorImplementationDescriptor getConnectorImplementation(long processDefinitionId,
                                                              java.lang.String connectorId,
                                                              java.lang.String connectorVersion)
                                                       throws SConnectorException

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

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

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

Parameters:

parameters -

sExpressionContext -

inputValues -

Returns:

Throws:

SExpressionTypeUnknownException

SExpressionEvaluationException

SExpressionDependencyMissingException

SInvalidExpressionException

getConnectorImplementationDescriptor

SConnectorImplementationDescriptor getConnectorImplementationDescriptor(long processDefinitionId,
                                                                        java.lang.String connectorId,
                                                                        java.lang.String version)
                                                                 throws SConnectorException

Throws:

SConnectorException

executeOutputOperation

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

Parameters:

outputs -

expressionContext -

result -

Throws:

SConnectorException

executeConnector

java.util.concurrent.CompletableFuture<ConnectorResult> executeConnector(long processDefinitionId,
                                                                         SConnectorInstance sConnectorInstance,
                                                                         SConnectorImplementationDescriptor connectorImplementationDescriptor,
                                                                         java.lang.ClassLoader classLoader,
                                                                         java.util.Map<java.lang.String,java.lang.Object> inputParameters)
                                                                  throws SConnectorException

Parameters:

processDefinitionId -

sConnectorInstance -

connectorImplementationDescriptor -

classLoader -

inputParameters -

Returns:

the result of the connector execution

Throws:

SConnectorException

disconnect

void disconnect(ConnectorResult result)
         throws SConnectorException

Parameters:

result -

Throws:

SConnectorException

getNumberOfConnectorImplementations

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

Parameters:

processDefinitionId - the id of the process definition

Returns:

the number of connector implementation for this process definition

Throws:

SConnectorException

getConnectorImplementations

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

Throws:

SBonitaReadException

addConnectorImplementation

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

Throws:

SRecorderException

removeConnectorImplementations

void removeConnectorImplementations(long processDefinitionId)
                             throws SBonitaReadException,
                                    SRecorderException

Throws:

SBonitaReadException

SRecorderException