Package com.gooddata.connector

Class ConnectorService

java.lang.Object

com.gooddata.AbstractService

com.gooddata.connector.ConnectorService

public class ConnectorService
extends AbstractService

Service for connector integration creation, update of its settings or execution of its process.

Nested Class Summary

Nested classes/interfaces inherited from class com.gooddata.AbstractService

AbstractService.OutputStreamResponseExtractor

Field Summary

Fields inherited from class com.gooddata.AbstractService

mapper, restTemplate

Constructor Summary

Constructors

Constructor	Description
ConnectorService(org.springframework.web.client.RestTemplate restTemplate, ProjectService projectService)	Deprecated. use ConnectorService(RestTemplate, ProjectService, GoodDataSettings) constructor instead
ConnectorService(org.springframework.web.client.RestTemplate restTemplate, ProjectService projectService, GoodDataSettings settings)

Method Summary

Modifier and Type	Method	Description
CoupaInstance	createCoupaInstance(Project project, CoupaInstance instance)	Creates Coupa connector instance.
Integration	createIntegration(Project project, ConnectorType connectorType, Integration integration)	Create connector integration
Integration	createIntegration(Project project, Settings settings)	Create connector integration with given settings
protected FutureResult<ProcessStatus>	createProcessPollResult(String uri)
FutureResult<ProcessStatus>	executeProcess(Project project, ProcessExecution execution)	Execute connector process
Collection<CoupaInstance>	findCoupaInstances(Project project)	Returns collection of all existing Coupa instances
CoupaSettings	getCoupaSettings(Project project)	Gets settings for coupa connector.
Integration	getIntegration(Project project, ConnectorType connectorType)	Retrieve connector integration
PardotSettings	getPardotSettings(Project project)	Gets settings for pardot connector.
FutureResult<ProcessStatus>	getProcessStatus(IntegrationProcessStatus process)	Gets status of provided connector process.
<T extends Settings> T	getSettings(Project project, ConnectorType connectorType, Class<T> settingsClass)	Get settings for given connector of given class.
Zendesk4Settings	getZendesk4Settings(Project project)	Get settings for zendesk4 connector.
void	updateIntegration(Project project, ConnectorType connectorType, Integration integration)	Update connector integration
void	updateSettings(Project project, Settings settings)	Update integration settings

Methods inherited from class com.gooddata.AbstractService

extractData

Methods inherited from class java.lang.Object

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

Constructor Detail

ConnectorService

public ConnectorService(org.springframework.web.client.RestTemplate restTemplate,
                        ProjectService projectService,
                        GoodDataSettings settings)

ConnectorService

@Deprecated
public ConnectorService(org.springframework.web.client.RestTemplate restTemplate,
                        ProjectService projectService)

Deprecated.

use ConnectorService(RestTemplate, ProjectService, GoodDataSettings) constructor instead

Method Detail

getIntegration

public Integration getIntegration(Project project,
                                  ConnectorType connectorType)

Retrieve connector integration

Parameters:

project - project

connectorType - connector type

Returns:

integration

Throws:

ConnectorException - if integration can't be retrieved

createIntegration

public Integration createIntegration(Project project,
                                     Settings settings)

Create connector integration with given settings

Parameters:

project - project

settings - integration settings

Returns:

created integration

Throws:

ConnectorException - if integration can't be created

createIntegration

public Integration createIntegration(Project project,
                                     ConnectorType connectorType,
                                     Integration integration)

Create connector integration

Parameters:

project - project

connectorType - connector type

integration - integration

Returns:

created integration

Throws:

ConnectorException - if integration can't be created

updateIntegration

public void updateIntegration(Project project,
                              ConnectorType connectorType,
                              Integration integration)

Update connector integration

Parameters:

project - project

connectorType - connector type

integration - integration

Throws:

ConnectorException - if integration can't be updated

getZendesk4Settings

public Zendesk4Settings getZendesk4Settings(Project project)

Get settings for zendesk4 connector.

Parameters:

project - project

Returns:

settings for zendesk4 connector

getCoupaSettings

public CoupaSettings getCoupaSettings(Project project)

Gets settings for coupa connector.

Parameters:

project - project

Returns:

settings for coupa connector

getPardotSettings

public PardotSettings getPardotSettings(Project project)

Gets settings for pardot connector.

Parameters:

project - project

Returns:

settings for pardot connector

createCoupaInstance

public CoupaInstance createCoupaInstance(Project project,
                                         CoupaInstance instance)

Creates Coupa connector instance.

Parameters:

project - project

instance - instance with it's API URL, API key and name

Returns:

created Coupa instance

findCoupaInstances

public Collection<CoupaInstance> findCoupaInstances(Project project)

Returns collection of all existing Coupa instances

Parameters:

project - project

Returns:

collection of Coupa instances or empty collection if no Coupa instances are defined

getSettings

public <T extends Settings> T getSettings(Project project,
                                          ConnectorType connectorType,
                                          Class<T> settingsClass)

Get settings for given connector of given class.

Type Parameters:

T - type of fetched settings

Parameters:

project - project

connectorType - type of connector to fetch settings ofr

settingsClass - class of settings fetched

Returns:

settings of connector

updateSettings

public void updateSettings(Project project,
                           Settings settings)

Update integration settings

Parameters:

project - project

settings - integration settings

Throws:

ConnectorException - if settings can't be updated

executeProcess

public FutureResult<ProcessStatus> executeProcess(Project project,
                                                  ProcessExecution execution)

Execute connector process

Parameters:

project - project

execution - process execution

Returns:

executed process

Throws:

ConnectorException - if process execution fails

getProcessStatus

public FutureResult<ProcessStatus> getProcessStatus(IntegrationProcessStatus process)

Gets status of provided connector process.

You can use process retrieved by getXXXProcess methods on Integration as well as a result of executeProcess(Project, ProcessExecution).

Parameters:

process - process to be executed

Returns:

executed process

Throws:

ConnectorException - if process execution fails

createProcessPollResult

protected FutureResult<ProcessStatus> createProcessPollResult(String uri)