org.apache.commons.httpclient.methods.multipart
Class MultipartRequestEntity
java.lang.Object
org.apache.commons.httpclient.methods.multipart.MultipartRequestEntity
- RequestEntity
public class MultipartRequestEntity
extends java.lang.Object
Implements a request entity suitable for an HTTP multipart POST method.
The HTTP multipart POST method is defined in section 3.3 of
RFC1867:
The media-type multipart/form-data follows the rules of all multipart
MIME data streams as outlined in RFC 1521. The multipart/form-data contains
a series of parts. Each part is expected to contain a content-disposition
header where the value is "form-data" and a name attribute specifies
the field name within the form, e.g., 'content-disposition: form-data;
name="xxxxx"', where xxxxx is the field name corresponding to that field.
Field names originally in non-ASCII character sets may be encoded using
the method outlined in RFC 1522.
This entity is designed to be used in conjunction with the
post method
to provide
multipart posts. Example usage:
File f = new File("/path/fileToUpload.txt");
PostMethod filePost = new PostMethod("http://host/some_path");
Part[] parts = {
new StringPart("param_name", "value"),
new FilePart(f.getName(), f)
};
filePost.setRequestEntity(
new MultipartRequestEntity(parts, filePost.getParams())
);
HttpClient client = new HttpClient();
int status = client.executeMethod(filePost);
long | getContentLength() - Gets the request entity's length.
|
String | getContentType() - Gets the entity's content type.
|
boolean | isRepeatable() - Returns
true if all parts are repeatable, false otherwise.
|
void | writeRequest(OutputStream out) - Writes the request entity to the given stream.
|
MultipartRequestEntity
public MultipartRequestEntity(Part[] parts,
HttpMethodParams params)
Creates a new multipart entity containing the given parts.
parts
- The parts to include.params
- The params of the HttpMethod using this entity.
getContentType
public String getContentType()
Gets the entity's content type. This content type will be used as the value for the
"Content-Type" header.
- getContentType in interface RequestEntity
- the entity's content type
isRepeatable
public boolean isRepeatable()
Returns true
if all parts are repeatable, false
otherwise.
- isRepeatable in interface RequestEntity
writeRequest
public void writeRequest(OutputStream out)
throws IOException
Writes the request entity to the given stream.
- writeRequest in interface RequestEntity
Copyright (c) 1999-2005 - Apache Software Foundation