Package com.gooddata.sdk.service

Interface GoodDataRestProvider

All Known Implementing Classes:
LoginPasswordGoodDataRestProvider, SingleEndpointGoodDataRestProvider, SstGoodDataRestProvider
public interface GoodDataRestProvider
The main interface responsible for GoodData platform REST connection management. Should provide completely configured RestTemplate capable to perform valid communication with GoodData platform REST API. Mainly the following functionality should be provided:
  • prefixing the URI by API endpoint - services use only path part of URI
  • authentication
  • applying GoodDataSettings - especially user agent, headers and connection settings
  • configuring proper error handler (i.e. ResponseErrorHandler)
The default implementation (internally used by GoodData is LoginPasswordGoodDataRestProvider.

  • Method Summary

    Modifier and Type Method Description
    default java.util.Optional<DataStoreService> getDataStoreService​(java.util.function.Supplier<java.lang.String> stagingUriSupplier)
    Configured DataStoreService if provided.
    org.springframework.web.client.RestTemplate getRestTemplate()
    Configured RestTemplate instance.
    GoodDataSettings getSettings()
    Settings used by the provider.

  • Method Details

    • getSettings

      GoodDataSettings getSettings()
      Settings used by the provider.
      Returns:
      used settings

    • getRestTemplate

      org.springframework.web.client.RestTemplate getRestTemplate()
      Configured RestTemplate instance.
      Returns:
      provided RestTemplate

    • getDataStoreService

      default java.util.Optional<DataStoreService> getDataStoreService​(java.util.function.Supplier<java.lang.String> stagingUriSupplier)
      Configured DataStoreService if provided. By default empty.
      Parameters:
      stagingUriSupplier - supplier of the data store endpoint
      Returns:
      dataStoreService (empty by default)