Home » commons-httpclient-3.1-src » org.apache.commons » httpclient » methods » multipart » [javadoc | source]
org.apache.commons.httpclient.methods.multipart
public class: MultipartRequestEntity [javadoc | source]
java.lang.Object
   org.apache.commons.httpclient.methods.multipart.MultipartRequestEntity

All Implemented Interfaces:
    RequestEntity

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);
Field Summary
protected  Part[] parts    The MIME parts as set by the constructor 
Constructor:
 public MultipartRequestEntity(Part[] parts,
    HttpMethodParams params) 
    Creates a new multipart entity containing the given parts.
    Parameters:
    parts - The parts to include.
    params - The params of the HttpMethod using this entity.
Method from org.apache.commons.httpclient.methods.multipart.MultipartRequestEntity Summary:
getContentLength,   getContentType,   getMultipartBoundary,   isRepeatable,   writeRequest
Methods from java.lang.Object:
equals,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from org.apache.commons.httpclient.methods.multipart.MultipartRequestEntity Detail:
 public long getContentLength() 
 public String getContentType() 
 protected byte[] getMultipartBoundary() 
    Returns the MIME boundary string that is used to demarcate boundaries of this part. The first call to this method will implicitly create a new boundary string. To create a boundary string first the HttpMethodParams.MULTIPART_BOUNDARY parameter is considered. Otherwise a random one is generated.
 public boolean isRepeatable() 
    Returns true if all parts are repeatable, false otherwise.
 public  void writeRequest(OutputStream out) throws IOException