eu.europeana.corelib.web.service

Interface MediaStorageService

All Known Implementing Classes:

MediaStorageServiceImpl

public interface MediaStorageService

Method Summary

Modifier and Type	Method and Description
Boolean	checkIfExists(String id) Checks if a particular file with the provided id is present in the media storage
byte[]	convertPayloadToByteArray(org.jclouds.io.Payload payload) Helper class to convert payload to an array of bytes
void	createOrModify(MediaFile file) Deprecated. September 2018, no longer needed/required
void	delete(String id) Deprecated. September 2018, no longer needed/required
MediaFile	retrieveAsMediaFile(String id, String originalUrl, boolean withContent) Retrieves a file from media storage with or without the content.
eu.europeana.domain.StorageObject	retrieveAsStorageObject(String id, boolean withContent) Retrieves a file from media storage with or without the content.
byte[]	retrieveContent(String id) Retrieves only the content of a media file (so no metadata)
eu.europeana.domain.ObjectMetadata	retrieveMetaData(String id) Retrieves only the metadata of a media file

Method Detail

checkIfExists

Boolean checkIfExists(String id)

Checks if a particular file with the provided id is present in the media storage

Parameters:

id - the id of the file

Returns:

true if the file is present, false if it is not

retrieveAsMediaFile

MediaFile retrieveAsMediaFile(String id,
                              String originalUrl,
                              boolean withContent)

Retrieves a file from media storage with or without the content.

Parameters:

id - the id of the file

originalUrl -

withContent - boolean which indicates whether the actual contents should be retrieved, or only the metadata of the file

Returns:

an object which contains all the metadata of the file and optionally the actual content

retrieveAsStorageObject

eu.europeana.domain.StorageObject retrieveAsStorageObject(String id,
                                                          boolean withContent)

Retrieves a file from media storage with or without the content. Note that this method is a bit faster than retrieveAsMediaFile, but does require you to process a payload to access the actual file content (@see convertPayloadToByteArray) which makes it equally fast.

Parameters:

id - the id of the file

withContent - boolean which indicates whether the actual contents should be retrieved, or only the metadata of the file

Returns:

an object which contains all the metadata of the file and optionally the actual content

convertPayloadToByteArray

byte[] convertPayloadToByteArray(org.jclouds.io.Payload payload)
                          throws IOException

Helper class to convert payload to an array of bytes

Parameters:

payload -

Returns:

array of bytes representing the payload object

Throws:

IOException

retrieveContent

byte[] retrieveContent(String id)

Retrieves only the content of a media file (so no metadata)

Parameters:

id - the id of the file

Returns:

an array of bytes representing only the media content of the file

retrieveMetaData

eu.europeana.domain.ObjectMetadata retrieveMetaData(String id)

Retrieves only the metadata of a media file

Parameters:

id - the id of the file

Returns:

ObjectMetadata object

createOrModify

@Deprecated
void createOrModify(MediaFile file)

Deprecated. September 2018, no longer needed/required

If the file does not exists in the DB it creates it, otherwise it will be updated.

Parameters:

file - the new/modified MediaFile

delete

@Deprecated
void delete(String id)

Deprecated. September 2018, no longer needed/required

Deletes a file with a given id.

Parameters:

id - the id of the file