com.haulmont.cuba.gui.upload

Class FileUploading

java.lang.Object

com.haulmont.cuba.gui.upload.FileUploading

All Implemented Interfaces:

FileUploadingAPI

@Component(value="cuba_FileUploading")
public class FileUploading
extends java.lang.Object
implements FileUploadingAPI

Nested Class Summary

Nested classes/interfaces inherited from interface com.haulmont.cuba.gui.upload.FileUploadingAPI

FileUploadingAPI.FileInfo, FileUploadingAPI.UploadProgressListener

Field Summary

Fields

Modifier and Type	Field and Description
protected io.jmix.ui.upload.TemporaryStorage	delegate
protected CubaFileStorage	fileStorage
protected io.jmix.core.TimeSource	timeSource

Fields inherited from interface com.haulmont.cuba.gui.upload.FileUploadingAPI

NAME

Constructor Summary

Constructors

Constructor and Description
FileUploading()

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(io.jmix.ui.executor.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.

Methods inherited from class java.lang.Object

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

Field Detail

delegate

@Autowired
protected io.jmix.ui.upload.TemporaryStorage delegate

fileStorage

@Autowired
protected CubaFileStorage fileStorage

timeSource

@Autowired
protected io.jmix.core.TimeSource timeSource

Constructor Detail

FileUploading

public FileUploading()

Method Detail

saveFile

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

Description copied from interface: FileUploadingAPI

Store the byte array in a new temporary file.

Specified by:

saveFile in interface FileUploadingAPI

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

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

Description copied from interface: FileUploadingAPI

Store the content of stream in a new temporary file.

Specified by:

saveFile in interface FileUploadingAPI

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

public java.util.UUID createEmptyFile()
                               throws FileStorageException

Description copied from interface: FileUploadingAPI

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

Specified by:

createEmptyFile in interface FileUploadingAPI

Returns:

the new temporary file ID

Throws:

FileStorageException - in case of IO problems

createFile

public FileUploadingAPI.FileInfo createFile()
                                     throws FileStorageException

Description copied from interface: FileUploadingAPI

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

Specified by:

createFile in interface FileUploadingAPI

Returns:

the new temporary file ID

Throws:

FileStorageException - in case of IO problems

createNewFileId

public java.util.UUID createNewFileId()
                               throws FileStorageException

Description copied from interface: FileUploadingAPI

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

Specified by:

createNewFileId in interface FileUploadingAPI

Returns:

temporary file ID

Throws:

FileStorageException - in case of IO problems

getFile

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

Description copied from interface: FileUploadingAPI

Return a previously registered temporary file by its ID.

Specified by:

getFile in interface FileUploadingAPI

Parameters:

fileId - temporary file ID

Returns:

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

getFileDescriptor

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

Description copied from interface: FileUploadingAPI

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

Specified by:

getFileDescriptor in interface FileUploadingAPI

Parameters:

fileId - temporary file ID

name - file name to set in the FileDescriptor

Returns:

the new FileDescriptor instance

deleteFile

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

Description copied from interface: FileUploadingAPI

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

Specified by:

deleteFile in interface FileUploadingAPI

Parameters:

fileId - temporary file ID

Throws:

FileStorageException - in case of IO problems

deleteFileLink

public void deleteFileLink(java.lang.String fileName)

Description copied from interface: FileUploadingAPI

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.

Specified by:

deleteFileLink in interface FileUploadingAPI

Parameters:

fileName - absolute path to the temporary file

putFileIntoStorage

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

Description copied from interface: FileUploadingAPI

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

Specified by:

putFileIntoStorage in interface FileUploadingAPI

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

public FileDescriptor putFileIntoStorage(io.jmix.ui.executor.TaskLifeCycle<java.lang.Long> taskLifeCycle)
                                  throws FileStorageException,
                                         java.lang.InterruptedException

Description copied from interface: FileUploadingAPI

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(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);
 

Specified by:

putFileIntoStorage in interface FileUploadingAPI

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