org.jahia.tools.files

Class FileUpload

java.lang.Object

org.jahia.tools.files.FileUpload

public class FileUpload
extends Object

Class FileUpload. Class to handle fileupload It's essentially a wrapper for the Multipart Request class of the com.oreilly.servlet.Multipart class

Version:

1.0

Author:

Khue ng

Field Summary

Fields

Modifier and Type	Field and Description
static String	FILEUPLOAD_ATTRIBUTE

Constructor Summary

Constructors

Constructor and Description
FileUpload(javax.servlet.http.HttpServletRequest req, String savePath, int fileMaxSize) Constructor
FileUpload(javax.servlet.http.HttpServletRequest req, String savePath, int fileMaxSize, String charset) Constructor

Method Summary

Modifier and Type	Method and Description
protected boolean	checkSavePath(String path) Method checkSavePath Check if the path where to save files is valid
void	disposeItems()
File	getFile(String n)
String	getFileContentType(String n)
Map<String,org.apache.commons.fileupload.disk.DiskFileItem>	getFileItems() Returns the map of all FileUpload objects keyed by the form field name.
Set<String>	getFileNames() Return an Iterator of parameters name
String	getFileSystemName(String n)
String	getFormFieldName(String n)
String	getParameterContentType(String paramName) Return the content type of a parameter
Map<String,List<String>>	getParameterMap()
Set<String>	getParameterNames() Return an Iterator of parameters name
String[]	getParameterValues(String paramName) Return the values of a parameter
protected void	init() Init the MultiPartReq object if it's actually null
void	markFilesAsConsumed()
protected void	parseQueryString() Parse a query String and create an Map of parameter/value
void	setParameterMap(Map<String,List<String>> params)

Methods inherited from class java.lang.Object

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

Field Detail

FILEUPLOAD_ATTRIBUTE

public static final String FILEUPLOAD_ATTRIBUTE

See Also:

Constant Field Values

Constructor Detail

FileUpload

public FileUpload(javax.servlet.http.HttpServletRequest req,
                  String savePath,
                  int fileMaxSize)
           throws IOException

Constructor

Parameters:

req -

savePath - the path where files should be saved

fileMaxSize - the max size of file to upload

Throws:

IOException

FileUpload

public FileUpload(javax.servlet.http.HttpServletRequest req,
                  String savePath,
                  int fileMaxSize,
                  String charset)
           throws IOException

Constructor

Parameters:

req -

savePath - the path where files should be saved

fileMaxSize - the max size of file to upload

charset - The charset to use to decode the values (default = UTF-8)

Throws:

IOException

Method Detail

init

protected void init()
             throws IOException

Init the MultiPartReq object if it's actually null

Throws:

IOException

getParameterNames

public Set<String> getParameterNames()

Return an Iterator of parameters name

Returns:

an Iterator of parameters name

getParameterMap

public Map<String,List<String>> getParameterMap()

setParameterMap

public void setParameterMap(Map<String,List<String>> params)

getParameterValues

public String[] getParameterValues(String paramName)

Return the values of a parameter

Parameters:

paramName - the name of the parameter

Returns:

the values of a parameter as a String Array

getParameterContentType

public String getParameterContentType(String paramName)

Return the content type of a parameter

Parameters:

paramName - the name of the parameter

Returns:

the values of a parameter as a String Array

getFileNames

public Set<String> getFileNames()

Return an Iterator of parameters name

Returns:

an Iterator of parameters name

getFile

public File getFile(String n)

getFileItems

public Map<String,org.apache.commons.fileupload.disk.DiskFileItem> getFileItems()

Returns the map of all FileUpload objects keyed by the form field name.

Returns:

the map of all FileUpload objects keyed by the form field name

getFileSystemName

public String getFileSystemName(String n)

getFormFieldName

public String getFormFieldName(String n)

getFileContentType

public String getFileContentType(String n)

markFilesAsConsumed

public void markFilesAsConsumed()

checkSavePath

protected boolean checkSavePath(String path)

Method checkSavePath Check if the path where to save files is valid

Parameters:

path - the relative path where to save files to

Returns:

true if this directory exists, and can be write to

disposeItems

public void disposeItems()

parseQueryString

protected void parseQueryString()

Parse a query String and create an Map of parameter/value