org.apache.wicket.protocol.http.servlet
Class MultipartServletWebRequest

java.lang.Object
  org.apache.wicket.Request
      org.apache.wicket.protocol.http.WebRequest
          org.apache.wicket.protocol.http.servlet.ServletWebRequest
              org.apache.wicket.protocol.http.servlet.MultipartServletWebRequest

All Implemented Interfaces:

IMultipartWebRequest

public class MultipartServletWebRequest
extends ServletWebRequest
implements IMultipartWebRequest

Servlet specific WebRequest subclass for multipart content uploads.

Author:

Jonathan Locke, Eelco Hillenius, Cameron Braid, Ate Douma, Igor Vaynberg (ivaynberg)

Constructor Summary

MultipartServletWebRequest(javax.servlet.http.HttpServletRequest request, Bytes maxSize)
Constructor.

MultipartServletWebRequest(javax.servlet.http.HttpServletRequest request, Bytes maxSize, FileItemFactory factory)
Constructor

Method Summary

FileItem	getFile(String fieldName) Gets the file that was uploaded using the given field name.
Map<String,FileItem>	getFiles()
String	getParameter(String key) Gets the request parameter with the given key.
Map	getParameterMap() Gets the request parameters.
String[]	getParameters(String key) Gets the request parameters with the given key.
protected void	onUploadCompleted() Upload completed callback
protected void	onUploadStarted(int totalBytes) Upload start callback
protected void	onUploadUpdate(int bytesUploaded, int total) Upload status update callback
protected boolean	wantUploadProgressUpdates() Subclasses that want to receive upload notifications should return true

Methods inherited from class org.apache.wicket.protocol.http.servlet.ServletWebRequest

getDepthRelativeToWicketHandler, getHttpServletRequest, getLocale, getPath, getQueryString, getRelativePathPrefixToContextRoot, getRelativePathPrefixToWicketHandler, getServletPath, getURL, isAjax, mergeVersion, newMultipartWebRequest, setAjax, setForceNewVersion, setWicketRedirectUrl, toString

Methods inherited from class org.apache.wicket.protocol.http.WebRequest

getCookie, getCookies

Methods inherited from class org.apache.wicket.Request

decodeURL, getPage, getRelativeURL, getRequestParameters, setPage, setRequestParameters

Methods inherited from class java.lang.Object

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

Constructor Detail

MultipartServletWebRequest

public MultipartServletWebRequest(javax.servlet.http.HttpServletRequest request,
                                  Bytes maxSize)
                           throws FileUploadException

Constructor. This constructor will use DiskFileItemFactory to store uploads.

Parameters:

maxSize - the maximum size allowed for this request

request - the servlet request

Throws:

FileUploadException - Thrown if something goes wrong with upload

MultipartServletWebRequest

public MultipartServletWebRequest(javax.servlet.http.HttpServletRequest request,
                                  Bytes maxSize,
                                  FileItemFactory factory)
                           throws FileUploadException

Constructor

Parameters:

maxSize - the maximum size allowed for this request

request - the servlet request

factory - DiskFileItemFactory to use when creating file items used to represent uploaded files

Throws:

FileUploadException - Thrown if something goes wrong with upload

Method Detail

getFiles

public Map<String,FileItem> getFiles()

Specified by:

getFiles in interface IMultipartWebRequest

Returns:

Returns the files.

getFile

public FileItem getFile(String fieldName)

Gets the file that was uploaded using the given field name.

Specified by:

getFile in interface IMultipartWebRequest

Parameters:

fieldName - the field name that was used for the upload

Returns:

the upload with the given field name

getParameter

public String getParameter(String key)

Description copied from class: ServletWebRequest

Gets the request parameter with the given key.

Overrides:

getParameter in class ServletWebRequest

Parameters:

key - Parameter name

Returns:

Parameter value

See Also:

WebRequest.getParameter(java.lang.String)

getParameterMap

public Map getParameterMap()

Description copied from class: ServletWebRequest

Gets the request parameters.

Overrides:

getParameterMap in class ServletWebRequest

Returns:

Map of parameters

See Also:

WebRequest.getParameterMap()

getParameters

public String[] getParameters(String key)

Description copied from class: ServletWebRequest

Gets the request parameters with the given key.

Overrides:

getParameters in class ServletWebRequest

Parameters:

key - Parameter name

Returns:

Parameter values

See Also:

WebRequest.getParameters(java.lang.String)

wantUploadProgressUpdates

protected boolean wantUploadProgressUpdates()

Subclasses that want to receive upload notifications should return true

Returns:

true if upload status update event should be invoked

onUploadStarted

protected void onUploadStarted(int totalBytes)

Upload start callback

Parameters:

totalBytes -

onUploadUpdate

protected void onUploadUpdate(int bytesUploaded,
                              int total)

Upload status update callback

Parameters:

bytesUploaded -

total -

onUploadCompleted

protected void onUploadCompleted()

Upload completed callback