Package com.gooddata.sdk.service.connector

Class ConnectorService

  • public class ConnectorService
extends AbstractService
    Service for connector integration creation, update of its settings or execution of its process.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      com.gooddata.sdk.model.connector.Integration createIntegration​(com.gooddata.sdk.model.project.Project project, com.gooddata.sdk.model.connector.ConnectorType connectorType, com.gooddata.sdk.model.connector.Integration integration)
      Create connector integration
      com.gooddata.sdk.model.connector.Integration createIntegration​(com.gooddata.sdk.model.project.Project project, com.gooddata.sdk.model.connector.Settings settings)
      Create connector integration with given settings
      protected FutureResult<com.gooddata.sdk.model.connector.ProcessStatus> createProcessPollResult​(java.lang.String uri)  
      void deleteIntegration​(com.gooddata.sdk.model.project.Project project, com.gooddata.sdk.model.connector.ConnectorType connectorType)
      Delete connector integration.
      FutureResult<com.gooddata.sdk.model.connector.ProcessStatus> executeProcess​(com.gooddata.sdk.model.project.Project project, com.gooddata.sdk.model.connector.ProcessExecution execution)
      Execute connector process
      com.gooddata.sdk.model.connector.Integration getIntegration​(com.gooddata.sdk.model.project.Project project, com.gooddata.sdk.model.connector.ConnectorType connectorType)
      Retrieve connector integration
      FutureResult<com.gooddata.sdk.model.connector.ProcessStatus> getProcessStatus​(com.gooddata.sdk.model.connector.IntegrationProcessStatus process)
      Gets status of provided connector process.
      <T extends com.gooddata.sdk.model.connector.Settings>
      T      		 getSettings​(com.gooddata.sdk.model.project.Project project, com.gooddata.sdk.model.connector.ConnectorType connectorType, java.lang.Class<T> settingsClass)
      Get settings for given connector of given class.
      com.gooddata.sdk.model.connector.Zendesk4Settings getZendesk4Settings​(com.gooddata.sdk.model.project.Project project)
      Get settings for zendesk4 connector.
      void updateIntegration​(com.gooddata.sdk.model.project.Project project, com.gooddata.sdk.model.connector.ConnectorType connectorType, com.gooddata.sdk.model.connector.Integration integration)
      Update connector integration
      void updateSettings​(com.gooddata.sdk.model.project.Project project, com.gooddata.sdk.model.connector.Settings settings)
      Update integration settings

      • Methods inherited from class java.lang.Object

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

    • Field Detail

      • STATUS_TEMPLATE

        public static final org.springframework.web.util.UriTemplate STATUS_TEMPLATE

    • Constructor Detail

      • ConnectorService

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

    • Method Detail

      • getIntegration

        public com.gooddata.sdk.model.connector.Integration getIntegration​(com.gooddata.sdk.model.project.Project project,
                                                                   com.gooddata.sdk.model.connector.ConnectorType connectorType)
        Retrieve connector integration
        Parameters:
        project - project
        connectorType - connector type
        Returns:
        integration
        Throws:
        ConnectorException - if integration can't be retrieved

      • createIntegration

        public com.gooddata.sdk.model.connector.Integration createIntegration​(com.gooddata.sdk.model.project.Project project,
                                                                      com.gooddata.sdk.model.connector.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 com.gooddata.sdk.model.connector.Integration createIntegration​(com.gooddata.sdk.model.project.Project project,
                                                                      com.gooddata.sdk.model.connector.ConnectorType connectorType,
                                                                      com.gooddata.sdk.model.connector.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​(com.gooddata.sdk.model.project.Project project,
                              com.gooddata.sdk.model.connector.ConnectorType connectorType,
                              com.gooddata.sdk.model.connector.Integration integration)
        Update connector integration
        Parameters:
        project - project
        connectorType - connector type
        integration - integration
        Throws:
        ConnectorException - if integration can't be updated

      • deleteIntegration

        public void deleteIntegration​(com.gooddata.sdk.model.project.Project project,
                              com.gooddata.sdk.model.connector.ConnectorType connectorType)
        Delete connector integration.
        Parameters:
        project - project
        connectorType - connector type
        Throws:
        IntegrationNotFoundException - if integration doesn't exist
        ConnectorException - if integration can't be deleted

      • getZendesk4Settings

        public com.gooddata.sdk.model.connector.Zendesk4Settings getZendesk4Settings​(com.gooddata.sdk.model.project.Project project)
        Get settings for zendesk4 connector.
        Parameters:
        project - project
        Returns:
        settings for zendesk4 connector

      • getSettings

        public <T extends com.gooddata.sdk.model.connector.Settings> T getSettings​(com.gooddata.sdk.model.project.Project project,
                                                                           com.gooddata.sdk.model.connector.ConnectorType connectorType,
                                                                           java.lang.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​(com.gooddata.sdk.model.project.Project project,
                           com.gooddata.sdk.model.connector.Settings settings)
        Update integration settings
        Parameters:
        project - project
        settings - integration settings
        Throws:
        ConnectorException - if settings can't be updated

      • executeProcess

        public FutureResult<com.gooddata.sdk.model.connector.ProcessStatus> executeProcess​(com.gooddata.sdk.model.project.Project project,
                                                                                   com.gooddata.sdk.model.connector.ProcessExecution execution)
        Execute connector process
        Parameters:
        project - project
        execution - process execution
        Returns:
        executed process
        Throws:
        ConnectorException - if process execution fails

      • getProcessStatus

        public FutureResult<com.gooddata.sdk.model.connector.ProcessStatus> getProcessStatus​(com.gooddata.sdk.model.connector.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<com.gooddata.sdk.model.connector.ProcessStatus> createProcessPollResult​(java.lang.String uri)