com.gooddata.sdk.service.warehouse.WarehouseService Maven / Gradle / Ivy
/*
* Copyright (C) 2004-2019, GoodData(R) Corporation. All rights reserved.
* This source code is licensed under the BSD-style license found in the
* LICENSE.txt file in the root directory of this source tree.
*/
package com.gooddata.sdk.service.warehouse;
import com.gooddata.sdk.common.GoodDataException;
import com.gooddata.sdk.common.GoodDataRestException;
import com.gooddata.sdk.common.collections.CustomPageRequest;
import com.gooddata.sdk.common.collections.Page;
import com.gooddata.sdk.common.collections.PageBrowser;
import com.gooddata.sdk.common.collections.PageRequest;
import com.gooddata.sdk.common.util.SpringMutableUri;
import com.gooddata.sdk.model.warehouse.Warehouse;
import com.gooddata.sdk.model.warehouse.WarehouseSchema;
import com.gooddata.sdk.model.warehouse.WarehouseSchemas;
import com.gooddata.sdk.model.warehouse.WarehouseTask;
import com.gooddata.sdk.model.warehouse.WarehouseUser;
import com.gooddata.sdk.model.warehouse.WarehouseUsers;
import com.gooddata.sdk.model.warehouse.Warehouses;
import com.gooddata.sdk.service.AbstractPollHandler;
import com.gooddata.sdk.service.AbstractService;
import com.gooddata.sdk.service.FutureResult;
import com.gooddata.sdk.service.GoodDataSettings;
import com.gooddata.sdk.service.PollResult;
import org.springframework.http.HttpMethod;
import org.springframework.http.HttpStatus;
import org.springframework.http.client.ClientHttpResponse;
import org.springframework.web.client.RestClientException;
import org.springframework.web.client.RestTemplate;
import org.springframework.web.util.UriTemplate;
import java.io.IOException;
import java.net.URI;
import static com.gooddata.sdk.common.util.Validate.notEmpty;
import static com.gooddata.sdk.common.util.Validate.notNull;
/**
* Provide access to warehouse API - create, update, list and delete warehouses.
*/
public class WarehouseService extends AbstractService {
public static final UriTemplate SCHEMAS_TEMPLATE = new UriTemplate(WarehouseSchemas.URI);
public static final UriTemplate SCHEMA_TEMPLATE = new UriTemplate(WarehouseSchema.URI);
public static final UriTemplate WAREHOUSE_TEMPLATE = new UriTemplate(Warehouse.URI);
public static final UriTemplate USERS_TEMPLATE = new UriTemplate(WarehouseUsers.URI);
private static final String DEFAULT_SCHEMA_NAME = "default";
/**
* Sets RESTful HTTP Spring template. Should be called from constructor of concrete service extending
* this abstract one.
* @param restTemplate RESTful HTTP Spring template
* @param settings settings
*/
public WarehouseService(final RestTemplate restTemplate, final GoodDataSettings settings) {
super(restTemplate, settings);
}
/**
* Create new warehouse.
*
* @param warehouse warehouse to create
*
* @return created warehouse
*/
public FutureResult createWarehouse(final Warehouse warehouse) {
notNull(warehouse, "warehouse");
final WarehouseTask task;
try {
task = restTemplate.postForObject(Warehouses.URI, warehouse, WarehouseTask.class);
} catch (GoodDataException | RestClientException e) {
throw new GoodDataException("Unable to create Warehouse", e);
}
if (task == null) {
throw new GoodDataException("Empty response when Warehouse POSTed to API");
}
return new PollResult<>(this, new AbstractPollHandler(task.getPollUri(), WarehouseTask.class, Warehouse.class) {
@Override
public boolean isFinished(ClientHttpResponse response) throws IOException {
return HttpStatus.CREATED.equals(response.getStatusCode());
}
@Override
protected void onFinish() {
if (!getResult().isEnabled()) {
throw new GoodDataException("Created warehouse, uri: " + getResult().getUri() + " is not enabled!");
}
}
@Override
public void handlePollResult(WarehouseTask pollResult) {
try {
final Warehouse warehouse = restTemplate.getForObject(pollResult.getWarehouseUri(), Warehouse.class);
setResult(warehouse);
} catch (GoodDataException | RestClientException e) {
throw new GoodDataException("Warehouse creation finished, but can't get created warehouse, uri: "
+ pollResult.getWarehouseUri(), e);
}
}
@Override
public void handlePollException(final GoodDataRestException e) {
throw new GoodDataException("Unable to create warehouse", e);
}
});
}
/**
* Delete Warehouse.
* @param warehouse to delete
*/
public void removeWarehouse(final Warehouse warehouse) {
notNull(warehouse, "warehouse");
notNull(warehouse.getUri(), "warehouse.uri");
try {
restTemplate.delete(warehouse.getUri());
} catch (GoodDataException | RestClientException e) {
throw new GoodDataException("Unable to delete Warehouse, uri: " + warehouse.getUri(), e);
}
}
/**
* Get Warehouse identified by given uri.
* @param uri warehouse uri
* @return Warehouse
* @throws com.gooddata.sdk.common.GoodDataException when Warehouse can't be accessed
*/
public Warehouse getWarehouseByUri(final String uri) {
notEmpty(uri, "uri");
try {
return restTemplate.getForObject(uri, Warehouse.class);
} catch (GoodDataRestException e) {
if (HttpStatus.NOT_FOUND.value() == e.getStatusCode()) {
throw new WarehouseNotFoundException(uri, e);
} else {
throw e;
}
} catch (RestClientException e) {
throw new GoodDataException("Unable to get Warehouse instance " + uri, e);
}
}
/**
* Get Warehouse identified by given id.
* @param id warehouse id
* @return Warehouse
* @throws com.gooddata.sdk.common.GoodDataException when Warehouse can't be accessed
*/
public Warehouse getWarehouseById(String id) {
notEmpty(id, "id");
return getWarehouseByUri(uriFromId(id));
}
private static String uriFromId(String id) {
return WAREHOUSE_TEMPLATE.expand(id).toString();
}
/**
* Lists Warehouses. Returns empty list in case there are no warehouses.
* Returns only first page if there's more instances than page limit. Use {@link PageBrowser#allItemsStream()} ()} to iterate
* over all pages, or {@link PageBrowser#getAllItems()} ()} to load the entire list.
*
* @return {@link PageBrowser} first page of list of warehouse instances or empty list
*/
public PageBrowser listWarehouses() {
return listWarehouses(new CustomPageRequest());
}
/**
* Lists Warehouses. Returns empty list in case there are no warehouses.
* Returns requested page (by page limit and offset). Use {@link #listWarehouses()} to get first page with default setting.
*
* @param startPage page to be listed
* @return {@link PageBrowser} requested page of list of instances or empty list
*/
public PageBrowser listWarehouses(final PageRequest startPage) {
notNull(startPage, "startPage");
return new PageBrowser<>(startPage, page -> listWarehouses(getWarehousesUri(page)));
}
private URI getWarehousesUri() {
return URI.create(Warehouses.URI);
}
private URI getWarehousesUri(final PageRequest page) {
return page.getPageUri(new SpringMutableUri(getWarehousesUri()));
}
private Page listWarehouses(final URI uri) {
try {
final Warehouses result = restTemplate.getForObject(uri, Warehouses.class);
if (result == null) {
return new Page<>();
}
return result;
} catch (GoodDataException | RestClientException e) {
throw new GoodDataException("Unable to list Warehouses", e);
}
}
/**
* Lists warehouse users. Returns empty list in case there are no users.
* Use {@link PageBrowser#allItemsStream()} ()} to iterate over all pages,
* or {@link PageBrowser#getAllItems()} ()} to load the entire list.
*
* @param warehouse warehouse
* @return {@link PageBrowser} requested page of list of instances or empty list
*/
public PageBrowser listWarehouseUsers(final Warehouse warehouse) {
return listWarehouseUsers(warehouse, new CustomPageRequest());
}
/**
* Lists warehouse users, starting with specified page. Returns empty list in case there are no users.
* Use {@link PageBrowser#allItemsStream()} ()} to iterate over all pages,
* or {@link PageBrowser#getAllItems()} ()} to load the entire list.
*
* @param warehouse warehouse
* @param startPage page to start with
* @return {@link PageBrowser} requested page of list of instances starting with startPage or empty list
*/
public PageBrowser listWarehouseUsers(final Warehouse warehouse, final PageRequest startPage) {
notNull(warehouse, "warehouse");
notNull(warehouse.getId(), "warehouse.id");
notNull(startPage, "startPage");
return new PageBrowser<>(startPage,
page -> listWarehouseUsers(warehouse, getWarehouseUsersUri(warehouse, page)));
}
private URI getWarehouseUsersUri(final Warehouse warehouse) {
return USERS_TEMPLATE.expand(warehouse.getId());
}
private URI getWarehouseUsersUri(final Warehouse warehouse, final PageRequest page) {
return page.getPageUri(new SpringMutableUri(getWarehouseUsersUri(warehouse)));
}
private Page listWarehouseUsers(final Warehouse warehouse, final URI uri) {
try {
final WarehouseUsers result = restTemplate.getForObject(uri, WarehouseUsers.class);
return result == null ? new Page<>() : result;
} catch (GoodDataException | RestClientException e) {
throw new GoodDataException("Unable to list users of warehouse " + warehouse.getId(), e);
}
}
/**
* Add given user to given warehouse.
*
* @param warehouse warehouse the user should be added to
* @param user user to be added
* @return added user in warehouse
*/
public FutureResult addUserToWarehouse(final Warehouse warehouse, final WarehouseUser user) {
notNull(user, "user");
notNull(warehouse, "warehouse");
notNull(warehouse.getId(), "warehouse.id");
final WarehouseTask task;
try {
task = restTemplate.postForObject(WarehouseUsers.URI, user, WarehouseTask.class, warehouse.getId());
} catch (GoodDataException | RestClientException e) {
throw new GoodDataException("Unable add user to warehouse " + warehouse.getId(), e);
}
if (task == null) {
throw new GoodDataException("Empty response when user POSTed to API");
}
return new PollResult<>(this,
new AbstractPollHandler
(task.getPollUri(), WarehouseTask.class, WarehouseUser.class) {
@Override
public boolean isFinished(ClientHttpResponse response) throws IOException {
return HttpStatus.CREATED.equals(response.getStatusCode());
}
@Override
public void handlePollResult(WarehouseTask pollResult) {
try {
final WarehouseUser newUser = restTemplate.getForObject(pollResult.getWarehouseUserUri(), WarehouseUser.class);
setResult(newUser);
} catch (GoodDataException | RestClientException e) {
throw new GoodDataException("User added to warehouse, but can't get it back, uri: "
+ pollResult.getWarehouseUserUri(), e);
}
}
@Override
public void handlePollException(final GoodDataRestException e) {
throw new GoodDataException("Unable to add user to warehouse", e);
}
});
}
/**
* Remove given user from warehouse instance
* @param user to remove from warehouse
* @return empty future result
* @throws WarehouseUserNotFoundException when user for removal can't be found
* @throws GoodDataException any other reason
*/
public FutureResult removeUserFromWarehouse(final WarehouseUser user) {
notNull(user, "user");
notNull(user.getUri(), "user.uri");
final WarehouseTask task;
try {
task = restTemplate.exchange(user.getUri(), HttpMethod.DELETE, null, WarehouseTask.class).getBody();
} catch (GoodDataRestException e) {
if (HttpStatus.NOT_FOUND.value() == e.getStatusCode()) {
throw new WarehouseUserNotFoundException(user.getUri(), e);
} else {
throw e;
}
} catch (RestClientException e) {
throw new GoodDataException("Unable to remove Warehouse user from instance " + user.getUri(), e);
}
if (task == null) {
throw new GoodDataException("Empty response when user removed");
}
return new PollResult<>(this,
new AbstractPollHandler
(task.getPollUri(), WarehouseTask.class, Void.class) {
@Override
public boolean isFinished(ClientHttpResponse response) throws IOException {
return HttpStatus.CREATED.equals(response.getStatusCode());
}
@Override
public void handlePollResult(WarehouseTask pollResult) {
setResult(null);
}
@Override
public void handlePollException(final GoodDataRestException e) {
throw new GoodDataException("Unable to remove user from warehouse", e);
}
});
}
/**
* Updates given Warehouse.
*
* @param toUpdate warehouse to be updated
* @return updated warehouse
* @throws com.gooddata.sdk.common.GoodDataException when update fails
*/
public Warehouse updateWarehouse(final Warehouse toUpdate) {
notNull(toUpdate, "warehouse");
notNull(toUpdate.getUri(), "warehouse.uri");
try {
restTemplate.put(toUpdate.getUri(), toUpdate);
} catch (GoodDataRestException | RestClientException e) {
throw new GoodDataException("Unable to update Warehouse, uri: " + toUpdate.getUri());
}
return getWarehouseByUri(toUpdate.getUri());
}
/**
* list schemas for Warehouse
*
* @param warehouse to list schemas for
* @return {@link PageBrowser} pageable list of warehouse schemas
*/
public PageBrowser listWarehouseSchemas(final Warehouse warehouse) {
return listWarehouseSchemas(warehouse, new CustomPageRequest());
}
/**
* list schemas for Warehouse
*
* @param warehouse to list schemas for
* @param startPage page to be listed
* @return {@link PageBrowser} pageable list of warehouse schemas
*/
public PageBrowser listWarehouseSchemas(final Warehouse warehouse, final PageRequest startPage) {
return new PageBrowser<>(startPage,
page -> listWarehouseSchemas(getWarehouseSchemasUri(warehouse, page))
);
}
private URI getWarehouseSchemasUri(final Warehouse warehouse) {
notNull(warehouse, "warehouse");
notNull(warehouse.getId(), "warehouse.id");
return SCHEMAS_TEMPLATE.expand(warehouse.getId());
}
private URI getWarehouseSchemasUri(final Warehouse warehouse, final PageRequest page) {
notNull(page, "page");
return page.getPageUri(new SpringMutableUri(getWarehouseSchemasUri(warehouse)));
}
private Page listWarehouseSchemas(final URI uri) {
try {
final WarehouseSchemas result = restTemplate.getForObject(uri, WarehouseSchemas.class);
if (result == null) {
return new Page<>();
}
return result;
} catch (GoodDataException | RestClientException e) {
throw new GoodDataException("Unable to list Warehouse schemas", e);
}
}
/**
* get warehouse schema by name
*
* @param warehouse to get schema for
* @param name of schema
* @return warehouse schema
*/
public WarehouseSchema getWarehouseSchemaByName(final Warehouse warehouse, final String name) {
notNull(warehouse, "warehouse");
notNull(warehouse.getId(), "warehouse.id");
notEmpty(name, "name");
final String uri = SCHEMA_TEMPLATE.expand(warehouse.getId(), name).toString();
return getWarehouseSchemaByUri(uri);
}
/**
* get warehouse schema by uri
*
* @param uri of schema
* @return warehouse schema
*/
public WarehouseSchema getWarehouseSchemaByUri(final String uri) {
notEmpty(uri, "uri");
try {
return restTemplate.getForObject(uri, WarehouseSchema.class);
} catch (GoodDataRestException e) {
if (HttpStatus.NOT_FOUND.value() == e.getStatusCode()) {
throw new WarehouseSchemaNotFoundException(uri, e);
} else {
throw e;
}
} catch (RestClientException e) {
throw new GoodDataException("Unable to get Warehouse instance " + uri, e);
}
}
/**
* get default warehouse schema
*
* @param warehouse to get default schema for
* @return default warehouse schema
*/
public WarehouseSchema getDefaultWarehouseSchema(final Warehouse warehouse) {
return getWarehouseSchemaByName(warehouse, DEFAULT_SCHEMA_NAME);
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy