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
Interface MultiPartRequest

All Known Implementing Classes:
  JakartaMultiPartRequest, JakartaStreamMultiPartRequest

    public interface MultiPartRequest

Abstract wrapper class HTTP requests to handle multi-part data.

Method Summary
`void` | `cleanUp()` Cleans up all uploaded file, should be called at the end of request
`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<String>` | `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(javax.servlet.http.HttpServletRequest request, String saveDir)`

Method Detail

### parse

    void parse(javax.servlet.http.HttpServletRequest request,
               String saveDir)
               throws IOException

  Throws:
    `IOException`

### getFileParameterNames

    Enumeration<String> getFileParameterNames()

  Returns an enumeration of the parameter names for uploaded files

  Returns:
    an enumeration of the parameter names for uploaded files

### getContentType

    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.

  Parameters:
    `fieldName` - input field name
  Returns:
    an array of content encoding for the specified input field name or `null` if no content type was specified.

### getFile

    File[] getFile(String fieldName)

  Returns a `File` object for the filename specified or `null` if no files are associated with the given field name.

  Parameters:
    `fieldName` - input field name
  Returns:
    a File[] object for files associated with the specified input field name

### getFileNames

    String[] getFileNames(String fieldName)

  Returns a String[] of file names for files associated with the specified input field name

  Parameters:
    `fieldName` - input field name
  Returns:
    a String[] of file names for files associated with the specified input field name

### getFilesystemName

    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.

  Parameters:
    `fieldName` - input field name
  Returns:
    the file system name(s) of files associated with the given field name

### getParameter

    String getParameter(String name)

  Returns the specified request parameter.

  Parameters:
    `name` - the name of the parameter to get
  Returns:
    the parameter or `null` if it was not found.

### getParameterNames

    Enumeration<String> getParameterNames()

  Returns an enumeration of String parameter names.

  Returns:
    an enumeration of String parameter names.

### getParameterValues

    String[] getParameterValues(String name)

  Returns a list of all parameter values associated with a parameter name. If there is only one parameter value per name the resulting array will be of length 1.

  Parameters:
    `name` - the name of the parameter.
  Returns:
    an array of all values associated with the parameter name.

### getErrors

    List<String> getErrors()

  Returns a list of error messages that may have occurred while processing the request. If there are no errors, an empty list is returned. If the underlying implementation (ie: pell, cos, jakarta, etc) cannot support providing these errors, an empty list is also returned. This list of errors is repoted back to the `MultiPartRequestWrapper`'s errors field.

  Returns:
    a list of Strings that represent various errors during parsing

### cleanUp

    void cleanUp()

  Cleans up all uploaded file, should be called at the end of request

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

Copyright © 2000–2018 Apache Software Foundation. All rights reserved.