org.bonitasoft.engine.connector

Interface Connector

All Known Implementing Classes:

AbstractConnector

public interface Connector

Author:

Feng Hui

Method Summary

Modifier and Type	Method and Description
void	connect() Called by the engine before the connector is executed This method can be implemented by connectors to handle here opening of connections like database connection
void	disconnect() Called by the engine after the connector and its output operations are executed This method can be implemented by connectors to close connections here.
Map<String,Object>	execute() Execute the connector.
void	setInputParameters(Map<String,Object> parameters) Set the input parameter for a connector.
void	validateInputParameters() Validate the input parameters.

Method Detail

setInputParameters

void setInputParameters(Map<String,Object> parameters)

Set the input parameter for a connector.

Parameters:

parameters - parameters is a map with parameter names and their value.

validateInputParameters

void validateInputParameters()
                      throws ConnectorValidationException

Validate the input parameters. Check the parameters types and boundaries.

Throws:

ConnectorValidationException - when the input parameters are not valid

execute

Map<String,Object> execute()
                    throws ConnectorException

Execute the connector.

Returns:

the connector outputs map corresponding to the output definition.

Throws:

ConnectorException - when something went wrong during connector execution

connect

void connect()
      throws ConnectorException

Called by the engine before the connector is executed This method can be implemented by connectors to handle here opening of connections like database connection

Throws:

ConnectorException - when something went wrong during connector connection

disconnect

void disconnect()
         throws ConnectorException

Called by the engine after the connector and its output operations are executed This method can be implemented by connectors to close connections here. The typical use of this is to be able to return connected objects that will be used in output operation and then disconnect them.

Throws:

ConnectorException - when something went wrong during connector disconnection