| org.apache.commons.httpclient.methods.ExpectContinueMethod org.apache.commons.httpclient.methods.EntityEnclosingMethod org.apache.commons.httpclient.methods.PostMethod
All known Subclasses: org.apache.commons.httpclient.NoncompliantPostMethod,
PostMethod | public class PostMethod extends EntityEnclosingMethod (Code) | | Implements the HTTP POST method.
The HTTP POST method is defined in section 9.5 of
RFC2616:
The POST method is used to request that the origin server accept the entity
enclosed in the request as a new subordinate of the resource identified by
the Request-URI in the Request-Line. POST is designed to allow a uniform
method to cover the following functions:
- Annotation of existing resources
- Posting a message to a bulletin board, newsgroup, mailing list, or
similar group of articles
- Providing a block of data, such as the result of submitting a form,
to a data-handling process
- Extending a database through an append operation
author: Remy Maucherat author: Doug Sale author: Jeff Dever author: Ortwin Gl???ck author: Mike Bowler author: Oleg Kalnichevski version: $Revision: 480424 $ since: 1.0 |
FORM_URL_ENCODED_CONTENT_TYPE | final public static String FORM_URL_ENCODED_CONTENT_TYPE(Code) | | The Content-Type for www-form-urlencoded.
|
PostMethod | public PostMethod()(Code) | | No-arg constructor.
since: 1.0 |
PostMethod | public PostMethod(String uri)(Code) | | Constructor specifying a URI.
Parameters: uri - either an absolute or relative URI since: 1.0 |
addParameter | public void addParameter(String paramName, String paramValue) throws IllegalArgumentException(Code) | | Adds a new parameter to be used in the POST request body.
Parameters: paramName - The parameter name to add. Parameters: paramValue - The parameter value to add. throws: IllegalArgumentException - if either argument is null since: 1.0 |
addParameters | public void addParameters(NameValuePair[] parameters)(Code) | | Adds an array of parameters to be used in the POST request body. Logs a
warning if the parameters argument is null.
Parameters: parameters - The array of parameters to add. since: 2.0 |
clearRequestBody | protected void clearRequestBody()(Code) | | Clears request body.
This method must be overwritten by sub-classes that implement
alternative request content input methods
since: 2.0beta1 |
getName | public String getName()(Code) | | Returns "POST".
"POST" since: 2.0 |
getParameter | public NameValuePair getParameter(String paramName)(Code) | | Gets the parameter of the specified name. If there exists more than one
parameter with the name paramName, then only the first one is returned.
Parameters: paramName - name of the parameter If a parameter exists with the name argument, the corespondingNameValuePair is returned. Otherwise null. since: 2.0 |
getParameters | public NameValuePair[] getParameters()(Code) | | Gets the parameters currently added to the PostMethod. If there are no
parameters, a valid array is returned with zero elements. The returned
array object contains an array of pointers to the internal data
members.
An array of the current parameters since: 2.0 |
hasRequestContent | protected boolean hasRequestContent()(Code) | | Returns true if there is a request body to be sent.
This method must be overwritten by sub-classes that implement
alternative request content input methods
boolean since: 2.0beta1 |
removeParameter | public boolean removeParameter(String paramName) throws IllegalArgumentException(Code) | | Removes all parameters with the given paramName. If there is more than
one parameter with the given paramName, all of them are removed. If
there is just one, it is removed. If there are none, then the request
is ignored.
Parameters: paramName - The parameter name to remove. true if at least one parameter was removed throws: IllegalArgumentException - When the parameter name passed is null since: 2.0 |
removeParameter | public boolean removeParameter(String paramName, String paramValue) throws IllegalArgumentException(Code) | | Removes all parameter with the given paramName and paramValue. If there
is more than one parameter with the given paramName, only one is
removed. If there are none, then the request is ignored.
Parameters: paramName - The parameter name to remove. Parameters: paramValue - The parameter value to remove. true if a parameter was removed. throws: IllegalArgumentException - when param name or value are null since: 2.0 |
setParameter | public void setParameter(String parameterName, String parameterValue)(Code) | | Sets the value of parameter with parameterName to parameterValue. This method
does not preserve the initial insertion order.
Parameters: parameterName - name of the parameter Parameters: parameterValue - value of the parameter since: 2.0 |
Fields inherited from org.apache.commons.httpclient.methods.EntityEnclosingMethod | final public static long CONTENT_LENGTH_AUTO(Code)(Java Doc) final public static long CONTENT_LENGTH_CHUNKED(Code)(Java Doc)
|
|
|