|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.wicket.util.upload.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.
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.InvalidContentTypeException
Thrown to indicate that the request is not a multipart request. |
static class |
FileUploadBase.SizeLimitExceededException
Thrown to indicate that the request size exceeds the configured maximum. |
static class |
FileUploadBase.UnknownSizeException
Thrown to indicate that the request size is not specified. |
Field Summary | |
---|---|
static String |
ATTACHMENT
Content-disposition value for file attachment. |
static String |
CONTENT_DISPOSITION
HTTP content disposition 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
The maximum length of a single header line that will be parsed (1024 bytes). |
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<String,String> headers,
boolean isFormField)
Creates a new FileItem instance. |
protected byte[] |
getBoundary(String contentType)
Retrieves the boundary from the Content-type header. |
protected String |
getFieldName(Map<String,String> headers)
Retrieves the field name from the Content-disposition header. |
abstract FileItemFactory |
getFileItemFactory()
Returns the factory class used when creating file items. |
protected String |
getFileName(Map<String,String> headers)
Retrieves the file name from the Content-disposition header. |
protected String |
getHeader(Map<String,String> headers,
String name)
Returns the header with the specified name from the supplied map. |
String |
getHeaderEncoding()
Retrieves the character encoding used when reading the headers of an individual part. |
long |
getSizeMax()
Returns the maximum allowed upload size. |
static boolean |
isMultipartContent(RequestContext ctx)
Utility method that determines whether the request contains multipart content. |
protected Map<String,String> |
parseHeaders(String headerPart)
Parses the header-part and returns as key/value pairs. |
List<FileItem> |
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 |
setHeaderEncoding(String encoding)
Specifies the character encoding to be used when reading the headers of individual parts. |
void |
setSizeMax(long sizeMax)
Sets the maximum allowed upload size. |
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 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
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 abstract FileItemFactory getFileItemFactory()
public abstract void setFileItemFactory(FileItemFactory factory)
factory
- The factory class for new file items.public long getSizeMax()
setSizeMax(long)
public void setSizeMax(long sizeMax)
sizeMax
- The maximum allowed size, in bytes, or -1 for no maximum.getSizeMax()
public String getHeaderEncoding()
null
, the platform default encoding is used.
public void setHeaderEncoding(String encoding)
null
, the platform default encoding is used.
encoding
- The encoding used to read part headers.public List<FileItem> 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<String,String> headers)
Content-disposition
header.
headers
- A Map
containing the HTTP request headers.
encapsulation
.protected String getFieldName(Map<String,String> headers)
Content-disposition
header.
headers
- A Map
containing the HTTP request headers.
encapsulation
.protected FileItem createItem(Map<String,String> headers, boolean isFormField)
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.protected Map<String,String> parseHeaders(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 final String getHeader(Map<String,String> headers, String name)
headers
- A Map
containing the HTTP request headers.name
- The name of the header to return.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |