eu.europeana.cloud.service.uis.rest

Class DataProviderResource

java.lang.Object

eu.europeana.cloud.service.uis.rest.DataProviderResource

public class DataProviderResource
extends Object

Resource for DataProvider.

Constructor Summary

Constructors

Constructor and Description
DataProviderResource()

Method Summary

Methods

Modifier and Type	Method and Description
Response	createIdMapping(String providerId, String localId) Create a mapping between a cloud identifier and a record identifier for a provider
Response	getCloudIdsByProvider(String providerId, String from, int to) Get the cloud identifiers for a specific provider identifier with pagination
Response	getLocalIdsByProvider(String providerId, String from, int to) Get the record identifiers for a specific provider identifier with pagination
DataProvider	getProvider(String providerId) Gets provider.
Response	removeIdMapping(String providerId) Remove the mapping between a record identifier and a cloud identifier
void	updateProvider(DataProviderProperties dataProviderProperties, String providerId, UriInfo uriInfo) Updates data provider information.

Methods inherited from class java.lang.Object

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

Constructor Detail

DataProviderResource

public DataProviderResource()

Method Detail

getProvider

public DataProvider getProvider(String providerId)
                         throws ProviderDoesNotExistException

Gets provider.

Returns:

Data provider.

Throws:

ProviderDoesNotExistException

updateProvider

public void updateProvider(DataProviderProperties dataProviderProperties,
                  String providerId,
                  UriInfo uriInfo)
                    throws ProviderDoesNotExistException

Updates data provider information.

Parameters:

dataProviderProperties - data provider properties.

Throws:

ProviderDoesNotExistException

getLocalIdsByProvider

public Response getLocalIdsByProvider(String providerId,
                             String from,
                             int to)
                               throws DatabaseConnectionException,
                                      ProviderDoesNotExistException,
                                      RecordDatasetEmptyException

Get the record identifiers for a specific provider identifier with pagination

Parameters:

from -

to -

Returns:

A list of record Identifiers (with their cloud identifiers)

Throws:

DatabaseConnectionException

ProviderDoesNotExistException

RecordDatasetEmptyException

getCloudIdsByProvider

public Response getCloudIdsByProvider(String providerId,
                             String from,
                             int to)
                               throws DatabaseConnectionException,
                                      ProviderDoesNotExistException,
                                      RecordDatasetEmptyException

Get the cloud identifiers for a specific provider identifier with pagination

Parameters:

from -

to -

Returns:

A list of cloud Identifiers

Throws:

DatabaseConnectionException

ProviderDoesNotExistException

RecordDatasetEmptyException

createIdMapping

public Response createIdMapping(String providerId,
                       String localId)
                         throws DatabaseConnectionException,
                                CloudIdDoesNotExistException,
                                IdHasBeenMappedException,
                                ProviderDoesNotExistException,
                                RecordDatasetEmptyException

Create a mapping between a cloud identifier and a record identifier for a provider

Parameters:

localId -

Returns:

The newly associated cloud identifier

Throws:

DatabaseConnectionException

CloudIdDoesNotExistException

IdHasBeenMappedException

ProviderDoesNotExistException

RecordDatasetEmptyException

removeIdMapping

public Response removeIdMapping(String providerId)
                         throws DatabaseConnectionException,
                                ProviderDoesNotExistException,
                                RecordIdDoesNotExistException

Remove the mapping between a record identifier and a cloud identifier

Returns:

Confirmation that the mapping has been removed

Throws:

DatabaseConnectionException

ProviderDoesNotExistException

RecordIdDoesNotExistException