eu.europeana.cloud.mcs.driver

Class DataSetServiceClient

java.lang.Object

eu.europeana.cloud.mcs.driver.MCSClient

eu.europeana.cloud.mcs.driver.DataSetServiceClient

public class DataSetServiceClient
extends MCSClient

Client for managing datasets in MCS.

Field Summary

Fields inherited from class eu.europeana.cloud.mcs.driver.MCSClient

baseUrl

Constructor Summary

Constructors

Constructor and Description
DataSetServiceClient(String baseUrl) Creates instance of DataSetServiceClient.
DataSetServiceClient(String baseUrl, String username, String password) Creates instance of DataSetServiceClient.

Method Summary

Methods

Modifier and Type	Method and Description
void	assignRepresentationToDataSet(String providerId, String dataSetId, String cloudId, String representationName, String versionId) Assigns representation into data set.
URI	createDataSet(String providerId, String dataSetId, String description) Creates a new data set.
void	deleteDataSet(String providerId, String dataSetId) Deletes data set.
protected void	finalize()
List<eu.europeana.cloud.common.response.CloudVersionRevisionResponse>	getDataSetCloudIdsByRepresentation(String dataSetId, String providerId, String representationName, String dateFrom, String tag) Lists all cloud identifiers from data provider's data set having representation name and published revision added after specified date.
eu.europeana.cloud.common.response.ResultSlice<eu.europeana.cloud.common.response.CloudVersionRevisionResponse>	getDataSetCloudIdsByRepresentationChunk(String dataSetId, String providerId, String representationName, String dateFrom, String tag, String startFrom) Returns chunk of cloud identifiers list of specified provider in specified data set having specific representation name and published revision created after the specified date.
DataSetIterator	getDataSetIteratorForProvider(String providerId) Returns iterator to the list of all data sets of specified provider.
List<eu.europeana.cloud.common.model.Representation>	getDataSetRepresentations(String providerId, String dataSetId) Lists all representation versions from data set.
eu.europeana.cloud.common.response.ResultSlice<eu.europeana.cloud.common.model.Representation>	getDataSetRepresentationsChunk(String providerId, String dataSetId, String startFrom) Returns chunk of representation versions list from data set.
List<eu.europeana.cloud.common.response.CloudTagsResponse>	getDataSetRevisions(String providerId, String dataSetId, String representationName, String revisionName, String revisionProviderId, String revisionTimestamp) Lists cloudIds and tags from data set for specific revision.
eu.europeana.cloud.common.response.ResultSlice<eu.europeana.cloud.common.response.CloudTagsResponse>	getDataSetRevisionsChunk(String providerId, String dataSetId, String representationName, String revisionName, String revisionProviderId, String revisionTimestamp, String startFrom, Integer limit) Retrieve chunk of cloudIds and tags from data set for specific revision.
List<eu.europeana.cloud.common.model.DataSet>	getDataSetsForProvider(String providerId) Lists all data sets of specified provider.
eu.europeana.cloud.common.response.ResultSlice<eu.europeana.cloud.common.model.DataSet>	getDataSetsForProviderChunk(String providerId, String startFrom) Returns chunk of data sets list of specified provider.
String	getLatelyTaggedRecords(String dataSetId, String providerId, String cloudId, String representationName, String revisionName, String revisionProviderId) Gives the versionId of specified representation that has the newest revision (by revision timestamp) with given name.
List<eu.europeana.cloud.common.model.CloudIdAndTimestampResponse>	getLatestDataSetCloudIdByRepresentationAndRevision(String dataSetId, String providerId, String revisionProvider, String revisionName, String representationName, Boolean isDeleted) Returns list of the latest cloud identifier,revision timestamp that belong to data set of a specified provider for a specific representation and revision
eu.europeana.cloud.common.response.ResultSlice<eu.europeana.cloud.common.model.CloudIdAndTimestampResponse>	getLatestDataSetCloudIdByRepresentationAndRevisionChunk(String dataSetId, String providerId, String revisionProvider, String revisionName, String representationName, Boolean isDeleted, String startFrom) Returns chunk of the latest cloud identifier,revision timestamp that belong to data set of a specified provider for a specific representation and revision.
RepresentationIterator	getRepresentationIterator(String providerId, String dataSetId) Returns iterator to list of representation versions of data set.
void	unassignRepresentationFromDataSet(String providerId, String dataSetId, String cloudId, String representationName, String representationVersion) Unassigns representation from data set.
void	updateDescriptionOfDataSet(String providerId, String dataSetId, String description) Updates description of data set.
void	useAuthorizationHeader(String headerValue)

Methods inherited from class java.lang.Object

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

Constructor Detail

DataSetServiceClient

public DataSetServiceClient(String baseUrl)

Creates instance of DataSetServiceClient.

Parameters:

baseUrl - URL of the MCS Rest Service

DataSetServiceClient

public DataSetServiceClient(String baseUrl,
                    String username,
                    String password)

Creates instance of DataSetServiceClient. Same as DataSetServiceClient(String) but includes username and password to perform authenticated requests.

Parameters:

baseUrl - URL of the MCS Rest Service

Method Detail

getDataSetsForProviderChunk

public eu.europeana.cloud.common.response.ResultSlice<eu.europeana.cloud.common.model.DataSet> getDataSetsForProviderChunk(String providerId,
                                                                                                                  String startFrom)
                                                                                                                    throws eu.europeana.cloud.service.mcs.exception.MCSException

Returns chunk of data sets list of specified provider.

This method returns the chunk specified by startFrom parameter. If parameter is null, the first chunk is returned. You can use ResultSlice.getNextSlice() of returned result to obtain startFrom value to get the next chunk, etc; if ResultSlice.getNextSlice()==null in returned result it means it is the last slice.

If you just need all representations, you can use getDataSetRepresentations(java.lang.String, java.lang.String) method, which encapsulates this method.

Parameters:

providerId - provider identifier (required)

startFrom - code pointing to the requested result slice (if equal to null, first slice is returned)

Returns:

chunk of data sets list of specified provider (empty if provider does not exist)

Throws:

eu.europeana.cloud.service.mcs.exception.MCSException - on unexpected situations

getDataSetsForProvider

public List<eu.europeana.cloud.common.model.DataSet> getDataSetsForProvider(String providerId)
                                                                     throws eu.europeana.cloud.service.mcs.exception.MCSException

Lists all data sets of specified provider.

If provider does not exist, the empty list is returned.

Parameters:

providerId - provider identifier (required)

Returns:

list of all data sets of specified provider (empty if provider does not exist)

Throws:

eu.europeana.cloud.service.mcs.exception.MCSException - on unexpected situations

getDataSetIteratorForProvider

public DataSetIterator getDataSetIteratorForProvider(String providerId)

Returns iterator to the list of all data sets of specified provider.

If provider does not exist, the iterator returned will be empty. Iterator is not initialised with data on creation, calls to MCS server are performed in iterator methods.

Parameters:

providerId - provider identifier (required)

Returns:

iterator to the list of all data sets of specified provider (empty if provider does not exist)

createDataSet

public URI createDataSet(String providerId,
                String dataSetId,
                String description)
                  throws eu.europeana.cloud.service.mcs.exception.ProviderNotExistsException,
                         eu.europeana.cloud.service.mcs.exception.DataSetAlreadyExistsException,
                         eu.europeana.cloud.service.mcs.exception.MCSException

Creates a new data set.

Parameters:

providerId - provider identifier (required)

dataSetId - data set identifier (required)

description - data set description (not required)

Returns:

URI to created data set

Throws:

eu.europeana.cloud.service.mcs.exception.DataSetAlreadyExistsException - when data set with given id (for given provider) already exists

eu.europeana.cloud.service.mcs.exception.ProviderNotExistsException - when provider with given id does not exist

eu.europeana.cloud.service.mcs.exception.MCSException - on unexpected situations

getDataSetRepresentationsChunk

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

Returns chunk of representation versions list from data set.

If specific version of representation is assigned to data set, this version is returned. If a whole representation is assigned to data set, the latest persistent representation version is returned.

This method returns the chunk specified by startFrom parameter. If parameter is empty, the first chunk is returned. You can use ResultSlice.getNextSlice() of returned result to obtain startFrom value to get the next chunk, etc. If you just need all representations, you can use getDataSetRepresentations(java.lang.String, java.lang.String) method, which encapsulates this method.

Parameters:

providerId - provider identifier (required)

dataSetId - data set identifier (required)

startFrom - code pointing to the requested result slice (if equal to null, first slice is returned)

Returns:

chunk of representation versions list from data set

Throws:

eu.europeana.cloud.service.mcs.exception.DataSetNotExistsException - if data set does not exist

eu.europeana.cloud.service.mcs.exception.MCSException - on unexpected situations

getDataSetRepresentations

public List<eu.europeana.cloud.common.model.Representation> getDataSetRepresentations(String providerId,
                                                                             String dataSetId)
                                                                               throws eu.europeana.cloud.service.mcs.exception.DataSetNotExistsException,
                                                                                      eu.europeana.cloud.service.mcs.exception.MCSException

Lists all representation versions from data set.

If specific version of representation is assigned to data set, this version is returned. If a whole representation is assigned to data set, the latest persistent representation version is returned.

Parameters:

providerId - provider identifier (required)

dataSetId - data set identifier (required)

Returns:

list of representation versions from data set

Throws:

eu.europeana.cloud.service.mcs.exception.DataSetNotExistsException - if data set does not exist

eu.europeana.cloud.service.mcs.exception.MCSException - on unexpected situations

getRepresentationIterator

public RepresentationIterator getRepresentationIterator(String providerId,
                                               String dataSetId)

Returns iterator to list of representation versions of data set.

Iterator is not initialised with data on creation, calls to MCS server are performed in iterator methods.

Parameters:

providerId - provider identifier (required)

dataSetId - data set identifier (required)

Returns:

iterator to the list of all data sets of specified provider (empty if provider does not exist)

updateDescriptionOfDataSet

public void updateDescriptionOfDataSet(String providerId,
                              String dataSetId,
                              String description)
                                throws eu.europeana.cloud.service.mcs.exception.DataSetNotExistsException,
                                       eu.europeana.cloud.service.mcs.exception.MCSException

Updates description of data set.

Parameters:

providerId - provider identifier (required)

dataSetId - data set identifier (required)

description - new description of data set (if "" will be set to "", if null will be set to null)

Throws:

eu.europeana.cloud.service.mcs.exception.DataSetNotExistsException - if data set does not exist

eu.europeana.cloud.service.mcs.exception.MCSException - on unexpected situations

deleteDataSet

public void deleteDataSet(String providerId,
                 String dataSetId)
                   throws eu.europeana.cloud.service.mcs.exception.DataSetNotExistsException,
                          eu.europeana.cloud.service.mcs.exception.MCSException

Deletes data set.

Parameters:

providerId - provider identifier (required)

dataSetId - data set identifier (required)

Throws:

eu.europeana.cloud.service.mcs.exception.DataSetNotExistsException - if data set does not exist

eu.europeana.cloud.service.mcs.exception.MCSException - on unexpected situations

assignRepresentationToDataSet

public void assignRepresentationToDataSet(String providerId,
                                 String dataSetId,
                                 String cloudId,
                                 String representationName,
                                 String versionId)
                                   throws eu.europeana.cloud.service.mcs.exception.DataSetNotExistsException,
                                          eu.europeana.cloud.service.mcs.exception.RepresentationNotExistsException,
                                          eu.europeana.cloud.service.mcs.exception.MCSException

Assigns representation into data set.

If specific version is assigned, and then other version of the same representation name assigned again, the old version is overridden. You can also assign the representation without version in this case the old version will also be overridden. Note that the version number will be then set to null in Cassandra, but getDataSetRepresentations(java.lang.String, java.lang.String) method will return the last persistent version with Representation.version filled.

Parameters:

providerId - provider identifier (required)

dataSetId - data set identifier (required)

cloudId - cloudId of the record (required)

representationName - name of the representation (required)

versionId - version of representation; if not provided, latest persistent version will be assigned to data set

Throws:

eu.europeana.cloud.service.mcs.exception.DataSetNotExistsException - if data set does not exist

eu.europeana.cloud.service.mcs.exception.RepresentationNotExistsException - if no such representation exists

eu.europeana.cloud.service.mcs.exception.MCSException - on unexpected situations

unassignRepresentationFromDataSet

public void unassignRepresentationFromDataSet(String providerId,
                                     String dataSetId,
                                     String cloudId,
                                     String representationName,
                                     String representationVersion)
                                       throws eu.europeana.cloud.service.mcs.exception.DataSetNotExistsException,
                                              eu.europeana.cloud.service.mcs.exception.MCSException

Unassigns representation from data set.

If representation was not assigned to data set, nothing happens. If representation does not exist, nothing happens.

Parameters:

providerId - provider identifier (required)

dataSetId - data set identifier (required)

cloudId - cloudId of the record (required)

representationName - name of the representation (required)

Throws:

eu.europeana.cloud.service.mcs.exception.DataSetNotExistsException - if data set does not exist

eu.europeana.cloud.service.mcs.exception.MCSException - on unexpected situations

getDataSetRevisionsChunk

public eu.europeana.cloud.common.response.ResultSlice<eu.europeana.cloud.common.response.CloudTagsResponse> getDataSetRevisionsChunk(String providerId,
                                                                                                                            String dataSetId,
                                                                                                                            String representationName,
                                                                                                                            String revisionName,
                                                                                                                            String revisionProviderId,
                                                                                                                            String revisionTimestamp,
                                                                                                                            String startFrom,
                                                                                                                            Integer limit)
                                                                                                                              throws eu.europeana.cloud.service.mcs.exception.MCSException

Retrieve chunk of cloudIds and tags from data set for specific revision.

Parameters:

providerId - provider identifier (required)

dataSetId - data set identifier (requred)

representationName - name of the representation (required)

revisionName - revision naem (required)

revisionProviderId - revision provider id (required)

revisionTimestamp - timestamp of the searched revision which is part of the revision identifier

startFrom - code pointing to the requested result slice (if equal to null, first slice is returned)

Returns:

chunk of representation cloud identifier list from data set together with tags of the revision

Throws:

eu.europeana.cloud.service.mcs.exception.MCSException - on unexpected situations

getDataSetRevisions

public List<eu.europeana.cloud.common.response.CloudTagsResponse> getDataSetRevisions(String providerId,
                                                                             String dataSetId,
                                                                             String representationName,
                                                                             String revisionName,
                                                                             String revisionProviderId,
                                                                             String revisionTimestamp)
                                                                               throws eu.europeana.cloud.service.mcs.exception.MCSException

Lists cloudIds and tags from data set for specific revision.

Parameters:

providerId - provider identifier (required)

dataSetId - data set identifier (requred)

representationName - name of the representation (required)

revisionName - revision naem (required)

revisionProviderId - revision provider id (required)

revisionTimestamp - timestamp of the searched revision which is part of the revision identifier

Returns:

chunk of representation cloud identifier list from data set together with revision tags

Throws:

eu.europeana.cloud.service.mcs.exception.MCSException - on unexpected situations

useAuthorizationHeader

public void useAuthorizationHeader(String headerValue)

finalize

protected void finalize()
                 throws Throwable

Overrides:

finalize in class Object

Throws:

Throwable

getDataSetCloudIdsByRepresentationChunk

public eu.europeana.cloud.common.response.ResultSlice<eu.europeana.cloud.common.response.CloudVersionRevisionResponse> getDataSetCloudIdsByRepresentationChunk(String dataSetId,
                                                                                                                                                      String providerId,
                                                                                                                                                      String representationName,
                                                                                                                                                      String dateFrom,
                                                                                                                                                      String tag,
                                                                                                                                                      String startFrom)
                                                                                                                                                        throws eu.europeana.cloud.service.mcs.exception.MCSException

Returns chunk of cloud identifiers list of specified provider in specified data set having specific representation name and published revision created after the specified date.

This method returns the chunk specified by startFrom parameter. If parameter is null, the first chunk is returned. You can use ResultSlice.getNextSlice() of returned result to obtain startFrom value to get the next chunk, etc; if ResultSlice.getNextSlice()==null in returned result it means it is the last slice.

Parameters:

dataSetId - data set identifier (required)

providerId - provider identifier (required)

representationName - name of the representation (required)

dateFrom - starting date (required)

tag - tag of revision, must be published, other are not supported yet (required)

startFrom - code pointing to the requested result slice (if equal to null, first slice is returned)

Returns:

chunk of cloud identifiers list of specified provider in specified data set having specific representation name and published revision created after the specified date

Throws:

eu.europeana.cloud.service.mcs.exception.MCSException - on unexpected situations

getDataSetCloudIdsByRepresentation

public List<eu.europeana.cloud.common.response.CloudVersionRevisionResponse> getDataSetCloudIdsByRepresentation(String dataSetId,
                                                                                                       String providerId,
                                                                                                       String representationName,
                                                                                                       String dateFrom,
                                                                                                       String tag)
                                                                                                         throws eu.europeana.cloud.service.mcs.exception.MCSException

Lists all cloud identifiers from data provider's data set having representation name and published revision added after specified date.

Parameters:

dataSetId - data set identifier (required)

providerId - provider identifier (required)

representationName - name of the representation (required)

dateFrom - starting date (required)

tag - tag of revision, must be published, other are not supported yet (required)

Returns:

list of all data sets of specified provider (empty if provider does not exist)

Throws:

eu.europeana.cloud.service.mcs.exception.MCSException - on unexpected situations

getLatestDataSetCloudIdByRepresentationAndRevisionChunk

public eu.europeana.cloud.common.response.ResultSlice<eu.europeana.cloud.common.model.CloudIdAndTimestampResponse> getLatestDataSetCloudIdByRepresentationAndRevisionChunk(String dataSetId,
                                                                                                                                                                  String providerId,
                                                                                                                                                                  String revisionProvider,
                                                                                                                                                                  String revisionName,
                                                                                                                                                                  String representationName,
                                                                                                                                                                  Boolean isDeleted,
                                                                                                                                                                  String startFrom)
                                                                                                                                                                    throws eu.europeana.cloud.service.mcs.exception.MCSException

Returns chunk of the latest cloud identifier,revision timestamp that belong to data set of a specified provider for a specific representation and revision.

Parameters:

dataSetId - data set identifier

providerId - provider identifier

revisionProvider - revision provider

revisionName - revision name

representationName - representation name

startFrom - identifier to the requested result slice (cloudId) (if equal to null, first slice is returned)

Returns:

chunk of the latest cloud identifier,revision timestamp that belong to data set of a specified provider for a specific representation and revision.

Throws:

eu.europeana.cloud.service.mcs.exception.MCSException - on unexpected situations

getLatestDataSetCloudIdByRepresentationAndRevision

public List<eu.europeana.cloud.common.model.CloudIdAndTimestampResponse> getLatestDataSetCloudIdByRepresentationAndRevision(String dataSetId,
                                                                                                                   String providerId,
                                                                                                                   String revisionProvider,
                                                                                                                   String revisionName,
                                                                                                                   String representationName,
                                                                                                                   Boolean isDeleted)
                                                                                                                     throws eu.europeana.cloud.service.mcs.exception.MCSException

Returns list of the latest cloud identifier,revision timestamp that belong to data set of a specified provider for a specific representation and revision

Parameters:

dataSetId - data set identifier

providerId - provider identifier

revisionProvider - revision provider

revisionName - revision name

representationName - representation name

isDeleted - marked deleted

Throws:

eu.europeana.cloud.service.mcs.exception.MCSException - on unexpected situations

getLatelyTaggedRecords

public String getLatelyTaggedRecords(String dataSetId,
                            String providerId,
                            String cloudId,
                            String representationName,
                            String revisionName,
                            String revisionProviderId)
                              throws eu.europeana.cloud.service.mcs.exception.MCSException

Gives the versionId of specified representation that has the newest revision (by revision timestamp) with given name.

Parameters:

dataSetId - dataset identifier

providerId - dataset owner

cloudId - representation cloud identifier

representationName - representation name

revisionName - revision name

revisionProviderId - revision owner

Returns:

version identifier of representation

Throws:

eu.europeana.cloud.service.mcs.exception.DataSetNotExistsException

eu.europeana.cloud.service.mcs.exception.MCSException