com.haulmont.cuba.core.sys

Class FileLoaderImpl

java.lang.Object

com.haulmont.cuba.core.sys.FileLoaderImpl

All Implemented Interfaces:

FileLoader

@Component(value="cuba_FileLoader")
public class FileLoaderImpl
extends java.lang.Object
implements FileLoader

Nested Class Summary

Nested classes/interfaces inherited from interface com.haulmont.cuba.core.global.FileLoader

FileLoader.InputStreamSupplierException, FileLoader.RetryUnsupportedException, FileLoader.SingleInputStreamSupplier, FileLoader.StreamingProgressListener

Field Summary

Fields

Modifier and Type	Field and Description
protected EntityStates	entityStates
protected FileStorageAPI	fileStorageAPI
protected Persistence	persistence

Fields inherited from interface com.haulmont.cuba.core.global.FileLoader

NAME

Constructor Summary

Constructors

Constructor and Description
FileLoaderImpl()

Method Summary

Modifier and Type	Method and Description
protected void	checkIfFileDescriptorExists(FileDescriptor fd)
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.

Methods inherited from class java.lang.Object

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

Field Detail

fileStorageAPI

@Inject
protected FileStorageAPI fileStorageAPI

persistence

@Inject
protected Persistence persistence

entityStates

@Inject
protected EntityStates entityStates

Constructor Detail

FileLoaderImpl

public FileLoaderImpl()

Method Detail

saveStream

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

Description copied from interface: FileLoader

Save an InputStream contents into file storage on middleware.

Specified by:

saveStream in interface FileLoader

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:

FileStorageException - if something goes wrong

saveStream

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

Description copied from interface: FileLoader

Save an InputStream contents into file storage on middleware.

Specified by:

saveStream in interface FileLoader

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:

FileStorageException - if something goes wrong

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

openStream

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

Description copied from interface: FileLoader

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

Specified by:

openStream in interface FileLoader

Parameters:

fd - file descriptor

Returns:

input stream, must be closed after use

Throws:

FileStorageException - if something goes wrong

removeFile

public void removeFile(FileDescriptor fd)
                throws FileStorageException

Description copied from interface: FileLoader

Remove a file from the file storage.

Specified by:

removeFile in interface FileLoader

Parameters:

fd - file descriptor

Throws:

FileStorageException - if something goes wrong

fileExists

public boolean fileExists(FileDescriptor fd)
                   throws FileStorageException

Description copied from interface: FileLoader

Tests whether the file denoted by this file descriptor exists.

Specified by:

fileExists in interface FileLoader

Parameters:

fd - file descriptor

Returns:

true if the file denoted by this file descriptor exists

Throws:

FileStorageException - if something goes wrong@throws FileStorageException

checkIfFileDescriptorExists

protected void checkIfFileDescriptorExists(FileDescriptor fd)
                                    throws FileStorageException

Throws:

FileStorageException