Package com.gooddata

Class GoodData

  • public class GoodData
extends Object
    Entry point for GoodData SDK usage.

    Configure connection to GoodData using one of constructors. One can then get initialized service he needs from the newly constructed instance. This instance can be also used later for logout from GoodData Platform.

    Usage example: 

    
     GoodData gd = new GoodData("roman@gooddata.com", "Roman1");
     // do something useful like: gd.getSomeService().doSomething()
     gd.logout();

    • Constructor Detail

      • GoodData

        public GoodData​(String login,
                String password)
        Create instance configured to communicate with GoodData Platform under user with given credentials.
        Parameters:
        login - GoodData user's login
        password - GoodData user's password

      • GoodData

        public GoodData​(String login,
                String password,
                GoodDataSettings settings)
        Create instance configured to communicate with GoodData Platform under user with given credentials.
        Parameters:
        login - GoodData user's login
        password - GoodData user's password
        settings - additional settings

      • GoodData

        public GoodData​(String hostname,
                String login,
                String password)
        Create instance configured to communicate with GoodData Platform running on given host using given user's credentials.
        Parameters:
        hostname - GoodData Platform's host name (e.g. secure.gooddata.com)
        login - GoodData user's login
        password - GoodData user's password

      • GoodData

        public GoodData​(String hostname,
                String login,
                String password,
                GoodDataSettings settings)
        Create instance configured to communicate with GoodData Platform running on given host using given user's credentials.
        Parameters:
        hostname - GoodData Platform's host name (e.g. secure.gooddata.com)
        login - GoodData user's login
        password - GoodData user's password
        settings - additional settings

      • GoodData

        public GoodData​(String hostname,
                String login,
                String password,
                int port)
        Create instance configured to communicate with GoodData Platform running on given host and port using given user's credentials.
        Parameters:
        hostname - GoodData Platform's host name (e.g. secure.gooddata.com)
        login - GoodData user's login
        password - GoodData user's password
        port - GoodData Platform's API port (e.g. 443)

      • GoodData

        public GoodData​(String hostname,
                String login,
                String password,
                int port,
                GoodDataSettings settings)
        Create instance configured to communicate with GoodData Platform running on given host and port using given user's credentials.
        Parameters:
        hostname - GoodData Platform's host name (e.g. secure.gooddata.com)
        login - GoodData user's login
        password - GoodData user's password
        port - GoodData Platform's API port (e.g. 443)
        settings - additional settings

      • GoodData

        protected GoodData​(String hostname,
                   String login,
                   String password,
                   int port,
                   String protocol,
                   GoodDataSettings settings)
        Create instance configured to communicate with GoodData Platform running on given host, port and protocol using given user's credentials.
        Parameters:
        hostname - GoodData Platform's host name (e.g. secure.gooddata.com)
        login - GoodData user's login
        password - GoodData user's password
        port - GoodData Platform's API port (e.g. 443)
        protocol - GoodData Platform's API protocol (e.g. https)
        settings - additional settings

      • GoodData

        protected GoodData​(GoodDataEndpoint endpoint,
                   Authentication authentication)
        Create instance configured to communicate with GoodData Platform running on given endpoint and using given http client factory.
        Parameters:
        endpoint - GoodData Platform's endpoint
        authentication - authentication

      • GoodData

        protected GoodData​(GoodDataEndpoint endpoint,
                   Authentication authentication,
                   GoodDataSettings settings)
        Create instance configured to communicate with GoodData Platform running on given endpoint and using given http client factory.
        Parameters:
        endpoint - GoodData Platform's endpoint
        authentication - authentication
        settings - additional settings

    • Method Detail

      • getRestTemplate

        protected final org.springframework.web.client.RestTemplate getRestTemplate()
        Get the configured RestTemplate used by the library. This is the extension point for inheriting classes providing additional services.
        Returns:
        REST template

      • getHttpClient

        protected final org.apache.http.client.HttpClient getHttpClient()
        Get the configured HttpClient used by the library. This is the extension point for inheriting classes providing additional services.
        Returns:
        HTTP client

      • logout

        public void logout()
        Logout from GoodData Platform

      • getProjectService

        @Bean
public ProjectService getProjectService()
        Get initialized service for project management (to list projects, create a project, ...)
        Returns:
        initialized service for project management

      • getAccountService

        @Bean
public AccountService getAccountService()
        Get initialized service for account management (to get current account information, logout, ...)
        Returns:
        initialized service for account management

      • getMetadataService

        @Bean
public MetadataService getMetadataService()
        Get initialized service for metadata management (to query, create and update project metadata like attributes, facts, metrics, reports, ...)
        Returns:
        initialized service for metadata management

      • getModelService

        @Bean
public ModelService getModelService()
        Get initialized service for model management (to get model diff, update model, ...)
        Returns:
        initialized service for model management

      • getGdcService

        @Bean
public GdcService getGdcService()
        Get initialized service for API root management (to get API root links, ...)
        Returns:
        initialized service for API root management

      • getDataStoreService

        @Bean
public DataStoreService getDataStoreService()
        Get initialized service for data store (user staging/WebDAV) management (to upload, download, delete, ...)
        Returns:
        initialized service for data store management

      • getDatasetService

        @Bean
public DatasetService getDatasetService()
        Get initialized service for dataset management (to list manifest, get datasets, load dataset, ...)
        Returns:
        initialized service for dataset management

      • getReportService

        @Bean
public ReportService getReportService()
        Get initialized service for report management (to execute and export report, ...)
        Returns:
        initialized service for report management

      • getExportService

        @Bean
public ExportService getExportService()
        Get initialized service for exports management (export report,...)
        Returns:
        initialized service for exports

      • getProcessService

        @Bean
public ProcessService getProcessService()
        Get initialized service for dataload processes management and process executions.
        Returns:
        initialized service for dataload processes management and process executions

      • getWarehouseService

        @Bean
public WarehouseService getWarehouseService()
        Get initialized service for ADS management (create, access and delete ads instances).
        Returns:
        initialized service for ADS management

      • getConnectorService

        @Bean
public ConnectorService getConnectorService()
        Get initialized service for connector integration management (create, update, start process, ...).
        Returns:
        initialized service for connector integration management

      • getNotificationService

        @Bean
public NotificationService getNotificationService()
        Get initialized service for project notifications management.
        Returns:
        initialized service for project notifications management

      • getExportImportService

        @Bean
public ExportImportService getExportImportService()
        Get initialized service for metadata export/import.
        Returns:
        initialized service for metadata export/import

      • getFeatureFlagService

        @Bean
public FeatureFlagService getFeatureFlagService()
        Get initialized service for feature flag management.
        Returns:
        initialized service for feature flag management

      • getOutputStageService

        @Bean
public OutputStageService getOutputStageService()
        Get initialized service for output stage management.
        Returns:
        initialized service for output stage management

      • getProjectTemplateService

        @Bean
public ProjectTemplateService getProjectTemplateService()
        Get initialized service for project templates
        Returns:
        initialized service for project templates

      • getAuditEventService

        @Bean
public AuditEventService getAuditEventService()
        Get initialized service for audit events
        Returns:
        initialized service for audit events

      • getExecuteAfmService

        @Bean
public ExecuteAfmService getExecuteAfmService()
        Get initialized service for afm execution
        Returns:
        initialized service for afm execution

      • getLcmService

        @Bean
public LcmService getLcmService()
        Get initialized service for Life Cycle Management
        Returns:
        initialized service for Life Cycle Management