eu.europeana.cloud.service.uis.rest

Class DataProvidersResource

java.lang.Object

eu.europeana.cloud.service.uis.rest.DataProvidersResource

@Path(value="/data-providers")
@Component
@Scope(value="request")
public class DataProvidersResource
extends Object

Resource for DataProviders.

Author:

Constructor Summary

Constructors

Constructor and Description
DataProvidersResource()

Method Summary

Methods

Modifier and Type	Method and Description
javax.ws.rs.core.Response	createProvider(javax.ws.rs.core.UriInfo uriInfo, eu.europeana.cloud.common.model.DataProviderProperties dataProviderProperties, String providerId) Creates a new data provider.
eu.europeana.cloud.common.response.ResultSlice<eu.europeana.cloud.common.model.DataProvider>	getProviders(String startFrom) Lists all providers stored in eCloud.

Methods inherited from class java.lang.Object

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

Constructor Detail

DataProvidersResource

public DataProvidersResource()

Method Detail

getProviders

@GET
@Produces(value={"application/xml","application/json"})
public eu.europeana.cloud.common.response.ResultSlice<eu.europeana.cloud.common.model.DataProvider> getProviders(@QueryParam(value="from")
                                                                                                                     String startFrom)

Lists all providers stored in eCloud. Result is returned in slices.

Parameters:

startFrom - data provider identifier from which returned slice of results will be generated. If not provided then result list will contain data providers from the first one.

Returns:

one slice of result containing eCloud data providers.

createProvider

@POST
@Produces(value={"application/xml","application/json"})
@Consumes(value={"application/xml","application/json"})
@PreAuthorize(value="isAuthenticated()")
public javax.ws.rs.core.Response createProvider(@Context
                                                                           javax.ws.rs.core.UriInfo uriInfo,
                                                                           eu.europeana.cloud.common.model.DataProviderProperties dataProviderProperties,
                                                                           @QueryParam(value="providerId")
                                                                           String providerId)
                                         throws eu.europeana.cloud.service.uis.exception.ProviderAlreadyExistsException

Creates a new data provider. Response contains uri to created resource in as content location.

Parameters:

dataProviderProperties - REQUIRED data provider properties.

providerId - REQUIRED data provider identifier for newly created provider

Returns:

URI to created resource in content location

Throws:

eu.europeana.cloud.service.uis.exception.ProviderAlreadyExistsException - provider already exists.