com.haulmont.cuba.core.global

Interface FileLoader

All Known Implementing Classes:

FileLoaderClientImpl, FileLoaderImpl

public interface FileLoader

Interface to store and load files defined by FileDescriptors. Can be used on both middle and client tiers.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	FileLoader.InputStreamSupplierException Runtime exception that can be thrown from Supplier<InputStream> implementation.
static class	FileLoader.RetryUnsupportedException Exception that can be thrown if implementation of Supplier<InputStream> cannot provide input stream once again.
static class	FileLoader.SingleInputStreamSupplier Simple implementation of Supplier<InputStream> that can provide input stream only once.
static interface	FileLoader.StreamingProgressListener Listener that is fired during file streaming to middleware.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	NAME

Method Summary

Modifier and Type	Method and Description
boolean	fileExists(FileDescriptor fd) Tests whether the file denoted by this file descriptor exists.
java.io.InputStream	openStream(FileDescriptor fd) Return an input stream to load a file contents from middleware.
void	removeFile(FileDescriptor fd) Remove a file from the file storage.
void	saveStream(FileDescriptor fd, java.util.function.Supplier<java.io.InputStream> inputStreamSupplier) Save an InputStream contents into file storage on middleware.
void	saveStream(FileDescriptor fd, java.util.function.Supplier<java.io.InputStream> inputStreamSupplier, FileLoader.StreamingProgressListener streamingListener) Save an InputStream contents into file storage on middleware.

Field Detail

NAME

static final java.lang.String NAME

See Also:

Constant Field Values

Method Detail

saveStream

void saveStream(FileDescriptor fd,
                java.util.function.Supplier<java.io.InputStream> inputStreamSupplier)
         throws FileStorageException

Save an InputStream contents into file storage on middleware.

Parameters:

fd - file descriptor

inputStreamSupplier - input stream supplier May throw FileLoader.RetryUnsupportedException if supplier cannot provide stream twice. May throw FileLoader.InputStreamSupplierException in case of exception in supplier.

Throws:

java.lang.IllegalArgumentException - if arguments are incorrect

FileStorageException - if something goes wrong

saveStream

void saveStream(FileDescriptor fd,
                java.util.function.Supplier<java.io.InputStream> inputStreamSupplier,
                @Nullable
                FileLoader.StreamingProgressListener streamingListener)
         throws FileStorageException,
                java.lang.InterruptedException

Save an InputStream contents into file storage on middleware.

Parameters:

fd - file descriptor

inputStreamSupplier - input stream supplier. May throw FileLoader.RetryUnsupportedException if supplier cannot provide stream twice. May throw FileLoader.InputStreamSupplierException in case of exception in supplier.

streamingListener - streaming progress listener

Throws:

java.lang.IllegalArgumentException - if arguments are incorrect

FileStorageException - if something goes wrong

java.lang.InterruptedException - if current thread is interrupted during streaming process

openStream

java.io.InputStream openStream(FileDescriptor fd)
                        throws FileStorageException

Return an input stream to load a file contents from middleware.

Parameters:

fd - file descriptor

Returns:

input stream, must be closed after use

Throws:

java.lang.IllegalArgumentException - if arguments are incorrect

FileStorageException - if something goes wrong

removeFile

void removeFile(FileDescriptor fd)
         throws FileStorageException

Remove a file from the file storage.

Parameters:

fd - file descriptor

Throws:

java.lang.IllegalArgumentException - if arguments are incorrect

FileStorageException - if something goes wrong

fileExists

boolean fileExists(FileDescriptor fd)
            throws FileStorageException

Tests whether the file denoted by this file descriptor exists.

Parameters:

fd - file descriptor

Returns:

true if the file denoted by this file descriptor exists

Throws:

java.lang.IllegalArgumentException - if arguments are incorrect

FileStorageException - if something goes wrong@throws FileStorageException