Package org.nuxeo.ecm.core.blob.binary

Interface FileStorage

All Known Implementing Classes:

AzureFileStorage, GoogleStorageBinaryManager.GCPFileStorage, S3BinaryManager.S3FileStorage

public interface FileStorage

Interface to store a file or fetch a file or its length.

Since:

5.9.2

Method Summary

Modifier and Type	Method	Description
default boolean	exists(String key)	Does a blob with the given key exist in the storage.
boolean	fetchFile(String key, File file)	Fetches a file based on its key.
void	storeFile(String key, File file)	Stores a file based on a key.

Method Detail

storeFile

void storeFile(String key,
               File file)
        throws IOException

Stores a file based on a key.

Parameters:

key - the file key

file - the file

Throws:

IOException - if a storage error occurred

fetchFile

boolean fetchFile(String key,
                  File file)
           throws IOException

Fetches a file based on its key.

Parameters:

key - the file key

file - the file to use to store the fetched data

Returns:

true if the file was fetched, false if the file was not found

Throws:

IOException - if a storage error occurred

exists

default boolean exists(String key)

Does a blob with the given key exist in the storage.

The existence of the blob is checked in the storage where the blob is effectively stored. Intermediate cache is ignored.

Parameters:

key - the blob key

Returns:

true if it exists in the storage

Since:

2023