com.haulmont.cuba.core.app

Interface FileStorageAPI

All Known Implementing Classes:

AmazonS3FileStorage, FileStorage

public interface FileStorageAPI

Interface to store and load files defined by FileDescriptors.

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 fileDescr) Tests whether the file denoted by this file descriptor exists.
byte[]	loadFile(FileDescriptor fileDescr) Load a file contents into byte array.
java.io.InputStream	openStream(FileDescriptor fileDescr) Return an input stream to load a file contents.
void	removeFile(FileDescriptor fileDescr) Remove a file from the file storage.
void	saveFile(FileDescriptor fileDescr, byte[] data) Save a byte array into file storage.
long	saveStream(FileDescriptor fileDescr, java.io.InputStream inputStream) Save an InputStream contents into file storage.

Field Detail

NAME

static final java.lang.String NAME

See Also:

Constant Field Values

Method Detail

saveStream

long saveStream(FileDescriptor fileDescr,
                java.io.InputStream inputStream)
         throws FileStorageException

Save an InputStream contents into file storage.

Parameters:

fileDescr - file descriptor

inputStream - input stream, must be closed in the calling code

Returns:

number of bytes saved

Throws:

java.lang.IllegalArgumentException - if arguments are incorrect

FileStorageException - if something goes wrong

saveFile

void saveFile(FileDescriptor fileDescr,
              byte[] data)
       throws FileStorageException

Save a byte array into file storage.

Parameters:

fileDescr - file descriptor

data - byte array

Throws:

java.lang.IllegalArgumentException - if arguments are incorrect

FileStorageException - if something goes wrong

removeFile

void removeFile(FileDescriptor fileDescr)
         throws FileStorageException

Remove a file from the file storage.

Parameters:

fileDescr - file descriptor

Throws:

java.lang.IllegalArgumentException - if arguments are incorrect

FileStorageException - if something goes wrong

openStream

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

Return an input stream to load a file contents.

Parameters:

fileDescr - file descriptor

Returns:

input stream, must be closed after use

Throws:

java.lang.IllegalArgumentException - if arguments are incorrect

FileStorageException - if something goes wrong

loadFile

byte[] loadFile(FileDescriptor fileDescr)
         throws FileStorageException

Load a file contents into byte array.

Parameters:

fileDescr - file descriptor

Returns:

file contents

Throws:

java.lang.IllegalArgumentException - if arguments are incorrect

FileStorageException - if something goes wrong

fileExists

boolean fileExists(FileDescriptor fileDescr)
            throws FileStorageException

Tests whether the file denoted by this file descriptor exists.

Parameters:

fileDescr - file descriptor

Returns:

true if the file denoted by this file descriptor exists

Throws:

java.lang.IllegalArgumentException - if arguments are incorrect

FileStorageException