eu.europeana.cloud.service.uis.rest

Class UniqueIdentifierResource

java.lang.Object

eu.europeana.cloud.service.uis.rest.UniqueIdentifierResource

@Component
@Path(value="/cloudIds")
@Scope(value="request")
public class UniqueIdentifierResource
extends Object

Implementation of the Unique Identifier Service.

Since:

Oct 17, 2013

Author:

Yorgos.Mamakis@ kb.nl

Constructor Summary

Constructors

Constructor and Description
UniqueIdentifierResource()

Method Summary

Methods

Modifier and Type	Method and Description
javax.ws.rs.core.Response	createCloudId(String providerId, String localId) Invokes the generation of a cloud identifier using the provider identifier and a record identifier.
javax.ws.rs.core.Response	deleteCloudId(String cloudId) Remove a cloud identifier and all the associations to its record identifiers Required permissions: Admin role
javax.ws.rs.core.Response	getCloudId(String providerId, String recordId) Retrieves cloud identifier based on given provider identifier and record identifier
javax.ws.rs.core.Response	getLocalIds(String cloudId) Retrieves list of record Identifiers associated with the cloud identifier.

Methods inherited from class java.lang.Object

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

Constructor Detail

UniqueIdentifierResource

public UniqueIdentifierResource()

Method Detail

createCloudId

@POST
@Produces(value={"application/json","application/xml"})
@PreAuthorize(value="isAuthenticated()")
public javax.ws.rs.core.Response createCloudId(@QueryParam(value="providerId")
                                                                 String providerId,
                                                                 @QueryParam(value="recordId")
                                                                 String localId)
                                        throws eu.europeana.cloud.service.uis.exception.DatabaseConnectionException,
                                               eu.europeana.cloud.service.uis.exception.RecordExistsException,
                                               eu.europeana.cloud.common.exceptions.ProviderDoesNotExistException,
                                               eu.europeana.cloud.service.uis.exception.RecordDatasetEmptyException,
                                               eu.europeana.cloud.service.uis.exception.CloudIdDoesNotExistException,
                                               eu.europeana.cloud.service.uis.exception.CloudIdAlreadyExistException

Invokes the generation of a cloud identifier using the provider identifier and a record identifier.

Required permissions:

• Authenticated user

Parameters:

providerId - REQUIRED identifier of data-provider for which new cloud identifier will be created.

localId - record identifier which will be binded to the newly created cloud identifier. If not provided, random value will be generated.

Returns:

The newly created CloudId

Throws:

eu.europeana.cloud.service.uis.exception.DatabaseConnectionException - database error

eu.europeana.cloud.service.uis.exception.RecordExistsException - Record already exists in repository

eu.europeana.cloud.common.exceptions.ProviderDoesNotExistException - Supplied Data-provider does not exist

eu.europeana.cloud.service.uis.exception.RecordDatasetEmptyException - dataset is empty

eu.europeana.cloud.service.uis.exception.CloudIdDoesNotExistException - cloud identifier does not exist

eu.europeana.cloud.service.uis.exception.CloudIdAlreadyExistException - Cloud identifier was created previously

getCloudId

@GET
@Produces(value={"application/json","application/xml"})
public javax.ws.rs.core.Response getCloudId(@QueryParam(value="providerId")
                                                String providerId,
                                                @QueryParam(value="recordId")
                                                String recordId)
                                     throws eu.europeana.cloud.service.uis.exception.DatabaseConnectionException,
                                            eu.europeana.cloud.service.uis.exception.RecordDoesNotExistException,
                                            eu.europeana.cloud.common.exceptions.ProviderDoesNotExistException,
                                            eu.europeana.cloud.service.uis.exception.RecordDatasetEmptyException

Retrieves cloud identifier based on given provider identifier and record identifier

Parameters:

providerId - REQUIRED provider identifier

recordId - REQUIRED record identifier

Returns:

Cloud identifier associated with given provider identifier and record identifier

Throws:

eu.europeana.cloud.service.uis.exception.DatabaseConnectionException - database error

eu.europeana.cloud.service.uis.exception.RecordDoesNotExistException - record does not exist

eu.europeana.cloud.common.exceptions.ProviderDoesNotExistException - provider does not exist

eu.europeana.cloud.service.uis.exception.RecordDatasetEmptyException - dataset is empty

getLocalIds

@GET
@Path(value="{cloudId}")
@Produces(value={"application/json","application/xml"})
public javax.ws.rs.core.Response getLocalIds(@PathParam(value="cloudId")
                                                      String cloudId)
                                      throws eu.europeana.cloud.service.uis.exception.DatabaseConnectionException,
                                             eu.europeana.cloud.service.uis.exception.CloudIdDoesNotExistException,
                                             eu.europeana.cloud.common.exceptions.ProviderDoesNotExistException,
                                             eu.europeana.cloud.service.uis.exception.RecordDatasetEmptyException

Retrieves list of record Identifiers associated with the cloud identifier. Result is returned in slices which contain fixed amount of results and reference (token) to next slice of results.

Parameters:

cloudId - REQUIRED cloud identifier for which list of all record identifiers will be retrieved

Returns:

The list of record identifiers bound to given provider identifier

Throws:

eu.europeana.cloud.service.uis.exception.DatabaseConnectionException - database error

eu.europeana.cloud.service.uis.exception.CloudIdDoesNotExistException - cloud identifier does not exist

eu.europeana.cloud.common.exceptions.ProviderDoesNotExistException - provider does not exist

eu.europeana.cloud.service.uis.exception.RecordDatasetEmptyException - datset is empty

deleteCloudId

@DELETE
@Path(value="{cloudId}")
@Produces(value={"application/json","application/xml"})
@PreAuthorize(value="hasRole(\'ROLE_ADMIN\')")
public javax.ws.rs.core.Response deleteCloudId(@PathParam(value="cloudId")
                                                                        String cloudId)
                                        throws eu.europeana.cloud.service.uis.exception.DatabaseConnectionException,
                                               eu.europeana.cloud.service.uis.exception.CloudIdDoesNotExistException,
                                               eu.europeana.cloud.common.exceptions.ProviderDoesNotExistException,
                                               eu.europeana.cloud.service.uis.exception.RecordIdDoesNotExistException

Remove a cloud identifier and all the associations to its record identifiers

Required permissions:

• Admin role

Parameters:

cloudId - REQUIRED cloud identifier which will be removed

Returns:

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

Throws:

eu.europeana.cloud.service.uis.exception.DatabaseConnectionException - database error

eu.europeana.cloud.service.uis.exception.CloudIdDoesNotExistException - cloud identifier does not exist

eu.europeana.cloud.common.exceptions.ProviderDoesNotExistException - provider does not exist

eu.europeana.cloud.service.uis.exception.RecordIdDoesNotExistException - record identifier does not exist