Package io.clonecloudstore.driver.api

Interface DriverApi

All Superinterfaces:

AutoCloseable, Closeable

All Known Implementing Classes:

DriverAzure, DriverGoogle, DriverS3, FakeDriver

public interface DriverApi
extends Closeable

Driver Java Interface for Object Storage. This shall be retrieved through the DriverApiFactory and closed when usage is over.

Method Summary

Modifier and Type	Method	Description
StorageBucket	bucketCreate(StorageBucket bucket)	Create one Bucket and returns it
default void	bucketDelete(StorageBucket bucket)	Delete one Bucket if it exists and is empty
void	bucketDelete(String bucket)	Delete one Bucket if it exists and is empty
default boolean	bucketExists(StorageBucket bucket)	Check existence of Bucket
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.
default StorageType	directoryOrObjectExistsInBucket(StorageBucket bucket, String directoryOrObject)	Check if Directory or Object exists in specified Bucket (based on prefix)
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.
default StorageObject	objectCopy(String bucketSource, String objectSource, String bucketTarget, String objectTarget, Map<String,String> targetMetadata, Instant expireDate)	Copy one object to another one, possibly in a different bucket.
default void	objectDeleteInBucket(StorageObject object)	Delete the Object from this Bucket
void	objectDeleteInBucket(String bucket, String object)	Delete the Object from this Bucket
default StorageObject	objectFinalizeCreateInBucket(StorageObject object, long realLen, String sha256)	Second step in creation of an object within a Bucket.
StorageObject	objectFinalizeCreateInBucket(String bucket, String object, long realLen, String sha256)	Second step in creation of an object within a Bucket.
default InputStream	objectGetInputStreamInBucket(StorageObject object)	Get the content of the specified Object within specified Bucket
InputStream	objectGetInputStreamInBucket(String bucket, String object)	Get the content of the specified Object within specified Bucket
default StorageObject	objectGetMetadataInBucket(StorageObject object)	Get the Object metadata from this Bucket (those available from Object Storage)
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.
default long	objectsCountInBucket(StorageBucket bucket)	Count Objects in specified Bucket
default long	objectsCountInBucket(StorageBucket bucket, String prefix, Instant from, Instant to)	Count Objects in specified Bucket with filters (all optionals)
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)
default Iterator<StorageObject>	objectsIteratorInBucket(StorageBucket bucket)	Iterator on Objects in specified Bucket
default Iterator<StorageObject>	objectsIteratorInBucket(StorageBucket bucket, String prefix, Instant from, Instant to)	Iterator on 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)
default Stream<StorageObject>	objectsStreamInBucket(StorageBucket bucket)	Stream Objects in specified Bucket
default Stream<StorageObject>	objectsStreamInBucket(StorageBucket bucket, String prefix, Instant from, Instant to)	Stream 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)
default void	validCopy(StorageObject objectSource, StorageObject objectTarget)

Method Details

bucketsCount

long bucketsCount()
           throws DriverException

Count Buckets

Throws:

DriverException

bucketsStream

Stream<StorageBucket> bucketsStream()
                             throws DriverException

Stream Buckets list

Throws:

DriverException

bucketsIterator

Iterator<StorageBucket> bucketsIterator()
                                 throws DriverException

Iterator on Buckets list

Throws:

DriverException

bucketGet

StorageBucket bucketGet(String bucket)
                 throws DriverNotFoundException,
DriverException

Get one Bucket and returns it

Returns:

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

Throws:

DriverNotFoundException

DriverException

bucketCreate

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

Create one Bucket and returns it

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

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

Import one Bucket and returns it

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

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

Delete one Bucket if it exists and is empty

Throws:

DriverNotAcceptableException

DriverNotFoundException

DriverException

bucketDelete

default void bucketDelete(StorageBucket bucket)
                   throws DriverNotAcceptableException,
DriverNotFoundException,
DriverException

Delete one Bucket if it exists and is empty

Throws:

DriverNotAcceptableException

DriverNotFoundException

DriverException

bucketExists

boolean bucketExists(String bucket)
              throws DriverException

Check existence of Bucket

Throws:

DriverException

bucketExists

default boolean bucketExists(StorageBucket bucket)
                      throws DriverException

Check existence of Bucket

Throws:

DriverException

objectsCountInBucket

long objectsCountInBucket(String bucket)
                   throws DriverNotFoundException,
DriverException

Count Objects in specified Bucket

Throws:

DriverNotFoundException

DriverException

objectsCountInBucket

default long objectsCountInBucket(StorageBucket bucket)
                           throws DriverNotFoundException,
DriverException

Count Objects in specified Bucket

Throws:

DriverNotFoundException

DriverException

objectsCountInBucket

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

Count Objects in specified Bucket with filters (all optionals)

Throws:

DriverNotFoundException

DriverException

objectsCountInBucket

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

Count Objects in specified Bucket with filters (all optionals)

Throws:

DriverNotFoundException

DriverException

objectsStreamInBucket

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

Stream Objects in specified Bucket

Throws:

DriverNotFoundException

DriverException

objectsStreamInBucket

default Stream<StorageObject> objectsStreamInBucket(StorageBucket bucket)
                                             throws DriverNotFoundException,
DriverException

Stream Objects in specified Bucket

Throws:

DriverNotFoundException

DriverException

objectsStreamInBucket

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

Stream Objects in specified Bucket with filters (all optionals)

Throws:

DriverNotFoundException

DriverException

objectsStreamInBucket

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

Stream Objects in specified Bucket with filters (all optionals)

Throws:

DriverNotFoundException

DriverException

objectsIteratorInBucket

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

Iterator on Objects in specified Bucket

Throws:

DriverNotFoundException

DriverException

objectsIteratorInBucket

default Iterator<StorageObject> objectsIteratorInBucket(StorageBucket bucket)
                                                 throws DriverNotFoundException,
DriverException

Iterator on Objects in specified Bucket

Throws:

DriverNotFoundException

DriverException

objectsIteratorInBucket

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

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

Throws:

DriverNotFoundException

DriverException

objectsIteratorInBucket

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

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

Throws:

DriverNotFoundException

DriverException

directoryOrObjectExistsInBucket

StorageType directoryOrObjectExistsInBucket(String bucket,
 String directoryOrObject)
                                     throws DriverException

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

Throws:

DriverException

directoryOrObjectExistsInBucket

default StorageType directoryOrObjectExistsInBucket(StorageBucket bucket,
 String directoryOrObject)
                                             throws DriverException

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

Throws:

DriverException

objectPrepareCreateInBucket

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

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.

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

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

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.

Returns:

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

Throws:

DriverNotFoundException

DriverAlreadyExistException

DriverException

objectFinalizeCreateInBucket

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

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.

Returns:

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

Throws:

DriverNotFoundException

DriverAlreadyExistException

DriverException

objectGetInputStreamInBucket

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

Get the content of the specified Object within specified Bucket

Throws:

DriverNotFoundException

DriverException

objectGetInputStreamInBucket

default InputStream objectGetInputStreamInBucket(StorageObject object)
                                          throws DriverNotFoundException,
DriverException

Get the content of the specified Object within specified Bucket

Throws:

DriverNotFoundException

DriverException

validCopy

default void validCopy(StorageObject objectSource,
 StorageObject objectTarget)
                throws DriverException

Throws:

DriverException

objectCopy

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

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

Parameters:

objectSource - source object

objectTarget - target object

Throws:

DriverNotFoundException

DriverAlreadyExistException

DriverException

objectCopy

default StorageObject objectCopy(String bucketSource,
 String objectSource,
 String bucketTarget,
 String objectTarget,
 Map<String,String> targetMetadata,
 Instant expireDate)
                          throws DriverNotFoundException,
DriverAlreadyExistException,
DriverException

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

Throws:

DriverNotFoundException

DriverAlreadyExistException

DriverException

objectGetMetadataInBucket

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

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

Throws:

DriverNotFoundException

DriverException

objectGetMetadataInBucket

default StorageObject objectGetMetadataInBucket(StorageObject object)
                                         throws DriverNotFoundException,
DriverException

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

Throws:

DriverNotFoundException

DriverException

objectDeleteInBucket

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

Delete the Object from this Bucket

Throws:

DriverNotAcceptableException

DriverNotFoundException

DriverException

objectDeleteInBucket

default void objectDeleteInBucket(StorageObject object)
                           throws DriverNotAcceptableException,
DriverNotFoundException,
DriverException

Delete the Object from this Bucket

Throws:

DriverNotAcceptableException

DriverNotFoundException

DriverException

close

void close()

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