com.artipie.asto

Interface Storage

All Known Subinterfaces:

Transaction

All Known Implementing Classes:

FileStorage, FileSystemTransaction, GoogleStorage, InMemoryStorage, InMemoryTransaction, S3Storage, Storage.Wrap

public interface Storage

The storage.

You are supposed to implement this interface the way you want. It has to abstract the binary storage. You may use FileStorage if you want to work with files. Otherwise, for S3 or something else, you have to implement it yourself.

Since:

0.1

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	Storage.Wrap Forwarding decorator for Storage.

Method Summary

Modifier and Type	Method and Description
CompletableFuture<Void>	delete(Key key) Removes value from storage.
CompletableFuture<Boolean>	exists(Key key) This file exists?
CompletableFuture<Collection<Key>>	list(Key prefix) Return the list of keys that start with this prefix, for example "foo/bar/".
CompletableFuture<Void>	move(Key source, Key destination) Moves value from one location to another.
CompletableFuture<Void>	save(Key key, Content content) Saves the bytes to the specified key.
CompletableFuture<Long>	size(Key key) Get value size.
CompletableFuture<Transaction>	transaction(List<Key> keys) Start a transaction with specified keys.
CompletableFuture<Content>	value(Key key) Obtain bytes by key.

Method Detail

exists

CompletableFuture<Boolean> exists(Key key)

This file exists?

Parameters:

key - The key (file name)

Returns:

TRUE if exists, FALSE otherwise

list

CompletableFuture<Collection<Key>> list(Key prefix)

Return the list of keys that start with this prefix, for example "foo/bar/".

Parameters:

prefix - The prefix.

Returns:

Collection of relative keys.

save

CompletableFuture<Void> save(Key key,
                             Content content)

Saves the bytes to the specified key.

Parameters:

key - The key

content - Bytes to save

Returns:

Completion or error signal.

move

CompletableFuture<Void> move(Key source,
                             Key destination)

Moves value from one location to another.

Parameters:

source - Source key.

destination - Destination key.

Returns:

Completion or error signal.

size

CompletableFuture<Long> size(Key key)

Get value size.

Parameters:

key - The key of value.

Returns:

Size of value in bytes.

value

CompletableFuture<Content> value(Key key)

Obtain bytes by key.

Parameters:

key - The key

Returns:

Bytes.

delete

CompletableFuture<Void> delete(Key key)

Removes value from storage. Fails if value does not exist.

Parameters:

key - Key for value to be deleted.

Returns:

Completion or error signal.

transaction

CompletableFuture<Transaction> transaction(List<Key> keys)

Start a transaction with specified keys. These specified keys are the scope of a transaction. You will be able to perform storage operations like save(Key, Content) or value(Key) only in the scope of a transaction.

Parameters:

keys - The keys regarding which transaction is atomic

Returns:

Transaction