com.distelli.objectStore

Interface ObjectStore

public interface ObjectStore

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	ObjectStore.Builder
static interface	ObjectStore.Factory

Method Summary

Modifier and Type	Method and Description
void	abortPut(ObjectPartKey partKey) Abort a multipart put.
void	completePut(ObjectPartKey partKey, List<ObjectPartId> partKeys) Complete a multipart put.
void	createBucket(String bucketName)
URI	createSignedGet(ObjectKey objectKey, long timeout, TimeUnit unit)
void	delete(ObjectKey objectKey)
void	deleteBucket(String bucketName)
byte[]	get(ObjectKey objectKey)
void	get(ObjectKey objectKey, File file)
default <T> T	get(ObjectKey objectKey, ObjectReader<T> objectReader)
<T> T	get(ObjectKey objectKey, ObjectReader<T> objectReader, Long start, Long end) Get object with objectKey from offset start to end, streaming it into the objectReader.
ObjectMetadata	head(ObjectKey objectKey)
List<ObjectKey>	list(ObjectKey objectKey, com.distelli.persistence.PageIterator iterator)
ObjectPartId	multipartPut(ObjectPartKey partKey, int partNum, byte[] in)
ObjectPartId	multipartPut(ObjectPartKey partKey, int partNum, File in)
ObjectPartId	multipartPut(ObjectPartKey partKey, int partNum, long contentLength, InputStream in) PUT an individual part.
ObjectPartKey	newMultipartPut(ObjectKey objectKey) Create a new multipart PUT.
void	put(ObjectKey objectKey, byte[] in)
void	put(ObjectKey objectKey, File in)
void	put(ObjectKey objectKey, long contentLength, InputStream in)

Method Detail

createBucket

void createBucket(String bucketName)
           throws AccessControlException

Throws:

AccessControlException

deleteBucket

void deleteBucket(String bucketName)
           throws AccessControlException

Throws:

AccessControlException

put

void put(ObjectKey objectKey,
         long contentLength,
         InputStream in)
  throws javax.persistence.EntityNotFoundException,
         AccessControlException

Throws:

javax.persistence.EntityNotFoundException

AccessControlException

put

void put(ObjectKey objectKey,
         File in)
  throws javax.persistence.EntityNotFoundException,
         IOException,
         AccessControlException

Throws:

javax.persistence.EntityNotFoundException

IOException

AccessControlException

put

void put(ObjectKey objectKey,
         byte[] in)
  throws javax.persistence.EntityNotFoundException,
         AccessControlException

Throws:

javax.persistence.EntityNotFoundException

AccessControlException

head

ObjectMetadata head(ObjectKey objectKey)
             throws AccessControlException

Throws:

AccessControlException

get

<T> T get(ObjectKey objectKey,
          ObjectReader<T> objectReader,
          Long start,
          Long end)
   throws javax.persistence.EntityNotFoundException,
          IOException,
          AccessControlException,
          StreamCorruptedException

Get object with objectKey from offset start to end, streaming it into the objectReader.

Type Parameters:

T - - the return type of the object reader.

Parameters:

objectKey - - the key of the object to fetch.

objectReader - - the reader that will handle the results.

start - - the offset start (or null to start at the beginning).

end - - the offset end (or null to start at the end).

Returns:

Returns the result of ObjectReader

Throws:

javax.persistence.EntityNotFoundException - if the key does not exist.

IOException - if objectReader throws this.

AccessControlException - if access to this key is denied.

StreamCorruptedException - after reading the entire stream if the final checksum does not match the expected checksum. This check may be disabled in various scenarios depending on the underlying implementation.

get

default <T> T get(ObjectKey objectKey,
                  ObjectReader<T> objectReader)
           throws javax.persistence.EntityNotFoundException,
                  IOException,
                  AccessControlException,
                  StreamCorruptedException

Throws:

javax.persistence.EntityNotFoundException

IOException

AccessControlException

StreamCorruptedException

get

void get(ObjectKey objectKey,
         File file)
  throws javax.persistence.EntityNotFoundException,
         IOException,
         AccessControlException,
         StreamCorruptedException

Throws:

javax.persistence.EntityNotFoundException

IOException

AccessControlException

StreamCorruptedException

get

byte[] get(ObjectKey objectKey)
    throws javax.persistence.EntityNotFoundException,
           IOException,
           AccessControlException,
           StreamCorruptedException

Throws:

javax.persistence.EntityNotFoundException

IOException

AccessControlException

StreamCorruptedException

list

List<ObjectKey> list(ObjectKey objectKey,
                     com.distelli.persistence.PageIterator iterator)
              throws javax.persistence.EntityNotFoundException,
                     AccessControlException

Throws:

javax.persistence.EntityNotFoundException

AccessControlException

delete

void delete(ObjectKey objectKey)
     throws AccessControlException

Throws:

AccessControlException

createSignedGet

URI createSignedGet(ObjectKey objectKey,
                    long timeout,
                    TimeUnit unit)

newMultipartPut

ObjectPartKey newMultipartPut(ObjectKey objectKey)
                       throws javax.persistence.EntityNotFoundException,
                              AccessControlException

Create a new multipart PUT.

Parameters:

objectKey - is the object key we want to create.

Returns:

the part key which contains the new upload id.

Throws:

javax.persistence.EntityNotFoundException

AccessControlException

multipartPut

ObjectPartId multipartPut(ObjectPartKey partKey,
                          int partNum,
                          long contentLength,
                          InputStream in)
                   throws javax.persistence.EntityNotFoundException,
                          AccessControlException

PUT an individual part.

Parameters:

partKey - as returned from newMultipartPut().

partNum - used to sequence the parts uploaded.

in - the content to be uploaded.

Returns:

the "part id" that should be used in completePut().

Throws:

javax.persistence.EntityNotFoundException

AccessControlException

multipartPut

ObjectPartId multipartPut(ObjectPartKey partKey,
                          int partNum,
                          File in)
                   throws javax.persistence.EntityNotFoundException,
                          IOException,
                          AccessControlException

Throws:

javax.persistence.EntityNotFoundException

IOException

AccessControlException

multipartPut

ObjectPartId multipartPut(ObjectPartKey partKey,
                          int partNum,
                          byte[] in)
                   throws javax.persistence.EntityNotFoundException,
                          AccessControlException

Throws:

javax.persistence.EntityNotFoundException

AccessControlException

abortPut

void abortPut(ObjectPartKey partKey)
       throws javax.persistence.EntityNotFoundException

Abort a multipart put.

Parameters:

partKey - as returned from newMultipartPut().

Throws:

javax.persistence.EntityNotFoundException

completePut

void completePut(ObjectPartKey partKey,
                 List<ObjectPartId> partKeys)
          throws javax.persistence.EntityNotFoundException,
                 ChunkToSmallException

Complete a multipart put.

Parameters:

partKey - as returned from newMultipartPut().

partKeys - as returned by calls to multipartPut().

Throws:

ChunkToSmallException - if an individual part is < 5MB (unless it is the last chunk).

javax.persistence.EntityNotFoundException