io.jmix.core

Interface FileStorage

public interface FileStorage

Interface of a component to store and load files defined by file references.

Method Summary

Modifier and Type	Method and Description
boolean	fileExists(FileRef reference) Tests whether the file denoted by this file reference exists.
java.lang.String	getStorageName() Returns the name of this storage, which will be saved in FileRefs.
java.io.InputStream	openStream(FileRef reference) Returns an input stream to load a file contents.
void	removeFile(FileRef reference) Removes a file from the file storage.
FileRef	saveStream(java.lang.String fileName, java.io.InputStream inputStream) Saves an InputStream contents into the file storage.

Method Detail

getStorageName

java.lang.String getStorageName()

Returns the name of this storage, which will be saved in FileRefs.

Each file storage in the application should have a unique name.

saveStream

FileRef saveStream(java.lang.String fileName,
                   java.io.InputStream inputStream)

Saves an InputStream contents into the file storage.

Parameters:

fileName - file name

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

Returns:

file reference

Throws:

java.lang.IllegalArgumentException - if arguments are incorrect

FileStorageException - if something goes wrong

openStream

java.io.InputStream openStream(FileRef reference)

Returns an input stream to load a file contents.

Parameters:

reference - file reference

Returns:

input stream, must be closed after use

Throws:

java.lang.IllegalArgumentException - if arguments are incorrect

FileStorageException - if something goes wrong

removeFile

void removeFile(FileRef reference)

Removes a file from the file storage.

Parameters:

reference - file reference

Throws:

java.lang.IllegalArgumentException - if file reference is invalid

fileExists

boolean fileExists(FileRef reference)

Tests whether the file denoted by this file reference exists.

Parameters:

reference - file reference

Returns:

true if the file denoted by this file reference exists

Throws:

java.lang.IllegalArgumentException - if file reference is invalid