Package org.bonitasoft.engine.connector

Interface SConnector

All Known Implementing Classes:
AbstractSConnector, SConnectorAdapter, SConnectorUserFilterAdapter
public interface SConnector
Author:
Feng Hui

  • Method Summary

    Modifier and Type
    Method
    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
    validate()
    Validate the input parameters.

  • Method Details

    • 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.

    • validate

      void validate() throws SConnectorValidationException
      Validate the input parameters. Check the parameters types and boundaries.
      Throws:
      SConnectorValidationException

    • execute

      Map<String,Object> execute() throws SConnectorException
      Execute the connector.
      Returns:
      the connector outputs map corresponding to the output definition.
      Throws:
      SConnectorException

    • connect

      void connect() throws SConnectorException
      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:
      SConnectorException

    • disconnect

      void disconnect() throws SConnectorException
      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:
      SConnectorException