|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.commons.fileupload.FileUploadBase
public abstract class FileUploadBase
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. Use parseRequest(HttpServletRequest)
to acquire a list of FileItem
s associated with a given HTML
widget.
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.
Nested Class Summary | |
---|---|
static class |
FileUploadBase.FileSizeLimitExceededException
Thrown to indicate that A files size exceeds the configured maximum. |
static class |
FileUploadBase.FileUploadIOException
This exception is thrown for hiding an inner FileUploadException in an IOException . |
static class |
FileUploadBase.InvalidContentTypeException
Thrown to indicate that the request is not a multipart request. |
static class |
FileUploadBase.IOFileUploadException
Thrown to indicate an IOException. |
protected static class |
FileUploadBase.SizeException
This exception is thrown, if a requests permitted size is exceeded. |
static class |
FileUploadBase.SizeLimitExceededException
Thrown to indicate that the request size exceeds the configured maximum. |
static class |
FileUploadBase.UnknownSizeException
Deprecated. As of commons-fileupload 1.2, the presence of a content-length header is no longer required. |
Field Summary | |
---|---|
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 int |
MAX_HEADER_SIZE
Deprecated. This constant is no longer used. As of commons-fileupload 1.2, the only applicable limit is the total size of a parts headers, MultipartStream.HEADER_PART_SIZE_MAX . |
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. |
Constructor Summary | |
---|---|
FileUploadBase()
|
Method Summary | |
---|---|
protected FileItem |
createItem(Map headers,
boolean isFormField)
Deprecated. This method is no longer used in favour of internally created instances of FileItem . |
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 |
getFieldName(Map headers)
Deprecated. Use getFieldName(FileItemHeaders) . |
abstract FileItemFactory |
getFileItemFactory()
Returns the factory class used when creating file items. |
protected String |
getFileName(FileItemHeaders headers)
Retrieves the file name from the Content-disposition
header. |
protected String |
getFileName(Map headers)
Deprecated. Use getFileName(FileItemHeaders) . |
long |
getFileSizeMax()
Returns the maximum allowed size of a single uploaded file, as opposed to getSizeMax() . |
protected String |
getHeader(Map headers,
String name)
Deprecated. Use FileItemHeaders.getHeader(String) . |
String |
getHeaderEncoding()
Retrieves the character encoding used when reading the headers of an individual part. |
FileItemIterator |
getItemIterator(RequestContext ctx)
Processes an RFC 1867 compliant multipart/form-data stream. |
protected FileItemHeaders |
getParsedHeaders(String headerPart)
Parses the header-part and returns as key/value
pairs. |
ProgressListener |
getProgressListener()
Returns the progress listener. |
long |
getSizeMax()
Returns the maximum allowed size of a complete request, as opposed to getFileSizeMax() . |
static boolean |
isMultipartContent(javax.servlet.http.HttpServletRequest req)
Deprecated. Use the method on ServletFileUpload instead. |
static boolean |
isMultipartContent(RequestContext ctx)
Utility method that determines whether the request contains multipart content. |
protected FileItemHeadersImpl |
newFileItemHeaders()
Creates a new instance of FileItemHeaders . |
protected Map |
parseHeaders(String headerPart)
Deprecated. Use getParsedHeaders(String) |
List |
parseRequest(javax.servlet.http.HttpServletRequest req)
Deprecated. Use the method in ServletFileUpload instead. |
List |
parseRequest(RequestContext ctx)
Processes an RFC 1867 compliant multipart/form-data stream. |
abstract void |
setFileItemFactory(FileItemFactory factory)
Sets the factory class to use when creating file items. |
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 |
setProgressListener(ProgressListener pListener)
Sets the progress listener. |
void |
setSizeMax(long sizeMax)
Sets the maximum allowed size of a complete request, as opposed to setFileSizeMax(long) . |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final String CONTENT_TYPE
public static final String CONTENT_DISPOSITION
public static final String CONTENT_LENGTH
public static final String FORM_DATA
public static final String ATTACHMENT
public static final String MULTIPART
public static final String MULTIPART_FORM_DATA
public static final String MULTIPART_MIXED
public static final int MAX_HEADER_SIZE
MultipartStream.HEADER_PART_SIZE_MAX
.
Constructor Detail |
---|
public FileUploadBase()
Method Detail |
---|
public static final boolean isMultipartContent(RequestContext ctx)
Utility method that determines whether the request contains multipart content.
NOTE:This method will be moved to the
ServletFileUpload
class after the FileUpload 1.1 release.
Unfortunately, since this method is static, it is not possible to
provide its replacement until this method is removed.
ctx
- The request context to be evaluated. Must be non-null.
true
if the request is multipart;
false
otherwise.public static boolean isMultipartContent(javax.servlet.http.HttpServletRequest req)
ServletFileUpload
instead.
req
- The servlet request to be evaluated. Must be non-null.
true
if the request is multipart;
false
otherwise.public abstract FileItemFactory getFileItemFactory()
public abstract void setFileItemFactory(FileItemFactory factory)
factory
- The factory class for new file items.public long getSizeMax()
getFileSizeMax()
.
setSizeMax(long)
public void setSizeMax(long sizeMax)
setFileSizeMax(long)
.
sizeMax
- The maximum allowed size, in bytes. The default value of
-1 indicates, that there is no limit.getSizeMax()
public long getFileSizeMax()
getSizeMax()
.
setFileSizeMax(long)
public void setFileSizeMax(long fileSizeMax)
getSizeMax()
.
fileSizeMax
- Maximum size of a single uploaded file.getFileSizeMax()
public String getHeaderEncoding()
null
, the request
encoding is used. If that is also not specified, or null
,
the platform default encoding is used.
public void setHeaderEncoding(String encoding)
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.public List parseRequest(javax.servlet.http.HttpServletRequest req) throws FileUploadException
ServletFileUpload
instead.
multipart/form-data
stream.
req
- The servlet request to be parsed.
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.public FileItemIterator getItemIterator(RequestContext ctx) throws FileUploadException, IOException
multipart/form-data
stream.
ctx
- The context for the request to be parsed.
FileItemStream
parsed from the request, in the order that they were
transmitted.
FileUploadException
- if there are problems reading/parsing
the request or storing files.
FileUploadBase.FileUploadIOException
- An I/O error occurred. This may be a network
error while communicating with the client or a problem while
storing the uploaded content.
IOException
public List parseRequest(RequestContext ctx) throws FileUploadException
multipart/form-data
stream.
ctx
- The context for the request to be parsed.
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.protected byte[] getBoundary(String contentType)
Content-type
header.
contentType
- The value of the content type header from which to
extract the boundary value.
protected String getFileName(Map headers)
getFileName(FileItemHeaders)
.
Content-disposition
header.
headers
- A Map
containing the HTTP request headers.
encapsulation
.protected String getFileName(FileItemHeaders headers)
Content-disposition
header.
headers
- The HTTP headers object.
encapsulation
.protected String getFieldName(FileItemHeaders headers)
Content-disposition
header.
headers
- A Map
containing the HTTP request headers.
encapsulation
.protected String getFieldName(Map headers)
getFieldName(FileItemHeaders)
.
Content-disposition
header.
headers
- A Map
containing the HTTP request headers.
encapsulation
.protected FileItem createItem(Map headers, boolean isFormField) throws FileUploadException
FileItem
.
FileItem
instance.
headers
- A Map
containing the HTTP request
headers.isFormField
- Whether or not this item is a form field, as
opposed to a file.
FileItem
instance.
FileUploadException
- if an error occurs.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
.
Map
containing the parsed HTTP request headers.protected FileItemHeadersImpl newFileItemHeaders()
FileItemHeaders
.
protected Map parseHeaders(String headerPart)
getParsedHeaders(String)
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
.
Map
containing the parsed HTTP request headers.protected final String getHeader(Map headers, String name)
FileItemHeaders.getHeader(String)
.
headers
- A Map
containing the HTTP request headers.name
- The name of the header to return.
public ProgressListener getProgressListener()
public void setProgressListener(ProgressListener pListener)
pListener
- The progress listener, if any. Defaults to null.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |