eu.europeana.features

Class S3ObjectStorageClient

java.lang.Object

eu.europeana.features.S3ObjectStorageClient

All Implemented Interfaces:

ObjectStorageClient

public class S3ObjectStorageClient
extends Object
implements ObjectStorageClient

Client for accessing objects stored on (Amazon or Bluemix or ...) S3 service. Created by jeroen on 14-12-16; adapted to IBM Bluemix S3 by Luthien, Jan 18

Constructor Summary

Constructors

Constructor and Description
S3ObjectStorageClient(String clientKey, String secretKey, String region, String bucketName) Create a new S3 client for Amazon S3
S3ObjectStorageClient(String clientKey, String secretKey, String bucketName, String endpoint, com.amazonaws.services.s3.S3ClientOptions s3ClientOptions) Create a new S3 client and specify an endpoint and options
S3ObjectStorageClient(String clientKey, String secretKey, String region, String bucketName, String endpoint) Create a new S3 client for IBM Cloud/Bluemix.

Method Summary

Modifier and Type	Method and Description
void	close() Terminate all connections and shut down this client
com.amazonaws.services.s3.model.Bucket	createBucket(String bucketName) Create a new bucket with the provided name and switch to this new bucket
void	delete(String objectName) Deletes an object, if present.
void	deleteBucket(String bucket) Delete a bucket (requires admin privileges)
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 id) 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()
List<com.amazonaws.services.s3.model.Bucket>	listBuckets()
String	put(StorageObject storageObject) Creates or updates a StorageObject.
String	put(String key, org.jclouds.io.Payload value) Creates or updates a StorageObject.
void	setEndpoint(String endpoint)
void	setS3ClientOptions(com.amazonaws.services.s3.S3ClientOptions s3ClientOptions)

Methods inherited from class java.lang.Object

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

Constructor Detail

S3ObjectStorageClient

public S3ObjectStorageClient(String clientKey,
                             String secretKey,
                             String region,
                             String bucketName)

Create a new S3 client for Amazon S3

Parameters:

clientKey -

secretKey -

region -

bucketName -

S3ObjectStorageClient

public S3ObjectStorageClient(String clientKey,
                             String secretKey,
                             String region,
                             String bucketName,
                             String endpoint)

Create a new S3 client for IBM Cloud/Bluemix. Calling this constructor sets the boolean isBlueMix to true; it is used to switch to the correct way of constructing the Object URI when using resource path addressing (used by Bluemix) instead of virtual host addressing (default usage with Amazon S3). Also note that the region parameter is superfluous, but I will maintain it for now in order to be able to overload the constructor (using 5 Strings, hence different from the other two)

Parameters:

clientKey -

secretKey -

region -

bucketName -

endpoint -

S3ObjectStorageClient

public S3ObjectStorageClient(String clientKey,
                             String secretKey,
                             String bucketName,
                             String endpoint,
                             com.amazonaws.services.s3.S3ClientOptions s3ClientOptions)

Create a new S3 client and specify an endpoint and options

Parameters:

clientKey -

secretKey -

bucketName -

endpoint -

s3ClientOptions -

Method Detail

getName

public String getName()

Specified by:

getName in interface ObjectStorageClient

Returns:

the name of this object storage provider

See Also:

ObjectStorageClient.getName()

getBucketName

public String getBucketName()

Specified by:

getBucketName in interface ObjectStorageClient

Returns:

the name of the bucket

See Also:

ObjectStorageClient.getBucketName()

list

public List<StorageObject> list()

Specified by:

list in interface ObjectStorageClient

Returns:

an List.

See Also:

ObjectStorageClient.list()

isAvailable

public boolean isAvailable(String id)

Description copied from interface: ObjectStorageClient

Check if an object with the provided id exists

Specified by:

isAvailable in interface ObjectStorageClient

Returns:

true if it exists, false if it does not exist

See Also:

ObjectStorageClient.isAvailable(String)

setEndpoint

public void setEndpoint(String endpoint)

put

public String put(StorageObject storageObject)

Description copied from interface: ObjectStorageClient

Creates or updates a StorageObject.

Specified by:

put in interface ObjectStorageClient

Parameters:

storageObject - corresponds to StorageObject.getName().

Returns:

StorageObject.getETag() of the object.

See Also:

ObjectStorageClient.put(StorageObject)

put

public String put(String key,
                  org.jclouds.io.Payload value)

Description copied from interface: ObjectStorageClient

Creates or updates a StorageObject.

Specified by:

put in interface ObjectStorageClient

Parameters:

key - corresponds to StorageObject.getName().

value - corresponds to StorageObject.getPayload().

Returns:

StorageObject.getETag() of the object.

See Also:

ObjectStorageClient.put(String, Payload)

getWithoutBody

public Optional<StorageObject> getWithoutBody(String objectName)

Description copied from interface: ObjectStorageClient

Gets the StorageObject metadata without its body.

Specified by:

getWithoutBody in interface ObjectStorageClient

Parameters:

objectName - corresponds to StorageObject.getName().

Returns:

the StorageObject or empty Optional, if not found.

See Also:

ObjectStorageClient.getWithoutBody(String)

get

public Optional<StorageObject> get(String objectName)

Description copied from interface: ObjectStorageClient

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 ObjectStorageClient.get(String, boolean) method

Specified by:

get in interface ObjectStorageClient

Parameters:

objectName - corresponds to StorageObject.getName().

Returns:

the StorageObject or empty Optional, if not found.

See Also:

ObjectStorageClient.get(String)

get

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

Description copied from interface: ObjectStorageClient

Gets the StorageObject including its body.

Specified by:

get in interface ObjectStorageClient

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.

See Also:

ObjectStorageClient.get(String, boolean)

getContent

public byte[] getContent(String objectName)

Description copied from interface: ObjectStorageClient

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.

Specified by:

getContent in interface ObjectStorageClient

Parameters:

objectName - corresponds to StorageObject.getName().

Returns:

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

See Also:

ObjectStorageClient.getContent(String)

getMetaData

public ObjectMetadata getMetaData(String id)

Description copied from interface: ObjectStorageClient

Get the metadata of the specified object

Specified by:

getMetaData in interface ObjectStorageClient

Parameters:

id - corresponds to StorageObject.getName().

Returns:

ObjectMetadata of the requests object or null if not found.

See Also:

ObjectStorageClient.getMetaData(String)

delete

public void delete(String objectName)

Description copied from interface: ObjectStorageClient

Deletes an object, if present.

Specified by:

delete in interface ObjectStorageClient

Parameters:

objectName - corresponds to StorageObject.getName().

See Also:

ObjectStorageClient.delete(String)

close

public void close()

Description copied from interface: ObjectStorageClient

Terminate all connections and shut down this client

Specified by:

close in interface ObjectStorageClient

See Also:

ObjectStorageClient.close()

createBucket

public com.amazonaws.services.s3.model.Bucket createBucket(String bucketName)

Create a new bucket with the provided name and switch to this new bucket

Parameters:

bucketName -

Returns:

the newly created bucket

listBuckets

public List<com.amazonaws.services.s3.model.Bucket> listBuckets()

Returns:

a list of all buckets

deleteBucket

public void deleteBucket(String bucket)

Delete a bucket (requires admin privileges)

Parameters:

bucket -

setS3ClientOptions

public void setS3ClientOptions(com.amazonaws.services.s3.S3ClientOptions s3ClientOptions)