eu.europeana.cloud.client.uis.rest

Class UISClient

java.lang.Object

eu.europeana.cloud.client.uis.rest.UISClient

public class UISClient
extends Object

The REST API client for the Unique Identifier Service.

Author:

Yorgos.Mamakis@ kb.nl

Constructor Summary

Constructors

Constructor and Description
UISClient() Creates a new instance of this class.
UISClient(eu.europeana.cloud.service.coordination.provider.ServiceProvider uisProvider) Creates a new instance of this class.
UISClient(eu.europeana.cloud.service.coordination.provider.ServiceProvider uisProvider, String username, String password) Creates a new instance of this class.
UISClient(String uisUrl) Creates a new instance of this class, with a static UIS url.
UISClient(String username, String password) Creates a new instance of this class.
UISClient(String uisUrl, String username, String password) Creates a new instance of this class.

Method Summary

Methods

Modifier and Type	Method and Description
eu.europeana.cloud.common.model.CloudId	createCloudId(String providerId) Invoke the creation of a new CloudId REST call.
eu.europeana.cloud.common.model.CloudId	createCloudId(String providerId, String recordId) Invoke the creation of a new CloudId REST call.
boolean	createMapping(String cloudId, String providerId, String recordId) Create a mapping between a cloud id and provider and record id.
String	createProvider(String providerId, eu.europeana.cloud.common.model.DataProviderProperties dp) Create a data provider.
boolean	deleteCloudId(String cloudId) Delete a cloud id and all its mapped record ids.
CloudException	generateException(eu.europeana.cloud.common.response.ErrorInfo e) Generates the exception to be returned to the client.
eu.europeana.cloud.common.model.CloudId	getCloudId(String providerId, String recordId) Invoke the retrieval of a cloud identifier.
eu.europeana.cloud.common.response.ResultSlice<eu.europeana.cloud.common.model.CloudId>	getCloudIdsByProvider(String providerId) Retrieve the Cloud ids associated with a provider.
eu.europeana.cloud.common.response.ResultSlice<eu.europeana.cloud.common.model.CloudId>	getCloudIdsByProviderWithPagination(String providerId, String cloudId, int window) Retrieve the cloud ids associated with a provider with pagination.
eu.europeana.cloud.common.model.DataProvider	getDataProvider(String providerId) Retrieve a selected data provider.
eu.europeana.cloud.common.response.ResultSlice<eu.europeana.cloud.common.model.DataProvider>	getDataProviders(String from) Get data providers
eu.europeana.cloud.common.response.ResultSlice<eu.europeana.cloud.common.model.CloudId>	getRecordId(String cloudId) Retrieve the local identifiers associated with a cloud identifier
eu.europeana.cloud.common.response.ResultSlice<eu.europeana.cloud.common.model.LocalId>	getRecordIdsByProvider(String providerId) Retrieve records associated with a provider.
eu.europeana.cloud.common.response.ResultSlice<eu.europeana.cloud.common.model.LocalId>	getRecordIdsByProviderWithPagination(String providerId, String recordId, int window) Retrieve the record ids associated with a provider with pagination.
boolean	removeMappingByLocalId(String providerId, String recordId) Remove the association of a record id to a cloud id.
boolean	updateProvider(String providerId, eu.europeana.cloud.common.model.DataProviderProperties dp) Update a Data Provider.

Methods inherited from class java.lang.Object

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

Constructor Detail

UISClient

public UISClient()

Creates a new instance of this class. Since no URL is provided, default properties will be read from the properties file.

UISClient

public UISClient(String username,
         String password)

Creates a new instance of this class. Since no URL is provided, default properties will be read from the properties file. Same as UISClient() but includes username and password to perform authenticated requests.

UISClient

public UISClient(eu.europeana.cloud.service.coordination.provider.ServiceProvider uisProvider)

Creates a new instance of this class. UIS url is dynamically provided from the specified ServiceProvider

Parameters:

uisProvider -

UISClient

public UISClient(eu.europeana.cloud.service.coordination.provider.ServiceProvider uisProvider,
         String username,
         String password)

Creates a new instance of this class. Same as UISClient(ServiceProvider) but includes username and password to perform authenticated requests.

UISClient

public UISClient(String uisUrl,
         String username,
         String password)

Creates a new instance of this class. Same as UISClient(String) but includes username and password to perform authenticated requests.

UISClient

public UISClient(String uisUrl)

Creates a new instance of this class, with a static UIS url.

Parameters:

uisUrl - The URL of some UIS instance to connect to.

Method Detail

createCloudId

public eu.europeana.cloud.common.model.CloudId createCloudId(String providerId,
                                                    String recordId)
                                                      throws CloudException

Invoke the creation of a new CloudId REST call.

Parameters:

providerId - The provider Id

recordId - The record Id

Returns:

The newly generated CloudId

Throws:

CloudException - The generic cloud exception wrapper

createCloudId

public eu.europeana.cloud.common.model.CloudId createCloudId(String providerId)
                                                      throws CloudException

Invoke the creation of a new CloudId REST call.

Parameters:

providerId - The provider Id

Returns:

The newly generated CloudId

Throws:

CloudException - The generic cloud exception wrapper

getCloudId

public eu.europeana.cloud.common.model.CloudId getCloudId(String providerId,
                                                 String recordId)
                                                   throws CloudException

Invoke the retrieval of a cloud identifier.

Parameters:

providerId - The provider Id

recordId - The record Id

Returns:

The retrieved cloud Id

Throws:

CloudException - The generic cloud exception wrapper

getRecordId

public eu.europeana.cloud.common.response.ResultSlice<eu.europeana.cloud.common.model.CloudId> getRecordId(String cloudId)
                                                                                                    throws CloudException

Retrieve the local identifiers associated with a cloud identifier

Parameters:

cloudId - The cloud id to search for

Returns:

The List of local ids associated with the cloud id

Throws:

CloudException - The generic cloud exception wrapper

getRecordIdsByProvider

public eu.europeana.cloud.common.response.ResultSlice<eu.europeana.cloud.common.model.LocalId> getRecordIdsByProvider(String providerId)
                                                                                                               throws CloudException

Retrieve records associated with a provider.

Parameters:

providerId - The provider Id

Returns:

The List of Local ids associated with a provider

Throws:

CloudException - The generic cloud exception wrapper

getCloudIdsByProvider

public eu.europeana.cloud.common.response.ResultSlice<eu.europeana.cloud.common.model.CloudId> getCloudIdsByProvider(String providerId)
                                                                                                              throws CloudException

Retrieve the Cloud ids associated with a provider.

Parameters:

providerId - The provider id

Returns:

The list of cloud ids associated with the provider id

Throws:

CloudException - The generic cloud exception wrapper

getRecordIdsByProviderWithPagination

public eu.europeana.cloud.common.response.ResultSlice<eu.europeana.cloud.common.model.LocalId> getRecordIdsByProviderWithPagination(String providerId,
                                                                                                                           String recordId,
                                                                                                                           int window)
                                                                                                                             throws CloudException

Retrieve the record ids associated with a provider with pagination.

Parameters:

providerId - The provider id

recordId - The record id to start retrieval from

window - The maximum number of records to fetch

Returns:

A list of record ids associated with the provider

Throws:

CloudException - The generic cloud exception wrapper

getCloudIdsByProviderWithPagination

public eu.europeana.cloud.common.response.ResultSlice<eu.europeana.cloud.common.model.CloudId> getCloudIdsByProviderWithPagination(String providerId,
                                                                                                                          String cloudId,
                                                                                                                          int window)
                                                                                                                            throws CloudException

Retrieve the cloud ids associated with a provider with pagination.

Parameters:

providerId - The provider id

cloudId - The cloud id to start retrieval from

window - The maximum number of records to fetch

Returns:

A list of cloud ids associated with the provider

Throws:

CloudException - The generic cloud exception wrapper

createMapping

public boolean createMapping(String cloudId,
                    String providerId,
                    String recordId)
                      throws CloudException

Create a mapping between a cloud id and provider and record id.

Parameters:

cloudId - The cloud id

providerId - The provider id

recordId - The record id

Returns:

A confirmation that the mapping has been created

Throws:

CloudException - The generic cloud exception wrapper

removeMappingByLocalId

public boolean removeMappingByLocalId(String providerId,
                             String recordId)
                               throws CloudException

Remove the association of a record id to a cloud id.

Parameters:

providerId - The provider id to use

recordId - The record id to use

Returns:

A confirmation that the mapping has removed correctly

Throws:

CloudException - The generic cloud exception wrapper

deleteCloudId

public boolean deleteCloudId(String cloudId)
                      throws CloudException

Delete a cloud id and all its mapped record ids.

Parameters:

cloudId - The cloud id to remove

Returns:

A confirmation message that the mappings have been removed correctly

Throws:

CloudException - The generic cloud exception wrapper

createProvider

public String createProvider(String providerId,
                    eu.europeana.cloud.common.model.DataProviderProperties dp)
                      throws CloudException

Create a data provider.

Parameters:

providerId - The data provider Id

dp - The data provider properties

Returns:

A URL that points to the data provider

Throws:

CloudException

updateProvider

public boolean updateProvider(String providerId,
                     eu.europeana.cloud.common.model.DataProviderProperties dp)
                       throws CloudException

Update a Data Provider.

Parameters:

providerId - The provider to update

dp - The data provider properties

Returns:

True if successful, false else

Throws:

CloudException

getDataProviders

public eu.europeana.cloud.common.response.ResultSlice<eu.europeana.cloud.common.model.DataProvider> getDataProviders(String from)
                                                                                                              throws CloudException

Get data providers

Parameters:

from - The record to start from

Returns:

A predefined number of data providers

Throws:

CloudException

getDataProvider

public eu.europeana.cloud.common.model.DataProvider getDataProvider(String providerId)
                                                             throws CloudException

Retrieve a selected data provider.

Parameters:

providerId - The provider id to retrieve

Returns:

The Data provider that corresponds to the selected id

Throws:

CloudException

generateException

public CloudException generateException(eu.europeana.cloud.common.response.ErrorInfo e)

Generates the exception to be returned to the client.

Parameters:

e - The error info that was generated

Returns:

A CloudException that wraps the original exception