Package io.clonecloudstore.accessor.apache.client

Class AccessorClient

java.lang.Object

io.clonecloudstore.accessor.apache.client.AccessorClient

All Implemented Interfaces:

Closeable, AutoCloseable

public class AccessorClient
extends Object
implements Closeable

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AccessorClient(AccessorApiFactory factory)

Method Summary

Modifier and Type	Method	Description
StorageType	checkBucket(String bucketName)
StorageType	checkObjectOrDirectory(String bucketName, String pathDirectoryOrObject)	Check if object or directory exist
void	close()
AccessorBucket	createBucket(String bucketName)
AccessorObject	createObject(AccessorObject accessorObject, InputStream body)
AccessorObject	createObject(AccessorObject accessorObject, InputStream body, boolean useCompression)
boolean	deleteBucket(String bucketName)
boolean	deleteObject(String bucketName, String objectName)
AccessorBucket	getBucket(String bucketName)
Collection<AccessorBucket>	getBuckets()
InputStreamBusinessOut<AccessorObject>	getObject(String bucketName, String objectName)
InputStreamBusinessOut<AccessorObject>	getObject(String bucketName, String objectName, boolean compressed)	Note: Compression is only between client and server, result InputStream is uncompressed
AccessorObject	getObjectInfo(String bucketName, String objectName)
Iterator<AccessorObject>	listObjects(String bucketName, AccessorFilter filter)	Returns an Iterator containing AccessorObjects

Methods inherited from class java.lang.Object

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

Constructor Details

AccessorClient

protected AccessorClient(AccessorApiFactory factory)

Method Details

getBuckets

public Collection<AccessorBucket> getBuckets()
                                      throws CcsWithStatusException

Returns:

the collection of Buckets

Throws:

CcsWithStatusException

checkBucket

public StorageType checkBucket(String bucketName)
                        throws CcsWithStatusException

Returns:

the StorageType for this Bucket

Throws:

CcsWithStatusException

getBucket

public AccessorBucket getBucket(String bucketName)
                         throws CcsWithStatusException

Returns:

the Bucket Metadata

Throws:

CcsWithStatusException

createBucket

public AccessorBucket createBucket(String bucketName)
                            throws CcsWithStatusException

Returns:

the DTO if the Bucket is created

Throws:

CcsWithStatusException

deleteBucket

public boolean deleteBucket(String bucketName)
                     throws CcsWithStatusException

Returns:

True if deleted (or already deleted), else False or an exception

Throws:

CcsWithStatusException

checkObjectOrDirectory

public StorageType checkObjectOrDirectory(String bucketName,
 String pathDirectoryOrObject)
                                   throws CcsWithStatusException

Check if object or directory exist

Parameters:

pathDirectoryOrObject - may contain only directory, not full path (as prefix)

Returns:

the associated StorageType

Throws:

CcsWithStatusException

getObjectInfo

public AccessorObject getObjectInfo(String bucketName,
 String objectName)
                             throws CcsWithStatusException

Returns:

the associated DTO

Throws:

CcsWithStatusException

getObject

public InputStreamBusinessOut<AccessorObject> getObject(String bucketName,
 String objectName)
                                                 throws CcsWithStatusException

Returns:

both InputStream and Object DTO

Throws:

CcsWithStatusException

getObject

public InputStreamBusinessOut<AccessorObject> getObject(String bucketName,
 String objectName,
 boolean compressed)
                                                 throws CcsWithStatusException

Note: Compression is only between client and server, result InputStream is uncompressed

Returns:

both InputStream and Object DTO

Throws:

CcsWithStatusException

listObjects

public Iterator<AccessorObject> listObjects(String bucketName,
 AccessorFilter filter)
                                     throws CcsWithStatusException

Returns an Iterator containing AccessorObjects

Throws:

CcsWithStatusException

createObject

public AccessorObject createObject(AccessorObject accessorObject,
 InputStream body)
                            throws CcsWithStatusException

Returns:

the associated DTO

Throws:

CcsWithStatusException

createObject

public AccessorObject createObject(AccessorObject accessorObject,
 InputStream body,
 boolean useCompression)
                            throws CcsWithStatusException

Returns:

the associated DTO

Throws:

CcsWithStatusException

deleteObject

public boolean deleteObject(String bucketName,
 String objectName)
                     throws CcsWithStatusException

Returns:

True if deleted (or already deleted), else False or an exception

Throws:

CcsWithStatusException

close

public void close()

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable