io.jmix.ui.upload

Class TemporaryStorageImpl

java.lang.Object

io.jmix.ui.upload.TemporaryStorageImpl

All Implemented Interfaces:

TemporaryStorage

@Component(value="ui_TemporaryStorage")
public class TemporaryStorageImpl
extends java.lang.Object
implements TemporaryStorage

Nested Class Summary

Nested classes/interfaces inherited from interface io.jmix.ui.upload.TemporaryStorage

TemporaryStorage.FileInfo, TemporaryStorage.UploadProgressListener

Field Summary

Fields

Modifier and Type	Field and Description
protected static int	BUFFER_SIZE Upload buffer size.
protected io.jmix.core.FileStorageLocator	fileStorageLocator
protected java.lang.String	tempDir
protected java.util.Map<java.util.UUID,java.io.File>	tempFiles
protected io.jmix.core.TimeSource	timeSource

Constructor Summary

Constructors

Constructor and Description
TemporaryStorageImpl()

Method Summary

Modifier and Type	Method and Description
void	clearTempDirectory()
TemporaryStorage.FileInfo	createFile() Create a new empty temporary file and cache its ID for subsequent operations.
protected TemporaryStorage.FileInfo	createFileInternal()
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.
io.jmix.core.FileRef	putFileIntoStorage(java.util.UUID fileId, java.lang.String fileName) Uploads a file from the temporary storage to the default FileStorage, which is determined by calling FileStorageLocator.getDefault().
io.jmix.core.FileRef	putFileIntoStorage(java.util.UUID fileId, java.lang.String fileName, io.jmix.core.FileStorage fileStorage) Uploads a file from the temporary storage to the FileStorage.
java.util.UUID	saveFile(byte[] data) Store the byte array in a new temporary file.
java.util.UUID	saveFile(java.io.InputStream stream, TemporaryStorage.UploadProgressListener listener) Store the content of stream in a new temporary file.
void	setCoreProperties(io.jmix.core.CoreProperties coreProperties)
java.lang.String	showTempFiles()

Methods inherited from class java.lang.Object

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

Field Detail

tempFiles

protected java.util.Map<java.util.UUID,java.io.File> tempFiles

BUFFER_SIZE

protected static final int BUFFER_SIZE

Upload buffer size. Default: 64 KB

See Also:

Constant Field Values

tempDir

protected java.lang.String tempDir

timeSource

@Autowired
protected io.jmix.core.TimeSource timeSource

fileStorageLocator

@Autowired
protected io.jmix.core.FileStorageLocator fileStorageLocator

Constructor Detail

TemporaryStorageImpl

public TemporaryStorageImpl()

Method Detail

setCoreProperties

@Autowired
public void setCoreProperties(io.jmix.core.CoreProperties coreProperties)

saveFile

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

Description copied from interface: TemporaryStorage

Store the byte array in a new temporary file.

Specified by:

saveFile in interface TemporaryStorage

Parameters:

data - file contents

Returns:

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

saveFile

public java.util.UUID saveFile(java.io.InputStream stream,
                               TemporaryStorage.UploadProgressListener listener)

Description copied from interface: TemporaryStorage

Store the content of stream in a new temporary file.

Specified by:

saveFile in interface TemporaryStorage

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.

createFile

public TemporaryStorage.FileInfo createFile()

Description copied from interface: TemporaryStorage

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

Specified by:

createFile in interface TemporaryStorage

Returns:

the new temporary file ID

createFileInternal

protected TemporaryStorage.FileInfo createFileInternal()

getFile

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

Description copied from interface: TemporaryStorage

Return a previously registered temporary file by its ID.

Specified by:

getFile in interface TemporaryStorage

Parameters:

fileId - temporary file ID

Returns:

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

deleteFile

public void deleteFile(java.util.UUID fileId)

Description copied from interface: TemporaryStorage

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 TemporaryStorage

Parameters:

fileId - temporary file ID

deleteFileLink

public void deleteFileLink(java.lang.String fileName)

Description copied from interface: TemporaryStorage

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 TemporaryStorage

Parameters:

fileName - absolute path to the temporary file

putFileIntoStorage

public io.jmix.core.FileRef putFileIntoStorage(java.util.UUID fileId,
                                               java.lang.String fileName,
                                               io.jmix.core.FileStorage fileStorage)

Description copied from interface: TemporaryStorage

Uploads a file from the temporary storage to the FileStorage.

Specified by:

putFileIntoStorage in interface TemporaryStorage

Parameters:

fileId - temporary file ID

fileName - file name

fileStorage - file storage

putFileIntoStorage

public io.jmix.core.FileRef putFileIntoStorage(java.util.UUID fileId,
                                               java.lang.String fileName)

Description copied from interface: TemporaryStorage

Uploads a file from the temporary storage to the default FileStorage, which is determined by calling FileStorageLocator.getDefault().

Specified by:

putFileIntoStorage in interface TemporaryStorage

Parameters:

fileId - temporary file ID

fileName - file name

clearTempDirectory

public void clearTempDirectory()

showTempFiles

public java.lang.String showTempFiles()