eu.europeana.cloud.mcs.driver

Class RecordServiceClient

java.lang.Object

eu.europeana.cloud.mcs.driver.RecordServiceClient

public class RecordServiceClient
extends Object

Exposes API related to records.

Constructor Summary

Constructors

Constructor and Description
RecordServiceClient(String baseUrl) Creates instance of RecordServiceClient.
RecordServiceClient(String baseUrl, String username, String password) Creates instance of RecordServiceClient.

Method Summary

Methods

Modifier and Type	Method and Description
URI	copyRepresentation(String cloudId, String representationName, String version) Copies all information from one representation version to another.
URI	createRepresentation(String cloudId, String representationName, String providerId) Creates new representation version.
void	deleteRecord(String cloudId) Deletes record with all its representations in all versions.
void	deleteRepresentation(String cloudId, String representationName) Deletes representation with all versions.
void	deleteRepresentation(String cloudId, String representationName, String version) Deletes representation in specified version.
eu.europeana.cloud.common.model.Record	getRecord(String cloudId) Returns record with all its latest persistent representations.
eu.europeana.cloud.common.model.Representation	getRepresentation(String cloudId, String representationName) Returns latest persistent version of representation.
eu.europeana.cloud.common.model.Representation	getRepresentation(String cloudId, String representationName, String version) Returns representation in specified version.
List<eu.europeana.cloud.common.model.Representation>	getRepresentations(String cloudId) Lists all latest persistent versions of record representation.
List<eu.europeana.cloud.common.model.Representation>	getRepresentations(String cloudId, String representationName) Lists all versions of record representation.
void	grantPermissionsToVersion(String cloudId, String representationName, String version, String userName, eu.europeana.cloud.common.model.Permission permission) Adds selected permission(s) to selected representation version.
void	permitVersion(String cloudId, String representationName, String version) Adds selected permission(s) to selected representation version.
URI	persistRepresentation(String cloudId, String representationName, String version) Makes specified temporary representation version persistent.
void	revokePermissionsToVersion(String cloudId, String representationName, String version, String userName, eu.europeana.cloud.common.model.Permission permission) Revokes permission(s) to selected representation version.
RecordServiceClient	useAuthorizationHeader(String headerValue) Client will use provided authorization header for all requests;

Methods inherited from class java.lang.Object

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

Constructor Detail

RecordServiceClient

public RecordServiceClient(String baseUrl)

Creates instance of RecordServiceClient.

Parameters:

baseUrl - URL of the MCS Rest Service

RecordServiceClient

public RecordServiceClient(String baseUrl,
                   String username,
                   String password)

Creates instance of RecordServiceClient. Same as RecordServiceClient(String) but includes username and password to perform authenticated requests.

Parameters:

baseUrl - URL of the MCS Rest Service

Method Detail

useAuthorizationHeader

public RecordServiceClient useAuthorizationHeader(String headerValue)

Client will use provided authorization header for all requests;

Parameters:

headerValue - authorization header value

Returns:

getRecord

public eu.europeana.cloud.common.model.Record getRecord(String cloudId)
                                                 throws eu.europeana.cloud.service.mcs.exception.RecordNotExistsException,
                                                        eu.europeana.cloud.service.mcs.exception.MCSException

Returns record with all its latest persistent representations.

Parameters:

cloudId - id of the record (required)

Returns:

record of specified cloudId (required)

Throws:

eu.europeana.cloud.service.mcs.exception.RecordNotExistsException - when id is not known UIS Service

eu.europeana.cloud.service.mcs.exception.MCSException - on unexpected situations

deleteRecord

public void deleteRecord(String cloudId)
                  throws eu.europeana.cloud.service.mcs.exception.RecordNotExistsException,
                         eu.europeana.cloud.service.mcs.exception.MCSException

Deletes record with all its representations in all versions. Does not remove mapping from Unique Identifier Service. If record exists, but nothing was deleted (it had no representations assigned), nothing happens.

Parameters:

cloudId - id of deleted record (required)

Throws:

eu.europeana.cloud.service.mcs.exception.RecordNotExistsException - if cloudId is not known UIS Service

eu.europeana.cloud.service.mcs.exception.MCSException - on unexpected situations

getRepresentations

public List<eu.europeana.cloud.common.model.Representation> getRepresentations(String cloudId)
                                                                        throws eu.europeana.cloud.service.mcs.exception.RecordNotExistsException,
                                                                               eu.europeana.cloud.service.mcs.exception.MCSException

Lists all latest persistent versions of record representation.

Parameters:

cloudId - id of record from which to get representations (required)

Returns:

list of representations

Throws:

eu.europeana.cloud.service.mcs.exception.RecordNotExistsException - if cloudId is not known UIS Service

eu.europeana.cloud.service.mcs.exception.MCSException - on unexpected situations

getRepresentation

public eu.europeana.cloud.common.model.Representation getRepresentation(String cloudId,
                                                               String representationName)
                                                                 throws eu.europeana.cloud.service.mcs.exception.RepresentationNotExistsException,
                                                                        eu.europeana.cloud.service.mcs.exception.MCSException

Returns latest persistent version of representation.

Parameters:

cloudId - id of record from which to get representations (required)

representationName - name of the representation (required)

Returns:

representation of specified representationName and cloudId

Throws:

eu.europeana.cloud.service.mcs.exception.RepresentationNotExistsException - representation does not exist or no persistent version of this representation exists

eu.europeana.cloud.service.mcs.exception.MCSException - on unexpected situations

createRepresentation

public URI createRepresentation(String cloudId,
                       String representationName,
                       String providerId)
                         throws eu.europeana.cloud.service.mcs.exception.ProviderNotExistsException,
                                eu.europeana.cloud.service.mcs.exception.RecordNotExistsException,
                                eu.europeana.cloud.service.mcs.exception.MCSException

Creates new representation version.

Parameters:

cloudId - id of the record in which to create the representation (required)

representationName - name of the representation to be created (required)

providerId - provider of this representation version (required)

Returns:

URI to the created representation

Throws:

eu.europeana.cloud.service.mcs.exception.ProviderNotExistsException - when no provider with given id exists

eu.europeana.cloud.service.mcs.exception.RecordNotExistsException - when cloud id is not known to UIS Service

eu.europeana.cloud.service.mcs.exception.MCSException - on unexpected situations

deleteRepresentation

public void deleteRepresentation(String cloudId,
                        String representationName)
                          throws eu.europeana.cloud.service.mcs.exception.RepresentationNotExistsException,
                                 eu.europeana.cloud.service.mcs.exception.MCSException

Deletes representation with all versions.

Parameters:

cloudId - id of the record to delete representation from (required)

representationName - representation name of deleted representation (required)

Throws:

eu.europeana.cloud.service.mcs.exception.RepresentationNotExistsException - if specified Representation does not exist

eu.europeana.cloud.service.mcs.exception.MCSException - on unexpected situations

getRepresentations

public List<eu.europeana.cloud.common.model.Representation> getRepresentations(String cloudId,
                                                                      String representationName)
                                                                        throws eu.europeana.cloud.service.mcs.exception.RepresentationNotExistsException,
                                                                               eu.europeana.cloud.service.mcs.exception.MCSException

Lists all versions of record representation.

Parameters:

cloudId - id of the record to get representation from (required)

representationName - name of the representation (required)

Returns:

representation versions list

Throws:

eu.europeana.cloud.service.mcs.exception.RepresentationNotExistsException - if specified Representation does not exist

eu.europeana.cloud.service.mcs.exception.MCSException - on unexpected situations

getRepresentation

public eu.europeana.cloud.common.model.Representation getRepresentation(String cloudId,
                                                               String representationName,
                                                               String version)
                                                                 throws eu.europeana.cloud.service.mcs.exception.RepresentationNotExistsException,
                                                                        eu.europeana.cloud.service.mcs.exception.MCSException

Returns representation in specified version. If Version = LATEST, will redirect to actual latest persistent version at the moment of invoking this method.

Parameters:

cloudId - id of the record to get representation from (required)

representationName - name of the representation (required)

version - version of the representation to be obtained; if version==LATEST function will return latest persistent version (required)

Returns:

requested representation version

Throws:

eu.europeana.cloud.service.mcs.exception.RepresentationNotExistsException - if specified representation does not exist

eu.europeana.cloud.service.mcs.exception.MCSException - on unexpected situations

deleteRepresentation

public void deleteRepresentation(String cloudId,
                        String representationName,
                        String version)
                          throws eu.europeana.cloud.service.mcs.exception.RepresentationNotExistsException,
                                 eu.europeana.cloud.service.mcs.exception.CannotModifyPersistentRepresentationException,
                                 eu.europeana.cloud.service.mcs.exception.MCSException

Deletes representation in specified version.

Parameters:

cloudId - id of the record to delete representation version from (required)

representationName - name of the representation (required)

version - the deleted version of the representation (required)

Throws:

eu.europeana.cloud.service.mcs.exception.RepresentationNotExistsException - if specified representation does not exist

eu.europeana.cloud.service.mcs.exception.CannotModifyPersistentRepresentationException - if specified representation is persistent and thus cannot be removed

eu.europeana.cloud.service.mcs.exception.MCSException - on unexpected situations

copyRepresentation

public URI copyRepresentation(String cloudId,
                     String representationName,
                     String version)
                       throws eu.europeana.cloud.service.mcs.exception.RepresentationNotExistsException,
                              eu.europeana.cloud.service.mcs.exception.MCSException

Copies all information from one representation version to another. Copies all information with all files and their content from one representation version to a new temporary one.

Parameters:

cloudId - id of the record that holds representation (required)

representationName - name of the copied representation (required)

version - version of the copied representation (required)

Returns:

URI to the created copy of representation

Throws:

eu.europeana.cloud.service.mcs.exception.RepresentationNotExistsException - if specified representation version does not exist

eu.europeana.cloud.service.mcs.exception.MCSException - on unexpected situations

persistRepresentation

public URI persistRepresentation(String cloudId,
                        String representationName,
                        String version)
                          throws eu.europeana.cloud.service.mcs.exception.RepresentationNotExistsException,
                                 eu.europeana.cloud.service.mcs.exception.CannotModifyPersistentRepresentationException,
                                 eu.europeana.cloud.service.mcs.exception.CannotPersistEmptyRepresentationException,
                                 eu.europeana.cloud.service.mcs.exception.MCSException

Makes specified temporary representation version persistent.

Parameters:

cloudId - id of the record that holds representation (required)

representationName - name of the representation to be persisted (required)

version - version that should be made persistent (required)

Returns:

URI to the persisted representation

Throws:

eu.europeana.cloud.service.mcs.exception.RepresentationNotExistsException - when representation does not exist in specified version

eu.europeana.cloud.service.mcs.exception.CannotModifyPersistentRepresentationException - when representation version is already persistent

eu.europeana.cloud.service.mcs.exception.CannotPersistEmptyRepresentationException - when representation version has no file attached and thus cannot be made persistent

eu.europeana.cloud.service.mcs.exception.MCSException - on unexpected situations

grantPermissionsToVersion

public void grantPermissionsToVersion(String cloudId,
                             String representationName,
                             String version,
                             String userName,
                             eu.europeana.cloud.common.model.Permission permission)
                               throws eu.europeana.cloud.service.mcs.exception.MCSException

Adds selected permission(s) to selected representation version.

Parameters:

cloudId - record identifier

representationName - representation name

version - representation version

userName - user who will get access to representation version

permission - permission that will be granted

Throws:

eu.europeana.cloud.service.mcs.exception.MCSException

revokePermissionsToVersion

public void revokePermissionsToVersion(String cloudId,
                              String representationName,
                              String version,
                              String userName,
                              eu.europeana.cloud.common.model.Permission permission)
                                throws eu.europeana.cloud.service.mcs.exception.MCSException

Revokes permission(s) to selected representation version.

Parameters:

cloudId - record identifier

representationName - representation name

version - representation version

userName - user who will get access to representation version

permission - permission that will be granted

Throws:

eu.europeana.cloud.service.mcs.exception.MCSException

permitVersion

public void permitVersion(String cloudId,
                 String representationName,
                 String version)
                   throws eu.europeana.cloud.service.mcs.exception.MCSException

Adds selected permission(s) to selected representation version.

Parameters:

cloudId - record identifier

representationName - representation name

version - representation version

Throws:

eu.europeana.cloud.service.mcs.exception.MCSException