org.apache.samza.storage.blobstore

Interface BlobStoreManager

@InterfaceStability.Unstable
public interface BlobStoreManager

Provides interface for common blob store operations: GET, PUT and DELETE

Method Summary

Modifier and Type	Method and Description
void	close() Cleanly close resources like blob store client
java.util.concurrent.CompletionStage<java.lang.Void>	delete(java.lang.String id, Metadata metadata) Non-blocking call to mark a blob for deletion in the remote blob store
java.util.concurrent.CompletionStage<java.lang.Void>	get(java.lang.String id, java.io.OutputStream outputStream, Metadata metadata) Non-blocking GET call to remote blob store
void	init() Initialize underlying blob store client, if necessary.
java.util.concurrent.CompletionStage<java.lang.String>	put(java.io.InputStream inputStream, Metadata metadata) Non-blocking PUT call to remote blob store with supplied metadata
java.util.concurrent.CompletionStage<java.lang.Void>	removeTTL(java.lang.String blobId, Metadata metadata) Non-blocking call to remove the Time-To-Live (TTL) for a blob and make it permanent.

Method Detail

init

void init()

Initialize underlying blob store client, if necessary.

put

java.util.concurrent.CompletionStage<java.lang.String> put(java.io.InputStream inputStream,
                                                           Metadata metadata)

Non-blocking PUT call to remote blob store with supplied metadata

Parameters:

inputStream - InputStream to read the file

metadata - user supplied Metadata of the request

Returns:

a future containing the blob ID of the uploaded blob if the upload is successful.

get

java.util.concurrent.CompletionStage<java.lang.Void> get(java.lang.String id,
                                                         java.io.OutputStream outputStream,
                                                         Metadata metadata)

Non-blocking GET call to remote blob store

Parameters:

id - Blob ID of the blob to get

outputStream - OutputStream to write the downloaded blob

metadata - User supplied Metadata of the request

Returns:

A future that completes when all the chunks are downloaded and written successfully to the OutputStream

Throws:

DeletedException - returned future should complete exceptionally with DeletedException on failure with the blob already deleted error.

delete

java.util.concurrent.CompletionStage<java.lang.Void> delete(java.lang.String id,
                                                            Metadata metadata)

Non-blocking call to mark a blob for deletion in the remote blob store

Parameters:

id - Blob ID of the blob to delete

metadata - User supplied Metadata of the request

Returns:

A future that completes when the blob is successfully deleted from the blob store.

Throws:

DeletedException - returned future should complete exceptionally with DeletedException on failure with the blob already deleted error. This exception is caught and ignored by the caller of the delete method during initial cleanup and SnapshotIndex read.

removeTTL

java.util.concurrent.CompletionStage<java.lang.Void> removeTTL(java.lang.String blobId,
                                                               Metadata metadata)

Non-blocking call to remove the Time-To-Live (TTL) for a blob and make it permanent.

Parameters:

blobId - Blob ID of blob to remove TTL for.

metadata - User supplied Metadata of the request

Returns:

a future that completes when the TTL for the blob is removed.

Throws:

DeletedException - returned future should complete exceptionally with DeletedException on failure with the blob already deleted error.

close

void close()

Cleanly close resources like blob store client