eu.europeana.cloud.service.uis.rest

Class DataProviderResource

java.lang.Object

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

@Path(value="/data-providers/{DATAPROVIDER}")
@Component
@Scope(value="request")
public class DataProviderResource
extends Object

Resource for DataProvider.

Author:

Field Summary

Fields

Modifier and Type	Field and Description
protected String	LOCAL_ID_CLASS_NAME

Constructor Summary

Constructors

Constructor and Description
DataProviderResource()

Method Summary

Methods

Modifier and Type	Method and Description
javax.ws.rs.core.Response	createIdMapping(String providerId, String cloudId, String localId) Create a mapping between a cloud identifier and a record identifier for a provider Required permissions: Authenticated user
protected void	deleteLocalIdAcl(String localId, String providerId)
javax.ws.rs.core.Response	deleteProvider(String dataProviderId) Deletes data provider from database Required permissions: Admin role
javax.ws.rs.core.Response	getCloudIdsByProvider(String providerId, String from, int to) Get the cloud identifiers for a specific provider identifier with pagination
javax.ws.rs.core.Response	getLocalIdsByProvider(String providerId, String from, int to) Get the local identifiers for a specific provider identifier with pagination
eu.europeana.cloud.common.model.DataProvider	getProvider(String providerId) Retrieves details about selected data provider
protected void	grantPermissionsToLocalId(eu.europeana.cloud.common.model.CloudId result, String providerId)
javax.ws.rs.core.Response	removeIdMapping(String providerId, String localId) Remove the mapping between a record identifier and a cloud identifier Required permissions: Authenticated user Write permissions for selected data provider and local identifier (granted at the mapping creation)
void	updateProvider(eu.europeana.cloud.common.model.DataProviderProperties dataProviderProperties, String providerId, javax.ws.rs.core.UriInfo uriInfo) Updates data provider information.

Methods inherited from class java.lang.Object

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

Field Detail

LOCAL_ID_CLASS_NAME

protected final String LOCAL_ID_CLASS_NAME

See Also:

Constant Field Values

Constructor Detail

DataProviderResource

public DataProviderResource()

Method Detail

getProvider

@GET
@Produces(value={"application/xml","application/json"})
public eu.europeana.cloud.common.model.DataProvider getProvider(@PathParam(value="DATAPROVIDER")
                                                                    String providerId)
                                                         throws eu.europeana.cloud.common.exceptions.ProviderDoesNotExistException

Retrieves details about selected data provider

Parameters:

providerId - REQUIRED identifier of the provider that will be retrieved

Returns:

Selected Data provider details

Throws:

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

updateProvider

@PUT
@Consumes(value={"application/xml","application/json"})
@PreAuthorize(value="hasPermission(#providerId, \'eu.europeana.cloud.common.model.DataProvider\', write)")
public void updateProvider(eu.europeana.cloud.common.model.DataProviderProperties dataProviderProperties,
                                            @PathParam(value="DATAPROVIDER")
                                            String providerId,
                                            @Context
                                            javax.ws.rs.core.UriInfo uriInfo)
                    throws eu.europeana.cloud.common.exceptions.ProviderDoesNotExistException

Updates data provider information.

Required permissions:

• Authenticated user
• Write permission for the selected data provider

Parameters:

dataProviderProperties - REQUIRED data provider properties.

providerId - REQUIRED identifier of data provider which will be updated.

Throws:

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

deleteProvider

@DELETE
@PreAuthorize(value="hasRole(\'ROLE_ADMIN\')")
public javax.ws.rs.core.Response deleteProvider(@PathParam(value="DATAPROVIDER")
                                                           String dataProviderId)
                                         throws eu.europeana.cloud.common.exceptions.ProviderDoesNotExistException

Deletes data provider from database

Required permissions:

• Admin role

Parameters:

dataProviderId - REQUIRED data provider id

Returns:

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

Throws:

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

getLocalIdsByProvider

@GET
@Path(value="localIds")
@Produces(value={"application/json","application/xml"})
public javax.ws.rs.core.Response getLocalIdsByProvider(@PathParam(value="DATAPROVIDER")
                                                                String providerId,
                                                                @QueryParam(value="from")
                                                                String from,
                                                                @QueryParam(value="to")@DefaultValue(value="10000")
                                                                int to)
                                                throws eu.europeana.cloud.service.uis.exception.DatabaseConnectionException,
                                                       eu.europeana.cloud.common.exceptions.ProviderDoesNotExistException,
                                                       eu.europeana.cloud.service.uis.exception.RecordDatasetEmptyException

Get the local identifiers for a specific provider identifier with pagination

Parameters:

providerId - REQUIRED identifier of provider for which all local identifiers will be retrieved

from - from which one local identifier should we start.

to - how many local identifiers should be contained in results list. Default is 10000

Returns:

A list of local Identifiers (with their cloud identifiers)

Throws:

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

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

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

getCloudIdsByProvider

@GET
@Path(value="cloudIds")
@Produces(value={"application/json","application/xml"})
public javax.ws.rs.core.Response getCloudIdsByProvider(@PathParam(value="DATAPROVIDER")
                                                                String providerId,
                                                                @QueryParam(value="from")
                                                                String from,
                                                                @QueryParam(value="to")@DefaultValue(value="10000")
                                                                int to)
                                                throws eu.europeana.cloud.service.uis.exception.DatabaseConnectionException,
                                                       eu.europeana.cloud.common.exceptions.ProviderDoesNotExistException,
                                                       eu.europeana.cloud.service.uis.exception.RecordDatasetEmptyException

Get the cloud identifiers for a specific provider identifier with pagination

Parameters:

providerId - REQUIRED identifier of provider for which all cloud identifiers will be retrieved

from - from which one cloud identifier should we start.

to - how many cloud identifiers should be contained in results list. Default is 10000

Returns:

List of cloud identifiers for specific provider

Throws:

eu.europeana.cloud.service.uis.exception.DatabaseConnectionException - database connection errot

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

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

createIdMapping

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

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

Required permissions:

• Authenticated user

Parameters:

providerId - REQUIRED identifier of data provider, owner of the record

cloudId - REQUIRED cloud identifier for which new record identifier will be added

localId - record identifier which will be bound to selected cloud identifier. If not specified, random one will be generated

Returns:

The newly associated cloud identifier

Throws:

eu.europeana.cloud.service.uis.exception.DatabaseConnectionException - datbase connection error

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

eu.europeana.cloud.service.uis.exception.IdHasBeenMappedException - identifier already mapped

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

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

eu.europeana.cloud.service.uis.exception.CloudIdAlreadyExistException - cloud identifier alrrasy exist

grantPermissionsToLocalId

protected void grantPermissionsToLocalId(eu.europeana.cloud.common.model.CloudId result,
                             String providerId)
                                  throws org.springframework.security.acls.model.NotFoundException,
                                         org.springframework.security.acls.model.AlreadyExistsException

Throws:

org.springframework.security.acls.model.NotFoundException

org.springframework.security.acls.model.AlreadyExistsException

removeIdMapping

@DELETE
@Path(value="localIds/{LOCALID}")
@Produces(value={"application/json","application/xml"})
@PreAuthorize(value="hasPermission(#localId.concat(\'/\').concat(#providerId),\'LocalId\', write)")
public javax.ws.rs.core.Response removeIdMapping(@PathParam(value="DATAPROVIDER")
                                                                          String providerId,
                                                                          @PathParam(value="LOCALID")
                                                                          String localId)
                                          throws eu.europeana.cloud.service.uis.exception.DatabaseConnectionException,
                                                 eu.europeana.cloud.common.exceptions.ProviderDoesNotExistException,
                                                 eu.europeana.cloud.service.uis.exception.RecordIdDoesNotExistException

Remove the mapping between a record identifier and a cloud identifier

Required permissions:

• Authenticated user
• Write permissions for selected data provider and local identifier (granted at the mapping creation)

Parameters:

providerId - REQUIRED identifier of the provider, owner of the record

localId - REQUIRED record identifier which will be detached from selected provider identifier.

Returns:

Confirmation that the mapping has been removed

Throws:

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

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

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

deleteLocalIdAcl

protected void deleteLocalIdAcl(String localId,
                    String providerId)
                         throws org.springframework.security.acls.model.ChildrenExistException

Throws:

org.springframework.security.acls.model.ChildrenExistException