org.apache.commons.httpclient.params
public class HttpMethodParams extends DefaultHttpParams
HTTP methods
. Protocol
parameters may be linked together to form a hierarchy. If a particular
parameter value has not been explicitly defined in the collection itself,
its value will be drawn from the parent collection of parameters.
Since: 3.0
Version: $Revision: 354155 $
Field Summary | |
---|---|
static String | BUFFER_WARN_TRIGGER_LIMIT
Sets the maximum buffered response size (in bytes) that triggers no warning. |
static String | COOKIE_POLICY
Defines cookie policy to be used for cookie management.
|
static String | CREDENTIAL_CHARSET
Defines the charset to be used when encoding
Credentials. |
static String | DATE_PATTERNS
The key used to look up the date patterns used for parsing. |
static String | HEAD_BODY_CHECK_TIMEOUT
Sets period of time in milliseconds to wait for a content body sent in response to
HEAD method from a
non-compliant server. |
static String | HTTP_CONTENT_CHARSET
Defines the charset to be used for encoding content body.
|
static String | HTTP_ELEMENT_CHARSET
Defines the charset to be used for encoding HTTP protocol elements.
|
static String | MULTIPART_BOUNDARY
Sets the value to use as the multipart boundary.
|
static String | PROTOCOL_VERSION
Defines the HTTP protocol version used by
HTTP methods per
default.
|
static String | REJECT_HEAD_BODY
Defines whether the content body sent in response to
HeadMethod should be rejected.
|
static String | RETRY_HANDLER
Sets the method retry handler parameter.
|
static String | SINGLE_COOKIE_HEADER
Defines whether cookies should be put on
a single response header .
|
static String | SO_TIMEOUT
Sets the socket timeout (SO_TIMEOUT) in milliseconds to be used when executing the method.
|
static String | STATUS_LINE_GARBAGE_LIMIT
Defines the maximum number of ignorable lines before we expect
a HTTP response's status code.
|
static String | STRICT_TRANSFER_ENCODING
Defines whether responses with an invalid Transfer-Encoding header should be
rejected.
|
static String | UNAMBIGUOUS_STATUS_LINE
Defines whether HTTP methods should
reject ambiguous HTTP status line .
|
static String | USER_AGENT
Defines the content of the User-Agent header used by
HTTP methods .
|
static String | USE_EXPECT_CONTINUE
Activates 'Expect: 100-Continue' handshake for the
|
static String | VIRTUAL_HOST
Defines the virtual host name.
|
static String | WARN_EXTRA_INPUT
Defines HttpClient's behavior when a response provides more bytes than
expected (specified with Content-Length, for example).
|
Constructor Summary | |
---|---|
HttpMethodParams()
Creates a new collection of parameters with the collection returned
by HttpMethodParams as a parent. | |
HttpMethodParams(HttpParams defaults)
Creates a new collection of parameters with the given parent.
|
Method Summary | |
---|---|
String | getContentCharset()
Returns the default charset to be used for writing content body,
when no charset explicitly specified. |
String | getCookiePolicy()
Returns cookie policy to be used by the
HTTP methods
this collection of parameters applies to.
|
String | getCredentialCharset()
Returns the charset to be used for Credentials. |
String | getHttpElementCharset()
Returns the charset to be used for writing HTTP headers. |
int | getSoTimeout()
Returns the default socket timeout (SO_TIMEOUT) in milliseconds which is the
timeout for waiting for data. |
HttpVersion | getVersion()
Returns HTTP protocol version to be used by the
HTTP methods that
this collection of parameters applies to.
|
String | getVirtualHost()
Returns the virtual host name.
|
void | makeLenient()
Makes the HTTP methods
attempt to mimic the exact behaviour of commonly used HTTP agents,
which many HTTP servers expect, even though such behaviour may violate
the HTTP protocol specification (RFC 2616 and other relevant RFCs). |
void | makeStrict()
Makes the HTTP methods
strictly follow the HTTP protocol specification (RFC 2616 and other relevant RFCs).
|
void | setContentCharset(String charset)
Sets the default charset to be used for writing content body,
when no charset explicitly specified. |
void | setCookiePolicy(String policy)
Assigns the cookie policy to be used by the
HTTP methods
this collection of parameters applies to.
|
void | setCredentialCharset(String charset)
Sets the charset to be used for writing HTTP headers. |
void | setHttpElementCharset(String charset)
Sets the charset to be used for writing HTTP headers. |
void | setSoTimeout(int timeout)
Sets the default socket timeout (SO_TIMEOUT) in milliseconds which is the
timeout for waiting for data. |
void | setVersion(HttpVersion version)
Assigns the HTTP protocol version to be used by the
HTTP methods that
this collection of parameters applies to.
|
void | setVirtualHost(String hostname)
Sets the virtual host name.
|
This parameter expects a value if type Integer.
cookie policy
to be used for cookie management.
This parameter expects a value of type String.
This parameter expects a value of type String.
This parameter expects a value of type java.util.Collection.
HEAD method
from a
non-compliant server. If the parameter is not set or set to -1 non-compliant
response body check is disabled.
This parameter expects a value of type Integer.
This parameter expects a value of type String.
This parameter expects a value of type String.
This parameter expects a value if type String.
See Also: MultipartRequestEntity
HTTP protocol version
used by
HTTP methods
per
default.
This parameter expects a value of type HttpVersion.
This parameter expects a value of type Boolean.
This parameter expects a value of type HttpMethodRetryHandler.
cookies
should be put on
a single response header
.
This parameter expects a value of type Boolean.
This parameter expects a value of type Integer.
See Also: java.net.SocketOptions#SO_TIMEOUT
With HTTP/1.1 persistent connections, the problem arises that
broken scripts could return a wrong Content-Length
(there are more bytes sent than specified).
Unfortunately, in some cases, this is not possible after the bad response,
but only before the next one.
So, HttpClient must be able to skip those surplus lines this way.
Set this to 0 to disallow any garbage/empty lines before the status line.
To specify no limit, use java.lang.Integer#MAX_VALUE (default in lenient mode).
This parameter expects a value of type Boolean.
HTTP methods
should
reject ambiguous HTTP status line
.
This parameter expects a value of type Boolean.
HTTP methods
.
This parameter expects a value of type String.
Activates 'Expect: 100-Continue' handshake for the
entity enclosing methods
. The purpose of the 'Expect: 100-Continue'
handshake to allow a client that is sending a request message with
a request body to determine if the origin server is willing to
accept the request (based on the request headers) before the client
sends the request body.
The use of the 'Expect: 100-continue' handshake can result in noticable peformance improvement for entity enclosing requests (such as POST and PUT) that require the target server's authentication.
'Expect: 100-continue' handshake should be used with caution, as it may cause problems with HTTP servers and proxies that do not support HTTP/1.1 protocol.
This parameter expects a value of type Boolean.This parameter expects a value of type java.lang.String.
Such surplus data makes the HTTP connection unreliable for keep-alive requests, as malicious response data (faked headers etc.) can lead to undesired results on the next request using that connection.
If this parameter is set to true
, any detection of extra
input data will generate a warning in the log.
This parameter expects a value of type Boolean.
See Also: HttpMethodParams
Parameters: defaults the parent collection to defer to, if a parameter is not explictly set in the collection itself.
See Also: HttpMethodParams
Returns: The charset
cookie policy
to be used by the
HTTP methods
this collection of parameters applies to.
Returns: cookie policy
HTTP element charset
is used.Returns: The charset
Returns: The charset
Returns: timeout in milliseconds
HTTP protocol version
to be used by the
HTTP methods
that
this collection of parameters applies to.
Returns: HTTP protocol version
Returns: The virtual host name
HTTP methods
attempt to mimic the exact behaviour of commonly used HTTP agents,
which many HTTP servers expect, even though such behaviour may violate
the HTTP protocol specification (RFC 2616 and other relevant RFCs). HTTP methods
strictly follow the HTTP protocol specification (RFC 2616 and other relevant RFCs).
It must be noted that popular HTTP agents have different degree of HTTP protocol
compliance and some HTTP serves are programmed to expect the behaviour that does not
strictly adhere to the HTTP specification.Parameters: charset The charset
cookie policy
to be used by the
HTTP methods
this collection of parameters applies to.
Parameters: policy the cookie policy
Parameters: charset The charset
Parameters: charset The charset
Parameters: timeout Timeout in milliseconds
HTTP protocol version
to be used by the
HTTP methods
that
this collection of parameters applies to.
Parameters: version the HTTP protocol version
Parameters: hostname The host name