org.pfsw.file

Class TempFilesManager

java.lang.Object

org.pfsw.file.TempFilesManager

public class TempFilesManager
extends java.lang.Object

An instance of this class is maintaining an arbitrary number of temporary file in a dedicated folder of the file system (on which it must have write access).

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_BUFFER_SIZE
static java.lang.String	DEFAULT_SUFFIX
static java.lang.String	NAME_PART_SEPARATOR
static java.lang.String	TIMESTAMP_FORMAT

Constructor Summary

Constructors

Constructor and Description
TempFilesManager(java.io.File tempFolder)
TempFilesManager(java.io.File tempFolder, boolean requiresInstanceUniqueness)

Method Summary

Modifier and Type	Method and Description
protected java.lang.String	calculateInstanceUniqueId()
protected void	checkTempFolder()
protected java.io.File	createTempFileDescriptor()
protected java.io.File	createTempFileDescriptor(java.lang.String filenameSnippet)
protected java.lang.String	createTempFileName(java.lang.String nameSnippet)
java.lang.String	getFileNamePrefix()
java.lang.String	getFileNameSuffix()
java.lang.Long	getFileSizeLimit() Returns an optional limit for files that are created.
protected java.util.concurrent.atomic.AtomicInteger	getNextNumericId()
protected java.io.File	getTempFolder()
protected java.lang.String	getTempFolderName() Returns the absolute path of the temp folder with forward slash notation.
protected java.lang.String	getTimestamp()
protected java.lang.String	getUniqueId()
long	removeFilesOlderThan(long timestamp) Deletes all temporary files in the underlying temp files folder that are older that the given point in time.
protected boolean	requiresInstanceUniqueness()
void	setFileNamePrefix(java.lang.String fileNamePrefix)
void	setFileNameSuffix(java.lang.String fileNameSuffix)
void	setFileSizeLimit(java.lang.Long limit) Sets a limit for files that are created.
java.io.File	storeStream(java.io.InputStream inStream) Creates a temporary file and stores the whole contents of the given stream into it.
java.io.File	storeStream(java.io.InputStream inStream, java.lang.String filenameSnippet) Creates a temporary file and stores the whole contents of the given stream into it.
protected void	storeStreamToFile(java.io.InputStream inStream, java.io.File file) Creates a file for the given file description and stores the whole contents of the given stream into it.

Methods inherited from class java.lang.Object

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

Field Detail

TIMESTAMP_FORMAT

public static final java.lang.String TIMESTAMP_FORMAT

See Also:

Constant Field Values

DEFAULT_SUFFIX

public static final java.lang.String DEFAULT_SUFFIX

See Also:

Constant Field Values

NAME_PART_SEPARATOR

public static final java.lang.String NAME_PART_SEPARATOR

See Also:

Constant Field Values

DEFAULT_BUFFER_SIZE

public static final int DEFAULT_BUFFER_SIZE

See Also:

Constant Field Values

Constructor Detail

TempFilesManager

public TempFilesManager(java.io.File tempFolder)
                 throws java.io.IOException

Throws:

java.io.IOException

TempFilesManager

public TempFilesManager(java.io.File tempFolder,
                        boolean requiresInstanceUniqueness)
                 throws java.io.IOException

Throws:

java.io.IOException

Method Detail

getFileNamePrefix

public java.lang.String getFileNamePrefix()

setFileNamePrefix

public void setFileNamePrefix(java.lang.String fileNamePrefix)

getFileNameSuffix

public java.lang.String getFileNameSuffix()

setFileNameSuffix

public void setFileNameSuffix(java.lang.String fileNameSuffix)

getFileSizeLimit

public java.lang.Long getFileSizeLimit()

Returns an optional limit for files that are created. A null, zero or negative value mean "no limit".

setFileSizeLimit

public void setFileSizeLimit(java.lang.Long limit)

Sets a limit for files that are created. A null, zero or negative value mean "no limit".

storeStream

public java.io.File storeStream(java.io.InputStream inStream)
                         throws java.io.IOException

Creates a temporary file and stores the whole contents of the given stream into it. A defined file size limit will be respected and exceeding it will throw an IOException (in which case the target file be deleted).

Parameters:

inStream - The stream with the data to be stored into the file (must not be null).

Returns:

The file descriptor of the created temporary file.

Throws:

java.io.IOException

storeStream

public java.io.File storeStream(java.io.InputStream inStream,
                                java.lang.String filenameSnippet)
                         throws java.io.IOException

Creates a temporary file and stores the whole contents of the given stream into it. A defined file size limit will be respected and exceeding it will throw an IOException (inch which case the target file be deleted).

Parameters:

inStream - The stream with the data to be stored into the file (must not be null).

Returns:

The file descriptor of the created temporary file.

Throws:

java.io.IOException

removeFilesOlderThan

public long removeFilesOlderThan(long timestamp)

Deletes all temporary files in the underlying temp files folder that are older that the given point in time.

Parameters:

timestamp - Defines the point in time to compare with.

Returns:

The number of deleted files.

storeStreamToFile

protected void storeStreamToFile(java.io.InputStream inStream,
                                 java.io.File file)
                          throws java.io.IOException

Creates a file for the given file description and stores the whole contents of the given stream into it. A defined file size limit will be respected and exceeding it will throw an IOException (inch which case the target file be deleted).

Parameters:

inStream - The stream with the data to be stored into the file (must not be null).

file - The file to which the data of the stream must be written (must not be null).

Throws:

java.io.IOException

checkTempFolder

protected void checkTempFolder()
                        throws java.io.IOException

Throws:

java.io.IOException

createTempFileDescriptor

protected java.io.File createTempFileDescriptor()

createTempFileDescriptor

protected java.io.File createTempFileDescriptor(java.lang.String filenameSnippet)

createTempFileName

protected java.lang.String createTempFileName(java.lang.String nameSnippet)

calculateInstanceUniqueId

protected java.lang.String calculateInstanceUniqueId()

requiresInstanceUniqueness

protected boolean requiresInstanceUniqueness()

getTimestamp

protected java.lang.String getTimestamp()

getTempFolderName

protected java.lang.String getTempFolderName()

Returns the absolute path of the temp folder with forward slash notation.

getTempFolder

protected java.io.File getTempFolder()

getNextNumericId

protected java.util.concurrent.atomic.AtomicInteger getNextNumericId()

getUniqueId

protected java.lang.String getUniqueId()