eu.europeana.cloud.service.mcs

Interface RecordService

public interface RecordService

Service for manipulating representations and their content.

Method Summary

Methods

Modifier and Type	Method and Description
void	addRevision(String globalId, String schema, String version, eu.europeana.cloud.common.model.Revision revision) Creates or overrides revision with specific name.
eu.europeana.cloud.common.model.Representation	copyRepresentation(String globalId, String schema, String version) Creates a new temporary representation version from already existing version.
eu.europeana.cloud.common.model.Representation	createRepresentation(String globalId, String schema, String providerId) Creates a new representation version of a record.
void	deleteContent(String globalId, String schema, String version, String fileName) Deletes specified file from temporary representation version.
void	deleteRecord(String globalId) Deletes record with all its representations (even those not returned by getRecord), both persistent and temporary.
void	deleteRepresentation(String globalId, String schema) Deletes representation of a record in specific schema with all versions (temporary and persistent).
void	deleteRepresentation(String globalId, String schema, String version) Deletes a specified representation version of a record.
void	getContent(String globalId, String schema, String version, String fileName, long rangeStart, long rangeEnd, OutputStream outputStream) Copy a range of the file content to the output stream.
String	getContent(String globalId, String schema, String version, String fileName, OutputStream os) Fetches content of specified file in specified representation version and writes it into output stream.
eu.europeana.cloud.common.model.File	getFile(String globalId, String schema, String version, String fileName) Gets file metadata from a specified representation version.
eu.europeana.cloud.common.model.Record	getRecord(String globalId) Returns latest persistent versions of all representations of the record.
eu.europeana.cloud.common.model.Representation	getRepresentation(String globalId, String schema) Returns latest persistent version of particular representation of a record.
eu.europeana.cloud.common.model.Representation	getRepresentation(String globalId, String schema, String version) Returns a representation of a record in specified schema and version (might be persistent or not).
eu.europeana.cloud.common.response.RepresentationRevisionResponse	getRepresentationRevision(String globalId, String schema, String revisionProviderId, String revisionName, Date revisionTimestamp) Get RepresentationRevisionResponse object basing on cloud identifier, schema identifier and revision identifier.
eu.europeana.cloud.common.model.Revision	getRevision(String globalId, String schema, String version, String revisionKey) Gets Revision from a specified representation version.
void	insertRepresentationRevision(String globalId, String schema, String revisionProviderId, String revisionName, String versionId, Date revisionTimestamp) Insert information about representation revision association.
List<eu.europeana.cloud.common.model.Representation>	listRepresentationVersions(String globalId, String schema) Lists all (persistent or not) versions of a record representation.
eu.europeana.cloud.common.model.Representation	persistRepresentation(String globalId, String schema, String version) Makes a certain temporary representation version a persistent one.
boolean	putContent(String globalId, String schema, String version, eu.europeana.cloud.common.model.File file, InputStream content) Creates or overrides file with specific name in specified representation version.

Method Detail

getRecord

eu.europeana.cloud.common.model.Record getRecord(String globalId)
                                                 throws RecordNotExistsException

Returns latest persistent versions of all representations of the record. The returned record would not contain any trace of representations that do not contain any persistent version. Particularly, if there is no representation for this record or threre are only temporary representations, the returned record will be empty (but not null).

Parameters:

globalId - id for the record.

Returns:

record containing all latest persistent versions of all its representations.

Throws:

RecordNotExistsException - thrown if provided id is not registered id in the eCloud system.

deleteRecord

void deleteRecord(String globalId)
                  throws RecordNotExistsException,
                         RepresentationNotExistsException

Deletes record with all its representations (even those not returned by getRecord), both persistent and temporary.

Parameters:

globalId - id for the record

Throws:

RecordNotExistsException - thrown if provided id is not registered id in the eCloud system.

RepresentationNotExistsException - thrown if no representation can be found for requested record. Service cannot delete such record.

getRepresentation

eu.europeana.cloud.common.model.Representation getRepresentation(String globalId,
                                                               String schema)
                                                                 throws RepresentationNotExistsException

Returns latest persistent version of particular representation of a record.

Parameters:

globalId - id for the record

schema - schema of representation

Returns:

latest persistent version of representation in specified schema

Throws:

RepresentationNotExistsException - thrown if there is no representation for provided record and schema or such representation exists but is not persistent.

getRepresentation

eu.europeana.cloud.common.model.Representation getRepresentation(String globalId,
                                                               String schema,
                                                               String version)
                                                                 throws RepresentationNotExistsException

Returns a representation of a record in specified schema and version (might be persistent or not).

Parameters:

globalId - id of the record

schema - schema of the representation

version - version of the representation.

Returns:

representation.

Throws:

RepresentationNotExistsException - such representation does not exist in specified version.

listRepresentationVersions

List<eu.europeana.cloud.common.model.Representation> listRepresentationVersions(String globalId,
                                                                              String schema)
                                                                                throws RepresentationNotExistsException

Lists all (persistent or not) versions of a record representation.

Parameters:

globalId - id of the record

schema - schema of the representation

Returns:

list of representation versions.

Throws:

RepresentationNotExistsException - there is no representation in provided schema for specified record.

deleteRepresentation

void deleteRepresentation(String globalId,
                        String schema)
                          throws RepresentationNotExistsException

Deletes representation of a record in specific schema with all versions (temporary and persistent).

Parameters:

globalId - id of the record

schema - schema of the representation

Throws:

RepresentationNotExistsException - there is no representation in provided schema for specified record.

deleteRepresentation

void deleteRepresentation(String globalId,
                        String schema,
                        String version)
                          throws RepresentationNotExistsException,
                                 CannotModifyPersistentRepresentationException

Deletes a specified representation version of a record. Only temporary representations can be removed using this method!

Parameters:

globalId - id of the record

schema - schema of the representation

version - version of the representation

Throws:

RepresentationNotExistsException - such representation does not exist in specified version.

CannotModifyPersistentRepresentationException - specified representation version is persistent and cannot deleted.

createRepresentation

eu.europeana.cloud.common.model.Representation createRepresentation(String globalId,
                                                                  String schema,
                                                                  String providerId)
                                                                    throws RecordNotExistsException,
                                                                           ProviderNotExistsException

Creates a new representation version of a record. A version of newly created representation might be obtained from returned representation object.

Parameters:

globalId - id of the record

schema - schema of the representation

providerId - provider who created this representation version.

Returns:

newly created representation.

Throws:

RecordNotExistsException - provided id of a record is not registered in eCloud system.

ProviderNotExistsException - there is no such provider

persistRepresentation

eu.europeana.cloud.common.model.Representation persistRepresentation(String globalId,
                                                                   String schema,
                                                                   String version)
                                                                     throws RepresentationNotExistsException,
                                                                            CannotModifyPersistentRepresentationException,
                                                                            CannotPersistEmptyRepresentationException

Makes a certain temporary representation version a persistent one. A representation version must contain files in order to be made persistent.

Parameters:

globalId - id of the record

schema - schema of the representation

version - version of the representation

Returns:

a persisted representation.

Throws:

RepresentationNotExistsException - such representation does not exist in specified version.

CannotModifyPersistentRepresentationException - the representation version is already persistent.

CannotPersistEmptyRepresentationException - the representation version does not contain files.

copyRepresentation

eu.europeana.cloud.common.model.Representation copyRepresentation(String globalId,
                                                                String schema,
                                                                String version)
                                                                  throws RepresentationNotExistsException

Creates a new temporary representation version from already existing version. The new representation version will have all the same properties and files as the base one but will be temporary and new version id will be assigned to it.

Parameters:

globalId - id of the record

schema - schema of the representation

version - version of the representation which will be the base of the new version.

Returns:

copied representation

Throws:

RepresentationNotExistsException - representation does not exist in specified version.

putContent

boolean putContent(String globalId,
                 String schema,
                 String version,
                 eu.europeana.cloud.common.model.File file,
                 InputStream content)
                   throws CannotModifyPersistentRepresentationException,
                          RepresentationNotExistsException

Creates or overrides file with specific name in specified representation version.

Parameters:

globalId - id of the record

schema - schema of the representation

version - version of the representation

file - eCloud file representing content metadata. This object MUST contain fileName and SHOULD contain mime type.

content - stream of file content.

Returns:

true if new file was added, false if file already existed in representation version and only its content was updated.

Throws:

RepresentationNotExistsException - representation does not exist in specified version.

CannotModifyPersistentRepresentationException - specified representation version is persistent so its files cannot be modified.

getContent

void getContent(String globalId,
              String schema,
              String version,
              String fileName,
              long rangeStart,
              long rangeEnd,
              OutputStream outputStream)
                throws RepresentationNotExistsException,
                       FileNotExistsException,
                       WrongContentRangeException

Copy a range of the file content to the output stream. File is identified by global identifier, schema, version number and file name. Range start and range end starts at zero.

Parameters:

globalId - record identifier

schema - record schema

version - version number

fileName - file name

rangeStart - initial index of the range, inclusive

rangeEnd - final index of the range, inclusive.

outputStream - output stream

Throws:

RepresentationNotExistsException - representation does not exist in specified version.

FileNotExistsException - if file with given name does not exist

WrongContentRangeException - if range is invalid

getFile

eu.europeana.cloud.common.model.File getFile(String globalId,
                                           String schema,
                                           String version,
                                           String fileName)
                                             throws RepresentationNotExistsException,
                                                    FileNotExistsException

Gets file metadata from a specified representation version.

Parameters:

globalId - id of the record

schema - schema of the representation

version - version of the representation

fileName - name of requested file.

Returns:

File metadata

Throws:

RepresentationNotExistsException - representation does not exist in specified version.

FileNotExistsException - if file with given name does not exist in representation version

getContent

String getContent(String globalId,
                String schema,
                String version,
                String fileName,
                OutputStream os)
                  throws RepresentationNotExistsException,
                         FileNotExistsException

Fetches content of specified file in specified representation version and writes it into output stream.

Parameters:

globalId - id of the record

schema - schema of the representation

version - version of the representation

fileName - name of requested file.

os - stream which the content will be written into.

Returns:

md5 of content

Throws:

RepresentationNotExistsException - representation does not exist in specified version.

FileNotExistsException - if file with given name does not exist in representation version

deleteContent

void deleteContent(String globalId,
                 String schema,
                 String version,
                 String fileName)
                   throws RepresentationNotExistsException,
                          FileNotExistsException,
                          CannotModifyPersistentRepresentationException

Deletes specified file from temporary representation version.

Parameters:

globalId - id of the record

schema - schema of the representation

version - version of the representation

fileName - name of file to be removed

Throws:

RepresentationNotExistsException - representation does not exist in specified version.

FileNotExistsException - if file with given name does not exist in representation version

CannotModifyPersistentRepresentationException - specified representation version is persistent.

getRevision

eu.europeana.cloud.common.model.Revision getRevision(String globalId,
                                                   String schema,
                                                   String version,
                                                   String revisionKey)
                                                     throws RepresentationNotExistsException,
                                                            RevisionNotExistsException

Gets Revision from a specified representation version.

Parameters:

globalId - id of the record

schema - schema of the representation

version - version of the representation

revisionKey - name of revision key providerId_revisionName.

Returns:

Revision attributes

Throws:

RepresentationNotExistsException - representation does not exist in specified version.

RevisionNotExistsException - if revision with given key does not exist in representation version

addRevision

void addRevision(String globalId,
               String schema,
               String version,
               eu.europeana.cloud.common.model.Revision revision)
                 throws RevisionIsNotValidException

Creates or overrides revision with specific name.

Parameters:

globalId - id of the record

schema - schema of the representation

version - version of the representation

revision - eCloud revision. This object MUST contain providerId and revisionName type.

Throws:

RevisionIsNotValidException

getRepresentationRevision

eu.europeana.cloud.common.response.RepresentationRevisionResponse getRepresentationRevision(String globalId,
                                                                                          String schema,
                                                                                          String revisionProviderId,
                                                                                          String revisionName,
                                                                                          Date revisionTimestamp)

Get RepresentationRevisionResponse object basing on cloud identifier, schema identifier and revision identifier.

Parameters:

globalId - cloud identifier associated with the resulting representation revision

schema - representation name of the resulting representation revision

revisionProviderId - revision provider identifier of the resulting representation revision

revisionName - revision name

revisionTimestamp - revision timestamp

Returns:

RepresentationRevisionResponse object that associates cloud identifier, representation name, revision identifier, version identifier and files map

insertRepresentationRevision

void insertRepresentationRevision(String globalId,
                                String schema,
                                String revisionProviderId,
                                String revisionName,
                                String versionId,
                                Date revisionTimestamp)

Insert information about representation revision association.

Parameters:

globalId - cloud identifier

schema - representation name

revisionProviderId - revision provider identifier of the resulting representation revision

revisionName - revision name

revisionTimestamp - revision timestamp

versionId - version identifier