jodd.servlet.upload
Class MultipartStreamParser

java.lang.Object
  jodd.servlet.upload.MultipartStreamParser

Direct Known Subclasses:

MultipartRequest

public class MultipartStreamParser
extends java.lang.Object

Generic, serlvets-free multipart request input stream parser.

Field Summary

protected FileUploadFactory	fileUploadFactory
protected java.util.Map<java.lang.String,FileUpload[]>	requestFiles
protected java.util.Map<java.lang.String,java.lang.String[]>	requestParameters

Constructor Summary

MultipartStreamParser()

MultipartStreamParser(FileUploadFactory fileUploadFactory)

Method Summary

FileUpload	getFile(java.lang.String paramName) Returns uploaded file.
java.util.Set<java.lang.String>	getFileParameterNames() Returns parameter names of all uploaded files.
FileUpload[]	getFiles(java.lang.String paramName) Returns all uploaded files the given request parameter has.
java.lang.String	getParameter(java.lang.String paramName) Returns single value of a parameter.
java.util.Set<java.lang.String>	getParameterNames() Returns the names of the parameters contained in this request.
java.lang.String[]	getParameterValues(java.lang.String paramName) Returns all values all of the values the given request parameter has.
boolean	isLoaded() Returns true if multi-part request is already loaded.
void	parseRequestStream(java.io.InputStream inputStream, java.lang.String encoding) Extracts uploaded files and parameters from the request data.
protected void	putFile(java.lang.String name, FileUpload value)
protected void	putParameter(java.lang.String name, java.lang.String value)
protected void	putParameters(java.lang.String name, java.lang.String[] values)
protected void	setLoaded() Sets the loaded flag that indicates that input stream is loaded and parsed.

Methods inherited from class java.lang.Object

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

Field Detail

fileUploadFactory

protected FileUploadFactory fileUploadFactory

requestParameters

protected java.util.Map<java.lang.String,java.lang.String[]> requestParameters

requestFiles

protected java.util.Map<java.lang.String,FileUpload[]> requestFiles

Constructor Detail

MultipartStreamParser

public MultipartStreamParser()

MultipartStreamParser

public MultipartStreamParser(FileUploadFactory fileUploadFactory)

Method Detail

setLoaded

protected void setLoaded()
                  throws java.io.IOException

Sets the loaded flag that indicates that input stream is loaded and parsed. Throws an exception if stream already loaded.

Throws:

java.io.IOException

isLoaded

public boolean isLoaded()

Returns true if multi-part request is already loaded.

putFile

protected void putFile(java.lang.String name,
                       FileUpload value)

putParameters

protected void putParameters(java.lang.String name,
                             java.lang.String[] values)

putParameter

protected void putParameter(java.lang.String name,
                            java.lang.String value)

parseRequestStream

public void parseRequestStream(java.io.InputStream inputStream,
                               java.lang.String encoding)
                        throws java.io.IOException

Extracts uploaded files and parameters from the request data.

Throws:

java.io.IOException

getParameter

public java.lang.String getParameter(java.lang.String paramName)

Returns single value of a parameter. If parameter name is used for more then one parameter, only the first one will be returned.

Returns:

parameter value, or null if not found

getParameterNames

public java.util.Set<java.lang.String> getParameterNames()

Returns the names of the parameters contained in this request.

getParameterValues

public java.lang.String[] getParameterValues(java.lang.String paramName)

Returns all values all of the values the given request parameter has.

getFile

public FileUpload getFile(java.lang.String paramName)

Returns uploaded file.

Parameters:

paramName - parameter name of the uploaded file

Returns:

uploaded file or null if parameter name not found

getFiles

public FileUpload[] getFiles(java.lang.String paramName)

Returns all uploaded files the given request parameter has.

getFileParameterNames

public java.util.Set<java.lang.String> getFileParameterNames()

Returns parameter names of all uploaded files.