org.gytheio.content.file

Class TempFileProvider

java.lang.Object

org.gytheio.content.file.TempFileProvider

public class TempFileProvider
extends Object

A helper class that provides temporary files, providing a common point to clean them up.

The contents of APPLICATION_TEMP_FILE_DIR [%java.io.tmpdir%/Gytheio] are managed by this class.

Author:

derekh, mrogers

Field Summary

Fields

Modifier and Type	Field and Description
static String	APPLICATION_LONG_LIFE_FILE_DIR The prefix for the long life temporary files.
static String	APPLICATION_TEMP_FILE_DIR subdirectory in the temp directory where Gytheio temporary files will go
static String	SYSTEM_KEY_TEMP_DIR the system property key giving us the location of the temp directory

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	TempFileProvider() Static class only

Method Summary

Methods

Modifier and Type	Method and Description
static File	createTempFile(InputStream in, String namePrefix, String nameSufix)
static File	createTempFile(String prefix, String suffix) Create a temp file in the alfresco temp dir.
static File	createTempFile(String prefix, String suffix, File directory)
protected static String	getApplicationLongLifeFileDir() Gets the longer life file directory
protected static String	getApplicationTempFileDir() Gets the temp file directory
static File	getLongLifeTempDir(String key) creates a longer living temp dir.
static File	getSystemTempDir() Get the Java Temp dir e.g.
static File	getTempDir() Get the Gytheio temp dir, by defaut %java.io.tempdir%/Gytheio.
static File	getTempDir(String dirName) Get the specified temp dir, %java.io.tempdir%/dirName.
protected static boolean	isLongLifeTempDir(File file) Is this a long life folder ?

Methods inherited from class java.lang.Object

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

Field Detail

APPLICATION_TEMP_FILE_DIR

public static final String APPLICATION_TEMP_FILE_DIR

subdirectory in the temp directory where Gytheio temporary files will go

See Also:

Constant Field Values

APPLICATION_LONG_LIFE_FILE_DIR

public static final String APPLICATION_LONG_LIFE_FILE_DIR

The prefix for the long life temporary files.

See Also:

Constant Field Values

SYSTEM_KEY_TEMP_DIR

public static final String SYSTEM_KEY_TEMP_DIR

the system property key giving us the location of the temp directory

See Also:

Constant Field Values

Constructor Detail

TempFileProvider

protected TempFileProvider()

Static class only

Method Detail

getSystemTempDir

public static File getSystemTempDir()

Get the Java Temp dir e.g. java.io.tempdir

Returns:

Returns the system temporary directory i.e. isDir == true

getApplicationTempFileDir

protected static String getApplicationTempFileDir()

Gets the temp file directory

Returns:

the temp file directory

getApplicationLongLifeFileDir

protected static String getApplicationLongLifeFileDir()

Gets the longer life file directory

Returns:

the longer life file directory

getTempDir

public static File getTempDir()

Get the Gytheio temp dir, by defaut %java.io.tempdir%/Gytheio. Will create the temp dir on the fly if it does not already exist.

Returns:

Returns a temporary directory, i.e. isDir == true

getTempDir

public static File getTempDir(String dirName)

Get the specified temp dir, %java.io.tempdir%/dirName. Will create the temp dir on the fly if it does not already exist.

Parameters:

dirName - the name of sub-directory in %java.io.tempdir%

Returns:

Returns a temporary directory, i.e. isDir == true

createTempFile

public static File createTempFile(InputStream in,
                  String namePrefix,
                  String nameSufix)
                           throws Exception

Throws:

Exception

isLongLifeTempDir

protected static boolean isLongLifeTempDir(File file)

Is this a long life folder ?

Parameters:

file -

Returns:

true, this is a long life folder.

createTempFile

public static File createTempFile(String prefix,
                  String suffix)

Create a temp file in the alfresco temp dir.

Returns:

Returns a temp File that will be located in the Gytheio subdirectory of the default temp directory

See Also:

APPLICATION_TEMP_FILE_DIR, File.createTempFile(java.lang.String, java.lang.String)

createTempFile

public static File createTempFile(String prefix,
                  String suffix,
                  File directory)

Returns:

Returns a temp File that will be located in the given directory

See Also:

APPLICATION_TEMP_FILE_DIR, File.createTempFile(java.lang.String, java.lang.String)

getLongLifeTempDir

public static File getLongLifeTempDir(String key)

creates a longer living temp dir. Files within the longer living temp dir will not be garbage collected as soon as "normal" temporary files. By default long life temp files will live for for 24 hours rather than 1 hour.

Code using the longer life temporary files should be careful to clean up since abuse of this feature may result in out of memory/disk space errors.

Parameters:

key - can be blank in which case the system will generate a folder to be used by all processes or can be used to create a unique temporary folder name for a particular process. At the end of the process the client can simply delete the entire temporary folder.

Returns:

the long life temporary directory