org.apache.commons.httpclient.methods

Class MultipartPostMethod

java.lang.Object

org.apache.commons.httpclient.HttpMethodBase

org.apache.commons.httpclient.methods.ExpectContinueMethod

org.apache.commons.httpclient.methods.MultipartPostMethod

All Implemented Interfaces:

HttpMethod

Deprecated.

Use MultipartRequestEntity in conjunction with PostMethod instead.

public class MultipartPostMethod
extends ExpectContinueMethod

Implements the 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.

Since:

2.0

Field Summary

Fields

Modifier and Type	Field and Description
static String	MULTIPART_FORM_CONTENT_TYPE Deprecated. The Content-Type for multipart/form-data.

Constructor Summary

Constructors

Constructor and Description
MultipartPostMethod() Deprecated. No-arg constructor.
MultipartPostMethod(String uri) Deprecated. Constructor specifying a URI.

Method Summary

Modifier and Type	Method and Description
void	addParameter(String parameterName, File parameterFile) Deprecated. Adds a binary file part
void	addParameter(String parameterName, String parameterValue) Deprecated. Adds a text field part
void	addParameter(String parameterName, String fileName, File parameterFile) Deprecated. Adds a binary file part with the given file name
void	addPart(Part part) Deprecated. Adds a part.
String	getName() Deprecated. Returns "POST".
Part[]	getParts() Deprecated. Returns all parts.
void	recycle() Deprecated. no longer supported and will be removed in the future version of HttpClient

Methods inherited from class org.apache.commons.httpclient.methods.ExpectContinueMethod

getUseExpectHeader, setUseExpectHeader

Methods inherited from class org.apache.commons.httpclient.HttpMethodBase

abort, addRequestHeader, addRequestHeader, addResponseFooter, execute, getAuthenticationRealm, getDoAuthentication, getEffectiveVersion, getFollowRedirects, getHostAuthState, getHostConfiguration, getMethodRetryHandler, getParams, getPath, getProxyAuthenticationRealm, getProxyAuthState, getQueryString, getRecoverableExceptionCount, getRequestCharSet, getRequestHeader, getRequestHeaders, getRequestHeaders, getResponseBody, getResponseBody, getResponseBodyAsStream, getResponseBodyAsString, getResponseBodyAsString, getResponseCharSet, getResponseContentLength, getResponseFooter, getResponseFooters, getResponseHeader, getResponseHeaders, getResponseHeaders, getStatusCode, getStatusLine, getStatusText, getURI, hasBeenUsed, isAborted, isHttp11, isRequestSent, isStrictMode, releaseConnection, removeRequestHeader, removeRequestHeader, setDoAuthentication, setFollowRedirects, setHostConfiguration, setHttp11, setMethodRetryHandler, setParams, setPath, setQueryString, setQueryString, setRequestHeader, setRequestHeader, setStrictMode, setURI, validate

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

MULTIPART_FORM_CONTENT_TYPE

public static final String MULTIPART_FORM_CONTENT_TYPE

Deprecated.

The Content-Type for multipart/form-data.

See Also:

Constant Field Values

Constructor Detail

MultipartPostMethod

public MultipartPostMethod()

Deprecated.

No-arg constructor.

MultipartPostMethod

public MultipartPostMethod(String uri)

Deprecated.

Constructor specifying a URI.

Parameters:

uri - either an absolute or relative URI

Method Detail

getName

public String getName()

Deprecated.

Returns "POST".

Specified by:

getName in interface HttpMethod

Specified by:

getName in class HttpMethodBase

Returns:

"POST"

addParameter

public void addParameter(String parameterName,
                         String parameterValue)

Deprecated.

Adds a text field part

Parameters:

parameterName - The name of the parameter.

parameterValue - The value of the parameter.

addParameter

public void addParameter(String parameterName,
                         File parameterFile)
                  throws FileNotFoundException

Deprecated.

Adds a binary file part

Parameters:

parameterName - The name of the parameter

parameterFile - The name of the file.

Throws:

FileNotFoundException - If the file cannot be found.

addParameter

public void addParameter(String parameterName,
                         String fileName,
                         File parameterFile)
                  throws FileNotFoundException

Deprecated.

Adds a binary file part with the given file name

Parameters:

parameterName - The name of the parameter

fileName - The file name

parameterFile - The file

Throws:

FileNotFoundException - If the file cannot be found.

addPart

public void addPart(Part part)

Deprecated.

Adds a part.

Parameters:

part - The part to add.

getParts

public Part[] getParts()

Deprecated.

Returns all parts.

Returns:

an array of containing all parts

recycle

public void recycle()

Deprecated. no longer supported and will be removed in the future version of HttpClient

Recycles the HTTP method so that it can be used again. Note that all of the instance variables will be reset once this method has been called. This method will also release the connection being used by this HTTP method.

Specified by:

recycle in interface HttpMethod

Overrides:

recycle in class HttpMethodBase

See Also:

HttpMethodBase.releaseConnection()