com.haulmont.cuba.gui.upload

Interface FileUploadingAPI

All Known Implementing Classes:

FileUploading

public interface FileUploadingAPI

Client API for uploading files and transfer them to the middleware FileStorage.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	FileUploadingAPI.FileInfo
static interface	FileUploadingAPI.UploadProgressListener Listener to be notified about the progress of uploading file into the temporary storage.

Field Summary

Fields

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

Method Summary

Modifier and Type	Method and Description
java.util.UUID	createEmptyFile() Create a new empty temporary file and cache its ID for subsequent operations.
FileUploadingAPI.FileInfo	createFile() Create a new empty temporary file and cache its ID for subsequent operations.
java.util.UUID	createNewFileId() Create and cache a new temporary file ID.
void	deleteFile(java.util.UUID fileId) Remove a file from the temporary storage.
void	deleteFileLink(java.lang.String fileName) Remove an entry from the list of currently cached temporary file IDs, if such exists.
java.io.File	getFile(java.util.UUID fileId) Return a previously registered temporary file by its ID.
FileDescriptor	getFileDescriptor(java.util.UUID fileId, java.lang.String name) Construct a new FileDescriptor for a temporary file to store it in the middleware FileStorage.
FileDescriptor	putFileIntoStorage(TaskLifeCycle<java.lang.Long> taskLifeCycle) Upload a file from the client's temporary storage into the middleware FileStorage.
void	putFileIntoStorage(java.util.UUID fileId, FileDescriptor fileDescr) Upload a file from the client's temporary storage to the middleware FileStorage.
java.util.UUID	saveFile(byte[] data) Store the byte array in a new temporary file.
java.util.UUID	saveFile(java.io.InputStream stream, FileUploadingAPI.UploadProgressListener listener) Store the content of stream in a new temporary file.

Field Detail

NAME

static final java.lang.String NAME

See Also:

Constant Field Values

Method Detail

saveFile

java.util.UUID saveFile(byte[] data)
                 throws FileStorageException

Store the byte array in a new temporary file.

Parameters:

data - file contents

Returns:

temporary file ID. This ID is cached in memory and can be used for subsequent operations.

Throws:

FileStorageException - in case of IO problems

saveFile

java.util.UUID saveFile(java.io.InputStream stream,
                        @Nullable
                        FileUploadingAPI.UploadProgressListener listener)
                 throws FileStorageException

Store the content of stream in a new temporary file.

Parameters:

stream - stream which content is to be stored

listener - optional listener to be notified about storing progress

Returns:

temporary file ID. This ID is cached in memory and can be used for subsequent operations.

Throws:

FileStorageException - in case of IO problems

createEmptyFile

java.util.UUID createEmptyFile()
                        throws FileStorageException

Create a new empty temporary file and cache its ID for subsequent operations.

Returns:

the new temporary file ID

Throws:

FileStorageException - in case of IO problems

createFile

FileUploadingAPI.FileInfo createFile()
                              throws FileStorageException

Create a new empty temporary file and cache its ID for subsequent operations.

Returns:

the new temporary file ID

Throws:

FileStorageException - in case of IO problems

createNewFileId

java.util.UUID createNewFileId()
                        throws FileStorageException

Create and cache a new temporary file ID. Doesn't create any real file on disk.

Returns:

temporary file ID

Throws:

FileStorageException - in case of IO problems

getFile

@Nullable
java.io.File getFile(java.util.UUID fileId)

Return a previously registered temporary file by its ID.

Parameters:

fileId - temporary file ID

Returns:

temporary file object or null if no file registered under this ID

getFileDescriptor

@Nullable
FileDescriptor getFileDescriptor(java.util.UUID fileId,
                                           java.lang.String name)

Construct a new FileDescriptor for a temporary file to store it in the middleware FileStorage.

Parameters:

fileId - temporary file ID

name - file name to set in the FileDescriptor

Returns:

the new FileDescriptor instance

deleteFile

void deleteFile(java.util.UUID fileId)
         throws FileStorageException

Remove a file from the temporary storage.
This method is automatically called from putFileIntoStorage() when the file is successfully stored on the middleware.

Parameters:

fileId - temporary file ID

Throws:

FileStorageException - in case of IO problems

deleteFileLink

void deleteFileLink(java.lang.String fileName)

Remove an entry from the list of currently cached temporary file IDs, if such exists. This method is used by the framework when cleaning up the temp folder.

Parameters:

fileName - absolute path to the temporary file

putFileIntoStorage

void putFileIntoStorage(java.util.UUID fileId,
                        FileDescriptor fileDescr)
                 throws FileStorageException

Upload a file from the client's temporary storage to the middleware FileStorage.

Parameters:

fileId - file ID in the temporary storage

fileDescr - corresponding file descriptor entity. Attention: the FileDescriptor instance must be stored in the database separately.

Throws:

FileStorageException - in case of IO problems

putFileIntoStorage

FileDescriptor putFileIntoStorage(TaskLifeCycle<java.lang.Long> taskLifeCycle)
                           throws FileStorageException,
                                  java.lang.InterruptedException

Upload a file from the client's temporary storage into the middleware FileStorage.
This method is intended for integration with BackgroundTasks and should be called from BackgroundTask.run(com.haulmont.cuba.gui.executors.TaskLifeCycle)
TaskLifeCycle.getParams() map must contain the following entries with String keys:

• fileId - file ID in the temporary storage
• fileName - file name to set in the returned FileDescriptor

Usage:

 BackgroundTask<Long, FileDescriptor> uploadProgress = new BackgroundTask<Long, FileDescriptor>(2400, ownerWindow) {
     @Override
     public Map<String, Object> getParams() {
         // file parameters
         Map<String, Object> params = new HashMap<>();
         params.put("fileId", fileUpload.getFileId());
         params.put("fileName", fileUpload.getFileName());
         return params;
     }

     @Override
     public FileDescriptor run(final TaskLifeCycle<Long> taskLifeCycle) throws Exception {
         // upload file to middleware and return FileDescriptor
         return fileUploading.putFileIntoStorage(taskLifeCycle);
     }

     @Override
     public void done(FileDescriptor result) {
         // commit FileDescriptor to DB
         dataService.commit(new CommitContext(result));
     }
 };
 

And then we can show upload progress window:

     long fileSize = fileUploading.getFile(fileUpload.getFileId()).length();
           BackgroundWorkProgressWindow.show(uploadProgress, getMessage("uploadingFile"), null, fileSize, true, true);
 

Parameters:

taskLifeCycle - task life cycle with specified params: fileId and fileName

Returns:

a new file descriptor. Attention: the returned FileDescriptor instance must be stored in the database separately.

Throws:

FileStorageException - in case of IO problems

java.lang.InterruptedException - in case of uploading thread interrupted