eu.europeana.features

Interface ObjectStorageClient

All Known Implementing Classes:

S3ObjectStorageClient, SwiftObjectStorageClient

public interface ObjectStorageClient

Interface to a generic object storage client

Method Summary

Modifier and Type	Method and Description
void	close() Terminate all connections and shut down this client
void	delete(String objectName) Deletes an object, if present.
Optional<StorageObject>	get(String objectName) Gets the StorageObject including its body.
Optional<StorageObject>	get(String objectName, boolean verify) Gets the StorageObject including its body.
String	getBucketName()
byte[]	getContent(String objectName) Get the content of the specified object and return it as a byte array.
ObjectMetadata	getMetaData(String objectName) Get the metadata of the specified object
String	getName()
Optional<StorageObject>	getWithoutBody(String objectName) Gets the StorageObject metadata without its body.
boolean	isAvailable(String id) Check if an object with the provided id exists
List<StorageObject>	list()
String	put(StorageObject storageObject) Creates or updates a StorageObject.
String	put(String id, org.jclouds.io.Payload value) Creates or updates a StorageObject.

Method Detail

getName

String getName()

Returns:

the name of this object storage provider

getBucketName

String getBucketName()

Returns:

the name of the bucket

list

List<StorageObject> list()

Returns:

an List.

isAvailable

boolean isAvailable(String id)

Check if an object with the provided id exists

Parameters:

id -

Returns:

true if it exists, false if it does not exist

put

String put(String id,
           org.jclouds.io.Payload value)

Creates or updates a StorageObject.

Parameters:

id - corresponds to StorageObject.getName().

value - corresponds to StorageObject.getPayload().

Returns:

StorageObject.getETag() of the object.

put

String put(StorageObject storageObject)

Creates or updates a StorageObject.

Parameters:

storageObject - corresponds to StorageObject.getName().

Returns:

StorageObject.getETag() of the object.

getWithoutBody

Optional<StorageObject> getWithoutBody(String objectName)

Gets the StorageObject metadata without its body.

Parameters:

objectName - corresponds to StorageObject.getName().

Returns:

the StorageObject or empty Optional, if not found.

get

Optional<StorageObject> get(String objectName)

Gets the StorageObject including its body. Note that as of version 1.3 we no longer verify if the object was retrieved correctly. To do this you need to use get(String, boolean) method

Parameters:

objectName - corresponds to StorageObject.getName().

Returns:

the StorageObject or empty Optional, if not found.

get

Optional<StorageObject> get(String objectName,
                            boolean verify)
                     throws ContentValidationException

Gets the StorageObject including its body.

Parameters:

objectName - corresponds to StorageObject.getName().

verify - if true then the MD5 hash of the downloaded content is compared to the known MD5 hash stored on the server

Returns:

the StorageObject or empty Optional, if not found.

Throws:

ContentValidationException - thrown when verification of the validity of downloaded content fails.

getContent

byte[] getContent(String objectName)

Get the content of the specified object and return it as a byte array. This is the recommended (fastest) method of retrieving media content like images.

Parameters:

objectName - corresponds to StorageObject.getName().

Returns:

byte array representing the retrieved object, or empty byte array if no object was retrieved

getMetaData

ObjectMetadata getMetaData(String objectName)

Get the metadata of the specified object

Parameters:

objectName - corresponds to StorageObject.getName().

Returns:

ObjectMetadata of the requests object or null if not found.

delete

void delete(String objectName)

Deletes an object, if present.

Parameters:

objectName - corresponds to StorageObject.getName().

close

void close()

Terminate all connections and shut down this client