com.artipie.asto.fs

Class FileStorage

java.lang.Object

com.artipie.asto.fs.FileStorage

All Implemented Interfaces:

Storage

public final class FileStorage
extends Object
implements Storage

Simple storage, in files.

Since:

0.1

Nested Class Summary

Nested classes/interfaces inherited from interface com.artipie.asto.Storage

Storage.Wrap

Constructor Summary

Constructors

Constructor and Description
FileStorage(Path path) Ctor.
FileStorage(Path path, ExecutorService exec) Ctor.
FileStorage(Path path, Object nothing) Deprecated. Use FileStorage(Path) ctor instead.

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.

Methods inherited from class java.lang.Object

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

Constructor Detail

FileStorage

@Deprecated
public FileStorage(Path path,
                               Object nothing)

Deprecated. Use FileStorage(Path) ctor instead.

Ctor.

Parameters:

path - The path to the dir

nothing - Just for compatibility

FileStorage

public FileStorage(Path path)

Ctor.

Parameters:

path - File path

FileStorage

public FileStorage(Path path,
                   ExecutorService exec)

Ctor.

Parameters:

path - The path to the dir

exec - IO Executor service

Method Detail

exists

public CompletableFuture<Boolean> exists(Key key)

Description copied from interface: Storage

This file exists?

Specified by:

exists in interface Storage

Parameters:

key - The key (file name)

Returns:

TRUE if exists, FALSE otherwise

list

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

Description copied from interface: Storage

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

Specified by:

list in interface Storage

Parameters:

prefix - The prefix.

Returns:

Collection of relative keys.

save

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

Description copied from interface: Storage

Saves the bytes to the specified key.

Specified by:

save in interface Storage

Parameters:

key - The key

content - Bytes to save

Returns:

Completion or error signal.

move

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

Description copied from interface: Storage

Moves value from one location to another.

Specified by:

move in interface Storage

Parameters:

source - Source key.

destination - Destination key.

Returns:

Completion or error signal.

delete

public CompletableFuture<Void> delete(Key key)

Description copied from interface: Storage

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

Specified by:

delete in interface Storage

Parameters:

key - Key for value to be deleted.

Returns:

Completion or error signal.

size

public CompletableFuture<Long> size(Key key)

Description copied from interface: Storage

Get value size.

Specified by:

size in interface Storage

Parameters:

key - The key of value.

Returns:

Size of value in bytes.

value

public CompletableFuture<Content> value(Key key)

Description copied from interface: Storage

Obtain bytes by key.

Specified by:

value in interface Storage

Parameters:

key - The key

Returns:

Bytes.

transaction

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

Description copied from interface: Storage

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

Specified by:

transaction in interface Storage

Parameters:

keys - The keys regarding which transaction is atomic

Returns:

Transaction