/usr/share/doc/libcommons-httpclient-java/docs/preference-api.html is in libcommons-httpclient-java-doc 3.1-14.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html><head><title>HttpClient - HttpClient preference architecture and configuration guide</title><style type="text/css" media="all">
@import url("./style/maven-base.css");
@import url("./style/maven-theme.css");@import url("./style/project.css");</style><link rel="stylesheet" href="./style/print.css" type="text/css" media="print"></link><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"></meta><meta name="author" content="Oleg Kalnichevski"></meta><meta name="email" content="oleg -at- ural.ru"></meta></head><body class="composite"><div id="banner"><a href="http://jakarta.apache.org/" id="organizationLogo"><img alt="Apache Software Foundation" src=""></img></a><a href="http://jakarta.apache.org/httpcomponents/httpclient-3.x/" id="projectLogo"><img alt="HttpClient" src="./images/httpclient_logo.png"></img></a><div class="clear"><hr></hr></div></div><div id="breadcrumbs"><div class="xleft">Last published: 18 August 2007
<span class="separator">|</span> Doc for 3.1
</div><div class="xright"></div><div class="clear"><hr></hr></div></div><div id="leftColumn"><div id="navcolumn"><div id="menuOverview"><h5>Overview</h5><ul><li class="none"><a href="features.html">Features</a></li><li class="none"><a href="news.html">News</a></li><li class="none"><a href="status.html">Status</a></li><li class="none"><a href="downloads.html">Download</a></li><li class="none"><a href="http://wiki.apache.org/jakarta-httpclient/" class="externalLink" title="External Link">Wiki</a></li><li class="expanded"><a href="userguide.html">User Guide</a><ul><li class="none"><a href="authentication.html">Authentication Guide</a></li><li class="none"><a href="charencodings.html">Character Encodings</a></li><li class="none"><a href="cookies.html">Cookies</a></li><li class="none"><a href="exception-handling.html">Exception Handling</a></li><li class="none"><a href="logging.html">Logging Guide</a></li><li class="none"><a href="methods.html">Methods</a></li><li class="none"><a href="performance.html">Optimization Guide</a></li><li class="none"><strong><a href="preference-api.html">Preference Architecture</a></strong></li><li class="none"><a href="redirects.html">Redirects Handling</a></li><li class="none"><a href="http://svn.apache.org/viewvc/jakarta/httpcomponents/oac.hc3x/trunk/src/examples/" class="externalLink" title="External Link">Sample Code</a></li><li class="none"><a href="sslguide.html">SSL Guide</a></li><li class="none"><a href="threading.html">Threading</a></li><li class="none"><a href="troubleshooting.html">Trouble Shooting</a></li><li class="none"><a href="tutorial.html">Tutorial</a></li></ul></li><li class="none"><a href="developerguide.html">Developer Guide</a></li></ul></div><div id="menuProject_Documentation"><h5>Project Documentation</h5><ul><li class="none"><a href="index.html">About</a></li><li class="collapsed"><a href="project-info.html">Project Info</a></li><li class="collapsed"><a href="maven-reports.html">Project Reports</a></li><li class="none"><a href="development-process.html">Development Process</a></li></ul></div><div id="legend"><h5>Legend</h5><ul><li class="externalLink">External Link</li><li class="newWindow">Opens in a new window</li></ul></div><a href="http://maven.apache.org/" title="Built by Maven" id="poweredBy"><img alt="Built by Maven" src="./images/logos/mavenlogo_builtby_w.png"></img></a></div></div><div id="bodyColumn"><div class="contentBox"><div class="section"><a name="Table_of_contents"></a><h2>Table of contents</h2>
<ul>
<li>
<a href="#HttpClient_preference_architecture">HttpClient preference architecture</a>
<ul>
<li><a href="#HTTP_parameters">HTTP parameters</a></li>
<li><a href="#HTTP_parameter_hierarchy">HTTP parameter hierarchy</a></li>
</ul>
</li>
<li>
<a href="#Supported_parameters">Supported parameters</a>
<ul>
<li><a href="#HTTP_method_parameters">HTTP method parameters</a></li>
<li><a href="#HTTP_connection_parameters">HTTP connection parameters</a></li>
<li><a href="#HTTP_connection_manager_parameters">HTTP connection manager parameters</a></li>
<li><a href="#HTTP_client_parameters">HTTP client parameters</a></li>
</ul>
</li>
</ul>
</div><div class="section"><a name="HttpClient_preference_architecture"></a><h2>HttpClient preference architecture</h2>
<p>
Quality and extent of the <a href="http://www.ietf.org/rfc/rfc1945.txt" class="externalLink" title="External Link">
<code>HTTP/1.0</code></a> and <a href="http://www.ietf.org/rfc/rfc2616.txt" class="externalLink" title="External Link">
<code>HTTP/1.1</code></a> spec compliance vary significantly among commonly
used HTTP agents and HTTP servers. That requires of HttpClient to be able to
<ul>
<li>mimic (mis-)behavior of widely used web browsers;</li>
<li>support flexible and configurable level of leniency toward non-critical
protocol violations especially in those gray areas of the specification
subject to different, at times conflicting, interpretations;
</li>
<li>apply a different set of parameters to individual HTTP methods, hosts, or
client instances using common interface;
</li>
</ul>
</p>
<div class="subsection"><a name="HTTP_parameters"></a><h3>HTTP parameters</h3>
<p>
As of version 3 HttpClient sports a new preference API based on
<a href="apidocs/org/apache/commons/httpclient/params/HttpParams.html">
HttpParams</a> interface. All major components of the HttpClient toolkit
(agents, host configurations, methods, connections, connection managers)
contain a collection of HTTP parameters, which determine the runtime behavior
of those components.
<div class="source"><pre>
HttpClient httpclient = new HttpClient();
HttpVersion ver = (HttpVersion)httpclient.getParams().getParameter("http.protocol.version");</pre></div>
</p>
<p>
In a nutshell HTTP parameters is a collection of name/object pairs that can be linked
with other collections 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 upper level
collection of parameters.
<div class="source"><pre>
HttpClient httpclient = new HttpClient();
httpclient.getParams().setParameter("http.protocol.version", HttpVersion.HTTP_1_1);
httpclient.getParams().setParameter("http.socket.timeout", new Integer(1000));
httpclient.getParams().setParameter("http.protocol.content-charset", "UTF-8");
HostConfiguration hostconfig = new HostConfiguration();
hostconfig.setHost("www.yahoo.com");
hostconfig.getParams().setParameter("http.protocol.version", HttpVersion.HTTP_1_0);
GetMethod httpget = new GetMethod("/");
httpget.getParams().setParameter("http.socket.timeout", new Integer(5000));
try {
// Internally the parameter collections will be linked together
// by performing the following operations:
// hostconfig.getParams().setDefaults(httpclient.getParams());
// httpget.getParams().setDefaults(hostconfig.getParams());
httpclient.executeMethod(hostconfig, httpget);
System.out.println(httpget.getParams().getParameter("http.protocol.version"));
System.out.println(httpget.getParams().getParameter("http.socket.timeout"));
System.out.println(httpget.getParams().getParameter("http.protocol.content-charset"));
} finally {
httpget.releaseConnection();
}</pre></div>
</p>
<p>
The code above will produce the following output:
<div class="source"><pre>
HTTP/1.0
5000
UTF-8</pre></div>
</p>
<p>
When resolving a parameter HttpClient uses the following algorithm:
<ul>
<li>start parameter lookup from the lowest level at which this parameter applies</li>
<li>if the parameter is undefined at the current level, defer its resolution to the
next level up in the hierarchy</li>
<li>return parameter value from the lowest level in the hierarchy the parameter
defined at</li>
<li>return null if the parameter is undefined</li>
</ul>
</p>
<p>
This architecture enables the users to define generic parameters at a higher
level (for instance, at the agent level or host level) and selectively override
specific parameters at a lower level (for instance, at the method level). Whenever
a parameter is not explicitly defined at a given level, the defaults of the upper
levels will apply.
</p>
</div>
<div class="subsection"><a name="HTTP_parameter_hierarchy"></a><h3>HTTP parameter hierarchy</h3>
<p>
Presently HttpClient provides the following parameter hierarchy:
</p>
<div class="source"><pre>
global--+ | DefaultHttpParams
| |
client | HttpClient
| |
+-- connection manager | HttpConnectionManager
| | |
| +-- connection | HttpConnection
| |
+-- host | HostConfiguration
| |
+-- method | HttpMethod
</pre></div>
</div>
</div><div class="section"><a name="Supported_parameters"></a><h2>Supported parameters</h2>
<div class="subsection"><a name="HTTP_method_parameters"></a><h3>HTTP method parameters</h3>
<p>
Applicable at the following levels: <b>global</b> -> <b>client</b> -> <b>host</b> -> <b>method</b>
</p>
<table class="bodyTable">
<tr class="a">
<th>Name</th>
<th>Type</th>
<th>Description</th>
<th>Default</th>
</tr>
<tr class="b">
<td><p>http.useragent</p></td>
<td><p>String</p></td>
<td>
<p>
The content of the <code>User-Agent</code> header used by the HTTP methods.
</p>
</td>
<td><p>official release name, e.g. "Jakarta Commons-HttpClient/3.0"</p></td>
</tr>
<tr class="a">
<td><p>http.protocol.version</p></td>
<td><p><a href="apidocs/org/apache/commons/httpclient/HttpVersion.html">HttpVersion</a></p></td>
<td>
<p>
The HTTP protocol version used per default by the HTTP methods.
</p>
</td>
<td><p><a href="apidocs/org/apache/commons/httpclient/HttpVersion.html#HTTP_1_1">
<code>HttpVersion.HTTP_1_1</code></a></p></td>
</tr>
<tr class="b">
<td><p>http.protocol.unambiguous-statusline</p></td>
<td><p>Boolean</p></td>
<td>
<p>
Defines whether HTTP methods should reject ambiguous HTTP status line.
</p>
</td>
<td><p><code><undefined></code></p></td>
</tr>
<tr class="a">
<td><p>http.protocol.single-cookie-header</p></td>
<td><p>Boolean</p></td>
<td>
<p>
Defines whether cookies should be put on a single response header.
</p>
</td>
<td><p><code><undefined></code></p></td>
</tr>
<tr class="b">
<td><p>http.protocol.strict-transfer-encoding</p></td>
<td><p>Boolean</p></td>
<td>
<p>
Defines whether responses with an invalid <code>Transfer-Encoding</code> header should be
rejected.
</p>
</td>
<td><p><code><undefined></code></p></td>
</tr>
<tr class="a">
<td><p>http.protocol.reject-head-body</p></td>
<td><p>Boolean</p></td>
<td>
<p>
Defines whether the content body sent in response to <code>HEAD</code> request should be
rejected.
</p>
</td>
<td><p><code><undefined></code></p></td>
</tr>
<tr class="b">
<td><p>http.protocol.head-body-timeout</p></td>
<td><p>Integer</p></td>
<td>
<p>
Sets period of time in milliseconds to wait for a content body sent in response to
<code>HEAD</code> response from a non-compliant server. If the parameter is not set or set
to <code>-1</code> non-compliant response body check is disabled.
</p>
</td>
<td><p><code><undefined></code></p></td>
</tr>
<tr class="a">
<td><p>http.protocol.expect-continue</p></td>
<td><p>Boolean</p></td>
<td>
<p>
Activates 'Expect: 100-Continue' handshake for the entity enclosing methods. The 'Expect: 100-Continue'
handshake allows 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.
</p>
<p>
The use of the 'Expect: 100-continue' handshake can result in noticeable performance improvement
for entity enclosing requests (such as <code>POST</code> and <code>PUT</code>) that require the
target server's authentication.
</p>
<p>
'Expect: 100-continue' handshake should be used with caution, as it may cause problems with HTTP
servers and proxies that do not support <code>HTTP/1.1</code> protocol.
</p>
<td><p><code><undefined></code></p></td>
</td>
</tr>
<tr class="b">
<td><p>http.protocol.credential-charset</p></td>
<td><p>String</p></td>
<td>
<p>
The charset to be used when encoding credentials. If not defined then the value of the
'http.protocol.element-charset' should be used.
</p>
</td>
<td><p><code><undefined></code></p></td>
</tr>
<tr class="a">
<td><p>http.protocol.element-charset</p></td>
<td><p>String</p></td>
<td>
<p>
The charset to be used for encoding/decoding HTTP protocol elements (status line and headers).
</p>
</td>
<td><p>'US-ASCII'</p></td>
</tr>
<tr class="b">
<td><p>http.protocol.content-charset</p></td>
<td><p>String</p></td>
<td>
<p>
The charset to be used for encoding content body.
</p>
</td>
<td><p>'ISO-8859-1'</p></td>
</tr>
<tr class="a">
<td><p>http.protocol.cookie-policy</p></td>
<td><p>String</p></td>
<td>
<p>
The cookie policy to be used for cookie management.
</p>
</td>
<td><p><a href="apidocs/org/apache/commons/httpclient/cookie/CookiePolicy.html#RFC_2109">
<code>CookiePolicy.RFC_2109</code></a></p></td>
</tr>
<tr class="b">
<td><p>http.protocol.warn-extra-input</p></td>
<td><p>Boolean</p></td>
<td>
<p>
Defines HttpClient's behavior when a response provides more bytes than expected (specified
with <code>Content-Length</code> header, for example).
</p>
<p>
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.
</p>
<p>
If this parameter is set to <code>true</code>, any detection of extra input data will generate
a warning in the log.
</p>
</td>
<td><p><code><undefined></code></p></td>
</tr>
<tr class="a">
<td><p>http.protocol.status-line-garbage-limit</p></td>
<td><p>Integer</p></td>
<td>
<p>
Defines the maximum number of ignorable lines before we expect a HTTP response's status code.
</p>
<p>
With HTTP/1.1 persistent connections, the problem arises that broken scripts could return a
wrong <code>Content-Length</code> (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.
</p>
<p>
Set this to <code>0</code> to disallow any garbage/empty lines before the status line.
To specify no limit, use <code>Integer#MAX_VALUE</code>.
</p>
</td>
<td><p><code><undefined></code></p></td>
</tr>
<tr class="b">
<td><p>http.socket.timeout</p></td>
<td><p>Integer</p></td>
<td>
<p>
Sets the socket timeout (<code>SO_TIMEOUT</code>) in milliseconds to be used when executing the
method. A timeout value of zero is interpreted as an infinite timeout.
</p>
</td>
<td><p><code><undefined></code></p></td>
</tr>
<tr class="a">
<td><p>http.method.retry-handler</p></td>
<td><p><a href="apidocs/org/apache/commons/httpclient/HttpMethodRetryHandler.html">
HttpMethodRetryHandler</a></p></td>
<td>
<p>
The method retry handler used for retrying failed methods. For details see the
<a href="exception-handling.html#Custom%20exception%20handler">Exception handling guide</a>.
</p>
</td>
<td><p><a href="apidocs/org/apache/commons/httpclient/DefaultHttpMethodRetryHandler.html">
default implementation</a></p></td>
</tr>
<tr class="b">
<td><p>http.dateparser.patterns</p></td>
<td><p><a href="http://java.sun.com/j2se/1.4.2/docs/api/java/util/Collection.html" class="externalLink" title="External Link">
Collection</a></p></td>
<td>
<p>Date patterns used for parsing. The patterns are stored in a
<a href="http://java.sun.com/j2se/1.4.2/docs/api/java/util/Collection.html" class="externalLink" title="External Link">
Collection</a> and must be compatible with
<a href="http://java.sun.com/j2se/1.4.2/docs/api/java/text/SimpleDateFormat.html" class="externalLink" title="External Link">
SimpleDateFormat</a>.
</p>
</td>
<td>
<p>
'EEE, dd MMM yyyy HH:mm:ss zzz',<br></br>
'EEEE, dd-MMM-yy HH:mm:ss zzz',<br></br>
'EEE MMM d HH:mm:ss yyyy',<br></br>
'EEE, dd-MMM-yyyy HH:mm:ss z',<br></br>
'EEE, dd-MMM-yyyy HH-mm-ss z',<br></br>
'EEE, dd MMM yy HH:mm:ss z',<br></br>
'EEE dd-MMM-yyyy HH:mm:ss z',<br></br>
'EEE dd MMM yyyy HH:mm:ss z',<br></br>
'EEE dd-MMM-yyyy HH-mm-ss z',<br></br>
'EEE dd-MMM-yy HH:mm:ss z',<br></br>
'EEE dd MMM yy HH:mm:ss z',<br></br>
'EEE,dd-MMM-yy HH:mm:ss z',<br></br>
'EEE,dd-MMM-yyyy HH:mm:ss z',<br></br>
'EEE, dd-MM-yyyy HH:mm:ss z'
</p>
</td>
</tr>
<tr class="a">
<td><p>http.method.response.buffer.warnlimit</p></td>
<td><p>Integer</p></td>
<td><p>The maximum buffered response size (in bytes) that triggers no warning. Buffered
responses exceeding this size will trigger a warning in the log. If not set, the
limit is 1 MB.
</p>
</td>
<td>
<p><code><undefined></code></p>
</td>
</tr>
<tr class="b">
<td><p>http.method.multipart.boundary</p></td>
<td><p>String</p></td>
<td><p>The multipart boundary string to use in conjunction with the
<a href="apidocs/org/apache/commons/httpclient/params/MultipartRequestEntity.html">
MultipartRequestEntity</a>.
When not set a random value will be generated for each request.
</p>
</td>
<td>
<p><code><undefined></code></p>
</td>
</tr>
</table>
<p>
Whenever a parameter is left undefined (no value is explicitly set anywhere in
the parameter hierarchy) HttpClient will use its best judgment to pick up a value. This
default behavior is likely to provide the best compatibility with widely used HTTP servers.
</p>
</div>
<div class="subsection"><a name="HTTP_connection_parameters"></a><h3>HTTP connection parameters</h3>
<p>
Applicable at the following levels: <b>global</b> -> <b>client</b> -> <b>connection manager</b> ->
<b>connection</b>
</p>
<table class="bodyTable">
<tr class="a">
<th>Name</th>
<th>Type</th>
<th>Description</th>
<th>Default</th>
</tr>
<tr class="b">
<td><p>http.socket.timeout</p></td>
<td><p>Integer</p></td>
<td>
<p>
The default socket timeout (<code>SO_TIMEOUT</code>) in milliseconds which is the timeout
for waiting for data. A timeout value of zero is interpreted as an infinite timeout. This
value is used when no socket timeout is set in the HTTP method parameters.
</p>
</td>
<td><p><code><undefined></code></p></td>
</tr>
<tr class="a">
<td><p>http.tcp.nodelay</p></td>
<td><p>Boolean</p></td>
<td>
<p>
Determines whether Nagle's algorithm is to be used. The Nagle's algorithm tries to conserve
bandwidth by minimizing the number of segments that are sent. When applications wish to
decrease network latency and increase performance, they can disable Nagle's algorithm (by enabling
<code>TCP_NODELAY</code>). Data will be sent earlier, at the cost of an increase
in bandwidth consumption and number of packets.
</p>
</td>
<td><p><code><undefined></code></p></td>
</tr>
<tr class="b">
<td><p>http.socket.sendbuffer</p></td>
<td><p>Integer</p></td>
<td>
<p>
The value to set on <a href="http://java.sun.com/j2se/1.4.2/docs/api/java/net/Socket.html#setSendBufferSize(int)" class="externalLink" title="External Link">
Socket.setSendBufferSize(int)</a>. This value is a suggestion to the kernel from the
application about the size of buffers to use for the data to be sent over the socket.
</p>
</td>
<td><p><code><undefined></code></p></td>
</tr>
<tr class="a">
<td><p>http.socket.receivebuffer</p></td>
<td><p>Integer</p></td>
<td>
<p>
The value to set on <a href="http://java.sun.com/j2se/1.4.2/docs/api/java/net/Socket.html#setReceiveBufferSize(int)" class="externalLink" title="External Link">
Socket.setReceiveBufferSize(int)</a>. This value is a suggestion to the kernel from the
application about the size of buffers to use for the data to be received over the socket.
</p>
</td>
<td><p><code><undefined></code></p></td>
</tr>
<tr class="b">
<td><p>http.socket.linger</p></td>
<td><p>Integer</p></td>
<td>
<p>
The linger time (<code>SO_LINGER</code>) in seconds. This option disables/enables
immediate return from a close() of a TCP Socket. Enabling this option with a non-zero
Integer timeout means that a close() will block pending the transmission and
acknowledgement of all data written to the peer, at which point the socket is closed
gracefully. Value <code>0</code> implies that the option is disabled. Value
<code>-1</code> implies that the JRE default is used.
</p>
</td>
<td><p><code><undefined></code></p></td>
</tr>
<tr class="a">
<td><p>http.connection.timeout</p></td>
<td><p>Integer</p></td>
<td>
<p>
The timeout until a connection is established. A value of zero means the timeout is not used.
</p>
</td>
<td><p><code><undefined></code></p></td>
</tr>
<tr class="b">
<td><p>http.connection.stalecheck</p></td>
<td><p>Boolean</p></td>
<td>
<p>
Determines whether stale connection check is to be used. Disabling stale connection check may
result in slight performance improvement at the risk of getting an I/O error when executing a
request over a connection that has been closed at the server side.
</p>
</td>
<td><p><code><undefined></code></p></td>
</tr>
</table>
<p>
Whenever a parameter is left undefined (no value is explicitly set anywhere in
the parameter hierarchy) HttpClient will use its best judgment to pick up a value. This
default behavior is likely to provide the best compatibility with widely used HTTP servers.
</p>
</div>
<div class="subsection"><a name="HTTP_connection_manager_parameters"></a><h3>HTTP connection manager parameters</h3>
<p>
Applicable at the following levels: <b>global</b> -> <b>client</b> -> <b>connection manager</b>
</p>
<table class="bodyTable">
<tr class="a">
<th>Name</th>
<th>Type</th>
<th>Description</th>
<th>Default</th>
</tr>
<tr class="b">
<td><p>http.connection-manager.max-per-host</p></td>
<td><p><a href="http://java.sun.com/j2se/1.4.2/docs/api/java/util/Map.html" class="externalLink" title="External Link">Map</a></p></td>
<td>
<p>
Defines the maximum number of connections allowed per host configuration.
These values only apply to the number of connections from a particular instance
of HttpConnectionManager.
</p>
<p>
This parameter expects a value of type
<a href="http://java.sun.com/j2se/1.4.2/docs/api/java/util/Map.html" class="externalLink" title="External Link">
<code>Map</code></a>. The value should map instances of
<a href="apidocs/org/apache/commons/httpclient/HostConfiguration.html">
<code>HostConfiguration</code></a> to
<a href="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Integer.html" class="externalLink" title="External Link">
<code>Integer</code></a>s. The default value can be specified using
<a href="apidocs/org/apache/commons/httpclient/HostConfiguration.html#ANY_HOST_CONFIGURATION">
<code>ANY_HOST_CONFIGURATION</code></a>.
</p>
</td>
<td><p><code><undefined></code></p></td>
</tr>
<tr class="a">
<td><p>http.connection-manager.max-total</p></td>
<td><p>Integer</p></td>
<td>
<p>
Defines the maximum number of connections allowed overall. This value only applies
to the number of connections from a particular instance of HttpConnectionManager.
</p>
</td>
<td><p><code><undefined></code></p></td>
</tr>
</table>
<p>
Whenever a parameter is left undefined (no value is explicitly set anywhere in
the parameter hierarchy) HttpClient will use its best judgment to pick up a value. This
default behavior is likely to provide the best compatibility with widely used HTTP servers.
</p>
</div>
<div class="subsection"><a name="Host_configuration_parameters"></a><h3>Host configuration parameters</h3>
<p>
Applicable at the following levels: <b>global</b> -> <b>client</b> -> <b>host</b>
</p>
<table class="bodyTable">
<tr class="b">
<th>Name</th>
<th>Type</th>
<th>Description</th>
<th>Default</th>
</tr>
<tr class="a">
<td><p>http.default-headers</p></td>
<td><p><a href="http://java.sun.com/j2se/1.4.2/docs/api/java/util/Collection.html" class="externalLink" title="External Link">
Collection</a></p></td>
<td>
<p>The request headers to be sent per default with each request. This parameter expects
a value of type
<a href="http://java.sun.com/j2se/1.4.2/docs/api/java/util/Collection.html" class="externalLink" title="External Link">Collection</a>.
The collection is expected to contain
<a href="apidocs/org/apache/commons/httpclient/Header.html">HTTP headers</a></p>
</td>
<td><p><code><undefined></code></p></td>
</tr>
</table>
<p>
Whenever a parameter is left undefined (no value is explicitly set anywhere in
the parameter hierarchy) HttpClient will use its best judgment to pick up a value. This
default behavior is likely to provide the best compatibility with widely used HTTP servers.
</p>
</div>
<div class="subsection"><a name="HTTP_client_parameters"></a><h3>HTTP client parameters</h3>
<p>
Applicable at the following levels: <b>global</b> -> <b>client</b>
</p>
<table class="bodyTable">
<tr class="b">
<th>Name</th>
<th>Type</th>
<th>Description</th>
<th>Default</th>
</tr>
<tr class="a">
<td><p>http.connection-manager.timeout</p></td>
<td><p>Long</p></td>
<td>
<p>
The timeout in milliseconds used when retrieving an HTTP connection from the
HTTP connection manager. 0 means to wait indefinitely.
</p>
</td>
<td><p><code><undefined></code></p></td>
</tr>
<tr class="b">
<td><p>http.connection-manager.class</p></td>
<td><p>Class</p></td>
<td>
<p>
The default HTTP connection manager class.
</p>
</td>
<td><p>
<a href="apidocs/org/apache/commons/httpclient/SimpleHttpConnectionManager.html">
<code>SimpleHttpConnectionManager</code></a> class</p></td>
</tr>
<tr class="a">
<td><p>http.authentication.preemptive</p></td>
<td><p>Boolean</p></td>
<td>
<p>
Defines whether authentication should be attempted preemptively. See authentication guide.
</p>
</td>
<td><p><code><undefined></code></p></td>
</tr>
<tr class="b">
<td><p>http.protocol.reject-relative-redirect</p></td>
<td><p>Boolean</p></td>
<td>
<p>
Defines whether relative redirects should be rejected. Although redirects are supposed to be absolute
it is common internet practice to use relative URLs.
</p>
</td>
<td><p><code><undefined></code></p></td>
</tr>
<tr class="a">
<td><p>http.protocol.max-redirects</p></td>
<td><p>Integer</p></td>
<td>
<p>
Defines the maximum number of redirects to be followed. The limit on number of redirects
is intended to prevent infinite loops.
</p>
</td>
<td><p><code><undefined></code></p></td>
</tr>
<tr class="b">
<td><p>http.protocol.allow-circular-redirects</p></td>
<td><p>Boolean</p></td>
<td>
<p>
Defines whether circular redirects (redirects to the same location) should be allowed.
The HTTP spec is not sufficiently clear whether circular redirects are permitted,
therefore optionally they can be enabled.
</p>
</td>
<td><p><code><undefined></code></p></td>
</tr>
</table>
<p>
Whenever a parameter is left undefined (no value is explicitly set anywhere in
the parameter hierarchy) HttpClient will use its best judgment to pick up a value. This
default behavior is likely to provide the best compatibility with widely used HTTP servers.
</p>
</div>
</div></div></div><div class="clear"><hr></hr></div><div id="footer"><div class="xright">© 2001-2007, Apache Software Foundation</div><div class="clear"><hr></hr></div></div></body></html>
|