Package com.gooddata.sdk.service.account

Class AccountService

java.lang.Object
com.gooddata.sdk.service.AbstractService
com.gooddata.sdk.service.account.AccountService
public class AccountService extends AbstractService
Service to access and manipulate account.

  • Field Details

    • ACCOUNT_TEMPLATE

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

    • ACCOUNTS_TEMPLATE

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

    • ACCOUNT_BY_LOGIN_TEMPLATE

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

    • LOGIN_TEMPLATE

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

    • SEPARATORS_TEMPLATE

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

  • Constructor Details

    • AccountService

      public AccountService(org.springframework.web.client.RestTemplate restTemplate, GoodDataSettings settings)
      Constructs service for GoodData account management.
      Parameters:
      restTemplate - RESTful HTTP Spring template
      settings - settings

  • Method Details

    • getCurrent

      public Account getCurrent()
      Gets current account of logged user.
      Returns:
      current account
      Throws:
      com.gooddata.sdk.common.GoodDataException - when current account can't be accessed.

    • logout

      public void logout()
      Performs user logout.
      Throws:
      com.gooddata.sdk.common.GoodDataException - when logout failed.

    • createAccount

      public Account createAccount(Account account, String organizationName)
      Creates new account in given organization (domain). Only domain admin is allowed create new accounts! This means rest request has to authorized as domain admin.
      Parameters:
      account - to create
      organizationName - (domain) in which account should be created
      Returns:
      new account
      Throws:
      com.gooddata.sdk.common.GoodDataException - when account can't be created

    • removeAccount

      public void removeAccount(Account account)
      Delete given account
      Parameters:
      account - to remove
      Throws:
      AccountNotFoundException - when given account wasn't found
      com.gooddata.sdk.common.GoodDataException - when account can't be removed for other reason

    • getAccountById

      public Account getAccountById(String id)
      Get account for given account id
      Parameters:
      id - to search for
      Returns:
      account for id
      Throws:
      AccountNotFoundException - when account for given id can't be found
      com.gooddata.sdk.common.GoodDataException - when different error occurs

    • getAccountByLogin

      public Account getAccountByLogin(String email, String organizationName)
      Get account by given login. Only domain admin is allowed to search users by login.
      Parameters:
      email - used as login
      organizationName - (domain) in which account is present
      Returns:
      account found by given login
      Throws:
      AccountNotFoundException - when given account wasn't found
      com.gooddata.sdk.common.GoodDataException - when different error occurs

    • getAccountByUri

      public Account getAccountByUri(String uri)
      Get account for given account id
      Parameters:
      uri - to search for
      Returns:
      account for uri
      Throws:
      AccountNotFoundException - when account for given uri can't be found
      com.gooddata.sdk.common.GoodDataException - when different error occurs

    • updateAccount

      public void updateAccount(Account account)
      Updates account
      Parameters:
      account - to be updated
      Throws:
      AccountNotFoundException - when account for given uri can't be found

    • getSeparatorSettings

      public SeparatorSettings getSeparatorSettings(Account account)
      Returns default thousand and decimal separator settings for the given account.
      Parameters:
      account - account
      Returns:
      default SeparatorSettings for the account