Maximo 7.6.1.2 API - HttpMultipart

java.lang.Object
- psdi.iface.servlet.HttpMultipart

```
public class HttpMultipart
extends java.lang.Object
```
HttpMultipart represents a Multipart Request with ordered lists of parameters and files. This class is loosely based on the O'Reilly Multipart Request (com.oreilly.servlet.MultipartRequest). However it differs in the following aspects:
a) The O'reilly class does not guarantee order upon retrieval (i.e., getParameterNames() and getFileNames() invoke Hashtable.keys(), which returns keys in the reverse order of addition). b) It fixes a bug related to the order in which the headers are present. The headers can be present in any order, instead of a specific order. c) Stores any user-defined headers in each individual part of the muti-part data d) It uses better data structures like HashMap and Iterator instead of Hashtable and Enumeration.

Version:

1.0 4/15/02

Author:

Junaid Bhatra

Constructor Summary

Constructors
Constructor and Description
`HttpMultipart(javax.servlet.ServletRequest request, java.lang.String saveDirectory)` Constructs a new HttpMultipart to handle the specified request, saving any uploaded files to the given directory, and limiting the upload size to 2 MB.
`HttpMultipart(javax.servlet.ServletRequest request, java.lang.String saveDirectory, int maxPostSize)` Constructs a new HttpMultipart to handle the specified request, saving any uploaded files to the given directory, and limiting the upload size to the specified length.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`deleteAllUploadedFiles()` Delete all the uploaded files.
`java.lang.String`	`getContentType(java.lang.String name)` Returns the content type of the specified file (as supplied by the client browser), or null if the file was not included in the upload.
`java.io.File`	`getFile(java.lang.String name)` Returns a File object for the specified file saved on the server's filesystem, or null if the file was not included in the upload.
`java.util.Iterator`	`getFileNames()` Returns the names of all the uploaded files as an Iterator of Strings.
`java.lang.String`	`getFilesystemName(java.lang.String name)` Returns the filesystem name of the specified file, or null if the file was not included in the upload.
`java.util.Map`	`getHeaders(java.lang.String name)` Returns the user-defined headers associated with each individual part of the multi-part request
`java.util.List`	`getListFileName()` getListFileName - Get list of file names
`java.util.List`	`getListParameterName()` getListParameterName - Get list of parameter names
`java.lang.String`	`getParameter(java.lang.String name)` Returns the value of the named parameter as a String, or null if the parameter was not given.
`java.util.Iterator`	`getParameterNames()` Returns the names of all the parameters as an Iterator of Strings.

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

- Constructor Detail
  - HttpMultipart
```
public HttpMultipart(javax.servlet.ServletRequest request,
                     java.lang.String saveDirectory)
              throws java.io.IOException
```
    Constructs a new HttpMultipart to handle the specified request, saving any uploaded files to the given directory, and limiting the upload size to 2 MB. If the content is too large, an IOException is thrown. This constructor actually parses the multipart/form-data and throws an IOException if there's any problem reading or parsing the request.
    
    Parameters:
    
    request - the servlet request
    
    saveDirectory - the directory in which to save any uploaded files
    
    Throws:
    
    java.io.IOException - if the uploaded content is larger than 1 Megabyte or there's a problem reading or parsing the request
  - HttpMultipart
```
public HttpMultipart(javax.servlet.ServletRequest request,
                     java.lang.String saveDirectory,
                     int maxPostSize)
              throws java.io.IOException
```
    Constructs a new HttpMultipart to handle the specified request, saving any uploaded files to the given directory, and limiting the upload size to the specified length. If the content is too large, an IOException is thrown. This constructor actually parses the multipart/form-data and throws an IOException if there's any problem reading or parsing the request.
    
    Parameters:
    
    request - the servlet request
    
    saveDirectory - the directory in which to save any uploaded files
    
    maxPostSize - the maximum size of the POST content
    
    Throws:
    
    java.io.IOException - if the uploaded content is larger than maxPostSize or there's a problem reading or parsing the request
- Method Detail
  - getListParameterName
```
public java.util.List getListParameterName()
                                    throws java.lang.Exception
```
    getListParameterName - Get list of parameter names
    
    Parameters:
    
    None -
    
    Returns:
    
    List - List of parameter names
    
    Throws:
    
    java.lang.Exception
  - getListFileName
```
public java.util.List getListFileName()
                               throws java.lang.Exception
```
    getListFileName - Get list of file names
    
    Parameters:
    
    None -
    
    Returns:
    
    List - List of file names
    
    Throws:
    
    java.lang.Exception
  - getParameterNames
```
public java.util.Iterator getParameterNames()
```
    Returns the names of all the parameters as an Iterator of Strings. It returns an empty Enumeration if there are no parameters.
    
    Returns:
    
    the names of all the parameters as an Iterator of Strings
  - getFileNames
```
public java.util.Iterator getFileNames()
```
    Returns the names of all the uploaded files as an Iterator of Strings. It returns an empty Enumeration if there are no uploaded files. Each file name is the name specified by the form, not by the user.
    
    Returns:
    
    the names of all the uploaded files as an Iterator of Strings
  - getParameter
```
public java.lang.String getParameter(java.lang.String name)
```
    Returns the value of the named parameter as a String, or null if the parameter was not given. The value is guaranteed to be in its normal, decoded form. If the parameter has multiple values, only the last one is returned.
    
    Parameters:
    
    name - the parameter name
    
    Returns:
    
    the parameter value
  - getFilesystemName
```
public java.lang.String getFilesystemName(java.lang.String name)
```
    Returns the filesystem name of the specified file, or null if the file was not included in the upload. A filesystem name is the name specified by the user. It is also the name under which the file is actually saved.
    
    Parameters:
    
    name - the file name
    
    Returns:
    
    the filesystem name of the file
  - getContentType
```
public java.lang.String getContentType(java.lang.String name)
```
    Returns the content type of the specified file (as supplied by the client browser), or null if the file was not included in the upload.
    
    Parameters:
    
    name - the file name
    
    Returns:
    
    the content type of the file
  - getFile
```
public java.io.File getFile(java.lang.String name)
```
    Returns a File object for the specified file saved on the server's filesystem, or null if the file was not included in the upload.
    
    Parameters:
    
    name - the file name
    
    Returns:
    
    a File object for the named file
  - getHeaders
```
public java.util.Map getHeaders(java.lang.String name)
```
    Returns the user-defined headers associated with each individual part of the multi-part request
  - deleteAllUploadedFiles
```
public void deleteAllUploadedFiles()
```
    Delete all the uploaded files. Can be called after all the files of interest have been read/processed

Class HttpMultipart

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

HttpMultipart

HttpMultipart

Method Detail

getListParameterName

getListFileName

getParameterNames

getFileNames

getParameter

getFilesystemName

getContentType

getFile

getHeaders

deleteAllUploadedFiles