com.gooddata.warehouse

Class WarehouseService

java.lang.Object

com.gooddata.AbstractService

com.gooddata.warehouse.WarehouseService

public class WarehouseService
extends AbstractService

Provide access to warehouse API - create, update, list and delete warehouses.

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, WAIT_BEFORE_RETRY_IN_MILLIS

Constructor Summary

Constructors

Constructor and Description
WarehouseService(org.springframework.web.client.RestTemplate restTemplate) Sets RESTful HTTP Spring template.

Method Summary

Modifier and Type	Method and Description
FutureResult<WarehouseS3Credentials>	addS3CredentialsToWarehouse(Warehouse warehouse, WarehouseS3Credentials s3Credentials) add new S3 credentials to the Warehouse
FutureResult<WarehouseUser>	addUserToWarehouse(Warehouse warehouse, WarehouseUser user) Add given user to given warehouse.
FutureResult<Warehouse>	createWarehouse(Warehouse warehouse) Create new warehouse.
WarehouseSchema	getDefaultWarehouseSchema(Warehouse warehouse) get default warehouse schema
Warehouse	getWarehouseById(String id) Get Warehouse identified by given id.
Warehouse	getWarehouseByUri(String uri) Get Warehouse identified by given uri.
WarehouseS3Credentials	getWarehouseS3Credentials(Warehouse warehouse, String region, String accessKey) Get S3 credentials for the Warehouse based on region and accessKey.
WarehouseSchema	getWarehouseSchemaByName(Warehouse warehouse, String name) get warehouse schema by name
WarehouseSchema	getWarehouseSchemaByUri(String uri) get warehouse schema by uri
PageableList<Warehouse>	listWarehouses() Lists Warehouses.
PageableList<Warehouse>	listWarehouses(Page startPage) Lists Warehouses.
PageableList<WarehouseS3Credentials>	listWarehouseS3Credentials(Warehouse warehouse) List S3 credentials for the Warehouse.
PageableList<WarehouseSchema>	listWarehouseSchemas(Warehouse warehouse) list schemas for Warehouse
PageableList<WarehouseSchema>	listWarehouseSchemas(Warehouse warehouse, Page startPage) list schemas for Warehouse
PageableList<WarehouseUser>	listWarehouseUsers(Warehouse warehouse) Lists warehouse users.
PageableList<WarehouseUser>	listWarehouseUsers(Warehouse warehouse, Page startPage) Lists warehouse users, starting with specified page.
FutureResult<Void>	removeUserFromWarehouse(WarehouseUser user) Remove given user from warehouse instance
void	removeWarehouse(Warehouse warehouse) Delete Warehouse.
Warehouse	updateWarehouse(Warehouse toUpdate) Updates given Warehouse.

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

WarehouseService

public WarehouseService(org.springframework.web.client.RestTemplate restTemplate)

Sets RESTful HTTP Spring template. Should be called from constructor of concrete service extending this abstract one.

Parameters:

restTemplate - RESTful HTTP Spring template

Method Detail

createWarehouse

public FutureResult<Warehouse> createWarehouse(Warehouse warehouse)

Create new warehouse.

Parameters:

warehouse - warehouse to create

Returns:

created warehouse

removeWarehouse

public void removeWarehouse(Warehouse warehouse)

Delete Warehouse.

Parameters:

warehouse - to delete

getWarehouseByUri

public Warehouse getWarehouseByUri(String uri)

Get Warehouse identified by given uri.

Parameters:

uri - warehouse uri

Returns:

Warehouse

Throws:

GoodDataException - when Warehouse can't be accessed

getWarehouseById

public Warehouse getWarehouseById(String id)

Get Warehouse identified by given id.

Parameters:

id - warehouse id

Returns:

Warehouse

Throws:

GoodDataException - when Warehouse can't be accessed

listWarehouses

public PageableList<Warehouse> listWarehouses()

Lists Warehouses. Returns empty list in case there are no warehouses. Returns only first page if there's more instances than page limit. Use Collection.stream() to iterate over all pages, or MultiPageList.collectAll() to load the entire list.

Returns:

MultiPageList first page of list of warehouse instances or empty list

listWarehouses

public PageableList<Warehouse> listWarehouses(Page startPage)

Lists Warehouses. Returns empty list in case there are no warehouses. Returns requested page (by page limit and offset). Use listWarehouses() to get first page with default setting.

Parameters:

startPage - page to be listed

Returns:

MultiPageList requested page of list of instances or empty list

listWarehouseUsers

public PageableList<WarehouseUser> listWarehouseUsers(Warehouse warehouse)

Lists warehouse users. Returns empty list in case there are no users. Use Collection.stream() to iterate over all pages, or MultiPageList.collectAll() to load the entire list.

Parameters:

warehouse - warehouse

Returns:

MultiPageList requested page of list of instances or empty list

listWarehouseUsers

public PageableList<WarehouseUser> listWarehouseUsers(Warehouse warehouse,
                                                      Page startPage)

Lists warehouse users, starting with specified page. Returns empty list in case there are no users. Use Collection.stream() to iterate over all pages, or MultiPageList.collectAll() to load the entire list.

Parameters:

warehouse - warehouse

startPage - page to start with

Returns:

MultiPageList requested page of list of instances starting with startPage or empty list

addUserToWarehouse

public FutureResult<WarehouseUser> addUserToWarehouse(Warehouse warehouse,
                                                      WarehouseUser user)

Add given user to given warehouse.

Parameters:

warehouse - warehouse the user should be added to

user - user to be added

Returns:

added user in warehouse

removeUserFromWarehouse

public FutureResult<Void> removeUserFromWarehouse(WarehouseUser user)

Remove given user from warehouse instance

Parameters:

user - to remove from warehouse

Returns:

empty future result

Throws:

WarehouseUserNotFoundException - when user for removal can't be found

GoodDataException - any other reason

updateWarehouse

public Warehouse updateWarehouse(Warehouse toUpdate)

Updates given Warehouse.

Parameters:

toUpdate - warehouse to be updated

Returns:

updated warehouse

Throws:

GoodDataException - when update fails

listWarehouseSchemas

public PageableList<WarehouseSchema> listWarehouseSchemas(Warehouse warehouse)

list schemas for Warehouse

Parameters:

warehouse - to list schemas for

Returns:

MultiPageList pageable list of warehouse schemas

listWarehouseSchemas

public PageableList<WarehouseSchema> listWarehouseSchemas(Warehouse warehouse,
                                                          Page startPage)

list schemas for Warehouse

Parameters:

warehouse - to list schemas for

startPage - page to be listed

Returns:

MultiPageList pageable list of warehouse schemas

getWarehouseSchemaByName

public WarehouseSchema getWarehouseSchemaByName(Warehouse warehouse,
                                                String name)

get warehouse schema by name

Parameters:

warehouse - to get schema for

name - of schema

Returns:

warehouse schema

getWarehouseSchemaByUri

public WarehouseSchema getWarehouseSchemaByUri(String uri)

get warehouse schema by uri

Parameters:

uri - of schema

Returns:

warehouse schema

getDefaultWarehouseSchema

public WarehouseSchema getDefaultWarehouseSchema(Warehouse warehouse)

get default warehouse schema

Parameters:

warehouse - to get default schema for

Returns:

default warehouse schema

listWarehouseS3Credentials

public PageableList<WarehouseS3Credentials> listWarehouseS3Credentials(Warehouse warehouse)

List S3 credentials for the Warehouse. Returns empty list if no credentials are found.

Parameters:

warehouse - warehouse to get S3 credentials for

Returns:

PageableList with all S3 credentials belonging to the Warehouse (not null)

getWarehouseS3Credentials

public WarehouseS3Credentials getWarehouseS3Credentials(Warehouse warehouse,
                                                        String region,
                                                        String accessKey)

Get S3 credentials for the Warehouse based on region and accessKey.

Parameters:

warehouse - warehouse to get S3 credentials for

Returns:

single S3 credentials record (not null)

Throws:

WarehouseS3CredentialsNotFoundException - if no S3 credentials for the given parameters were found

addS3CredentialsToWarehouse

public FutureResult<WarehouseS3Credentials> addS3CredentialsToWarehouse(Warehouse warehouse,
                                                                        WarehouseS3Credentials s3Credentials)

add new S3 credentials to the Warehouse

Parameters:

warehouse - warehouse to add credentials to

s3Credentials - the credentials to store

Returns:

added credentials (not null)