org.bonitasoft.engine.connector

Class AbstractConnector

java.lang.Object

org.bonitasoft.engine.connector.AbstractConnector

All Implemented Interfaces:

Connector

public abstract class AbstractConnector
extends Object
implements Connector

Author:

Feng Hui, Romain Bioteau, Baptiste Mesta, Matthieu Chaffotte

Field Summary

Fields

Modifier and Type	Field and Description
protected APIAccessor	apiAccessor

Constructor Summary

Constructors

Constructor and Description
AbstractConnector()

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.
protected abstract void	executeBusinessLogic()
APIAccessor	getAPIAccessor()
EngineExecutionContext	getExecutionContext()
protected Object	getInputParameter(String paramName)
protected Object	getInputParameter(String parameterKey, Serializable defaultValue) get the input parameter or the default value if the parameter is not set
protected Map<String,Object>	getOutputParameters()
void	setAPIAccessor(APIAccessor apiAccessor)
void	setExecutionContext(EngineExecutionContext executionContext)
void	setInputParameters(Map<String,Object> parameters) Set the input parameter for a connector.
protected void	setOutputParameter(String paramName, Object value)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.bonitasoft.engine.connector.Connector

validateInputParameters

Field Detail

apiAccessor

protected APIAccessor apiAccessor

Constructor Detail

AbstractConnector

public AbstractConnector()

Method Detail

setInputParameters

public void setInputParameters(Map<String,Object> parameters)

Description copied from interface: Connector

Set the input parameter for a connector.

Specified by:

setInputParameters in interface Connector

Parameters:

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

getInputParameter

protected Object getInputParameter(String paramName)

getInputParameter

protected Object getInputParameter(String parameterKey,
                                   Serializable defaultValue)

get the input parameter or the default value if the parameter is not set

Parameters:

parameterKey - name of the parameter

defaultValue - value of the parameter if not set

Returns:

the value of the parameter

setOutputParameter

protected void setOutputParameter(String paramName,
                                  Object value)

getOutputParameters

protected Map<String,Object> getOutputParameters()

execute

public final Map<String,Object> execute()
                                 throws ConnectorException

Description copied from interface: Connector

Execute the connector.

Specified by:

execute in interface Connector

Returns:

the connector outputs map corresponding to the output definition.

Throws:

ConnectorException - when something went wrong during connector execution

connect

public void connect()
             throws ConnectorException

Description copied from interface: Connector

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

Specified by:

connect in interface Connector

Throws:

ConnectorException - when something went wrong during connector connection

disconnect

public void disconnect()
                throws ConnectorException

Description copied from interface: Connector

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.

Specified by:

disconnect in interface Connector

Throws:

ConnectorException - when something went wrong during connector disconnection

executeBusinessLogic

protected abstract void executeBusinessLogic()
                                      throws ConnectorException

Throws:

ConnectorException

setAPIAccessor

public void setAPIAccessor(APIAccessor apiAccessor)

getAPIAccessor

public APIAccessor getAPIAccessor()

getExecutionContext

public EngineExecutionContext getExecutionContext()

setExecutionContext

public void setExecutionContext(EngineExecutionContext executionContext)