JakartaMultiPartRequest (Struts 2 Core 2.1.2 API)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.apache.struts2.dispatcher.multipart
Class JakartaMultiPartRequest

java.lang.Object
  org.apache.struts2.dispatcher.multipart.JakartaMultiPartRequest

All Implemented Interfaces:: MultiPartRequest

public class JakartaMultiPartRequest
extends Object
implements MultiPartRequest
extends Object
implements MultiPartRequest

Multipart form data request adapter for Jakarta Commons Fileupload package.

Field Summary
`private List<String>`	`errors`
`private Map<String,List<org.apache.commons.fileupload.FileItem>>`	`files`
`(package private) static Logger`	`LOG`
`private long`	`maxSize`
`private Map<String,List<String>>`	`params`

Constructor Summary
`JakartaMultiPartRequest()`

Method Summary
`private org.apache.commons.fileupload.RequestContext`	`createRequestContext(HttpServletRequest req)` Creates a RequestContext needed by Jakarta Commons Upload.
`private String`	`getCanonicalName(String filename)` Returns the canonical name of the given file.
`String[]`	`getContentType(String fieldName)` Returns the content type(s) of the file(s) associated with the specified field name (as supplied by the client browser), or `null` if no files are associated with the given field name.
`List`	`getErrors()` Returns a list of error messages that may have occurred while processing the request.
`File[]`	`getFile(String fieldName)` Returns a `File` object for the filename specified or `null` if no files are associated with the given field name.
`String[]`	`getFileNames(String fieldName)` Returns a String[] of file names for files associated with the specified input field name
`Enumeration<String>`	`getFileParameterNames()` Returns an enumeration of the parameter names for uploaded files
`String[]`	`getFilesystemName(String fieldName)` Returns the file system name(s) of files associated with the given field name or `null` if no files are associated with the given field name.
`String`	`getParameter(String name)` Returns the specified request parameter.
`Enumeration<String>`	`getParameterNames()` Returns an enumeration of String parameter names.
`String[]`	`getParameterValues(String name)` Returns a list of all parameter values associated with a parameter name.
`void`	`parse(HttpServletRequest servletRequest, String saveDir)` Creates a new request wrapper to handle multi-part data using methods adapted from Jason Pell's multipart classes (see class description).
`void`	`setMaxSize(String maxSize)`

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Field Detail

LOG

static final Logger LOG

files

private Map<String,List<org.apache.commons.fileupload.FileItem>> files

params

private Map<String,List<String>> params

errors

private List<String> errors

maxSize

private long maxSize

Constructor Detail

JakartaMultiPartRequest

public JakartaMultiPartRequest()

Method Detail

setMaxSize

public void setMaxSize(String maxSize)

parse

public void parse(HttpServletRequest servletRequest,
                  String saveDir)
           throws IOException

Creates a new request wrapper to handle multi-part data using methods adapted from Jason Pell's multipart classes (see class description).

Specified by:: parse in interface MultiPartRequest

Parameters:: saveDir - the directory to save off the file; servletRequest - the request containing the multipart
Throws:: IOException - is thrown if encoding fails.