Package io.clonecloudstore.driver.s3

Class DriverS3

java.lang.Object

io.clonecloudstore.driver.s3.DriverS3

All Implemented Interfaces:

DriverApi, Closeable, AutoCloseable

public class DriverS3
extends Object
implements DriverApi

S3 Driver

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	DriverS3(DriverS3Helper driverS3Helper)

Method Summary

Modifier and Type	Method	Description
StorageBucket	bucketCreate(StorageBucket bucket)	Create one Bucket and returns it
void	bucketDelete(String bucket)	Delete one Bucket if it exists and is empty
boolean	bucketExists(String bucket)	Check existence of Bucket
StorageBucket	bucketGet(String bucket)	Get one Bucket and returns it
StorageBucket	bucketImport(StorageBucket bucket)	Import one Bucket and returns it
long	bucketsCount()	Count Buckets
Iterator<StorageBucket>	bucketsIterator()	Iterator on Buckets list
Stream<StorageBucket>	bucketsStream()	Stream Buckets list
void	close()	Close with no exception.
StorageType	directoryOrObjectExistsInBucket(String bucket, String directoryOrObject)	Check if Directory or Object exists in specified Bucket (based on prefix)
StorageObject	objectCopy(StorageObject objectSource, StorageObject objectTarget)	Copy one object to another one, possibly in a different bucket.
void	objectDeleteInBucket(String bucket, String object)	Delete the Object from this Bucket
StorageObject	objectFinalizeCreateInBucket(String bucket, String object, long realLen, String sha256)	Second step in creation of an object within a Bucket.
InputStream	objectGetInputStreamInBucket(String bucket, String object)	Get the content of the specified Object within specified Bucket
StorageObject	objectGetMetadataInBucket(String bucket, String object)	Get the Object metadata from this Bucket (those available from Object Storage)
void	objectPrepareCreateInBucket(StorageObject object, InputStream inputStream)	First step in creation of an object within a Bucket.
long	objectsCountInBucket(String bucket)	Count Objects in specified Bucket
long	objectsCountInBucket(String bucket, String prefix, Instant from, Instant to)	Count Objects in specified Bucket with filters (all optionals)
Iterator<StorageObject>	objectsIteratorInBucket(String bucket)	Iterator on Objects in specified Bucket
Iterator<StorageObject>	objectsIteratorInBucket(String bucket, String prefix, Instant from, Instant to)	Iterator on Objects in specified Bucket with filters (all optionals)
Stream<StorageObject>	objectsStreamInBucket(String bucket)	Stream Objects in specified Bucket
Stream<StorageObject>	objectsStreamInBucket(String bucket, String prefix, Instant from, Instant to)	Stream Objects in specified Bucket with filters (all optionals)

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.clonecloudstore.driver.api.DriverApi

bucketDelete, bucketExists, directoryOrObjectExistsInBucket, objectCopy, objectDeleteInBucket, objectFinalizeCreateInBucket, objectGetInputStreamInBucket, objectGetMetadataInBucket, objectsCountInBucket, objectsCountInBucket, objectsIteratorInBucket, objectsIteratorInBucket, objectsStreamInBucket, objectsStreamInBucket, validCopy

Constructor Details

DriverS3

protected DriverS3(DriverS3Helper driverS3Helper)
            throws DriverRuntimeException

Throws:

DriverRuntimeException

Method Details

bucketsCount

public long bucketsCount()
                  throws DriverException

Description copied from interface: DriverApi

Count Buckets

Specified by:

bucketsCount in interface DriverApi

Throws:

DriverException

bucketsStream

public Stream<StorageBucket> bucketsStream()
                                    throws DriverException

Description copied from interface: DriverApi

Stream Buckets list

Specified by:

bucketsStream in interface DriverApi

Throws:

DriverException

bucketsIterator

public Iterator<StorageBucket> bucketsIterator()
                                        throws DriverException

Description copied from interface: DriverApi

Iterator on Buckets list

Specified by:

bucketsIterator in interface DriverApi

Throws:

DriverException

bucketGet

public StorageBucket bucketGet(String bucket)
                        throws DriverNotFoundException,
DriverException

Description copied from interface: DriverApi

Get one Bucket and returns it

Specified by:

bucketGet in interface DriverApi

Returns:

the StorageBucket as instantiated within the Object Storage (real values)

Throws:

DriverNotFoundException

DriverException

bucketCreate

public StorageBucket bucketCreate(StorageBucket bucket)
                           throws DriverNotAcceptableException,
DriverAlreadyExistException,
DriverException

Description copied from interface: DriverApi

Create one Bucket and returns it

Specified by:

bucketCreate in interface DriverApi

Parameters:

bucket - contains various information that could be implemented within Object Storage, but, except the name of the bucket and the client Id, nothing is mandatory

Returns:

the StorageBucket as instantiated within the Object Storage (real values)

Throws:

DriverNotAcceptableException

DriverAlreadyExistException

DriverException

bucketImport

public StorageBucket bucketImport(StorageBucket bucket)
                           throws DriverNotAcceptableException,
DriverAlreadyExistException,
DriverException

Description copied from interface: DriverApi

Import one Bucket and returns it

Specified by:

bucketImport in interface DriverApi

Parameters:

bucket - contains various information that could be implemented within Object Storage, but, except the name of the bucket and the client Id, nothing is mandatory

Returns:

the StorageBucket as instantiated within the Object Storage (real values)

Throws:

DriverNotAcceptableException

DriverAlreadyExistException

DriverException

bucketDelete

public void bucketDelete(String bucket)
                  throws DriverNotAcceptableException,
DriverNotFoundException,
DriverException

Description copied from interface: DriverApi

Delete one Bucket if it exists and is empty

Specified by:

bucketDelete in interface DriverApi

Throws:

DriverNotAcceptableException

DriverNotFoundException

DriverException

bucketExists

public boolean bucketExists(String bucket)
                     throws DriverException

Description copied from interface: DriverApi

Check existence of Bucket

Specified by:

bucketExists in interface DriverApi

Throws:

DriverException

objectsCountInBucket

public long objectsCountInBucket(String bucket)
                          throws DriverNotFoundException,
DriverException

Description copied from interface: DriverApi

Count Objects in specified Bucket

Specified by:

objectsCountInBucket in interface DriverApi

Throws:

DriverNotFoundException

DriverException

objectsCountInBucket

public long objectsCountInBucket(String bucket,
 String prefix,
 Instant from,
 Instant to)
                          throws DriverNotFoundException,
DriverException

Description copied from interface: DriverApi

Count Objects in specified Bucket with filters (all optionals)

Specified by:

objectsCountInBucket in interface DriverApi

Throws:

DriverNotFoundException

DriverException

objectsStreamInBucket

public Stream<StorageObject> objectsStreamInBucket(String bucket)
                                            throws DriverNotFoundException,
DriverException

Description copied from interface: DriverApi

Stream Objects in specified Bucket

Specified by:

objectsStreamInBucket in interface DriverApi

Throws:

DriverNotFoundException

DriverException

objectsStreamInBucket

public Stream<StorageObject> objectsStreamInBucket(String bucket,
 String prefix,
 Instant from,
 Instant to)
                                            throws DriverNotFoundException,
DriverException

Description copied from interface: DriverApi

Stream Objects in specified Bucket with filters (all optionals)

Specified by:

objectsStreamInBucket in interface DriverApi

Throws:

DriverNotFoundException

DriverException

objectsIteratorInBucket

public Iterator<StorageObject> objectsIteratorInBucket(String bucket)
                                                throws DriverNotFoundException,
DriverException

Description copied from interface: DriverApi

Iterator on Objects in specified Bucket

Specified by:

objectsIteratorInBucket in interface DriverApi

Throws:

DriverNotFoundException

DriverException

objectsIteratorInBucket

public Iterator<StorageObject> objectsIteratorInBucket(String bucket,
 String prefix,
 Instant from,
 Instant to)
                                                throws DriverNotFoundException,
DriverException

Description copied from interface: DriverApi

Iterator on Objects in specified Bucket with filters (all optionals)

Specified by:

objectsIteratorInBucket in interface DriverApi

Throws:

DriverNotFoundException

DriverException

directoryOrObjectExistsInBucket

public StorageType directoryOrObjectExistsInBucket(String bucket,
 String directoryOrObject)
                                            throws DriverException

Description copied from interface: DriverApi

Check if Directory or Object exists in specified Bucket (based on prefix)

Specified by:

directoryOrObjectExistsInBucket in interface DriverApi

Throws:

DriverException

objectPrepareCreateInBucket

public void objectPrepareCreateInBucket(StorageObject object,
 InputStream inputStream)
                                 throws DriverNotFoundException,
DriverAlreadyExistException,
DriverException

Description copied from interface: DriverApi

First step in creation of an object within a Bucket. The InputStream is ready to be read in a concurrent independent thread to be provided by the driver. Sha256 might be null or empty. Len might be 0, meaning unknown.

Specified by:

objectPrepareCreateInBucket in interface DriverApi

Parameters:

object - contains various information that could be implemented within Object Storage, but, except the name of the bucket and the key of the object, nothing is mandatory

Throws:

DriverNotFoundException

DriverAlreadyExistException

DriverException

objectFinalizeCreateInBucket

public StorageObject objectFinalizeCreateInBucket(String bucket,
 String object,
 long realLen,
 String sha256)
                                           throws DriverNotFoundException,
DriverAlreadyExistException,
DriverException

Description copied from interface: DriverApi

Second step in creation of an object within a Bucket. Sha256 might be null or empty. Reallen must not be 0. This method waits for the prepare method to end and returns the final result.

Specified by:

objectFinalizeCreateInBucket in interface DriverApi

Returns:

the StorageObject as instantiated within the Object Storage (real values)

Throws:

DriverNotFoundException

DriverAlreadyExistException

DriverException

objectGetInputStreamInBucket

public InputStream objectGetInputStreamInBucket(String bucket,
 String object)
                                         throws DriverNotFoundException,
DriverException

Description copied from interface: DriverApi

Get the content of the specified Object within specified Bucket

Specified by:

objectGetInputStreamInBucket in interface DriverApi

Throws:

DriverNotFoundException

DriverException

objectCopy

public StorageObject objectCopy(StorageObject objectSource,
 StorageObject objectTarget)
                         throws DriverNotFoundException,
DriverAlreadyExistException,
DriverException

Description copied from interface: DriverApi

Copy one object to another one, possibly in a different bucket. Hash and Size come from given source, while Metadata and expired date come from target

Specified by:

objectCopy in interface DriverApi

Parameters:

objectSource - source object

objectTarget - target object

Throws:

DriverNotFoundException

DriverAlreadyExistException

DriverException

objectGetMetadataInBucket

public StorageObject objectGetMetadataInBucket(String bucket,
 String object)
                                        throws DriverNotFoundException,
DriverException

Description copied from interface: DriverApi

Get the Object metadata from this Bucket (those available from Object Storage)

Specified by:

objectGetMetadataInBucket in interface DriverApi

Throws:

DriverNotFoundException

DriverException

objectDeleteInBucket

public void objectDeleteInBucket(String bucket,
 String object)
                          throws DriverNotAcceptableException,
DriverNotFoundException,
DriverException

Description copied from interface: DriverApi

Delete the Object from this Bucket

Specified by:

objectDeleteInBucket in interface DriverApi

Throws:

DriverNotAcceptableException

DriverNotFoundException

DriverException

close

public void close()

Description copied from interface: DriverApi

Close with no exception. Closes this resource, relinquishing any underlying resources. This method is invoked automatically on objects managed by the try-with-resources statement.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Specified by:

close in interface DriverApi