eu.europeana.cloud.service.mcs.rest

Class DataSetResource

java.lang.Object

eu.europeana.cloud.service.mcs.rest.DataSetResource

@Component
@Scope(value="request")
public class DataSetResource
extends Object

Resource to manage data sets.

Constructor Summary

Constructors

Constructor and Description
DataSetResource()

Method Summary

Methods

Modifier and Type	Method and Description
javax.ws.rs.core.Response	deleteDataSet(String dataSetId, String providerId) Deletes data set.
eu.europeana.cloud.common.response.ResultSlice<eu.europeana.cloud.common.model.Representation>	getDataSetContents(String dataSetId, String providerId, String startFrom) Lists representation versions from data set.
void	updateDataSet(String dataSetId, String providerId, String description) Updates description of a data set.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DataSetResource

public DataSetResource()

Method Detail

deleteDataSet

@PreAuthorize(value="hasPermission(#dataSetId.concat(\'/\').concat(#providerId), \'eu.europeana.cloud.common.model.DataSet\', delete)")
public javax.ws.rs.core.Response deleteDataSet(String dataSetId,
                                                   String providerId)
                                        throws eu.europeana.cloud.service.mcs.exception.DataSetNotExistsException

Deletes data set. Delete permissions required.

Parameters:

providerId - identifier of the dataset's provider(required).

dataSetId - identifier of the deleted data set(required).

Returns:

Empty response with status code indicating whether the operation was successful or not.

Throws:

eu.europeana.cloud.service.mcs.exception.DataSetNotExistsException - data set not exists.

getDataSetContents

public eu.europeana.cloud.common.response.ResultSlice<eu.europeana.cloud.common.model.Representation> getDataSetContents(String dataSetId,
                                                                                                                String providerId,
                                                                                                                String startFrom)
                                                                                                                  throws eu.europeana.cloud.service.mcs.exception.DataSetNotExistsException

Lists representation versions from data set. Result is returned in slices.

Parameters:

providerId - identifier of the dataset's provider (required).

dataSetId - identifier of a data set (required).

startFrom - reference to next slice of result. If not provided, first slice of result will be returned.

Returns:

slice of representation version list.

Throws:

eu.europeana.cloud.service.mcs.exception.DataSetNotExistsException - no such data set exists.

updateDataSet

@PreAuthorize(value="hasPermission(#dataSetId.concat(\'/\').concat(#providerId), \'eu.europeana.cloud.common.model.DataSet\', write)")
public void updateDataSet(String dataSetId,
                              String providerId,
                              String description)
                   throws eu.europeana.cloud.service.mcs.exception.AccessDeniedOrObjectDoesNotExistException,
                          eu.europeana.cloud.service.mcs.exception.DataSetNotExistsException

Updates description of a data set. Write permissions required.

Parameters:

providerId - identifier of the dataset's provider (required).

dataSetId - identifier of a data set (required).

description - description of data set

Throws:

eu.europeana.cloud.service.mcs.exception.DataSetNotExistsException - no such data set exists.

eu.europeana.cloud.service.mcs.exception.AccessDeniedOrObjectDoesNotExistException - there is an attempt to access a resource without the proper permissions. or the resource does not exist at all