edu.northwestern.at.morphadorner.server

Class UploadedFileProcessor

java.lang.Object

edu.northwestern.at.morphadorner.server.UploadedFileProcessor

public class UploadedFileProcessor
extends java.lang.Object

Handle file upload to MorphAdorner server.

Field Summary

Fields

Modifier and Type	Field and Description
java.util.List<java.lang.String>	dirsToDelete Holds names of temporary directories.
java.util.Map<java.lang.String,java.lang.String>	fileNameMap Short names of uploaded files for each file parameter name.
java.util.List<java.lang.String>	filesToDelete Holds names of temporary files.
boolean	foundFiles true if parameters contain all the required files.
java.util.Map<java.lang.String,java.lang.String>	fullFileNameMap Full path name of each uploaded file for each file parameter name.
java.util.Map<java.lang.String,java.lang.String>	params Holds request parameter names and values.

Constructor Summary

Constructors

Constructor and Description
UploadedFileProcessor(org.restlet.Request request, java.lang.String[] fileParamNames, int maxUploadSize) Create uploaded file processor.
UploadedFileProcessor(org.restlet.Request request, java.lang.String fileParamName, int maxUploadSize) Create uploaded file processor when expecting a single file.

Method Summary

Methods

Modifier and Type	Method and Description
void	addTempDirectory(java.lang.String dirName) Add a directory to the list of temporary directories.
void	addTempFile(java.lang.String fileName) Add a file to the list of temporary file names.
void	deleteTemporaryFilesAndDirectories() Delete the temporary files and directories.
java.lang.String	getFileName(java.lang.String fieldName) Get short file name for a parameter.
java.lang.String	getFullFileName(java.lang.String fieldName) Get full file name for a parameter.
java.util.List<java.lang.String>	getTempDirectories() Get temporary directories to delete.
java.util.List<java.lang.String>	getTempFiles() Get temporary files to delete.
java.io.File	getTemporaryDirectory() Get a temporary directory.

Methods inherited from class java.lang.Object

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

Field Detail

params

public java.util.Map<java.lang.String,java.lang.String> params

Holds request parameter names and values.

fileNameMap

public java.util.Map<java.lang.String,java.lang.String> fileNameMap

Short names of uploaded files for each file parameter name.

fullFileNameMap

public java.util.Map<java.lang.String,java.lang.String> fullFileNameMap

Full path name of each uploaded file for each file parameter name.

filesToDelete

public java.util.List<java.lang.String> filesToDelete

Holds names of temporary files.

dirsToDelete

public java.util.List<java.lang.String> dirsToDelete

Holds names of temporary directories.

foundFiles

public boolean foundFiles

true if parameters contain all the required files.

Constructor Detail

UploadedFileProcessor

public UploadedFileProcessor(org.restlet.Request request,
                     java.lang.String[] fileParamNames,
                     int maxUploadSize)
                      throws java.lang.Exception

Create uploaded file processor.

Parameters:

request - Servlet request.

fileParamNames - Parameter names of the files to upload.

maxUploadSize - Maximum ize (in bytes) of file to upload.

Throws:

java.lang.Exception - In case of error.

UploadedFileProcessor

public UploadedFileProcessor(org.restlet.Request request,
                     java.lang.String fileParamName,
                     int maxUploadSize)
                      throws java.lang.Exception

Create uploaded file processor when expecting a single file.

Parameters:

request - Servlet request.

fileParamName - Parameter name of file upload.

maxUploadSize - Maximum ize (in bytes) of file to upload.

Throws:

java.lang.Exception - In case of error.

Method Detail

getTemporaryDirectory

public java.io.File getTemporaryDirectory()

Get a temporary directory.

Returns:

A temporary directory.

getFileName

public java.lang.String getFileName(java.lang.String fieldName)

Get short file name for a parameter.

Parameters:

fieldName - The form field name.

Returns:

The short file name corresponding to the form field name. May be null.

getFullFileName

public java.lang.String getFullFileName(java.lang.String fieldName)

Get full file name for a parameter.

Parameters:

fieldName - The form field name.

Returns:

The full file name corresponding to the form field name. May be null.

addTempFile

public void addTempFile(java.lang.String fileName)

Add a file to the list of temporary file names.

Parameters:

fileName - File name to add to list of temporary files.

addTempDirectory

public void addTempDirectory(java.lang.String dirName)

Add a directory to the list of temporary directories.

Parameters:

dirName - Directory name to add to list of temporary directories.

getTempDirectories

public java.util.List<java.lang.String> getTempDirectories()

Get temporary directories to delete.

Returns:

List of temporary directories.

getTempFiles

public java.util.List<java.lang.String> getTempFiles()

Get temporary files to delete.

Returns:

List of temporary files.

deleteTemporaryFilesAndDirectories

public void deleteTemporaryFilesAndDirectories()

Delete the temporary files and directories.