org.openhubframework.openhub.api.file

Interface FileRepository

All Known Implementing Classes:

DefaultFileRepository

public interface FileRepository

Contract for storing files in the repository and manipulating with them.

Supposed workflow:

1. save file into temporary store (file will be in this store for limited time only)
2. commit saving file - the file will be moved from temporary folder to the target place

Author:

Petr Juza

Method Summary

Methods

Modifier and Type	Method and Description
void	commitFile(String fileId, String fileName, FileContentTypeExtEnum contentType, List<String> subFolders) Commits saving file - the file will be moved from temporary folder to the target place.
boolean	isFileIdValid(String fileId) Is specified file ID valid identifier? In other words is there file with specified identifier?
String	saveTempFile(OutputStreamWriterCallback writerCallback) Saves temporary file in the repository.

Method Detail

saveTempFile

String saveTempFile(OutputStreamWriterCallback writerCallback)

Saves temporary file in the repository.

Parameters:

writerCallback - the callback for writing file to specified output stream

Returns:

new unique file identifier

isFileIdValid

boolean isFileIdValid(String fileId)

Is specified file ID valid identifier? In other words is there file with specified identifier?

Parameters:

fileId - the file ID

Returns:

true if file is valid otherwise false

commitFile

void commitFile(String fileId,
              String fileName,
              FileContentTypeExtEnum contentType,
              List<String> subFolders)

Commits saving file - the file will be moved from temporary folder to the target place. If there is already the file with the same name in the target folder then it's replaced by the new one.

Parameters:

fileId - the file identifier from saveTempFile(OutputStreamWriterCallback)

fileName - the original file name

contentType - the file content type

subFolders - the collection of sub-folders which determine where is the target folder for moving the file