FileUpload (Hasor-Web 4.1.2 API)

java.lang.Object
- net.hasor.web.upload.FileUpload

```
public class FileUpload
extends Object
```
High level API for processing file uploads.

This class handles multiple files per single HTML widget, sent using multipart/mixed encoding type, as specified by RFC 1867.
How the data for individual parts is stored is determined by the factory used to create them; a given part may be in memory, on disk, or somewhere else.

版本:

$Id: FileUpload.java 1743630 2016-05-13 09:20:45Z jochen $

嵌套类概要

嵌套类
限定符和类型类和说明

class FileUpload.FileItemIteratorImpl
The iterator, which is returned by getItemIterator(HttpServletRequest).

嵌套类
限定符和类型	类和说明
`class`	`FileUpload.FileItemIteratorImpl` The iterator, which is returned by `getItemIterator(HttpServletRequest)`.

字段概要

字段
限定符和类型	字段和说明
`static String`	`ATTACHMENT` Content-disposition value for file attachment.
`static String`	`CONTENT_DISPOSITION` HTTP content disposition header name.
`static String`	`CONTENT_LENGTH` HTTP content length header name.
`static String`	`CONTENT_TYPE` HTTP content type header name.
`static String`	`FORM_DATA` Content-disposition value for form data.
`static String`	`MULTIPART` Part of HTTP content type header.
`static String`	`MULTIPART_FORM_DATA` HTTP content type header for multipart forms.
`static String`	`MULTIPART_MIXED` HTTP content type header for multiple uploads.

构造器概要

构造器
构造器和说明

FileUpload()

FileUpload(Settings settings)

构造器
构造器和说明
`FileUpload()`
`FileUpload(Settings settings)`

方法概要

所有方法静态方法实例方法具体方法
限定符和类型	方法和说明
`protected byte[]`	`getBoundary(String contentType)` Retrieves the boundary from the `Content-type` header.
`protected String`	`getFieldName(FileItemHeaders headers)` Retrieves the field name from the `Content-disposition` header.
`protected String`	`getFileName(FileItemHeaders headers)` Retrieves the file name from the `Content-disposition` header.
`long`	`getFileSizeMax()` Returns the maximum allowed size of a single uploaded file, as opposed to `getSizeMax()`.
`String`	`getHeaderEncoding()` Retrieves the character encoding used when reading the headers of an individual part.
`Iterator<FileItemStream>`	`getItemIterator(javax.servlet.http.HttpServletRequest request)` Processes an RFC 1867 compliant `multipart/form-data` stream.
`protected FileItemHeaders`	`getParsedHeaders(String headerPart)` Parses the `header-part` and returns as key/value pairs.
`long`	`getSizeMax()` Returns the maximum allowed size of a complete request, as opposed to `getFileSizeMax()`.
`static boolean`	`isMultipartContent(javax.servlet.http.HttpServletRequest request)` Utility method that determines whether the request contains multipart content.
`List<FileItem>`	`parseRequest(javax.servlet.http.HttpServletRequest request, FileItemFactory factory)` Processes an RFC 1867 compliant `multipart/form-data` stream.
`void`	`setFileSizeMax(long fileSizeMax)` Sets the maximum allowed size of a single uploaded file, as opposed to `getSizeMax()`.
`void`	`setHeaderEncoding(String encoding)` Specifies the character encoding to be used when reading the headers of individual part.
`void`	`setSizeMax(long sizeMax)` Sets the maximum allowed size of a complete request, as opposed to `setFileSizeMax(long)`.

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 字段详细资料
  - CONTENT_TYPE
```
public static final String CONTENT_TYPE
```
    HTTP content type header name.
    
    另请参阅:
    
    常量字段值
  - CONTENT_DISPOSITION
```
public static final String CONTENT_DISPOSITION
```
    HTTP content disposition header name.
    
    另请参阅:
    
    常量字段值
  - CONTENT_LENGTH
```
public static final String CONTENT_LENGTH
```
    HTTP content length header name.
    
    另请参阅:
    
    常量字段值
  - FORM_DATA
```
public static final String FORM_DATA
```
    Content-disposition value for form data.
    
    另请参阅:
    
    常量字段值
  - ATTACHMENT
```
public static final String ATTACHMENT
```
    Content-disposition value for file attachment.
    
    另请参阅:
    
    常量字段值
  - MULTIPART
```
public static final String MULTIPART
```
    Part of HTTP content type header.
    
    另请参阅:
    
    常量字段值
  - MULTIPART_FORM_DATA
```
public static final String MULTIPART_FORM_DATA
```
    HTTP content type header for multipart forms.
    
    另请参阅:
    
    常量字段值
  - MULTIPART_MIXED
```
public static final String MULTIPART_MIXED
```
    HTTP content type header for multiple uploads.
    
    另请参阅:
    
    常量字段值
- 构造器详细资料
  - FileUpload
```
public FileUpload()
```
  - FileUpload
```
public FileUpload(Settings settings)
```
- 方法详细资料
  - isMultipartContent
```
public static final boolean isMultipartContent(javax.servlet.http.HttpServletRequest request)
```
    Utility method that determines whether the request contains multipart content.
    
    参数:
    
    request - The servlet request to be evaluated. Must be non-null.
    
    返回:
    
    true if the request is multipart; false otherwise.
  - getSizeMax
```
public long getSizeMax()
```
    Returns the maximum allowed size of a complete request, as opposed to getFileSizeMax().
    
    返回:
    
    The maximum allowed size, in bytes. The default value of -1 indicates, that there is no limit.
    
    另请参阅:
    
    setSizeMax(long)
  - setSizeMax
```
public void setSizeMax(long sizeMax)
```
    Sets the maximum allowed size of a complete request, as opposed to setFileSizeMax(long).
    
    参数:
    
    sizeMax - The maximum allowed size, in bytes. The default value of -1 indicates, that there is no limit.
    
    另请参阅:
    
    getSizeMax()
  - getFileSizeMax
```
public long getFileSizeMax()
```
    Returns the maximum allowed size of a single uploaded file, as opposed to getSizeMax().
    
    返回:
    
    Maximum size of a single uploaded file.
    
    另请参阅:
    
    setFileSizeMax(long)
  - setFileSizeMax
```
public void setFileSizeMax(long fileSizeMax)
```
    Sets the maximum allowed size of a single uploaded file, as opposed to getSizeMax().
    
    参数:
    
    fileSizeMax - Maximum size of a single uploaded file.
    
    另请参阅:
    
    getFileSizeMax()
  - getHeaderEncoding
```
public String getHeaderEncoding()
```
    Retrieves the character encoding used when reading the headers of an individual part. When not specified, or null, the request encoding is used. If that is also not specified, or null, the platform default encoding is used.
    
    返回:
    
    The encoding used to read part headers.
  - setHeaderEncoding
```
public void setHeaderEncoding(String encoding)
```
    Specifies the character encoding to be used when reading the headers of individual part. When not specified, or null, the request encoding is used. If that is also not specified, or null, the platform default encoding is used.
    
    参数:
    
    encoding - The encoding used to read part headers.
  - getItemIterator
```
public Iterator<FileItemStream> getItemIterator(javax.servlet.http.HttpServletRequest request)
                                         throws IOException
```
    Processes an RFC 1867 compliant multipart/form-data stream.
    
    参数:
    
    request - The request.
    
    返回:
    
    An iterator to instances of FileItemStream parsed from the request, in the order that they were transmitted.
    
    抛出:
    
    FileUploadException - if there are problems reading/parsing the request or storing files.
    
    IOException - An I/O error occurred. This may be a network error while communicating with the client or a problem while storing the uploaded content.
  - parseRequest
```
public List<FileItem> parseRequest(javax.servlet.http.HttpServletRequest request,
                                   FileItemFactory factory)
                            throws IOException
```
    Processes an RFC 1867 compliant multipart/form-data stream.
    
    参数:
    
    request - the request.
    
    返回:
    
    A list of FileItem instances parsed from the request, in the order that they were transmitted.
    
    抛出:
    
    FileUploadException - if there are problems reading/parsing the request or storing files.
    
    IOException
  - getBoundary
```
protected byte[] getBoundary(String contentType)
```
    Retrieves the boundary from the Content-type header.
    
    参数:
    
    contentType - The value of the content type header from which to extract the boundary value.
    
    返回:
    
    The boundary, as a byte array.
  - getFileName
```
protected String getFileName(FileItemHeaders headers)
```
    Retrieves the file name from the Content-disposition header.
    
    参数:
    
    headers - The HTTP headers object.
    
    返回:
    
    The file name for the current encapsulation.
  - getFieldName
```
protected String getFieldName(FileItemHeaders headers)
```
    Retrieves the field name from the Content-disposition header.
    
    参数:
    
    headers - A Map containing the HTTP request headers.
    
    返回:
    
    The field name for the current encapsulation.
  - getParsedHeaders
```
protected FileItemHeaders getParsedHeaders(String headerPart)
```
    Parses the header-part and returns as key/value pairs.
    If there are multiple headers of the same names, the name will map to a comma-separated list containing the values.
    
    参数:
    
    headerPart - The header-part of the current encapsulation.
    
    返回:
    
    A Map containing the parsed HTTP request headers.

类 FileUpload

嵌套类概要

字段概要

构造器概要

方法概要

从类继承的方法 java.lang.Object

字段详细资料

CONTENT_TYPE

CONTENT_DISPOSITION

CONTENT_LENGTH

FORM_DATA

ATTACHMENT

MULTIPART

MULTIPART_FORM_DATA

MULTIPART_MIXED

构造器详细资料

FileUpload

FileUpload

方法详细资料

isMultipartContent

getSizeMax

setSizeMax

getFileSizeMax

setFileSizeMax

getHeaderEncoding

setHeaderEncoding

getItemIterator

parseRequest

getBoundary

getFileName

getFieldName

getParsedHeaders