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
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="null" lang="null">
<head>
<meta http-equiv="content-type" content="text/html; charset=ISO-8859-1" /><title>HttpMethodBase xref</title>
<link type="text/css" rel="stylesheet" href="../../../../stylesheet.css" />
</head>
<body>
<div id="overview"><a href="../../../../../apidocs/org/apache/commons/httpclient/HttpMethodBase.html">View Javadoc</a></div><pre>
<a name="1" href="#1">1</a> <em class="comment">/*</em>
<a name="2" href="#2">2</a> <em class="comment"> * $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//httpclient/src/java/org/apache/commons/httpclient/HttpMethodBase.java,v 1.222 2005/01/14 21:16:40 olegk Exp $</em>
<a name="3" href="#3">3</a> <em class="comment"> * $Revision: 539441 $</em>
<a name="4" href="#4">4</a> <em class="comment"> * $Date: 2007-05-18 14:56:55 +0200 (Fri, 18 May 2007) $</em>
<a name="5" href="#5">5</a> <em class="comment"> *</em>
<a name="6" href="#6">6</a> <em class="comment"> * ====================================================================</em>
<a name="7" href="#7">7</a> <em class="comment"> *</em>
<a name="8" href="#8">8</a> <em class="comment"> * Licensed to the Apache Software Foundation (ASF) under one or more</em>
<a name="9" href="#9">9</a> <em class="comment"> * contributor license agreements. See the NOTICE file distributed with</em>
<a name="10" href="#10">10</a> <em class="comment"> * this work for additional information regarding copyright ownership.</em>
<a name="11" href="#11">11</a> <em class="comment"> * The ASF licenses this file to You under the Apache License, Version 2.0</em>
<a name="12" href="#12">12</a> <em class="comment"> * (the "License"); you may not use this file except in compliance with</em>
<a name="13" href="#13">13</a> <em class="comment"> * the License. You may obtain a copy of the License at</em>
<a name="14" href="#14">14</a> <em class="comment"> *</em>
<a name="15" href="#15">15</a> <em class="comment"> * <a href="http://www.apache.org/licenses/LICENSE-2.0" target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.0</a></em>
<a name="16" href="#16">16</a> <em class="comment"> *</em>
<a name="17" href="#17">17</a> <em class="comment"> * Unless required by applicable law or agreed to in writing, software</em>
<a name="18" href="#18">18</a> <em class="comment"> * distributed under the License is distributed on an "AS IS" BASIS,</em>
<a name="19" href="#19">19</a> <em class="comment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</em>
<a name="20" href="#20">20</a> <em class="comment"> * See the License for the specific language governing permissions and</em>
<a name="21" href="#21">21</a> <em class="comment"> * limitations under the License.</em>
<a name="22" href="#22">22</a> <em class="comment"> * ====================================================================</em>
<a name="23" href="#23">23</a> <em class="comment"> *</em>
<a name="24" href="#24">24</a> <em class="comment"> * This software consists of voluntary contributions made by many</em>
<a name="25" href="#25">25</a> <em class="comment"> * individuals on behalf of the Apache Software Foundation. For more</em>
<a name="26" href="#26">26</a> <em class="comment"> * information on the Apache Software Foundation, please see</em>
<a name="27" href="#27">27</a> <em class="comment"> * <<a href="http://www.apache.org/" target="alexandria_uri">http://www.apache.org/</a>>.</em>
<a name="28" href="#28">28</a> <em class="comment"> *</em>
<a name="29" href="#29">29</a> <em class="comment"> */</em>
<a name="30" href="#30">30</a>
<a name="31" href="#31">31</a> <strong>package</strong> org.apache.commons.httpclient;
<a name="32" href="#32">32</a>
<a name="33" href="#33">33</a> <strong>import</strong> java.io.ByteArrayInputStream;
<a name="34" href="#34">34</a> <strong>import</strong> java.io.ByteArrayOutputStream;
<a name="35" href="#35">35</a> <strong>import</strong> java.io.IOException;
<a name="36" href="#36">36</a> <strong>import</strong> java.io.InputStream;
<a name="37" href="#37">37</a> <strong>import</strong> java.io.InterruptedIOException;
<a name="38" href="#38">38</a> <strong>import</strong> java.util.Collection;
<a name="39" href="#39">39</a>
<a name="40" href="#40">40</a> <strong>import</strong> org.apache.commons.httpclient.auth.AuthState;
<a name="41" href="#41">41</a> <strong>import</strong> org.apache.commons.httpclient.cookie.CookiePolicy;
<a name="42" href="#42">42</a> <strong>import</strong> org.apache.commons.httpclient.cookie.CookieSpec;
<a name="43" href="#43">43</a> <strong>import</strong> org.apache.commons.httpclient.cookie.CookieVersionSupport;
<a name="44" href="#44">44</a> <strong>import</strong> org.apache.commons.httpclient.cookie.MalformedCookieException;
<a name="45" href="#45">45</a> <strong>import</strong> org.apache.commons.httpclient.params.HttpMethodParams;
<a name="46" href="#46">46</a> <strong>import</strong> org.apache.commons.httpclient.protocol.Protocol;
<a name="47" href="#47">47</a> <strong>import</strong> org.apache.commons.httpclient.util.EncodingUtil;
<a name="48" href="#48">48</a> <strong>import</strong> org.apache.commons.httpclient.util.ExceptionUtil;
<a name="49" href="#49">49</a> <strong>import</strong> org.apache.commons.logging.Log;
<a name="50" href="#50">50</a> <strong>import</strong> org.apache.commons.logging.LogFactory;
<a name="51" href="#51">51</a>
<a name="52" href="#52">52</a> <em>/**</em>
<a name="53" href="#53">53</a> <em> * An abstract base implementation of HttpMethod.</em>
<a name="54" href="#54">54</a> <em> * <p></em>
<a name="55" href="#55">55</a> <em> * At minimum, subclasses will need to override:</em>
<a name="56" href="#56">56</a> <em> * <ul></em>
<a name="57" href="#57">57</a> <em> * <li>{@link #getName} to return the approriate name for this method</em>
<a name="58" href="#58">58</a> <em> * </li></em>
<a name="59" href="#59">59</a> <em> * </ul></em>
<a name="60" href="#60">60</a> <em> * </p></em>
<a name="61" href="#61">61</a> <em> *</em>
<a name="62" href="#62">62</a> <em> * <p></em>
<a name="63" href="#63">63</a> <em> * When a method requires additional request headers, subclasses will typically</em>
<a name="64" href="#64">64</a> <em> * want to override:</em>
<a name="65" href="#65">65</a> <em> * <ul></em>
<a name="66" href="#66">66</a> <em> * <li>{@link #addRequestHeaders addRequestHeaders(HttpState,HttpConnection)}</em>
<a name="67" href="#67">67</a> <em> * to write those headers</em>
<a name="68" href="#68">68</a> <em> * </li></em>
<a name="69" href="#69">69</a> <em> * </ul></em>
<a name="70" href="#70">70</a> <em> * </p></em>
<a name="71" href="#71">71</a> <em> *</em>
<a name="72" href="#72">72</a> <em> * <p></em>
<a name="73" href="#73">73</a> <em> * When a method expects specific response headers, subclasses may want to</em>
<a name="74" href="#74">74</a> <em> * override:</em>
<a name="75" href="#75">75</a> <em> * <ul></em>
<a name="76" href="#76">76</a> <em> * <li>{@link #processResponseHeaders processResponseHeaders(HttpState,HttpConnection)}</em>
<a name="77" href="#77">77</a> <em> * to handle those headers</em>
<a name="78" href="#78">78</a> <em> * </li></em>
<a name="79" href="#79">79</a> <em> * </ul></em>
<a name="80" href="#80">80</a> <em> * </p></em>
<a name="81" href="#81">81</a> <em> *</em>
<a name="82" href="#82">82</a> <em> *</em>
<a name="83" href="#83">83</a> <em> * @author <a href="<a href="mailto:remm@apache.org" target="alexandria_uri">mailto:remm@apache.org</a>">Remy Maucherat</a></em>
<a name="84" href="#84">84</a> <em> * @author Rodney Waldhoff</em>
<a name="85" href="#85">85</a> <em> * @author Sean C. Sullivan</em>
<a name="86" href="#86">86</a> <em> * @author <a href="<a href="mailto:dion@apache.org" target="alexandria_uri">mailto:dion@apache.org</a>">dIon Gillard</a></em>
<a name="87" href="#87">87</a> <em> * @author <a href="<a href="mailto:jsdever@apache.org" target="alexandria_uri">mailto:jsdever@apache.org</a>">Jeff Dever</a></em>
<a name="88" href="#88">88</a> <em> * @author <a href="<a href="mailto:dims@apache.org" target="alexandria_uri">mailto:dims@apache.org</a>">Davanum Srinivas</a></em>
<a name="89" href="#89">89</a> <em> * @author Ortwin Glueck</em>
<a name="90" href="#90">90</a> <em> * @author Eric Johnson</em>
<a name="91" href="#91">91</a> <em> * @author Michael Becke</em>
<a name="92" href="#92">92</a> <em> * @author <a href="<a href="mailto:oleg@ural.ru" target="alexandria_uri">mailto:oleg@ural.ru</a>">Oleg Kalnichevski</a></em>
<a name="93" href="#93">93</a> <em> * @author <a href="<a href="mailto:mbowler@GargoyleSoftware.com" target="alexandria_uri">mailto:mbowler@GargoyleSoftware.com</a>">Mike Bowler</a></em>
<a name="94" href="#94">94</a> <em> * @author <a href="<a href="mailto:ggregory@seagullsw.com" target="alexandria_uri">mailto:ggregory@seagullsw.com</a>">Gary Gregory</a></em>
<a name="95" href="#95">95</a> <em> * @author Christian Kohlschuetter</em>
<a name="96" href="#96">96</a> <em> *</em>
<a name="97" href="#97">97</a> <em> * @version $Revision: 539441 $ $Date: 2007-05-18 14:56:55 +0200 (Fri, 18 May 2007) $</em>
<a name="98" href="#98">98</a> <em> */</em>
<a name="99" href="#99">99</a> <strong>public</strong> <strong>abstract</strong> <strong>class</strong> <a href="../../../../org/apache/commons/httpclient/HttpMethodBase.html">HttpMethodBase</a> implements <a href="../../../../org/apache/commons/httpclient/HttpMethod.html">HttpMethod</a> {
<a name="100" href="#100">100</a>
<a name="101" href="#101">101</a> <em class="comment">// -------------------------------------------------------------- Constants</em>
<a name="102" href="#102">102</a>
<a name="103" href="#103">103</a> <em>/**</em><em> Log object for this class. */</em>
<a name="104" href="#104">104</a> <strong>private</strong> <strong>static</strong> <strong>final</strong> Log LOG = LogFactory.getLog(HttpMethodBase.<strong>class</strong>);
<a name="105" href="#105">105</a>
<a name="106" href="#106">106</a> <em class="comment">// ----------------------------------------------------- Instance variables </em>
<a name="107" href="#107">107</a>
<a name="108" href="#108">108</a> <em>/**</em><em> Request headers, if any. */</em>
<a name="109" href="#109">109</a> <strong>private</strong> <a href="../../../../org/apache/commons/httpclient/HeaderGroup.html">HeaderGroup</a> requestHeaders = <strong>new</strong> <a href="../../../../org/apache/commons/httpclient/HeaderGroup.html">HeaderGroup</a>();
<a name="110" href="#110">110</a>
<a name="111" href="#111">111</a> <em>/**</em><em> The Status-Line from the response. */</em>
<a name="112" href="#112">112</a> <strong>protected</strong> <a href="../../../../org/apache/commons/httpclient/StatusLine.html">StatusLine</a> statusLine = <strong>null</strong>;
<a name="113" href="#113">113</a>
<a name="114" href="#114">114</a> <em>/**</em><em> Response headers, if any. */</em>
<a name="115" href="#115">115</a> <strong>private</strong> <a href="../../../../org/apache/commons/httpclient/HeaderGroup.html">HeaderGroup</a> responseHeaders = <strong>new</strong> <a href="../../../../org/apache/commons/httpclient/HeaderGroup.html">HeaderGroup</a>();
<a name="116" href="#116">116</a>
<a name="117" href="#117">117</a> <em>/**</em><em> Response trailer headers, if any. */</em>
<a name="118" href="#118">118</a> <strong>private</strong> <a href="../../../../org/apache/commons/httpclient/HeaderGroup.html">HeaderGroup</a> responseTrailerHeaders = <strong>new</strong> <a href="../../../../org/apache/commons/httpclient/HeaderGroup.html">HeaderGroup</a>();
<a name="119" href="#119">119</a>
<a name="120" href="#120">120</a> <em>/**</em><em> Path of the HTTP method. */</em>
<a name="121" href="#121">121</a> <strong>private</strong> String path = <strong>null</strong>;
<a name="122" href="#122">122</a>
<a name="123" href="#123">123</a> <em>/**</em><em> Query string of the HTTP method, if any. */</em>
<a name="124" href="#124">124</a> <strong>private</strong> String queryString = <strong>null</strong>;
<a name="125" href="#125">125</a>
<a name="126" href="#126">126</a> <em>/**</em><em> The response body of the HTTP method, assuming it has not be </em>
<a name="127" href="#127">127</a> <em> * intercepted by a sub-class. */</em>
<a name="128" href="#128">128</a> <strong>private</strong> InputStream responseStream = <strong>null</strong>;
<a name="129" href="#129">129</a>
<a name="130" href="#130">130</a> <em>/**</em><em> The connection that the response stream was read from. */</em>
<a name="131" href="#131">131</a> <strong>private</strong> <a href="../../../../org/apache/commons/httpclient/HttpConnection.html">HttpConnection</a> responseConnection = <strong>null</strong>;
<a name="132" href="#132">132</a>
<a name="133" href="#133">133</a> <em>/**</em><em> Buffer for the response */</em>
<a name="134" href="#134">134</a> <strong>private</strong> byte[] responseBody = <strong>null</strong>;
<a name="135" href="#135">135</a>
<a name="136" href="#136">136</a> <em>/**</em><em> True if the HTTP method should automatically follow HTTP redirects.*/</em>
<a name="137" href="#137">137</a> <strong>private</strong> <strong>boolean</strong> followRedirects = false;
<a name="138" href="#138">138</a>
<a name="139" href="#139">139</a> <em>/**</em><em> True if the HTTP method should automatically handle</em>
<a name="140" href="#140">140</a> <em> * HTTP authentication challenges. */</em>
<a name="141" href="#141">141</a> <strong>private</strong> <strong>boolean</strong> doAuthentication = <strong>true</strong>;
<a name="142" href="#142">142</a>
<a name="143" href="#143">143</a> <em>/**</em><em> HTTP protocol parameters. */</em>
<a name="144" href="#144">144</a> <strong>private</strong> <a href="../../../../org/apache/commons/httpclient/params/HttpMethodParams.html">HttpMethodParams</a> params = <strong>new</strong> <a href="../../../../org/apache/commons/httpclient/params/HttpMethodParams.html">HttpMethodParams</a>();
<a name="145" href="#145">145</a>
<a name="146" href="#146">146</a> <em>/**</em><em> Host authentication state */</em>
<a name="147" href="#147">147</a> <strong>private</strong> <a href="../../../../org/apache/commons/httpclient/auth/AuthState.html">AuthState</a> hostAuthState = <strong>new</strong> <a href="../../../../org/apache/commons/httpclient/auth/AuthState.html">AuthState</a>();
<a name="148" href="#148">148</a>
<a name="149" href="#149">149</a> <em>/**</em><em> Proxy authentication state */</em>
<a name="150" href="#150">150</a> <strong>private</strong> <a href="../../../../org/apache/commons/httpclient/auth/AuthState.html">AuthState</a> proxyAuthState = <strong>new</strong> <a href="../../../../org/apache/commons/httpclient/auth/AuthState.html">AuthState</a>();
<a name="151" href="#151">151</a>
<a name="152" href="#152">152</a> <em>/**</em><em> True if this method has already been executed. */</em>
<a name="153" href="#153">153</a> <strong>private</strong> <strong>boolean</strong> used = false;
<a name="154" href="#154">154</a>
<a name="155" href="#155">155</a> <em>/**</em><em> Count of how many times did this HTTP method transparently handle </em>
<a name="156" href="#156">156</a> <em> * a recoverable exception. */</em>
<a name="157" href="#157">157</a> <strong>private</strong> <strong>int</strong> recoverableExceptionCount = 0;
<a name="158" href="#158">158</a>
<a name="159" href="#159">159</a> <em>/**</em><em> the host for this HTTP method, can be null */</em>
<a name="160" href="#160">160</a> <strong>private</strong> <a href="../../../../org/apache/commons/httpclient/HttpHost.html">HttpHost</a> httphost = <strong>null</strong>;
<a name="161" href="#161">161</a>
<a name="162" href="#162">162</a> <em>/**</em>
<a name="163" href="#163">163</a> <em> * Handles method retries</em>
<a name="164" href="#164">164</a> <em> * </em>
<a name="165" href="#165">165</a> <em> * @deprecated no loner used</em>
<a name="166" href="#166">166</a> <em> */</em>
<a name="167" href="#167">167</a> <strong>private</strong> <a href="../../../../org/apache/commons/httpclient/MethodRetryHandler.html">MethodRetryHandler</a> methodRetryHandler;
<a name="168" href="#168">168</a>
<a name="169" href="#169">169</a> <em>/**</em><em> True if the connection must be closed when no longer needed */</em>
<a name="170" href="#170">170</a> <strong>private</strong> <strong>boolean</strong> connectionCloseForced = false;
<a name="171" href="#171">171</a>
<a name="172" href="#172">172</a> <em>/**</em><em> Number of milliseconds to wait for 100-contunue response. */</em>
<a name="173" href="#173">173</a> <strong>private</strong> <strong>static</strong> <strong>final</strong> <strong>int</strong> RESPONSE_WAIT_TIME_MS = 3000;
<a name="174" href="#174">174</a>
<a name="175" href="#175">175</a> <em>/**</em><em> HTTP protocol version used for execution of this method. */</em>
<a name="176" href="#176">176</a> <strong>protected</strong> <a href="../../../../org/apache/commons/httpclient/HttpVersion.html">HttpVersion</a> effectiveVersion = <strong>null</strong>;
<a name="177" href="#177">177</a>
<a name="178" href="#178">178</a> <em>/**</em><em> Whether the execution of this method has been aborted */</em>
<a name="179" href="#179">179</a> <strong>private</strong> <strong>volatile</strong> <strong>boolean</strong> aborted = false;
<a name="180" href="#180">180</a>
<a name="181" href="#181">181</a> <em>/**</em><em> Whether the HTTP request has been transmitted to the target</em>
<a name="182" href="#182">182</a> <em> * server it its entirety */</em>
<a name="183" href="#183">183</a> <strong>private</strong> <strong>boolean</strong> requestSent = false;
<a name="184" href="#184">184</a>
<a name="185" href="#185">185</a> <em>/**</em><em> Actual cookie policy */</em>
<a name="186" href="#186">186</a> <strong>private</strong> <a href="../../../../org/apache/commons/httpclient/cookie/CookieSpec.html">CookieSpec</a> cookiespec = <strong>null</strong>;
<a name="187" href="#187">187</a>
<a name="188" href="#188">188</a> <em>/**</em><em> Default initial size of the response buffer if content length is unknown. */</em>
<a name="189" href="#189">189</a> <strong>private</strong> <strong>static</strong> <strong>final</strong> <strong>int</strong> DEFAULT_INITIAL_BUFFER_SIZE = 4*1024; <em class="comment">// 4 kB</em>
<a name="190" href="#190">190</a>
<a name="191" href="#191">191</a> <em class="comment">// ----------------------------------------------------------- Constructors</em>
<a name="192" href="#192">192</a>
<a name="193" href="#193">193</a> <em>/**</em>
<a name="194" href="#194">194</a> <em> * No-arg constructor.</em>
<a name="195" href="#195">195</a> <em> */</em>
<a name="196" href="#196">196</a> <strong>public</strong> <a href="../../../../org/apache/commons/httpclient/HttpMethodBase.html">HttpMethodBase</a>() {
<a name="197" href="#197">197</a> }
<a name="198" href="#198">198</a>
<a name="199" href="#199">199</a> <em>/**</em>
<a name="200" href="#200">200</a> <em> * Constructor specifying a URI.</em>
<a name="201" href="#201">201</a> <em> * It is responsibility of the caller to ensure that URI elements</em>
<a name="202" href="#202">202</a> <em> * (path & query parameters) are properly encoded (URL safe).</em>
<a name="203" href="#203">203</a> <em> *</em>
<a name="204" href="#204">204</a> <em> * @param uri either an absolute or relative URI. The URI is expected</em>
<a name="205" href="#205">205</a> <em> * to be URL-encoded</em>
<a name="206" href="#206">206</a> <em> * </em>
<a name="207" href="#207">207</a> <em> * @throws IllegalArgumentException when URI is invalid</em>
<a name="208" href="#208">208</a> <em> * @throws IllegalStateException when protocol of the absolute URI is not recognised</em>
<a name="209" href="#209">209</a> <em> */</em>
<a name="210" href="#210">210</a> <strong>public</strong> <a href="../../../../org/apache/commons/httpclient/HttpMethodBase.html">HttpMethodBase</a>(String uri)
<a name="211" href="#211">211</a> throws IllegalArgumentException, IllegalStateException {
<a name="212" href="#212">212</a>
<a name="213" href="#213">213</a> <strong>try</strong> {
<a name="214" href="#214">214</a>
<a name="215" href="#215">215</a> <em class="comment">// create a URI and allow for null/empty uri values</em>
<a name="216" href="#216">216</a> <strong>if</strong> (uri == <strong>null</strong> || uri.equals(<span class="string">""</span>)) {
<a name="217" href="#217">217</a> uri = <span class="string">"/"</span>;
<a name="218" href="#218">218</a> }
<a name="219" href="#219">219</a> String charset = getParams().getUriCharset();
<a name="220" href="#220">220</a> setURI(<strong>new</strong> <a href="../../../../org/apache/commons/httpclient/URI.html">URI</a>(uri, <strong>true</strong>, charset));
<a name="221" href="#221">221</a> } <strong>catch</strong> (URIException e) {
<a name="222" href="#222">222</a> <strong>throw</strong> <strong>new</strong> IllegalArgumentException(<span class="string">"Invalid uri '"</span>
<a name="223" href="#223">223</a> + uri + <span class="string">"': "</span> + e.getMessage()
<a name="224" href="#224">224</a> );
<a name="225" href="#225">225</a> }
<a name="226" href="#226">226</a> }
<a name="227" href="#227">227</a>
<a name="228" href="#228">228</a> <em class="comment">// ------------------------------------------- Property Setters and Getters</em>
<a name="229" href="#229">229</a>
<a name="230" href="#230">230</a> <em>/**</em>
<a name="231" href="#231">231</a> <em> * Obtains the name of the HTTP method as used in the HTTP request line,</em>
<a name="232" href="#232">232</a> <em> * for example <tt>"GET"</tt> or <tt>"POST"</tt>.</em>
<a name="233" href="#233">233</a> <em> * </em>
<a name="234" href="#234">234</a> <em> * @return the name of this method</em>
<a name="235" href="#235">235</a> <em> */</em>
<a name="236" href="#236">236</a> <strong>public</strong> <strong>abstract</strong> String getName();
<a name="237" href="#237">237</a>
<a name="238" href="#238">238</a> <em>/**</em>
<a name="239" href="#239">239</a> <em> * Returns the URI of the HTTP method</em>
<a name="240" href="#240">240</a> <em> * </em>
<a name="241" href="#241">241</a> <em> * @return The URI</em>
<a name="242" href="#242">242</a> <em> * </em>
<a name="243" href="#243">243</a> <em> * @throws URIException If the URI cannot be created.</em>
<a name="244" href="#244">244</a> <em> * </em>
<a name="245" href="#245">245</a> <em> * @see org.apache.commons.httpclient.HttpMethod#getURI()</em>
<a name="246" href="#246">246</a> <em> */</em>
<a name="247" href="#247">247</a> <strong>public</strong> <a href="../../../../org/apache/commons/httpclient/URI.html">URI</a> getURI() throws URIException {
<a name="248" href="#248">248</a> StringBuffer buffer = <strong>new</strong> StringBuffer();
<a name="249" href="#249">249</a> <strong>if</strong> (<strong>this</strong>.httphost != <strong>null</strong>) {
<a name="250" href="#250">250</a> buffer.append(<strong>this</strong>.httphost.getProtocol().getScheme());
<a name="251" href="#251">251</a> buffer.append(<span class="string">"://"</span>);
<a name="252" href="#252">252</a> buffer.append(<strong>this</strong>.httphost.getHostName());
<a name="253" href="#253">253</a> <strong>int</strong> port = <strong>this</strong>.httphost.getPort();
<a name="254" href="#254">254</a> <strong>if</strong> (port != -1 && port != <strong>this</strong>.httphost.getProtocol().getDefaultPort()) {
<a name="255" href="#255">255</a> buffer.append(<span class="string">":"</span>);
<a name="256" href="#256">256</a> buffer.append(port);
<a name="257" href="#257">257</a> }
<a name="258" href="#258">258</a> }
<a name="259" href="#259">259</a> buffer.append(<strong>this</strong>.path);
<a name="260" href="#260">260</a> <strong>if</strong> (<strong>this</strong>.queryString != <strong>null</strong>) {
<a name="261" href="#261">261</a> buffer.append('?');
<a name="262" href="#262">262</a> buffer.append(<strong>this</strong>.queryString);
<a name="263" href="#263">263</a> }
<a name="264" href="#264">264</a> String charset = getParams().getUriCharset();
<a name="265" href="#265">265</a> <strong>return</strong> <strong>new</strong> <a href="../../../../org/apache/commons/httpclient/URI.html">URI</a>(buffer.toString(), <strong>true</strong>, charset);
<a name="266" href="#266">266</a> }
<a name="267" href="#267">267</a>
<a name="268" href="#268">268</a> <em>/**</em>
<a name="269" href="#269">269</a> <em> * Sets the URI for this method. </em>
<a name="270" href="#270">270</a> <em> * </em>
<a name="271" href="#271">271</a> <em> * @param uri URI to be set </em>
<a name="272" href="#272">272</a> <em> * </em>
<a name="273" href="#273">273</a> <em> * @throws URIException if a URI cannot be set</em>
<a name="274" href="#274">274</a> <em> * </em>
<a name="275" href="#275">275</a> <em> * @since 3.0</em>
<a name="276" href="#276">276</a> <em> */</em>
<a name="277" href="#277">277</a> <strong>public</strong> <strong>void</strong> setURI(<a href="../../../../org/apache/commons/httpclient/URI.html">URI</a> uri) throws URIException {
<a name="278" href="#278">278</a> <em class="comment">// only set the host if specified by the URI</em>
<a name="279" href="#279">279</a> <strong>if</strong> (uri.isAbsoluteURI()) {
<a name="280" href="#280">280</a> <strong>this</strong>.httphost = <strong>new</strong> <a href="../../../../org/apache/commons/httpclient/HttpHost.html">HttpHost</a>(uri);
<a name="281" href="#281">281</a> }
<a name="282" href="#282">282</a> <em class="comment">// set the path, defaulting to root</em>
<a name="283" href="#283">283</a> setPath(
<a name="284" href="#284">284</a> uri.getPath() == <strong>null</strong>
<a name="285" href="#285">285</a> ? <span class="string">"/"</span>
<a name="286" href="#286">286</a> : uri.getEscapedPath()
<a name="287" href="#287">287</a> );
<a name="288" href="#288">288</a> setQueryString(uri.getEscapedQuery());
<a name="289" href="#289">289</a> }
<a name="290" href="#290">290</a>
<a name="291" href="#291">291</a> <em>/**</em>
<a name="292" href="#292">292</a> <em> * Sets whether or not the HTTP method should automatically follow HTTP redirects </em>
<a name="293" href="#293">293</a> <em> * (status code 302, etc.)</em>
<a name="294" href="#294">294</a> <em> * </em>
<a name="295" href="#295">295</a> <em> * @param followRedirects <tt>true</tt> if the method will automatically follow redirects,</em>
<a name="296" href="#296">296</a> <em> * <tt>false</tt> otherwise.</em>
<a name="297" href="#297">297</a> <em> */</em>
<a name="298" href="#298">298</a> <strong>public</strong> <strong>void</strong> setFollowRedirects(<strong>boolean</strong> followRedirects) {
<a name="299" href="#299">299</a> <strong>this</strong>.followRedirects = followRedirects;
<a name="300" href="#300">300</a> }
<a name="301" href="#301">301</a>
<a name="302" href="#302">302</a> <em>/**</em>
<a name="303" href="#303">303</a> <em> * Returns <tt>true</tt> if the HTTP method should automatically follow HTTP redirects </em>
<a name="304" href="#304">304</a> <em> * (status code 302, etc.), <tt>false</tt> otherwise.</em>
<a name="305" href="#305">305</a> <em> * </em>
<a name="306" href="#306">306</a> <em> * @return <tt>true</tt> if the method will automatically follow HTTP redirects, </em>
<a name="307" href="#307">307</a> <em> * <tt>false</tt> otherwise.</em>
<a name="308" href="#308">308</a> <em> */</em>
<a name="309" href="#309">309</a> <strong>public</strong> <strong>boolean</strong> getFollowRedirects() {
<a name="310" href="#310">310</a> <strong>return</strong> <strong>this</strong>.followRedirects;
<a name="311" href="#311">311</a> }
<a name="312" href="#312">312</a>
<a name="313" href="#313">313</a> <em>/**</em><em> Sets whether version 1.1 of the HTTP protocol should be used per default.</em>
<a name="314" href="#314">314</a> <em> *</em>
<a name="315" href="#315">315</a> <em> * @param http11 <tt>true</tt> to use HTTP/1.1, <tt>false</tt> to use 1.0</em>
<a name="316" href="#316">316</a> <em> * </em>
<a name="317" href="#317">317</a> <em> * @deprecated Use {@link HttpMethodParams#setVersion(HttpVersion)}</em>
<a name="318" href="#318">318</a> <em> */</em>
<a name="319" href="#319">319</a> <strong>public</strong> <strong>void</strong> setHttp11(<strong>boolean</strong> http11) {
<a name="320" href="#320">320</a> <strong>if</strong> (http11) {
<a name="321" href="#321">321</a> <strong>this</strong>.params.setVersion(HttpVersion.HTTP_1_1);
<a name="322" href="#322">322</a> } <strong>else</strong> {
<a name="323" href="#323">323</a> <strong>this</strong>.params.setVersion(HttpVersion.HTTP_1_0);
<a name="324" href="#324">324</a> }
<a name="325" href="#325">325</a> }
<a name="326" href="#326">326</a>
<a name="327" href="#327">327</a> <em>/**</em>
<a name="328" href="#328">328</a> <em> * Returns <tt>true</tt> if the HTTP method should automatically handle HTTP </em>
<a name="329" href="#329">329</a> <em> * authentication challenges (status code 401, etc.), <tt>false</tt> otherwise</em>
<a name="330" href="#330">330</a> <em> *</em>
<a name="331" href="#331">331</a> <em> * @return <tt>true</tt> if authentication challenges will be processed </em>
<a name="332" href="#332">332</a> <em> * automatically, <tt>false</tt> otherwise.</em>
<a name="333" href="#333">333</a> <em> * </em>
<a name="334" href="#334">334</a> <em> * @since 2.0</em>
<a name="335" href="#335">335</a> <em> */</em>
<a name="336" href="#336">336</a> <strong>public</strong> <strong>boolean</strong> getDoAuthentication() {
<a name="337" href="#337">337</a> <strong>return</strong> doAuthentication;
<a name="338" href="#338">338</a> }
<a name="339" href="#339">339</a>
<a name="340" href="#340">340</a> <em>/**</em>
<a name="341" href="#341">341</a> <em> * Sets whether or not the HTTP method should automatically handle HTTP </em>
<a name="342" href="#342">342</a> <em> * authentication challenges (status code 401, etc.)</em>
<a name="343" href="#343">343</a> <em> *</em>
<a name="344" href="#344">344</a> <em> * @param doAuthentication <tt>true</tt> to process authentication challenges</em>
<a name="345" href="#345">345</a> <em> * authomatically, <tt>false</tt> otherwise.</em>
<a name="346" href="#346">346</a> <em> * </em>
<a name="347" href="#347">347</a> <em> * @since 2.0</em>
<a name="348" href="#348">348</a> <em> */</em>
<a name="349" href="#349">349</a> <strong>public</strong> <strong>void</strong> setDoAuthentication(<strong>boolean</strong> doAuthentication) {
<a name="350" href="#350">350</a> <strong>this</strong>.doAuthentication = doAuthentication;
<a name="351" href="#351">351</a> }
<a name="352" href="#352">352</a>
<a name="353" href="#353">353</a> <em class="comment">// ---------------------------------------------- Protected Utility Methods</em>
<a name="354" href="#354">354</a>
<a name="355" href="#355">355</a> <em>/**</em>
<a name="356" href="#356">356</a> <em> * Returns <tt>true</tt> if version 1.1 of the HTTP protocol should be </em>
<a name="357" href="#357">357</a> <em> * used per default, <tt>false</tt> if version 1.0 should be used.</em>
<a name="358" href="#358">358</a> <em> *</em>
<a name="359" href="#359">359</a> <em> * @return <tt>true</tt> to use HTTP/1.1, <tt>false</tt> to use 1.0</em>
<a name="360" href="#360">360</a> <em> * </em>
<a name="361" href="#361">361</a> <em> * @deprecated Use {@link HttpMethodParams#getVersion()}</em>
<a name="362" href="#362">362</a> <em> */</em>
<a name="363" href="#363">363</a> <strong>public</strong> <strong>boolean</strong> isHttp11() {
<a name="364" href="#364">364</a> <strong>return</strong> <strong>this</strong>.params.getVersion().equals(HttpVersion.HTTP_1_1);
<a name="365" href="#365">365</a> }
<a name="366" href="#366">366</a>
<a name="367" href="#367">367</a> <em>/**</em>
<a name="368" href="#368">368</a> <em> * Sets the path of the HTTP method.</em>
<a name="369" href="#369">369</a> <em> * It is responsibility of the caller to ensure that the path is</em>
<a name="370" href="#370">370</a> <em> * properly encoded (URL safe).</em>
<a name="371" href="#371">371</a> <em> *</em>
<a name="372" href="#372">372</a> <em> * @param path the path of the HTTP method. The path is expected</em>
<a name="373" href="#373">373</a> <em> * to be URL-encoded</em>
<a name="374" href="#374">374</a> <em> */</em>
<a name="375" href="#375">375</a> <strong>public</strong> <strong>void</strong> setPath(String path) {
<a name="376" href="#376">376</a> <strong>this</strong>.path = path;
<a name="377" href="#377">377</a> }
<a name="378" href="#378">378</a>
<a name="379" href="#379">379</a> <em>/**</em>
<a name="380" href="#380">380</a> <em> * Adds the specified request header, NOT overwriting any previous value.</em>
<a name="381" href="#381">381</a> <em> * Note that header-name matching is case insensitive.</em>
<a name="382" href="#382">382</a> <em> *</em>
<a name="383" href="#383">383</a> <em> * @param header the header to add to the request</em>
<a name="384" href="#384">384</a> <em> */</em>
<a name="385" href="#385">385</a> <strong>public</strong> <strong>void</strong> addRequestHeader(<a href="../../../../org/apache/commons/httpclient/Header.html">Header</a> header) {
<a name="386" href="#386">386</a> LOG.trace(<span class="string">"HttpMethodBase.addRequestHeader(Header)"</span>);
<a name="387" href="#387">387</a>
<a name="388" href="#388">388</a> <strong>if</strong> (header == <strong>null</strong>) {
<a name="389" href="#389">389</a> LOG.debug(<span class="string">"null header value ignored"</span>);
<a name="390" href="#390">390</a> } <strong>else</strong> {
<a name="391" href="#391">391</a> getRequestHeaderGroup().addHeader(header);
<a name="392" href="#392">392</a> }
<a name="393" href="#393">393</a> }
<a name="394" href="#394">394</a>
<a name="395" href="#395">395</a> <em>/**</em>
<a name="396" href="#396">396</a> <em> * Use this method internally to add footers.</em>
<a name="397" href="#397">397</a> <em> * </em>
<a name="398" href="#398">398</a> <em> * @param footer The footer to add.</em>
<a name="399" href="#399">399</a> <em> */</em>
<a name="400" href="#400">400</a> <strong>public</strong> <strong>void</strong> addResponseFooter(<a href="../../../../org/apache/commons/httpclient/Header.html">Header</a> footer) {
<a name="401" href="#401">401</a> getResponseTrailerHeaderGroup().addHeader(footer);
<a name="402" href="#402">402</a> }
<a name="403" href="#403">403</a>
<a name="404" href="#404">404</a> <em>/**</em>
<a name="405" href="#405">405</a> <em> * Gets the path of this HTTP method.</em>
<a name="406" href="#406">406</a> <em> * Calling this method <em>after</em> the request has been executed will </em>
<a name="407" href="#407">407</a> <em> * return the <em>actual</em> path, following any redirects automatically</em>
<a name="408" href="#408">408</a> <em> * handled by this HTTP method.</em>
<a name="409" href="#409">409</a> <em> *</em>
<a name="410" href="#410">410</a> <em> * @return the path to request or "/" if the path is blank.</em>
<a name="411" href="#411">411</a> <em> */</em>
<a name="412" href="#412">412</a> <strong>public</strong> String getPath() {
<a name="413" href="#413">413</a> <strong>return</strong> (path == <strong>null</strong> || path.equals(<span class="string">""</span>)) ? <span class="string">"/"</span> : path;
<a name="414" href="#414">414</a> }
<a name="415" href="#415">415</a>
<a name="416" href="#416">416</a> <em>/**</em>
<a name="417" href="#417">417</a> <em> * Sets the query string of this HTTP method. The caller must ensure that the string </em>
<a name="418" href="#418">418</a> <em> * is properly URL encoded. The query string should not start with the question </em>
<a name="419" href="#419">419</a> <em> * mark character.</em>
<a name="420" href="#420">420</a> <em> *</em>
<a name="421" href="#421">421</a> <em> * @param queryString the query string</em>
<a name="422" href="#422">422</a> <em> * </em>
<a name="423" href="#423">423</a> <em> * @see EncodingUtil#formUrlEncode(NameValuePair[], String)</em>
<a name="424" href="#424">424</a> <em> */</em>
<a name="425" href="#425">425</a> <strong>public</strong> <strong>void</strong> setQueryString(String queryString) {
<a name="426" href="#426">426</a> <strong>this</strong>.queryString = queryString;
<a name="427" href="#427">427</a> }
<a name="428" href="#428">428</a>
<a name="429" href="#429">429</a> <em>/**</em>
<a name="430" href="#430">430</a> <em> * Sets the query string of this HTTP method. The pairs are encoded as UTF-8 characters. </em>
<a name="431" href="#431">431</a> <em> * To use a different charset the parameters can be encoded manually using EncodingUtil </em>
<a name="432" href="#432">432</a> <em> * and set as a single String.</em>
<a name="433" href="#433">433</a> <em> *</em>
<a name="434" href="#434">434</a> <em> * @param params an array of {@link NameValuePair}s to add as query string</em>
<a name="435" href="#435">435</a> <em> * parameters. The name/value pairs will be automcatically </em>
<a name="436" href="#436">436</a> <em> * URL encoded</em>
<a name="437" href="#437">437</a> <em> * </em>
<a name="438" href="#438">438</a> <em> * @see EncodingUtil#formUrlEncode(NameValuePair[], String)</em>
<a name="439" href="#439">439</a> <em> * @see #setQueryString(String)</em>
<a name="440" href="#440">440</a> <em> */</em>
<a name="441" href="#441">441</a> <strong>public</strong> <strong>void</strong> setQueryString(<a href="../../../../org/apache/commons/httpclient/NameValuePair.html">NameValuePair</a>[] params) {
<a name="442" href="#442">442</a> LOG.trace(<span class="string">"enter HttpMethodBase.setQueryString(NameValuePair[])"</span>);
<a name="443" href="#443">443</a> queryString = EncodingUtil.formUrlEncode(params, <span class="string">"UTF-8"</span>);
<a name="444" href="#444">444</a> }
<a name="445" href="#445">445</a>
<a name="446" href="#446">446</a> <em>/**</em>
<a name="447" href="#447">447</a> <em> * Gets the query string of this HTTP method.</em>
<a name="448" href="#448">448</a> <em> *</em>
<a name="449" href="#449">449</a> <em> * @return The query string</em>
<a name="450" href="#450">450</a> <em> */</em>
<a name="451" href="#451">451</a> <strong>public</strong> String getQueryString() {
<a name="452" href="#452">452</a> <strong>return</strong> queryString;
<a name="453" href="#453">453</a> }
<a name="454" href="#454">454</a>
<a name="455" href="#455">455</a> <em>/**</em>
<a name="456" href="#456">456</a> <em> * Set the specified request header, overwriting any previous value. Note</em>
<a name="457" href="#457">457</a> <em> * that header-name matching is case-insensitive.</em>
<a name="458" href="#458">458</a> <em> *</em>
<a name="459" href="#459">459</a> <em> * @param headerName the header's name</em>
<a name="460" href="#460">460</a> <em> * @param headerValue the header's value</em>
<a name="461" href="#461">461</a> <em> */</em>
<a name="462" href="#462">462</a> <strong>public</strong> <strong>void</strong> setRequestHeader(String headerName, String headerValue) {
<a name="463" href="#463">463</a> <a href="../../../../org/apache/commons/httpclient/Header.html">Header</a> header = <strong>new</strong> <a href="../../../../org/apache/commons/httpclient/Header.html">Header</a>(headerName, headerValue);
<a name="464" href="#464">464</a> setRequestHeader(header);
<a name="465" href="#465">465</a> }
<a name="466" href="#466">466</a>
<a name="467" href="#467">467</a> <em>/**</em>
<a name="468" href="#468">468</a> <em> * Sets the specified request header, overwriting any previous value.</em>
<a name="469" href="#469">469</a> <em> * Note that header-name matching is case insensitive.</em>
<a name="470" href="#470">470</a> <em> * </em>
<a name="471" href="#471">471</a> <em> * @param header the header</em>
<a name="472" href="#472">472</a> <em> */</em>
<a name="473" href="#473">473</a> <strong>public</strong> <strong>void</strong> setRequestHeader(<a href="../../../../org/apache/commons/httpclient/Header.html">Header</a> header) {
<a name="474" href="#474">474</a>
<a name="475" href="#475">475</a> <a href="../../../../org/apache/commons/httpclient/Header.html">Header</a>[] headers = getRequestHeaderGroup().getHeaders(header.getName());
<a name="476" href="#476">476</a>
<a name="477" href="#477">477</a> <strong>for</strong> (<strong>int</strong> i = 0; i < headers.length; i++) {
<a name="478" href="#478">478</a> getRequestHeaderGroup().removeHeader(headers[i]);
<a name="479" href="#479">479</a> }
<a name="480" href="#480">480</a>
<a name="481" href="#481">481</a> getRequestHeaderGroup().addHeader(header);
<a name="482" href="#482">482</a>
<a name="483" href="#483">483</a> }
<a name="484" href="#484">484</a>
<a name="485" href="#485">485</a> <em>/**</em>
<a name="486" href="#486">486</a> <em> * Returns the specified request header. Note that header-name matching is</em>
<a name="487" href="#487">487</a> <em> * case insensitive. <tt>null</tt> will be returned if either</em>
<a name="488" href="#488">488</a> <em> * <i>headerName</i> is <tt>null</tt> or there is no matching header for</em>
<a name="489" href="#489">489</a> <em> * <i>headerName</i>.</em>
<a name="490" href="#490">490</a> <em> * </em>
<a name="491" href="#491">491</a> <em> * @param headerName The name of the header to be returned.</em>
<a name="492" href="#492">492</a> <em> *</em>
<a name="493" href="#493">493</a> <em> * @return The specified request header.</em>
<a name="494" href="#494">494</a> <em> * </em>
<a name="495" href="#495">495</a> <em> * @since 3.0</em>
<a name="496" href="#496">496</a> <em> */</em>
<a name="497" href="#497">497</a> <strong>public</strong> <a href="../../../../org/apache/commons/httpclient/Header.html">Header</a> getRequestHeader(String headerName) {
<a name="498" href="#498">498</a> <strong>if</strong> (headerName == <strong>null</strong>) {
<a name="499" href="#499">499</a> <strong>return</strong> <strong>null</strong>;
<a name="500" href="#500">500</a> } <strong>else</strong> {
<a name="501" href="#501">501</a> <strong>return</strong> getRequestHeaderGroup().getCondensedHeader(headerName);
<a name="502" href="#502">502</a> }
<a name="503" href="#503">503</a> }
<a name="504" href="#504">504</a>
<a name="505" href="#505">505</a> <em>/**</em>
<a name="506" href="#506">506</a> <em> * Returns an array of the requests headers that the HTTP method currently has</em>
<a name="507" href="#507">507</a> <em> *</em>
<a name="508" href="#508">508</a> <em> * @return an array of my request headers.</em>
<a name="509" href="#509">509</a> <em> */</em>
<a name="510" href="#510">510</a> <strong>public</strong> <a href="../../../../org/apache/commons/httpclient/Header.html">Header</a>[] getRequestHeaders() {
<a name="511" href="#511">511</a> <strong>return</strong> getRequestHeaderGroup().getAllHeaders();
<a name="512" href="#512">512</a> }
<a name="513" href="#513">513</a>
<a name="514" href="#514">514</a> <em>/**</em>
<a name="515" href="#515">515</a> <em> * @see org.apache.commons.httpclient.HttpMethod#getRequestHeaders(java.lang.String)</em>
<a name="516" href="#516">516</a> <em> */</em>
<a name="517" href="#517">517</a> <strong>public</strong> <a href="../../../../org/apache/commons/httpclient/Header.html">Header</a>[] getRequestHeaders(String headerName) {
<a name="518" href="#518">518</a> <strong>return</strong> getRequestHeaderGroup().getHeaders(headerName);
<a name="519" href="#519">519</a> }
<a name="520" href="#520">520</a>
<a name="521" href="#521">521</a> <em>/**</em>
<a name="522" href="#522">522</a> <em> * Gets the {@link HeaderGroup header group} storing the request headers.</em>
<a name="523" href="#523">523</a> <em> * </em>
<a name="524" href="#524">524</a> <em> * @return a HeaderGroup</em>
<a name="525" href="#525">525</a> <em> * </em>
<a name="526" href="#526">526</a> <em> * @since 2.0beta1</em>
<a name="527" href="#527">527</a> <em> */</em>
<a name="528" href="#528">528</a> <strong>protected</strong> <a href="../../../../org/apache/commons/httpclient/HeaderGroup.html">HeaderGroup</a> getRequestHeaderGroup() {
<a name="529" href="#529">529</a> <strong>return</strong> requestHeaders;
<a name="530" href="#530">530</a> }
<a name="531" href="#531">531</a>
<a name="532" href="#532">532</a> <em>/**</em>
<a name="533" href="#533">533</a> <em> * Gets the {@link HeaderGroup header group} storing the response trailer headers </em>
<a name="534" href="#534">534</a> <em> * as per RFC 2616 section 3.6.1.</em>
<a name="535" href="#535">535</a> <em> * </em>
<a name="536" href="#536">536</a> <em> * @return a HeaderGroup</em>
<a name="537" href="#537">537</a> <em> * </em>
<a name="538" href="#538">538</a> <em> * @since 2.0beta1</em>
<a name="539" href="#539">539</a> <em> */</em>
<a name="540" href="#540">540</a> <strong>protected</strong> <a href="../../../../org/apache/commons/httpclient/HeaderGroup.html">HeaderGroup</a> getResponseTrailerHeaderGroup() {
<a name="541" href="#541">541</a> <strong>return</strong> responseTrailerHeaders;
<a name="542" href="#542">542</a> }
<a name="543" href="#543">543</a>
<a name="544" href="#544">544</a> <em>/**</em>
<a name="545" href="#545">545</a> <em> * Gets the {@link HeaderGroup header group} storing the response headers.</em>
<a name="546" href="#546">546</a> <em> * </em>
<a name="547" href="#547">547</a> <em> * @return a HeaderGroup</em>
<a name="548" href="#548">548</a> <em> * </em>
<a name="549" href="#549">549</a> <em> * @since 2.0beta1</em>
<a name="550" href="#550">550</a> <em> */</em>
<a name="551" href="#551">551</a> <strong>protected</strong> <a href="../../../../org/apache/commons/httpclient/HeaderGroup.html">HeaderGroup</a> getResponseHeaderGroup() {
<a name="552" href="#552">552</a> <strong>return</strong> responseHeaders;
<a name="553" href="#553">553</a> }
<a name="554" href="#554">554</a>
<a name="555" href="#555">555</a> <em>/**</em>
<a name="556" href="#556">556</a> <em> * @see org.apache.commons.httpclient.HttpMethod#getResponseHeaders(java.lang.String)</em>
<a name="557" href="#557">557</a> <em> * </em>
<a name="558" href="#558">558</a> <em> * @since 3.0</em>
<a name="559" href="#559">559</a> <em> */</em>
<a name="560" href="#560">560</a> <strong>public</strong> <a href="../../../../org/apache/commons/httpclient/Header.html">Header</a>[] getResponseHeaders(String headerName) {
<a name="561" href="#561">561</a> <strong>return</strong> getResponseHeaderGroup().getHeaders(headerName);
<a name="562" href="#562">562</a> }
<a name="563" href="#563">563</a>
<a name="564" href="#564">564</a> <em>/**</em>
<a name="565" href="#565">565</a> <em> * Returns the response status code.</em>
<a name="566" href="#566">566</a> <em> *</em>
<a name="567" href="#567">567</a> <em> * @return the status code associated with the latest response.</em>
<a name="568" href="#568">568</a> <em> */</em>
<a name="569" href="#569">569</a> <strong>public</strong> <strong>int</strong> getStatusCode() {
<a name="570" href="#570">570</a> <strong>return</strong> statusLine.getStatusCode();
<a name="571" href="#571">571</a> }
<a name="572" href="#572">572</a>
<a name="573" href="#573">573</a> <em>/**</em>
<a name="574" href="#574">574</a> <em> * Provides access to the response status line.</em>
<a name="575" href="#575">575</a> <em> *</em>
<a name="576" href="#576">576</a> <em> * @return the status line object from the latest response.</em>
<a name="577" href="#577">577</a> <em> * @since 2.0</em>
<a name="578" href="#578">578</a> <em> */</em>
<a name="579" href="#579">579</a> <strong>public</strong> <a href="../../../../org/apache/commons/httpclient/StatusLine.html">StatusLine</a> getStatusLine() {
<a name="580" href="#580">580</a> <strong>return</strong> statusLine;
<a name="581" href="#581">581</a> }
<a name="582" href="#582">582</a>
<a name="583" href="#583">583</a> <em>/**</em>
<a name="584" href="#584">584</a> <em> * Checks if response data is available.</em>
<a name="585" href="#585">585</a> <em> * @return <tt>true</tt> if response data is available, <tt>false</tt> otherwise.</em>
<a name="586" href="#586">586</a> <em> */</em>
<a name="587" href="#587">587</a> <strong>private</strong> <strong>boolean</strong> responseAvailable() {
<a name="588" href="#588">588</a> <strong>return</strong> (responseBody != <strong>null</strong>) || (responseStream != <strong>null</strong>);
<a name="589" href="#589">589</a> }
<a name="590" href="#590">590</a>
<a name="591" href="#591">591</a> <em>/**</em>
<a name="592" href="#592">592</a> <em> * Returns an array of the response headers that the HTTP method currently has</em>
<a name="593" href="#593">593</a> <em> * in the order in which they were read.</em>
<a name="594" href="#594">594</a> <em> *</em>
<a name="595" href="#595">595</a> <em> * @return an array of response headers.</em>
<a name="596" href="#596">596</a> <em> */</em>
<a name="597" href="#597">597</a> <strong>public</strong> <a href="../../../../org/apache/commons/httpclient/Header.html">Header</a>[] getResponseHeaders() {
<a name="598" href="#598">598</a> <strong>return</strong> getResponseHeaderGroup().getAllHeaders();
<a name="599" href="#599">599</a> }
<a name="600" href="#600">600</a>
<a name="601" href="#601">601</a> <em>/**</em>
<a name="602" href="#602">602</a> <em> * Gets the response header associated with the given name. Header name</em>
<a name="603" href="#603">603</a> <em> * matching is case insensitive. <tt>null</tt> will be returned if either</em>
<a name="604" href="#604">604</a> <em> * <i>headerName</i> is <tt>null</tt> or there is no matching header for</em>
<a name="605" href="#605">605</a> <em> * <i>headerName</i>.</em>
<a name="606" href="#606">606</a> <em> *</em>
<a name="607" href="#607">607</a> <em> * @param headerName the header name to match</em>
<a name="608" href="#608">608</a> <em> *</em>
<a name="609" href="#609">609</a> <em> * @return the matching header</em>
<a name="610" href="#610">610</a> <em> */</em>
<a name="611" href="#611">611</a> <strong>public</strong> <a href="../../../../org/apache/commons/httpclient/Header.html">Header</a> getResponseHeader(String headerName) {
<a name="612" href="#612">612</a> <strong>if</strong> (headerName == <strong>null</strong>) {
<a name="613" href="#613">613</a> <strong>return</strong> <strong>null</strong>;
<a name="614" href="#614">614</a> } <strong>else</strong> {
<a name="615" href="#615">615</a> <strong>return</strong> getResponseHeaderGroup().getCondensedHeader(headerName);
<a name="616" href="#616">616</a> }
<a name="617" href="#617">617</a> }
<a name="618" href="#618">618</a>
<a name="619" href="#619">619</a>
<a name="620" href="#620">620</a> <em>/**</em>
<a name="621" href="#621">621</a> <em> * Return the length (in bytes) of the response body, as specified in a</em>
<a name="622" href="#622">622</a> <em> * <tt>Content-Length</tt> header.</em>
<a name="623" href="#623">623</a> <em> *</em>
<a name="624" href="#624">624</a> <em> * <p></em>
<a name="625" href="#625">625</a> <em> * Return <tt>-1</tt> when the content-length is unknown.</em>
<a name="626" href="#626">626</a> <em> * </p></em>
<a name="627" href="#627">627</a> <em> *</em>
<a name="628" href="#628">628</a> <em> * @return content length, if <tt>Content-Length</tt> header is available. </em>
<a name="629" href="#629">629</a> <em> * <tt>0</tt> indicates that the request has no body.</em>
<a name="630" href="#630">630</a> <em> * If <tt>Content-Length</tt> header is not present, the method </em>
<a name="631" href="#631">631</a> <em> * returns <tt>-1</tt>.</em>
<a name="632" href="#632">632</a> <em> */</em>
<a name="633" href="#633">633</a> <strong>public</strong> <strong>long</strong> getResponseContentLength() {
<a name="634" href="#634">634</a> <a href="../../../../org/apache/commons/httpclient/Header.html">Header</a>[] headers = getResponseHeaderGroup().getHeaders(<span class="string">"Content-Length"</span>);
<a name="635" href="#635">635</a> <strong>if</strong> (headers.length == 0) {
<a name="636" href="#636">636</a> <strong>return</strong> -1;
<a name="637" href="#637">637</a> }
<a name="638" href="#638">638</a> <strong>if</strong> (headers.length > 1) {
<a name="639" href="#639">639</a> LOG.warn(<span class="string">"Multiple content-length headers detected"</span>);
<a name="640" href="#640">640</a> }
<a name="641" href="#641">641</a> <strong>for</strong> (<strong>int</strong> i = headers.length - 1; i >= 0; i--) {
<a name="642" href="#642">642</a> <a href="../../../../org/apache/commons/httpclient/Header.html">Header</a> header = headers[i];
<a name="643" href="#643">643</a> <strong>try</strong> {
<a name="644" href="#644">644</a> <strong>return</strong> Long.parseLong(header.getValue());
<a name="645" href="#645">645</a> } <strong>catch</strong> (NumberFormatException e) {
<a name="646" href="#646">646</a> <strong>if</strong> (LOG.isWarnEnabled()) {
<a name="647" href="#647">647</a> LOG.warn(<span class="string">"Invalid content-length value: "</span> + e.getMessage());
<a name="648" href="#648">648</a> }
<a name="649" href="#649">649</a> }
<a name="650" href="#650">650</a> <em class="comment">// See if we can have better luck with another header, if present</em>
<a name="651" href="#651">651</a> }
<a name="652" href="#652">652</a> <strong>return</strong> -1;
<a name="653" href="#653">653</a> }
<a name="654" href="#654">654</a>
<a name="655" href="#655">655</a>
<a name="656" href="#656">656</a> <em>/**</em>
<a name="657" href="#657">657</a> <em> * Returns the response body of the HTTP method, if any, as an array of bytes.</em>
<a name="658" href="#658">658</a> <em> * If response body is not available or cannot be read, returns <tt>null</tt>.</em>
<a name="659" href="#659">659</a> <em> * Buffers the response and this method can be called several times yielding</em>
<a name="660" href="#660">660</a> <em> * the same result each time.</em>
<a name="661" href="#661">661</a> <em> * </em>
<a name="662" href="#662">662</a> <em> * Note: This will cause the entire response body to be buffered in memory. A</em>
<a name="663" href="#663">663</a> <em> * malicious server may easily exhaust all the VM memory. It is strongly</em>
<a name="664" href="#664">664</a> <em> * recommended, to use getResponseAsStream if the content length of the response</em>
<a name="665" href="#665">665</a> <em> * is unknown or resonably large.</em>
<a name="666" href="#666">666</a> <em> * </em>
<a name="667" href="#667">667</a> <em> * @return The response body.</em>
<a name="668" href="#668">668</a> <em> * </em>
<a name="669" href="#669">669</a> <em> * @throws IOException If an I/O (transport) problem occurs while obtaining the </em>
<a name="670" href="#670">670</a> <em> * response body.</em>
<a name="671" href="#671">671</a> <em> */</em>
<a name="672" href="#672">672</a> <strong>public</strong> byte[] getResponseBody() throws IOException {
<a name="673" href="#673">673</a> <strong>if</strong> (<strong>this</strong>.responseBody == <strong>null</strong>) {
<a name="674" href="#674">674</a> InputStream instream = getResponseBodyAsStream();
<a name="675" href="#675">675</a> <strong>if</strong> (instream != <strong>null</strong>) {
<a name="676" href="#676">676</a> <strong>long</strong> contentLength = getResponseContentLength();
<a name="677" href="#677">677</a> <strong>if</strong> (contentLength > Integer.MAX_VALUE) { <em class="comment">//guard below cast from overflow</em>
<a name="678" href="#678">678</a> <strong>throw</strong> <strong>new</strong> IOException(<span class="string">"Content too large to be buffered: "</span>+ contentLength +<span class="string">" bytes"</span>);
<a name="679" href="#679">679</a> }
<a name="680" href="#680">680</a> <strong>int</strong> limit = getParams().getIntParameter(HttpMethodParams.BUFFER_WARN_TRIGGER_LIMIT, 1024*1024);
<a name="681" href="#681">681</a> <strong>if</strong> ((contentLength == -1) || (contentLength > limit)) {
<a name="682" href="#682">682</a> LOG.warn(<span class="string">"Going to buffer response body of large or unknown size. "</span>
<a name="683" href="#683">683</a> +<span class="string">"Using getResponseBodyAsStream instead is recommended."</span>);
<a name="684" href="#684">684</a> }
<a name="685" href="#685">685</a> LOG.debug(<span class="string">"Buffering response body"</span>);
<a name="686" href="#686">686</a> ByteArrayOutputStream outstream = <strong>new</strong> ByteArrayOutputStream(
<a name="687" href="#687">687</a> contentLength > 0 ? (<strong>int</strong>) contentLength : DEFAULT_INITIAL_BUFFER_SIZE);
<a name="688" href="#688">688</a> byte[] buffer = <strong>new</strong> byte[4096];
<a name="689" href="#689">689</a> <strong>int</strong> len;
<a name="690" href="#690">690</a> <strong>while</strong> ((len = instream.read(buffer)) > 0) {
<a name="691" href="#691">691</a> outstream.write(buffer, 0, len);
<a name="692" href="#692">692</a> }
<a name="693" href="#693">693</a> outstream.close();
<a name="694" href="#694">694</a> setResponseStream(<strong>null</strong>);
<a name="695" href="#695">695</a> <strong>this</strong>.responseBody = outstream.toByteArray();
<a name="696" href="#696">696</a> }
<a name="697" href="#697">697</a> }
<a name="698" href="#698">698</a> <strong>return</strong> <strong>this</strong>.responseBody;
<a name="699" href="#699">699</a> }
<a name="700" href="#700">700</a>
<a name="701" href="#701">701</a> <em>/**</em>
<a name="702" href="#702">702</a> <em> * Returns the response body of the HTTP method, if any, as an array of bytes.</em>
<a name="703" href="#703">703</a> <em> * If response body is not available or cannot be read, returns <tt>null</tt>.</em>
<a name="704" href="#704">704</a> <em> * Buffers the response and this method can be called several times yielding</em>
<a name="705" href="#705">705</a> <em> * the same result each time.</em>
<a name="706" href="#706">706</a> <em> * </em>
<a name="707" href="#707">707</a> <em> * Note: This will cause the entire response body to be buffered in memory. This method is</em>
<a name="708" href="#708">708</a> <em> * safe if the content length of the response is unknown, because the amount of memory used</em>
<a name="709" href="#709">709</a> <em> * is limited.<p></em>
<a name="710" href="#710">710</a> <em> * </em>
<a name="711" href="#711">711</a> <em> * If the response is large this method involves lots of array copying and many object </em>
<a name="712" href="#712">712</a> <em> * allocations, which makes it unsuitable for high-performance / low-footprint applications.</em>
<a name="713" href="#713">713</a> <em> * Those applications should use {@link #getResponseBodyAsStream()}.</em>
<a name="714" href="#714">714</a> <em> * </em>
<a name="715" href="#715">715</a> <em> * @param maxlen the maximum content length to accept (number of bytes). </em>
<a name="716" href="#716">716</a> <em> * @return The response body.</em>
<a name="717" href="#717">717</a> <em> * </em>
<a name="718" href="#718">718</a> <em> * @throws IOException If an I/O (transport) problem occurs while obtaining the </em>
<a name="719" href="#719">719</a> <em> * response body.</em>
<a name="720" href="#720">720</a> <em> */</em>
<a name="721" href="#721">721</a> <strong>public</strong> byte[] getResponseBody(<strong>int</strong> maxlen) throws IOException {
<a name="722" href="#722">722</a> <strong>if</strong> (maxlen < 0) <strong>throw</strong> <strong>new</strong> IllegalArgumentException(<span class="string">"maxlen must be positive"</span>);
<a name="723" href="#723">723</a> <strong>if</strong> (<strong>this</strong>.responseBody == <strong>null</strong>) {
<a name="724" href="#724">724</a> InputStream instream = getResponseBodyAsStream();
<a name="725" href="#725">725</a> <strong>if</strong> (instream != <strong>null</strong>) {
<a name="726" href="#726">726</a> <em class="comment">// we might already know that the content is larger</em>
<a name="727" href="#727">727</a> <strong>long</strong> contentLength = getResponseContentLength();
<a name="728" href="#728">728</a> <strong>if</strong> ((contentLength != -1) && (contentLength > maxlen)) {
<a name="729" href="#729">729</a> <strong>throw</strong> <strong>new</strong> <a href="../../../../org/apache/commons/httpclient/HttpContentTooLargeException.html">HttpContentTooLargeException</a>(
<a name="730" href="#730">730</a> <span class="string">"Content-Length is "</span> + contentLength, maxlen);
<a name="731" href="#731">731</a> }
<a name="732" href="#732">732</a>
<a name="733" href="#733">733</a> LOG.debug(<span class="string">"Buffering response body"</span>);
<a name="734" href="#734">734</a> ByteArrayOutputStream rawdata = <strong>new</strong> ByteArrayOutputStream(
<a name="735" href="#735">735</a> contentLength > 0 ? (<strong>int</strong>) contentLength : DEFAULT_INITIAL_BUFFER_SIZE);
<a name="736" href="#736">736</a> byte[] buffer = <strong>new</strong> byte[2048];
<a name="737" href="#737">737</a> <strong>int</strong> pos = 0;
<a name="738" href="#738">738</a> <strong>int</strong> len;
<a name="739" href="#739">739</a> <strong>do</strong> {
<a name="740" href="#740">740</a> len = instream.read(buffer, 0, Math.min(buffer.length, maxlen-pos));
<a name="741" href="#741">741</a> <strong>if</strong> (len == -1) <strong>break</strong>;
<a name="742" href="#742">742</a> rawdata.write(buffer, 0, len);
<a name="743" href="#743">743</a> pos += len;
<a name="744" href="#744">744</a> } <strong>while</strong> (pos < maxlen);
<a name="745" href="#745">745</a>
<a name="746" href="#746">746</a> setResponseStream(<strong>null</strong>);
<a name="747" href="#747">747</a> <em class="comment">// check if there is even more data</em>
<a name="748" href="#748">748</a> <strong>if</strong> (pos == maxlen) {
<a name="749" href="#749">749</a> <strong>if</strong> (instream.read() != -1)
<a name="750" href="#750">750</a> <strong>throw</strong> <strong>new</strong> <a href="../../../../org/apache/commons/httpclient/HttpContentTooLargeException.html">HttpContentTooLargeException</a>(
<a name="751" href="#751">751</a> <span class="string">"Content-Length not known but larger than "</span>
<a name="752" href="#752">752</a> + maxlen, maxlen);
<a name="753" href="#753">753</a> }
<a name="754" href="#754">754</a> <strong>this</strong>.responseBody = rawdata.toByteArray();
<a name="755" href="#755">755</a> }
<a name="756" href="#756">756</a> }
<a name="757" href="#757">757</a> <strong>return</strong> <strong>this</strong>.responseBody;
<a name="758" href="#758">758</a> }
<a name="759" href="#759">759</a>
<a name="760" href="#760">760</a> <em>/**</em>
<a name="761" href="#761">761</a> <em> * Returns the response body of the HTTP method, if any, as an {@link InputStream}. </em>
<a name="762" href="#762">762</a> <em> * If response body is not available, returns <tt>null</tt>. If the response has been</em>
<a name="763" href="#763">763</a> <em> * buffered this method returns a new stream object on every call. If the response</em>
<a name="764" href="#764">764</a> <em> * has not been buffered the returned stream can only be read once.</em>
<a name="765" href="#765">765</a> <em> * </em>
<a name="766" href="#766">766</a> <em> * @return The response body or <code>null</code>.</em>
<a name="767" href="#767">767</a> <em> * </em>
<a name="768" href="#768">768</a> <em> * @throws IOException If an I/O (transport) problem occurs while obtaining the </em>
<a name="769" href="#769">769</a> <em> * response body.</em>
<a name="770" href="#770">770</a> <em> */</em>
<a name="771" href="#771">771</a> <strong>public</strong> InputStream getResponseBodyAsStream() throws IOException {
<a name="772" href="#772">772</a> <strong>if</strong> (responseStream != <strong>null</strong>) {
<a name="773" href="#773">773</a> <strong>return</strong> responseStream;
<a name="774" href="#774">774</a> }
<a name="775" href="#775">775</a> <strong>if</strong> (responseBody != <strong>null</strong>) {
<a name="776" href="#776">776</a> InputStream byteResponseStream = <strong>new</strong> ByteArrayInputStream(responseBody);
<a name="777" href="#777">777</a> LOG.debug(<span class="string">"re-creating response stream from byte array"</span>);
<a name="778" href="#778">778</a> <strong>return</strong> byteResponseStream;
<a name="779" href="#779">779</a> }
<a name="780" href="#780">780</a> <strong>return</strong> <strong>null</strong>;
<a name="781" href="#781">781</a> }
<a name="782" href="#782">782</a>
<a name="783" href="#783">783</a> <em>/**</em>
<a name="784" href="#784">784</a> <em> * Returns the response body of the HTTP method, if any, as a {@link String}. </em>
<a name="785" href="#785">785</a> <em> * If response body is not available or cannot be read, returns <tt>null</tt></em>
<a name="786" href="#786">786</a> <em> * The string conversion on the data is done using the character encoding specified</em>
<a name="787" href="#787">787</a> <em> * in <tt>Content-Type</tt> header. Buffers the response and this method can be </em>
<a name="788" href="#788">788</a> <em> * called several times yielding the same result each time.</em>
<a name="789" href="#789">789</a> <em> * </em>
<a name="790" href="#790">790</a> <em> * Note: This will cause the entire response body to be buffered in memory. A</em>
<a name="791" href="#791">791</a> <em> * malicious server may easily exhaust all the VM memory. It is strongly</em>
<a name="792" href="#792">792</a> <em> * recommended, to use getResponseAsStream if the content length of the response</em>
<a name="793" href="#793">793</a> <em> * is unknown or resonably large.</em>
<a name="794" href="#794">794</a> <em> * </em>
<a name="795" href="#795">795</a> <em> * @return The response body or <code>null</code>.</em>
<a name="796" href="#796">796</a> <em> * </em>
<a name="797" href="#797">797</a> <em> * @throws IOException If an I/O (transport) problem occurs while obtaining the </em>
<a name="798" href="#798">798</a> <em> * response body.</em>
<a name="799" href="#799">799</a> <em> */</em>
<a name="800" href="#800">800</a> <strong>public</strong> String getResponseBodyAsString() throws IOException {
<a name="801" href="#801">801</a> byte[] rawdata = <strong>null</strong>;
<a name="802" href="#802">802</a> <strong>if</strong> (responseAvailable()) {
<a name="803" href="#803">803</a> rawdata = getResponseBody();
<a name="804" href="#804">804</a> }
<a name="805" href="#805">805</a> <strong>if</strong> (rawdata != <strong>null</strong>) {
<a name="806" href="#806">806</a> <strong>return</strong> EncodingUtil.getString(rawdata, getResponseCharSet());
<a name="807" href="#807">807</a> } <strong>else</strong> {
<a name="808" href="#808">808</a> <strong>return</strong> <strong>null</strong>;
<a name="809" href="#809">809</a> }
<a name="810" href="#810">810</a> }
<a name="811" href="#811">811</a>
<a name="812" href="#812">812</a> <em>/**</em>
<a name="813" href="#813">813</a> <em> * Returns the response body of the HTTP method, if any, as a {@link String}. </em>
<a name="814" href="#814">814</a> <em> * If response body is not available or cannot be read, returns <tt>null</tt></em>
<a name="815" href="#815">815</a> <em> * The string conversion on the data is done using the character encoding specified</em>
<a name="816" href="#816">816</a> <em> * in <tt>Content-Type</tt> header. Buffers the response and this method can be </em>
<a name="817" href="#817">817</a> <em> * called several times yielding the same result each time.</p></em>
<a name="818" href="#818">818</a> <em> * </em>
<a name="819" href="#819">819</a> <em> * Note: This will cause the entire response body to be buffered in memory. This method is</em>
<a name="820" href="#820">820</a> <em> * safe if the content length of the response is unknown, because the amount of memory used</em>
<a name="821" href="#821">821</a> <em> * is limited.<p></em>
<a name="822" href="#822">822</a> <em> * </em>
<a name="823" href="#823">823</a> <em> * If the response is large this method involves lots of array copying and many object </em>
<a name="824" href="#824">824</a> <em> * allocations, which makes it unsuitable for high-performance / low-footprint applications.</em>
<a name="825" href="#825">825</a> <em> * Those applications should use {@link #getResponseBodyAsStream()}.</em>
<a name="826" href="#826">826</a> <em> * </em>
<a name="827" href="#827">827</a> <em> * @param maxlen the maximum content length to accept (number of bytes). Note that,</em>
<a name="828" href="#828">828</a> <em> * depending on the encoding, this is not equal to the number of characters.</em>
<a name="829" href="#829">829</a> <em> * @return The response body or <code>null</code>.</em>
<a name="830" href="#830">830</a> <em> * </em>
<a name="831" href="#831">831</a> <em> * @throws IOException If an I/O (transport) problem occurs while obtaining the </em>
<a name="832" href="#832">832</a> <em> * response body.</em>
<a name="833" href="#833">833</a> <em> */</em>
<a name="834" href="#834">834</a> <strong>public</strong> String getResponseBodyAsString(<strong>int</strong> maxlen) throws IOException {
<a name="835" href="#835">835</a> <strong>if</strong> (maxlen < 0) <strong>throw</strong> <strong>new</strong> IllegalArgumentException(<span class="string">"maxlen must be positive"</span>);
<a name="836" href="#836">836</a> byte[] rawdata = <strong>null</strong>;
<a name="837" href="#837">837</a> <strong>if</strong> (responseAvailable()) {
<a name="838" href="#838">838</a> rawdata = getResponseBody(maxlen);
<a name="839" href="#839">839</a> }
<a name="840" href="#840">840</a> <strong>if</strong> (rawdata != <strong>null</strong>) {
<a name="841" href="#841">841</a> <strong>return</strong> EncodingUtil.getString(rawdata, getResponseCharSet());
<a name="842" href="#842">842</a> } <strong>else</strong> {
<a name="843" href="#843">843</a> <strong>return</strong> <strong>null</strong>;
<a name="844" href="#844">844</a> }
<a name="845" href="#845">845</a> }
<a name="846" href="#846">846</a>
<a name="847" href="#847">847</a> <em>/**</em>
<a name="848" href="#848">848</a> <em> * Returns an array of the response footers that the HTTP method currently has</em>
<a name="849" href="#849">849</a> <em> * in the order in which they were read.</em>
<a name="850" href="#850">850</a> <em> *</em>
<a name="851" href="#851">851</a> <em> * @return an array of footers</em>
<a name="852" href="#852">852</a> <em> */</em>
<a name="853" href="#853">853</a> <strong>public</strong> <a href="../../../../org/apache/commons/httpclient/Header.html">Header</a>[] getResponseFooters() {
<a name="854" href="#854">854</a> <strong>return</strong> getResponseTrailerHeaderGroup().getAllHeaders();
<a name="855" href="#855">855</a> }
<a name="856" href="#856">856</a>
<a name="857" href="#857">857</a> <em>/**</em>
<a name="858" href="#858">858</a> <em> * Gets the response footer associated with the given name.</em>
<a name="859" href="#859">859</a> <em> * Footer name matching is case insensitive.</em>
<a name="860" href="#860">860</a> <em> * <tt>null</tt> will be returned if either <i>footerName</i> is</em>
<a name="861" href="#861">861</a> <em> * <tt>null</tt> or there is no matching footer for <i>footerName</i></em>
<a name="862" href="#862">862</a> <em> * or there are no footers available. If there are multiple footers</em>
<a name="863" href="#863">863</a> <em> * with the same name, there values will be combined with the ',' separator</em>
<a name="864" href="#864">864</a> <em> * as specified by RFC2616.</em>
<a name="865" href="#865">865</a> <em> * </em>
<a name="866" href="#866">866</a> <em> * @param footerName the footer name to match</em>
<a name="867" href="#867">867</a> <em> * @return the matching footer</em>
<a name="868" href="#868">868</a> <em> */</em>
<a name="869" href="#869">869</a> <strong>public</strong> <a href="../../../../org/apache/commons/httpclient/Header.html">Header</a> getResponseFooter(String footerName) {
<a name="870" href="#870">870</a> <strong>if</strong> (footerName == <strong>null</strong>) {
<a name="871" href="#871">871</a> <strong>return</strong> <strong>null</strong>;
<a name="872" href="#872">872</a> } <strong>else</strong> {
<a name="873" href="#873">873</a> <strong>return</strong> getResponseTrailerHeaderGroup().getCondensedHeader(footerName);
<a name="874" href="#874">874</a> }
<a name="875" href="#875">875</a> }
<a name="876" href="#876">876</a>
<a name="877" href="#877">877</a> <em>/**</em>
<a name="878" href="#878">878</a> <em> * Sets the response stream.</em>
<a name="879" href="#879">879</a> <em> * @param responseStream The new response stream.</em>
<a name="880" href="#880">880</a> <em> */</em>
<a name="881" href="#881">881</a> <strong>protected</strong> <strong>void</strong> setResponseStream(InputStream responseStream) {
<a name="882" href="#882">882</a> <strong>this</strong>.responseStream = responseStream;
<a name="883" href="#883">883</a> }
<a name="884" href="#884">884</a>
<a name="885" href="#885">885</a> <em>/**</em>
<a name="886" href="#886">886</a> <em> * Returns a stream from which the body of the current response may be read.</em>
<a name="887" href="#887">887</a> <em> * If the method has not yet been executed, if <code>responseBodyConsumed</code></em>
<a name="888" href="#888">888</a> <em> * has been called, or if the stream returned by a previous call has been closed,</em>
<a name="889" href="#889">889</a> <em> * <code>null</code> will be returned.</em>
<a name="890" href="#890">890</a> <em> *</em>
<a name="891" href="#891">891</a> <em> * @return the current response stream</em>
<a name="892" href="#892">892</a> <em> */</em>
<a name="893" href="#893">893</a> <strong>protected</strong> InputStream getResponseStream() {
<a name="894" href="#894">894</a> <strong>return</strong> responseStream;
<a name="895" href="#895">895</a> }
<a name="896" href="#896">896</a>
<a name="897" href="#897">897</a> <em>/**</em>
<a name="898" href="#898">898</a> <em> * Returns the status text (or "reason phrase") associated with the latest</em>
<a name="899" href="#899">899</a> <em> * response.</em>
<a name="900" href="#900">900</a> <em> * </em>
<a name="901" href="#901">901</a> <em> * @return The status text.</em>
<a name="902" href="#902">902</a> <em> */</em>
<a name="903" href="#903">903</a> <strong>public</strong> String getStatusText() {
<a name="904" href="#904">904</a> <strong>return</strong> statusLine.getReasonPhrase();
<a name="905" href="#905">905</a> }
<a name="906" href="#906">906</a>
<a name="907" href="#907">907</a> <em>/**</em>
<a name="908" href="#908">908</a> <em> * Defines how strictly HttpClient follows the HTTP protocol specification </em>
<a name="909" href="#909">909</a> <em> * (RFC 2616 and other relevant RFCs). In the strict mode HttpClient precisely</em>
<a name="910" href="#910">910</a> <em> * implements the requirements of the specification, whereas in non-strict mode </em>
<a name="911" href="#911">911</a> <em> * it attempts to mimic the exact behaviour of commonly used HTTP agents, </em>
<a name="912" href="#912">912</a> <em> * which many HTTP servers expect.</em>
<a name="913" href="#913">913</a> <em> * </em>
<a name="914" href="#914">914</a> <em> * @param strictMode <tt>true</tt> for strict mode, <tt>false</tt> otherwise</em>
<a name="915" href="#915">915</a> <em> * </em>
<a name="916" href="#916">916</a> <em> * @deprecated Use {@link org.apache.commons.httpclient.params.HttpParams#setParameter(String, Object)}</em>
<a name="917" href="#917">917</a> <em> * to exercise a more granular control over HTTP protocol strictness.</em>
<a name="918" href="#918">918</a> <em> */</em>
<a name="919" href="#919">919</a> <strong>public</strong> <strong>void</strong> setStrictMode(<strong>boolean</strong> strictMode) {
<a name="920" href="#920">920</a> <strong>if</strong> (strictMode) {
<a name="921" href="#921">921</a> <strong>this</strong>.params.makeStrict();
<a name="922" href="#922">922</a> } <strong>else</strong> {
<a name="923" href="#923">923</a> <strong>this</strong>.params.makeLenient();
<a name="924" href="#924">924</a> }
<a name="925" href="#925">925</a> }
<a name="926" href="#926">926</a>
<a name="927" href="#927">927</a> <em>/**</em>
<a name="928" href="#928">928</a> <em> * @deprecated Use {@link org.apache.commons.httpclient.params.HttpParams#setParameter(String, Object)}</em>
<a name="929" href="#929">929</a> <em> * to exercise a more granular control over HTTP protocol strictness.</em>
<a name="930" href="#930">930</a> <em> *</em>
<a name="931" href="#931">931</a> <em> * @return <tt>false</tt></em>
<a name="932" href="#932">932</a> <em> */</em>
<a name="933" href="#933">933</a> <strong>public</strong> <strong>boolean</strong> isStrictMode() {
<a name="934" href="#934">934</a> <strong>return</strong> false;
<a name="935" href="#935">935</a> }
<a name="936" href="#936">936</a>
<a name="937" href="#937">937</a> <em>/**</em>
<a name="938" href="#938">938</a> <em> * Adds the specified request header, NOT overwriting any previous value.</em>
<a name="939" href="#939">939</a> <em> * Note that header-name matching is case insensitive.</em>
<a name="940" href="#940">940</a> <em> *</em>
<a name="941" href="#941">941</a> <em> * @param headerName the header's name</em>
<a name="942" href="#942">942</a> <em> * @param headerValue the header's value</em>
<a name="943" href="#943">943</a> <em> */</em>
<a name="944" href="#944">944</a> <strong>public</strong> <strong>void</strong> addRequestHeader(String headerName, String headerValue) {
<a name="945" href="#945">945</a> addRequestHeader(<strong>new</strong> <a href="../../../../org/apache/commons/httpclient/Header.html">Header</a>(headerName, headerValue));
<a name="946" href="#946">946</a> }
<a name="947" href="#947">947</a>
<a name="948" href="#948">948</a> <em>/**</em>
<a name="949" href="#949">949</a> <em> * Tests if the connection should be force-closed when no longer needed.</em>
<a name="950" href="#950">950</a> <em> * </em>
<a name="951" href="#951">951</a> <em> * @return <code>true</code> if the connection must be closed</em>
<a name="952" href="#952">952</a> <em> */</em>
<a name="953" href="#953">953</a> <strong>protected</strong> <strong>boolean</strong> isConnectionCloseForced() {
<a name="954" href="#954">954</a> <strong>return</strong> <strong>this</strong>.connectionCloseForced;
<a name="955" href="#955">955</a> }
<a name="956" href="#956">956</a>
<a name="957" href="#957">957</a> <em>/**</em>
<a name="958" href="#958">958</a> <em> * Sets whether or not the connection should be force-closed when no longer </em>
<a name="959" href="#959">959</a> <em> * needed. This value should only be set to <code>true</code> in abnormal </em>
<a name="960" href="#960">960</a> <em> * circumstances, such as HTTP protocol violations. </em>
<a name="961" href="#961">961</a> <em> * </em>
<a name="962" href="#962">962</a> <em> * @param b <code>true</code> if the connection must be closed, <code>false</code></em>
<a name="963" href="#963">963</a> <em> * otherwise.</em>
<a name="964" href="#964">964</a> <em> */</em>
<a name="965" href="#965">965</a> <strong>protected</strong> <strong>void</strong> setConnectionCloseForced(<strong>boolean</strong> b) {
<a name="966" href="#966">966</a> <strong>if</strong> (LOG.isDebugEnabled()) {
<a name="967" href="#967">967</a> LOG.debug(<span class="string">"Force-close connection: "</span> + b);
<a name="968" href="#968">968</a> }
<a name="969" href="#969">969</a> <strong>this</strong>.connectionCloseForced = b;
<a name="970" href="#970">970</a> }
<a name="971" href="#971">971</a>
<a name="972" href="#972">972</a> <em>/**</em>
<a name="973" href="#973">973</a> <em> * Tests if the connection should be closed after the method has been executed.</em>
<a name="974" href="#974">974</a> <em> * The connection will be left open when using HTTP/1.1 or if <tt>Connection: </em>
<a name="975" href="#975">975</a> <em> * keep-alive</tt> header was sent.</em>
<a name="976" href="#976">976</a> <em> * </em>
<a name="977" href="#977">977</a> <em> * @param conn the connection in question</em>
<a name="978" href="#978">978</a> <em> * </em>
<a name="979" href="#979">979</a> <em> * @return boolean true if we should close the connection.</em>
<a name="980" href="#980">980</a> <em> */</em>
<a name="981" href="#981">981</a> <strong>protected</strong> <strong>boolean</strong> shouldCloseConnection(<a href="../../../../org/apache/commons/httpclient/HttpConnection.html">HttpConnection</a> conn) {
<a name="982" href="#982">982</a> <em class="comment">// Connection must be closed due to an abnormal circumstance </em>
<a name="983" href="#983">983</a> <strong>if</strong> (isConnectionCloseForced()) {
<a name="984" href="#984">984</a> LOG.debug(<span class="string">"Should force-close connection."</span>);
<a name="985" href="#985">985</a> <strong>return</strong> <strong>true</strong>;
<a name="986" href="#986">986</a> }
<a name="987" href="#987">987</a>
<a name="988" href="#988">988</a> <a href="../../../../org/apache/commons/httpclient/Header.html">Header</a> connectionHeader = <strong>null</strong>;
<a name="989" href="#989">989</a> <em class="comment">// In case being connected via a proxy server</em>
<a name="990" href="#990">990</a> <strong>if</strong> (!conn.isTransparent()) {
<a name="991" href="#991">991</a> <em class="comment">// Check for 'proxy-connection' directive</em>
<a name="992" href="#992">992</a> connectionHeader = responseHeaders.getFirstHeader(<span class="string">"proxy-connection"</span>);
<a name="993" href="#993">993</a> }
<a name="994" href="#994">994</a> <em class="comment">// In all cases Check for 'connection' directive</em>
<a name="995" href="#995">995</a> <em class="comment">// some non-complaint proxy servers send it instread of</em>
<a name="996" href="#996">996</a> <em class="comment">// expected 'proxy-connection' directive</em>
<a name="997" href="#997">997</a> <strong>if</strong> (connectionHeader == <strong>null</strong>) {
<a name="998" href="#998">998</a> connectionHeader = responseHeaders.getFirstHeader(<span class="string">"connection"</span>);
<a name="999" href="#999">999</a> }
<a name="1000" href="#1000">1000</a> <em class="comment">// In case the response does not contain any explict connection</em>
<a name="1001" href="#1001">1001</a> <em class="comment">// directives, check whether the request does</em>
<a name="1002" href="#1002">1002</a> <strong>if</strong> (connectionHeader == <strong>null</strong>) {
<a name="1003" href="#1003">1003</a> connectionHeader = requestHeaders.getFirstHeader(<span class="string">"connection"</span>);
<a name="1004" href="#1004">1004</a> }
<a name="1005" href="#1005">1005</a> <strong>if</strong> (connectionHeader != <strong>null</strong>) {
<a name="1006" href="#1006">1006</a> <strong>if</strong> (connectionHeader.getValue().equalsIgnoreCase(<span class="string">"close"</span>)) {
<a name="1007" href="#1007">1007</a> <strong>if</strong> (LOG.isDebugEnabled()) {
<a name="1008" href="#1008">1008</a> LOG.debug(<span class="string">"Should close connection in response to directive: "</span>
<a name="1009" href="#1009">1009</a> + connectionHeader.getValue());
<a name="1010" href="#1010">1010</a> }
<a name="1011" href="#1011">1011</a> <strong>return</strong> <strong>true</strong>;
<a name="1012" href="#1012">1012</a> } <strong>else</strong> <strong>if</strong> (connectionHeader.getValue().equalsIgnoreCase(<span class="string">"keep-alive"</span>)) {
<a name="1013" href="#1013">1013</a> <strong>if</strong> (LOG.isDebugEnabled()) {
<a name="1014" href="#1014">1014</a> LOG.debug(<span class="string">"Should NOT close connection in response to directive: "</span>
<a name="1015" href="#1015">1015</a> + connectionHeader.getValue());
<a name="1016" href="#1016">1016</a> }
<a name="1017" href="#1017">1017</a> <strong>return</strong> false;
<a name="1018" href="#1018">1018</a> } <strong>else</strong> {
<a name="1019" href="#1019">1019</a> <strong>if</strong> (LOG.isDebugEnabled()) {
<a name="1020" href="#1020">1020</a> LOG.debug(<span class="string">"Unknown directive: "</span> + connectionHeader.toExternalForm());
<a name="1021" href="#1021">1021</a> }
<a name="1022" href="#1022">1022</a> }
<a name="1023" href="#1023">1023</a> }
<a name="1024" href="#1024">1024</a> LOG.debug(<span class="string">"Resorting to protocol version default close connection policy"</span>);
<a name="1025" href="#1025">1025</a> <em class="comment">// missing or invalid connection header, do the default</em>
<a name="1026" href="#1026">1026</a> <strong>if</strong> (<strong>this</strong>.effectiveVersion.greaterEquals(HttpVersion.HTTP_1_1)) {
<a name="1027" href="#1027">1027</a> <strong>if</strong> (LOG.isDebugEnabled()) {
<a name="1028" href="#1028">1028</a> LOG.debug(<span class="string">"Should NOT close connection, using "</span> + <strong>this</strong>.effectiveVersion.toString());
<a name="1029" href="#1029">1029</a> }
<a name="1030" href="#1030">1030</a> } <strong>else</strong> {
<a name="1031" href="#1031">1031</a> <strong>if</strong> (LOG.isDebugEnabled()) {
<a name="1032" href="#1032">1032</a> LOG.debug(<span class="string">"Should close connection, using "</span> + <strong>this</strong>.effectiveVersion.toString());
<a name="1033" href="#1033">1033</a> }
<a name="1034" href="#1034">1034</a> }
<a name="1035" href="#1035">1035</a> <strong>return</strong> <strong>this</strong>.effectiveVersion.lessEquals(HttpVersion.HTTP_1_0);
<a name="1036" href="#1036">1036</a> }
<a name="1037" href="#1037">1037</a>
<a name="1038" href="#1038">1038</a> <em>/**</em>
<a name="1039" href="#1039">1039</a> <em> * Tests if the this method is ready to be executed.</em>
<a name="1040" href="#1040">1040</a> <em> * </em>
<a name="1041" href="#1041">1041</a> <em> * @param state the {@link HttpState state} information associated with this method</em>
<a name="1042" href="#1042">1042</a> <em> * @param conn the {@link HttpConnection connection} to be used</em>
<a name="1043" href="#1043">1043</a> <em> * @throws HttpException If the method is in invalid state.</em>
<a name="1044" href="#1044">1044</a> <em> */</em>
<a name="1045" href="#1045">1045</a> <strong>private</strong> <strong>void</strong> checkExecuteConditions(<a href="../../../../org/apache/commons/httpclient/HttpState.html">HttpState</a> state, <a href="../../../../org/apache/commons/httpclient/HttpConnection.html">HttpConnection</a> conn)
<a name="1046" href="#1046">1046</a> throws <a href="../../../../org/apache/commons/httpclient/HttpException.html">HttpException</a> {
<a name="1047" href="#1047">1047</a>
<a name="1048" href="#1048">1048</a> <strong>if</strong> (state == <strong>null</strong>) {
<a name="1049" href="#1049">1049</a> <strong>throw</strong> <strong>new</strong> IllegalArgumentException(<span class="string">"HttpState parameter may not be null"</span>);
<a name="1050" href="#1050">1050</a> }
<a name="1051" href="#1051">1051</a> <strong>if</strong> (conn == <strong>null</strong>) {
<a name="1052" href="#1052">1052</a> <strong>throw</strong> <strong>new</strong> IllegalArgumentException(<span class="string">"HttpConnection parameter may not be null"</span>);
<a name="1053" href="#1053">1053</a> }
<a name="1054" href="#1054">1054</a> <strong>if</strong> (<strong>this</strong>.aborted) {
<a name="1055" href="#1055">1055</a> <strong>throw</strong> <strong>new</strong> IllegalStateException(<span class="string">"Method has been aborted"</span>);
<a name="1056" href="#1056">1056</a> }
<a name="1057" href="#1057">1057</a> <strong>if</strong> (!validate()) {
<a name="1058" href="#1058">1058</a> <strong>throw</strong> <strong>new</strong> <a href="../../../../org/apache/commons/httpclient/ProtocolException.html">ProtocolException</a>(<span class="string">"HttpMethodBase object not valid"</span>);
<a name="1059" href="#1059">1059</a> }
<a name="1060" href="#1060">1060</a> }
<a name="1061" href="#1061">1061</a>
<a name="1062" href="#1062">1062</a> <em>/**</em>
<a name="1063" href="#1063">1063</a> <em> * Executes this method using the specified <code>HttpConnection</code> and</em>
<a name="1064" href="#1064">1064</a> <em> * <code>HttpState</code>. </em>
<a name="1065" href="#1065">1065</a> <em> *</em>
<a name="1066" href="#1066">1066</a> <em> * @param state {@link HttpState state} information to associate with this</em>
<a name="1067" href="#1067">1067</a> <em> * request. Must be non-null.</em>
<a name="1068" href="#1068">1068</a> <em> * @param conn the {@link HttpConnection connection} to used to execute</em>
<a name="1069" href="#1069">1069</a> <em> * this HTTP method. Must be non-null.</em>
<a name="1070" href="#1070">1070</a> <em> *</em>
<a name="1071" href="#1071">1071</a> <em> * @return the integer status code if one was obtained, or <tt>-1</tt></em>
<a name="1072" href="#1072">1072</a> <em> *</em>
<a name="1073" href="#1073">1073</a> <em> * @throws IOException if an I/O (transport) error occurs</em>
<a name="1074" href="#1074">1074</a> <em> * @throws HttpException if a protocol exception occurs.</em>
<a name="1075" href="#1075">1075</a> <em> */</em>
<a name="1076" href="#1076">1076</a> <strong>public</strong> <strong>int</strong> execute(<a href="../../../../org/apache/commons/httpclient/HttpState.html">HttpState</a> state, <a href="../../../../org/apache/commons/httpclient/HttpConnection.html">HttpConnection</a> conn)
<a name="1077" href="#1077">1077</a> throws HttpException, IOException {
<a name="1078" href="#1078">1078</a>
<a name="1079" href="#1079">1079</a> LOG.trace(<span class="string">"enter HttpMethodBase.execute(HttpState, HttpConnection)"</span>);
<a name="1080" href="#1080">1080</a>
<a name="1081" href="#1081">1081</a> <em class="comment">// this is our connection now, assign it to a local variable so </em>
<a name="1082" href="#1082">1082</a> <em class="comment">// that it can be released later</em>
<a name="1083" href="#1083">1083</a> <strong>this</strong>.responseConnection = conn;
<a name="1084" href="#1084">1084</a>
<a name="1085" href="#1085">1085</a> checkExecuteConditions(state, conn);
<a name="1086" href="#1086">1086</a> <strong>this</strong>.statusLine = <strong>null</strong>;
<a name="1087" href="#1087">1087</a> <strong>this</strong>.connectionCloseForced = false;
<a name="1088" href="#1088">1088</a>
<a name="1089" href="#1089">1089</a> conn.setLastResponseInputStream(<strong>null</strong>);
<a name="1090" href="#1090">1090</a>
<a name="1091" href="#1091">1091</a> <em class="comment">// determine the effective protocol version</em>
<a name="1092" href="#1092">1092</a> <strong>if</strong> (<strong>this</strong>.effectiveVersion == <strong>null</strong>) {
<a name="1093" href="#1093">1093</a> <strong>this</strong>.effectiveVersion = <strong>this</strong>.params.getVersion();
<a name="1094" href="#1094">1094</a> }
<a name="1095" href="#1095">1095</a>
<a name="1096" href="#1096">1096</a> writeRequest(state, conn);
<a name="1097" href="#1097">1097</a> <strong>this</strong>.requestSent = <strong>true</strong>;
<a name="1098" href="#1098">1098</a> readResponse(state, conn);
<a name="1099" href="#1099">1099</a> <em class="comment">// the method has successfully executed</em>
<a name="1100" href="#1100">1100</a> used = <strong>true</strong>;
<a name="1101" href="#1101">1101</a>
<a name="1102" href="#1102">1102</a> <strong>return</strong> statusLine.getStatusCode();
<a name="1103" href="#1103">1103</a> }
<a name="1104" href="#1104">1104</a>
<a name="1105" href="#1105">1105</a> <em>/**</em>
<a name="1106" href="#1106">1106</a> <em> * Aborts the execution of this method.</em>
<a name="1107" href="#1107">1107</a> <em> * </em>
<a name="1108" href="#1108">1108</a> <em> * @since 3.0</em>
<a name="1109" href="#1109">1109</a> <em> */</em>
<a name="1110" href="#1110">1110</a> <strong>public</strong> <strong>void</strong> abort() {
<a name="1111" href="#1111">1111</a> <strong>if</strong> (<strong>this</strong>.aborted) {
<a name="1112" href="#1112">1112</a> <strong>return</strong>;
<a name="1113" href="#1113">1113</a> }
<a name="1114" href="#1114">1114</a> <strong>this</strong>.aborted = <strong>true</strong>;
<a name="1115" href="#1115">1115</a> <a href="../../../../org/apache/commons/httpclient/HttpConnection.html">HttpConnection</a> conn = <strong>this</strong>.responseConnection;
<a name="1116" href="#1116">1116</a> <strong>if</strong> (conn != <strong>null</strong>) {
<a name="1117" href="#1117">1117</a> conn.close();
<a name="1118" href="#1118">1118</a> }
<a name="1119" href="#1119">1119</a> }
<a name="1120" href="#1120">1120</a>
<a name="1121" href="#1121">1121</a> <em>/**</em>
<a name="1122" href="#1122">1122</a> <em> * Returns <tt>true</tt> if the HTTP method has been already {@link #execute executed},</em>
<a name="1123" href="#1123">1123</a> <em> * but not {@link #recycle recycled}.</em>
<a name="1124" href="#1124">1124</a> <em> * </em>
<a name="1125" href="#1125">1125</a> <em> * @return <tt>true</tt> if the method has been executed, <tt>false</tt> otherwise</em>
<a name="1126" href="#1126">1126</a> <em> */</em>
<a name="1127" href="#1127">1127</a> <strong>public</strong> <strong>boolean</strong> hasBeenUsed() {
<a name="1128" href="#1128">1128</a> <strong>return</strong> used;
<a name="1129" href="#1129">1129</a> }
<a name="1130" href="#1130">1130</a>
<a name="1131" href="#1131">1131</a> <em>/**</em>
<a name="1132" href="#1132">1132</a> <em> * Recycles the HTTP method so that it can be used again.</em>
<a name="1133" href="#1133">1133</a> <em> * Note that all of the instance variables will be reset</em>
<a name="1134" href="#1134">1134</a> <em> * once this method has been called. This method will also</em>
<a name="1135" href="#1135">1135</a> <em> * release the connection being used by this HTTP method.</em>
<a name="1136" href="#1136">1136</a> <em> * </em>
<a name="1137" href="#1137">1137</a> <em> * @see #releaseConnection()</em>
<a name="1138" href="#1138">1138</a> <em> * </em>
<a name="1139" href="#1139">1139</a> <em> * @deprecated no longer supported and will be removed in the future</em>
<a name="1140" href="#1140">1140</a> <em> * version of HttpClient</em>
<a name="1141" href="#1141">1141</a> <em> */</em>
<a name="1142" href="#1142">1142</a> <strong>public</strong> <strong>void</strong> recycle() {
<a name="1143" href="#1143">1143</a> LOG.trace(<span class="string">"enter HttpMethodBase.recycle()"</span>);
<a name="1144" href="#1144">1144</a>
<a name="1145" href="#1145">1145</a> releaseConnection();
<a name="1146" href="#1146">1146</a>
<a name="1147" href="#1147">1147</a> path = <strong>null</strong>;
<a name="1148" href="#1148">1148</a> followRedirects = false;
<a name="1149" href="#1149">1149</a> doAuthentication = <strong>true</strong>;
<a name="1150" href="#1150">1150</a> queryString = <strong>null</strong>;
<a name="1151" href="#1151">1151</a> getRequestHeaderGroup().clear();
<a name="1152" href="#1152">1152</a> getResponseHeaderGroup().clear();
<a name="1153" href="#1153">1153</a> getResponseTrailerHeaderGroup().clear();
<a name="1154" href="#1154">1154</a> statusLine = <strong>null</strong>;
<a name="1155" href="#1155">1155</a> effectiveVersion = <strong>null</strong>;
<a name="1156" href="#1156">1156</a> aborted = false;
<a name="1157" href="#1157">1157</a> used = false;
<a name="1158" href="#1158">1158</a> params = <strong>new</strong> <a href="../../../../org/apache/commons/httpclient/params/HttpMethodParams.html">HttpMethodParams</a>();
<a name="1159" href="#1159">1159</a> responseBody = <strong>null</strong>;
<a name="1160" href="#1160">1160</a> recoverableExceptionCount = 0;
<a name="1161" href="#1161">1161</a> connectionCloseForced = false;
<a name="1162" href="#1162">1162</a> hostAuthState.invalidate();
<a name="1163" href="#1163">1163</a> proxyAuthState.invalidate();
<a name="1164" href="#1164">1164</a> cookiespec = <strong>null</strong>;
<a name="1165" href="#1165">1165</a> requestSent = false;
<a name="1166" href="#1166">1166</a> }
<a name="1167" href="#1167">1167</a>
<a name="1168" href="#1168">1168</a> <em>/**</em>
<a name="1169" href="#1169">1169</a> <em> * Releases the connection being used by this HTTP method. In particular the</em>
<a name="1170" href="#1170">1170</a> <em> * connection is used to read the response(if there is one) and will be held</em>
<a name="1171" href="#1171">1171</a> <em> * until the response has been read. If the connection can be reused by other </em>
<a name="1172" href="#1172">1172</a> <em> * HTTP methods it is NOT closed at this point.</em>
<a name="1173" href="#1173">1173</a> <em> *</em>
<a name="1174" href="#1174">1174</a> <em> * @since 2.0</em>
<a name="1175" href="#1175">1175</a> <em> */</em>
<a name="1176" href="#1176">1176</a> <strong>public</strong> <strong>void</strong> releaseConnection() {
<a name="1177" href="#1177">1177</a> <strong>try</strong> {
<a name="1178" href="#1178">1178</a> <strong>if</strong> (<strong>this</strong>.responseStream != <strong>null</strong>) {
<a name="1179" href="#1179">1179</a> <strong>try</strong> {
<a name="1180" href="#1180">1180</a> <em class="comment">// FYI - this may indirectly invoke responseBodyConsumed.</em>
<a name="1181" href="#1181">1181</a> <strong>this</strong>.responseStream.close();
<a name="1182" href="#1182">1182</a> } <strong>catch</strong> (IOException ignore) {
<a name="1183" href="#1183">1183</a> }
<a name="1184" href="#1184">1184</a> }
<a name="1185" href="#1185">1185</a> } <strong>finally</strong> {
<a name="1186" href="#1186">1186</a> ensureConnectionRelease();
<a name="1187" href="#1187">1187</a> }
<a name="1188" href="#1188">1188</a> }
<a name="1189" href="#1189">1189</a>
<a name="1190" href="#1190">1190</a> <em>/**</em>
<a name="1191" href="#1191">1191</a> <em> * Remove the request header associated with the given name. Note that</em>
<a name="1192" href="#1192">1192</a> <em> * header-name matching is case insensitive.</em>
<a name="1193" href="#1193">1193</a> <em> *</em>
<a name="1194" href="#1194">1194</a> <em> * @param headerName the header name</em>
<a name="1195" href="#1195">1195</a> <em> */</em>
<a name="1196" href="#1196">1196</a> <strong>public</strong> <strong>void</strong> removeRequestHeader(String headerName) {
<a name="1197" href="#1197">1197</a>
<a name="1198" href="#1198">1198</a> <a href="../../../../org/apache/commons/httpclient/Header.html">Header</a>[] headers = getRequestHeaderGroup().getHeaders(headerName);
<a name="1199" href="#1199">1199</a> <strong>for</strong> (<strong>int</strong> i = 0; i < headers.length; i++) {
<a name="1200" href="#1200">1200</a> getRequestHeaderGroup().removeHeader(headers[i]);
<a name="1201" href="#1201">1201</a> }
<a name="1202" href="#1202">1202</a>
<a name="1203" href="#1203">1203</a> }
<a name="1204" href="#1204">1204</a>
<a name="1205" href="#1205">1205</a> <em>/**</em>
<a name="1206" href="#1206">1206</a> <em> * Removes the given request header.</em>
<a name="1207" href="#1207">1207</a> <em> * </em>
<a name="1208" href="#1208">1208</a> <em> * @param header the header</em>
<a name="1209" href="#1209">1209</a> <em> */</em>
<a name="1210" href="#1210">1210</a> <strong>public</strong> <strong>void</strong> removeRequestHeader(<strong>final</strong> <a href="../../../../org/apache/commons/httpclient/Header.html">Header</a> header) {
<a name="1211" href="#1211">1211</a> <strong>if</strong> (header == <strong>null</strong>) {
<a name="1212" href="#1212">1212</a> <strong>return</strong>;
<a name="1213" href="#1213">1213</a> }
<a name="1214" href="#1214">1214</a> getRequestHeaderGroup().removeHeader(header);
<a name="1215" href="#1215">1215</a> }
<a name="1216" href="#1216">1216</a>
<a name="1217" href="#1217">1217</a> <em class="comment">// ---------------------------------------------------------------- Queries</em>
<a name="1218" href="#1218">1218</a>
<a name="1219" href="#1219">1219</a> <em>/**</em>
<a name="1220" href="#1220">1220</a> <em> * Returns <tt>true</tt> the method is ready to execute, <tt>false</tt> otherwise.</em>
<a name="1221" href="#1221">1221</a> <em> * </em>
<a name="1222" href="#1222">1222</a> <em> * @return This implementation always returns <tt>true</tt>.</em>
<a name="1223" href="#1223">1223</a> <em> */</em>
<a name="1224" href="#1224">1224</a> <strong>public</strong> <strong>boolean</strong> validate() {
<a name="1225" href="#1225">1225</a> <strong>return</strong> <strong>true</strong>;
<a name="1226" href="#1226">1226</a> }
<a name="1227" href="#1227">1227</a>
<a name="1228" href="#1228">1228</a>
<a name="1229" href="#1229">1229</a> <em>/**</em><em> </em>
<a name="1230" href="#1230">1230</a> <em> * Returns the actual cookie policy</em>
<a name="1231" href="#1231">1231</a> <em> * </em>
<a name="1232" href="#1232">1232</a> <em> * @param state HTTP state. TODO: to be removed in the future</em>
<a name="1233" href="#1233">1233</a> <em> * </em>
<a name="1234" href="#1234">1234</a> <em> * @return cookie spec</em>
<a name="1235" href="#1235">1235</a> <em> */</em>
<a name="1236" href="#1236">1236</a> <strong>private</strong> <a href="../../../../org/apache/commons/httpclient/cookie/CookieSpec.html">CookieSpec</a> getCookieSpec(<strong>final</strong> <a href="../../../../org/apache/commons/httpclient/HttpState.html">HttpState</a> state) {
<a name="1237" href="#1237">1237</a> <strong>if</strong> (<strong>this</strong>.cookiespec == <strong>null</strong>) {
<a name="1238" href="#1238">1238</a> <strong>int</strong> i = state.getCookiePolicy();
<a name="1239" href="#1239">1239</a> <strong>if</strong> (i == -1) {
<a name="1240" href="#1240">1240</a> <strong>this</strong>.cookiespec = CookiePolicy.getCookieSpec(<strong>this</strong>.params.getCookiePolicy());
<a name="1241" href="#1241">1241</a> } <strong>else</strong> {
<a name="1242" href="#1242">1242</a> <strong>this</strong>.cookiespec = CookiePolicy.getSpecByPolicy(i);
<a name="1243" href="#1243">1243</a> }
<a name="1244" href="#1244">1244</a> <strong>this</strong>.cookiespec.setValidDateFormats(
<a name="1245" href="#1245">1245</a> (Collection)<strong>this</strong>.params.getParameter(HttpMethodParams.DATE_PATTERNS));
<a name="1246" href="#1246">1246</a> }
<a name="1247" href="#1247">1247</a> <strong>return</strong> <strong>this</strong>.cookiespec;
<a name="1248" href="#1248">1248</a> }
<a name="1249" href="#1249">1249</a>
<a name="1250" href="#1250">1250</a> <em>/**</em>
<a name="1251" href="#1251">1251</a> <em> * Generates <tt>Cookie</tt> request headers for those {@link Cookie cookie}s</em>
<a name="1252" href="#1252">1252</a> <em> * that match the given host, port and path.</em>
<a name="1253" href="#1253">1253</a> <em> *</em>
<a name="1254" href="#1254">1254</a> <em> * @param state the {@link HttpState state} information associated with this method</em>
<a name="1255" href="#1255">1255</a> <em> * @param conn the {@link HttpConnection connection} used to execute</em>
<a name="1256" href="#1256">1256</a> <em> * this HTTP method</em>
<a name="1257" href="#1257">1257</a> <em> *</em>
<a name="1258" href="#1258">1258</a> <em> * @throws IOException if an I/O (transport) error occurs. Some transport exceptions</em>
<a name="1259" href="#1259">1259</a> <em> * can be recovered from.</em>
<a name="1260" href="#1260">1260</a> <em> * @throws HttpException if a protocol exception occurs. Usually protocol exceptions </em>
<a name="1261" href="#1261">1261</a> <em> * cannot be recovered from.</em>
<a name="1262" href="#1262">1262</a> <em> */</em>
<a name="1263" href="#1263">1263</a> <strong>protected</strong> <strong>void</strong> addCookieRequestHeader(<a href="../../../../org/apache/commons/httpclient/HttpState.html">HttpState</a> state, <a href="../../../../org/apache/commons/httpclient/HttpConnection.html">HttpConnection</a> conn)
<a name="1264" href="#1264">1264</a> throws IOException, <a href="../../../../org/apache/commons/httpclient/HttpException.html">HttpException</a> {
<a name="1265" href="#1265">1265</a>
<a name="1266" href="#1266">1266</a> LOG.trace(<span class="string">"enter HttpMethodBase.addCookieRequestHeader(HttpState, "</span>
<a name="1267" href="#1267">1267</a> + <span class="string">"HttpConnection)"</span>);
<a name="1268" href="#1268">1268</a>
<a name="1269" href="#1269">1269</a> <a href="../../../../org/apache/commons/httpclient/Header.html">Header</a>[] cookieheaders = getRequestHeaderGroup().getHeaders(<span class="string">"Cookie"</span>);
<a name="1270" href="#1270">1270</a> <strong>for</strong> (<strong>int</strong> i = 0; i < cookieheaders.length; i++) {
<a name="1271" href="#1271">1271</a> <a href="../../../../org/apache/commons/httpclient/Header.html">Header</a> cookieheader = cookieheaders[i];
<a name="1272" href="#1272">1272</a> <strong>if</strong> (cookieheader.isAutogenerated()) {
<a name="1273" href="#1273">1273</a> getRequestHeaderGroup().removeHeader(cookieheader);
<a name="1274" href="#1274">1274</a> }
<a name="1275" href="#1275">1275</a> }
<a name="1276" href="#1276">1276</a>
<a name="1277" href="#1277">1277</a> <a href="../../../../org/apache/commons/httpclient/cookie/CookieSpec.html">CookieSpec</a> matcher = getCookieSpec(state);
<a name="1278" href="#1278">1278</a> String host = <strong>this</strong>.params.getVirtualHost();
<a name="1279" href="#1279">1279</a> <strong>if</strong> (host == <strong>null</strong>) {
<a name="1280" href="#1280">1280</a> host = conn.getHost();
<a name="1281" href="#1281">1281</a> }
<a name="1282" href="#1282">1282</a> <a href="../../../../org/apache/commons/httpclient/Cookie.html">Cookie</a>[] cookies = matcher.match(host, conn.getPort(),
<a name="1283" href="#1283">1283</a> getPath(), conn.isSecure(), state.getCookies());
<a name="1284" href="#1284">1284</a> <strong>if</strong> ((cookies != <strong>null</strong>) && (cookies.length > 0)) {
<a name="1285" href="#1285">1285</a> <strong>if</strong> (getParams().isParameterTrue(HttpMethodParams.SINGLE_COOKIE_HEADER)) {
<a name="1286" href="#1286">1286</a> <em class="comment">// In strict mode put all cookies on the same header</em>
<a name="1287" href="#1287">1287</a> String s = matcher.formatCookies(cookies);
<a name="1288" href="#1288">1288</a> getRequestHeaderGroup().addHeader(<strong>new</strong> Header(<span class="string">"Cookie"</span>, s, <strong>true</strong>));
<a name="1289" href="#1289">1289</a> } <strong>else</strong> {
<a name="1290" href="#1290">1290</a> <em class="comment">// In non-strict mode put each cookie on a separate header</em>
<a name="1291" href="#1291">1291</a> <strong>for</strong> (<strong>int</strong> i = 0; i < cookies.length; i++) {
<a name="1292" href="#1292">1292</a> String s = matcher.formatCookie(cookies[i]);
<a name="1293" href="#1293">1293</a> getRequestHeaderGroup().addHeader(<strong>new</strong> Header(<span class="string">"Cookie"</span>, s, <strong>true</strong>));
<a name="1294" href="#1294">1294</a> }
<a name="1295" href="#1295">1295</a> }
<a name="1296" href="#1296">1296</a> <strong>if</strong> (matcher instanceof CookieVersionSupport) {
<a name="1297" href="#1297">1297</a> <a href="../../../../org/apache/commons/httpclient/cookie/CookieVersionSupport.html">CookieVersionSupport</a> versupport = (CookieVersionSupport) matcher;
<a name="1298" href="#1298">1298</a> <strong>int</strong> ver = versupport.getVersion();
<a name="1299" href="#1299">1299</a> <strong>boolean</strong> needVersionHeader = false;
<a name="1300" href="#1300">1300</a> <strong>for</strong> (<strong>int</strong> i = 0; i < cookies.length; i++) {
<a name="1301" href="#1301">1301</a> <strong>if</strong> (ver != cookies[i].getVersion()) {
<a name="1302" href="#1302">1302</a> needVersionHeader = <strong>true</strong>;
<a name="1303" href="#1303">1303</a> }
<a name="1304" href="#1304">1304</a> }
<a name="1305" href="#1305">1305</a> <strong>if</strong> (needVersionHeader) {
<a name="1306" href="#1306">1306</a> <em class="comment">// Advertise cookie version support</em>
<a name="1307" href="#1307">1307</a> getRequestHeaderGroup().addHeader(versupport.getVersionHeader());
<a name="1308" href="#1308">1308</a> }
<a name="1309" href="#1309">1309</a> }
<a name="1310" href="#1310">1310</a> }
<a name="1311" href="#1311">1311</a> }
<a name="1312" href="#1312">1312</a>
<a name="1313" href="#1313">1313</a> <em>/**</em>
<a name="1314" href="#1314">1314</a> <em> * Generates <tt>Host</tt> request header, as long as no <tt>Host</tt> request</em>
<a name="1315" href="#1315">1315</a> <em> * header already exists.</em>
<a name="1316" href="#1316">1316</a> <em> *</em>
<a name="1317" href="#1317">1317</a> <em> * @param state the {@link HttpState state} information associated with this method</em>
<a name="1318" href="#1318">1318</a> <em> * @param conn the {@link HttpConnection connection} used to execute</em>
<a name="1319" href="#1319">1319</a> <em> * this HTTP method</em>
<a name="1320" href="#1320">1320</a> <em> *</em>
<a name="1321" href="#1321">1321</a> <em> * @throws IOException if an I/O (transport) error occurs. Some transport exceptions</em>
<a name="1322" href="#1322">1322</a> <em> * can be recovered from.</em>
<a name="1323" href="#1323">1323</a> <em> * @throws HttpException if a protocol exception occurs. Usually protocol exceptions </em>
<a name="1324" href="#1324">1324</a> <em> * cannot be recovered from.</em>
<a name="1325" href="#1325">1325</a> <em> */</em>
<a name="1326" href="#1326">1326</a> <strong>protected</strong> <strong>void</strong> addHostRequestHeader(<a href="../../../../org/apache/commons/httpclient/HttpState.html">HttpState</a> state, <a href="../../../../org/apache/commons/httpclient/HttpConnection.html">HttpConnection</a> conn)
<a name="1327" href="#1327">1327</a> throws IOException, <a href="../../../../org/apache/commons/httpclient/HttpException.html">HttpException</a> {
<a name="1328" href="#1328">1328</a> LOG.trace(<span class="string">"enter HttpMethodBase.addHostRequestHeader(HttpState, "</span>
<a name="1329" href="#1329">1329</a> + <span class="string">"HttpConnection)"</span>);
<a name="1330" href="#1330">1330</a>
<a name="1331" href="#1331">1331</a> <em class="comment">// Per 19.6.1.1 of RFC 2616, it is legal for HTTP/1.0 based</em>
<a name="1332" href="#1332">1332</a> <em class="comment">// applications to send the Host request-header.</em>
<a name="1333" href="#1333">1333</a> <em class="comment">// TODO: Add the ability to disable the sending of this header for</em>
<a name="1334" href="#1334">1334</a> <em class="comment">// HTTP/1.0 requests.</em>
<a name="1335" href="#1335">1335</a> String host = <strong>this</strong>.params.getVirtualHost();
<a name="1336" href="#1336">1336</a> <strong>if</strong> (host != <strong>null</strong>) {
<a name="1337" href="#1337">1337</a> LOG.debug(<span class="string">"Using virtual host name: "</span> + host);
<a name="1338" href="#1338">1338</a> } <strong>else</strong> {
<a name="1339" href="#1339">1339</a> host = conn.getHost();
<a name="1340" href="#1340">1340</a> }
<a name="1341" href="#1341">1341</a> <strong>int</strong> port = conn.getPort();
<a name="1342" href="#1342">1342</a>
<a name="1343" href="#1343">1343</a> <em class="comment">// Note: RFC 2616 uses the term "internet host name" for what goes on the</em>
<a name="1344" href="#1344">1344</a> <em class="comment">// host line. It would seem to imply that host should be blank if the</em>
<a name="1345" href="#1345">1345</a> <em class="comment">// host is a number instead of an name. Based on the behavior of web</em>
<a name="1346" href="#1346">1346</a> <em class="comment">// browsers, and the fact that RFC 2616 never defines the phrase "internet</em>
<a name="1347" href="#1347">1347</a> <em class="comment">// host name", and the bad behavior of HttpClient that follows if we</em>
<a name="1348" href="#1348">1348</a> <em class="comment">// send blank, I interpret this as a small misstatement in the RFC, where</em>
<a name="1349" href="#1349">1349</a> <em class="comment">// they meant to say "internet host". So IP numbers get sent as host</em>
<a name="1350" href="#1350">1350</a> <em class="comment">// entries too. -- Eric Johnson 12/13/2002</em>
<a name="1351" href="#1351">1351</a> <strong>if</strong> (LOG.isDebugEnabled()) {
<a name="1352" href="#1352">1352</a> LOG.debug(<span class="string">"Adding Host request header"</span>);
<a name="1353" href="#1353">1353</a> }
<a name="1354" href="#1354">1354</a>
<a name="1355" href="#1355">1355</a> <em class="comment">//appends the port only if not using the default port for the protocol</em>
<a name="1356" href="#1356">1356</a> <strong>if</strong> (conn.getProtocol().getDefaultPort() != port) {
<a name="1357" href="#1357">1357</a> host += (<span class="string">":"</span> + port);
<a name="1358" href="#1358">1358</a> }
<a name="1359" href="#1359">1359</a>
<a name="1360" href="#1360">1360</a> setRequestHeader(<span class="string">"Host"</span>, host);
<a name="1361" href="#1361">1361</a> }
<a name="1362" href="#1362">1362</a>
<a name="1363" href="#1363">1363</a> <em>/**</em>
<a name="1364" href="#1364">1364</a> <em> * Generates <tt>Proxy-Connection: Keep-Alive</tt> request header when </em>
<a name="1365" href="#1365">1365</a> <em> * communicating via a proxy server.</em>
<a name="1366" href="#1366">1366</a> <em> *</em>
<a name="1367" href="#1367">1367</a> <em> * @param state the {@link HttpState state} information associated with this method</em>
<a name="1368" href="#1368">1368</a> <em> * @param conn the {@link HttpConnection connection} used to execute</em>
<a name="1369" href="#1369">1369</a> <em> * this HTTP method</em>
<a name="1370" href="#1370">1370</a> <em> *</em>
<a name="1371" href="#1371">1371</a> <em> * @throws IOException if an I/O (transport) error occurs. Some transport exceptions</em>
<a name="1372" href="#1372">1372</a> <em> * can be recovered from.</em>
<a name="1373" href="#1373">1373</a> <em> * @throws HttpException if a protocol exception occurs. Usually protocol exceptions </em>
<a name="1374" href="#1374">1374</a> <em> * cannot be recovered from.</em>
<a name="1375" href="#1375">1375</a> <em> */</em>
<a name="1376" href="#1376">1376</a> <strong>protected</strong> <strong>void</strong> addProxyConnectionHeader(<a href="../../../../org/apache/commons/httpclient/HttpState.html">HttpState</a> state,
<a name="1377" href="#1377">1377</a> <a href="../../../../org/apache/commons/httpclient/HttpConnection.html">HttpConnection</a> conn)
<a name="1378" href="#1378">1378</a> throws IOException, <a href="../../../../org/apache/commons/httpclient/HttpException.html">HttpException</a> {
<a name="1379" href="#1379">1379</a> LOG.trace(<span class="string">"enter HttpMethodBase.addProxyConnectionHeader("</span>
<a name="1380" href="#1380">1380</a> + <span class="string">"HttpState, HttpConnection)"</span>);
<a name="1381" href="#1381">1381</a> <strong>if</strong> (!conn.isTransparent()) {
<a name="1382" href="#1382">1382</a> <strong>if</strong> (getRequestHeader(<span class="string">"Proxy-Connection"</span>) == <strong>null</strong>) {
<a name="1383" href="#1383">1383</a> addRequestHeader(<span class="string">"Proxy-Connection"</span>, <span class="string">"Keep-Alive"</span>);
<a name="1384" href="#1384">1384</a> }
<a name="1385" href="#1385">1385</a> }
<a name="1386" href="#1386">1386</a> }
<a name="1387" href="#1387">1387</a>
<a name="1388" href="#1388">1388</a> <em>/**</em>
<a name="1389" href="#1389">1389</a> <em> * Generates all the required request {@link Header header}s </em>
<a name="1390" href="#1390">1390</a> <em> * to be submitted via the given {@link HttpConnection connection}.</em>
<a name="1391" href="#1391">1391</a> <em> *</em>
<a name="1392" href="#1392">1392</a> <em> * <p></em>
<a name="1393" href="#1393">1393</a> <em> * This implementation adds <tt>User-Agent</tt>, <tt>Host</tt>,</em>
<a name="1394" href="#1394">1394</a> <em> * <tt>Cookie</tt>, <tt>Authorization</tt>, <tt>Proxy-Authorization</tt></em>
<a name="1395" href="#1395">1395</a> <em> * and <tt>Proxy-Connection</tt> headers, when appropriate.</em>
<a name="1396" href="#1396">1396</a> <em> * </p></em>
<a name="1397" href="#1397">1397</a> <em> *</em>
<a name="1398" href="#1398">1398</a> <em> * <p></em>
<a name="1399" href="#1399">1399</a> <em> * Subclasses may want to override this method to to add additional</em>
<a name="1400" href="#1400">1400</a> <em> * headers, and may choose to invoke this implementation (via</em>
<a name="1401" href="#1401">1401</a> <em> * <tt>super</tt>) to add the "standard" headers.</em>
<a name="1402" href="#1402">1402</a> <em> * </p></em>
<a name="1403" href="#1403">1403</a> <em> *</em>
<a name="1404" href="#1404">1404</a> <em> * @param state the {@link HttpState state} information associated with this method</em>
<a name="1405" href="#1405">1405</a> <em> * @param conn the {@link HttpConnection connection} used to execute</em>
<a name="1406" href="#1406">1406</a> <em> * this HTTP method</em>
<a name="1407" href="#1407">1407</a> <em> *</em>
<a name="1408" href="#1408">1408</a> <em> * @throws IOException if an I/O (transport) error occurs. Some transport exceptions</em>
<a name="1409" href="#1409">1409</a> <em> * can be recovered from.</em>
<a name="1410" href="#1410">1410</a> <em> * @throws HttpException if a protocol exception occurs. Usually protocol exceptions </em>
<a name="1411" href="#1411">1411</a> <em> * cannot be recovered from.</em>
<a name="1412" href="#1412">1412</a> <em> *</em>
<a name="1413" href="#1413">1413</a> <em> * @see #writeRequestHeaders</em>
<a name="1414" href="#1414">1414</a> <em> */</em>
<a name="1415" href="#1415">1415</a> <strong>protected</strong> <strong>void</strong> addRequestHeaders(<a href="../../../../org/apache/commons/httpclient/HttpState.html">HttpState</a> state, <a href="../../../../org/apache/commons/httpclient/HttpConnection.html">HttpConnection</a> conn)
<a name="1416" href="#1416">1416</a> throws IOException, <a href="../../../../org/apache/commons/httpclient/HttpException.html">HttpException</a> {
<a name="1417" href="#1417">1417</a> LOG.trace(<span class="string">"enter HttpMethodBase.addRequestHeaders(HttpState, "</span>
<a name="1418" href="#1418">1418</a> + <span class="string">"HttpConnection)"</span>);
<a name="1419" href="#1419">1419</a>
<a name="1420" href="#1420">1420</a> addUserAgentRequestHeader(state, conn);
<a name="1421" href="#1421">1421</a> addHostRequestHeader(state, conn);
<a name="1422" href="#1422">1422</a> addCookieRequestHeader(state, conn);
<a name="1423" href="#1423">1423</a> addProxyConnectionHeader(state, conn);
<a name="1424" href="#1424">1424</a> }
<a name="1425" href="#1425">1425</a>
<a name="1426" href="#1426">1426</a> <em>/**</em>
<a name="1427" href="#1427">1427</a> <em> * Generates default <tt>User-Agent</tt> request header, as long as no</em>
<a name="1428" href="#1428">1428</a> <em> * <tt>User-Agent</tt> request header already exists.</em>
<a name="1429" href="#1429">1429</a> <em> *</em>
<a name="1430" href="#1430">1430</a> <em> * @param state the {@link HttpState state} information associated with this method</em>
<a name="1431" href="#1431">1431</a> <em> * @param conn the {@link HttpConnection connection} used to execute</em>
<a name="1432" href="#1432">1432</a> <em> * this HTTP method</em>
<a name="1433" href="#1433">1433</a> <em> *</em>
<a name="1434" href="#1434">1434</a> <em> * @throws IOException if an I/O (transport) error occurs. Some transport exceptions</em>
<a name="1435" href="#1435">1435</a> <em> * can be recovered from.</em>
<a name="1436" href="#1436">1436</a> <em> * @throws HttpException if a protocol exception occurs. Usually protocol exceptions </em>
<a name="1437" href="#1437">1437</a> <em> * cannot be recovered from.</em>
<a name="1438" href="#1438">1438</a> <em> */</em>
<a name="1439" href="#1439">1439</a> <strong>protected</strong> <strong>void</strong> addUserAgentRequestHeader(<a href="../../../../org/apache/commons/httpclient/HttpState.html">HttpState</a> state,
<a name="1440" href="#1440">1440</a> <a href="../../../../org/apache/commons/httpclient/HttpConnection.html">HttpConnection</a> conn)
<a name="1441" href="#1441">1441</a> throws IOException, <a href="../../../../org/apache/commons/httpclient/HttpException.html">HttpException</a> {
<a name="1442" href="#1442">1442</a> LOG.trace(<span class="string">"enter HttpMethodBase.addUserAgentRequestHeaders(HttpState, "</span>
<a name="1443" href="#1443">1443</a> + <span class="string">"HttpConnection)"</span>);
<a name="1444" href="#1444">1444</a>
<a name="1445" href="#1445">1445</a> <strong>if</strong> (getRequestHeader(<span class="string">"User-Agent"</span>) == <strong>null</strong>) {
<a name="1446" href="#1446">1446</a> String agent = (String)getParams().getParameter(HttpMethodParams.USER_AGENT);
<a name="1447" href="#1447">1447</a> <strong>if</strong> (agent == <strong>null</strong>) {
<a name="1448" href="#1448">1448</a> agent = <span class="string">"Jakarta Commons-HttpClient"</span>;
<a name="1449" href="#1449">1449</a> }
<a name="1450" href="#1450">1450</a> setRequestHeader(<span class="string">"User-Agent"</span>, agent);
<a name="1451" href="#1451">1451</a> }
<a name="1452" href="#1452">1452</a> }
<a name="1453" href="#1453">1453</a>
<a name="1454" href="#1454">1454</a> <em>/**</em>
<a name="1455" href="#1455">1455</a> <em> * Throws an {@link IllegalStateException} if the HTTP method has been already</em>
<a name="1456" href="#1456">1456</a> <em> * {@link #execute executed}, but not {@link #recycle recycled}.</em>
<a name="1457" href="#1457">1457</a> <em> *</em>
<a name="1458" href="#1458">1458</a> <em> * @throws IllegalStateException if the method has been used and not</em>
<a name="1459" href="#1459">1459</a> <em> * recycled</em>
<a name="1460" href="#1460">1460</a> <em> */</em>
<a name="1461" href="#1461">1461</a> <strong>protected</strong> <strong>void</strong> checkNotUsed() throws IllegalStateException {
<a name="1462" href="#1462">1462</a> <strong>if</strong> (used) {
<a name="1463" href="#1463">1463</a> <strong>throw</strong> <strong>new</strong> IllegalStateException(<span class="string">"Already used."</span>);
<a name="1464" href="#1464">1464</a> }
<a name="1465" href="#1465">1465</a> }
<a name="1466" href="#1466">1466</a>
<a name="1467" href="#1467">1467</a> <em>/**</em>
<a name="1468" href="#1468">1468</a> <em> * Throws an {@link IllegalStateException} if the HTTP method has not been</em>
<a name="1469" href="#1469">1469</a> <em> * {@link #execute executed} since last {@link #recycle recycle}.</em>
<a name="1470" href="#1470">1470</a> <em> *</em>
<a name="1471" href="#1471">1471</a> <em> *</em>
<a name="1472" href="#1472">1472</a> <em> * @throws IllegalStateException if not used</em>
<a name="1473" href="#1473">1473</a> <em> */</em>
<a name="1474" href="#1474">1474</a> <strong>protected</strong> <strong>void</strong> checkUsed() throws IllegalStateException {
<a name="1475" href="#1475">1475</a> <strong>if</strong> (!used) {
<a name="1476" href="#1476">1476</a> <strong>throw</strong> <strong>new</strong> IllegalStateException(<span class="string">"Not Used."</span>);
<a name="1477" href="#1477">1477</a> }
<a name="1478" href="#1478">1478</a> }
<a name="1479" href="#1479">1479</a>
<a name="1480" href="#1480">1480</a> <em class="comment">// ------------------------------------------------- Static Utility Methods</em>
<a name="1481" href="#1481">1481</a>
<a name="1482" href="#1482">1482</a> <em>/**</em>
<a name="1483" href="#1483">1483</a> <em> * Generates HTTP request line according to the specified attributes.</em>
<a name="1484" href="#1484">1484</a> <em> *</em>
<a name="1485" href="#1485">1485</a> <em> * @param connection the {@link HttpConnection connection} used to execute</em>
<a name="1486" href="#1486">1486</a> <em> * this HTTP method</em>
<a name="1487" href="#1487">1487</a> <em> * @param name the method name generate a request for</em>
<a name="1488" href="#1488">1488</a> <em> * @param requestPath the path string for the request</em>
<a name="1489" href="#1489">1489</a> <em> * @param query the query string for the request</em>
<a name="1490" href="#1490">1490</a> <em> * @param version the protocol version to use (e.g. HTTP/1.0)</em>
<a name="1491" href="#1491">1491</a> <em> *</em>
<a name="1492" href="#1492">1492</a> <em> * @return HTTP request line</em>
<a name="1493" href="#1493">1493</a> <em> */</em>
<a name="1494" href="#1494">1494</a> <strong>protected</strong> <strong>static</strong> String generateRequestLine(<a href="../../../../org/apache/commons/httpclient/HttpConnection.html">HttpConnection</a> connection,
<a name="1495" href="#1495">1495</a> String name, String requestPath, String query, String version) {
<a name="1496" href="#1496">1496</a> LOG.trace(<span class="string">"enter HttpMethodBase.generateRequestLine(HttpConnection, "</span>
<a name="1497" href="#1497">1497</a> + <span class="string">"String, String, String, String)"</span>);
<a name="1498" href="#1498">1498</a>
<a name="1499" href="#1499">1499</a> StringBuffer buf = <strong>new</strong> StringBuffer();
<a name="1500" href="#1500">1500</a> <em class="comment">// Append method name</em>
<a name="1501" href="#1501">1501</a> buf.append(name);
<a name="1502" href="#1502">1502</a> buf.append(<span class="string">" "</span>);
<a name="1503" href="#1503">1503</a> <em class="comment">// Absolute or relative URL?</em>
<a name="1504" href="#1504">1504</a> <strong>if</strong> (!connection.isTransparent()) {
<a name="1505" href="#1505">1505</a> <a href="../../../../org/apache/commons/httpclient/protocol/Protocol.html">Protocol</a> protocol = connection.getProtocol();
<a name="1506" href="#1506">1506</a> buf.append(protocol.getScheme().toLowerCase());
<a name="1507" href="#1507">1507</a> buf.append(<span class="string">"://"</span>);
<a name="1508" href="#1508">1508</a> buf.append(connection.getHost());
<a name="1509" href="#1509">1509</a> <strong>if</strong> ((connection.getPort() != -1)
<a name="1510" href="#1510">1510</a> && (connection.getPort() != protocol.getDefaultPort())
<a name="1511" href="#1511">1511</a> ) {
<a name="1512" href="#1512">1512</a> buf.append(<span class="string">":"</span>);
<a name="1513" href="#1513">1513</a> buf.append(connection.getPort());
<a name="1514" href="#1514">1514</a> }
<a name="1515" href="#1515">1515</a> }
<a name="1516" href="#1516">1516</a> <em class="comment">// Append path, if any</em>
<a name="1517" href="#1517">1517</a> <strong>if</strong> (requestPath == <strong>null</strong>) {
<a name="1518" href="#1518">1518</a> buf.append(<span class="string">"/"</span>);
<a name="1519" href="#1519">1519</a> } <strong>else</strong> {
<a name="1520" href="#1520">1520</a> <strong>if</strong> (!connection.isTransparent() && !requestPath.startsWith(<span class="string">"/"</span>)) {
<a name="1521" href="#1521">1521</a> buf.append(<span class="string">"/"</span>);
<a name="1522" href="#1522">1522</a> }
<a name="1523" href="#1523">1523</a> buf.append(requestPath);
<a name="1524" href="#1524">1524</a> }
<a name="1525" href="#1525">1525</a> <em class="comment">// Append query, if any</em>
<a name="1526" href="#1526">1526</a> <strong>if</strong> (query != <strong>null</strong>) {
<a name="1527" href="#1527">1527</a> <strong>if</strong> (query.indexOf(<span class="string">"?"</span>) != 0) {
<a name="1528" href="#1528">1528</a> buf.append(<span class="string">"?"</span>);
<a name="1529" href="#1529">1529</a> }
<a name="1530" href="#1530">1530</a> buf.append(query);
<a name="1531" href="#1531">1531</a> }
<a name="1532" href="#1532">1532</a> <em class="comment">// Append protocol</em>
<a name="1533" href="#1533">1533</a> buf.append(<span class="string">" "</span>);
<a name="1534" href="#1534">1534</a> buf.append(version);
<a name="1535" href="#1535">1535</a> buf.append(<span class="string">"\r\n"</span>);
<a name="1536" href="#1536">1536</a>
<a name="1537" href="#1537">1537</a> <strong>return</strong> buf.toString();
<a name="1538" href="#1538">1538</a> }
<a name="1539" href="#1539">1539</a>
<a name="1540" href="#1540">1540</a> <em>/**</em>
<a name="1541" href="#1541">1541</a> <em> * This method is invoked immediately after </em>
<a name="1542" href="#1542">1542</a> <em> * {@link #readResponseBody(HttpState,HttpConnection)} and can be overridden by</em>
<a name="1543" href="#1543">1543</a> <em> * sub-classes in order to provide custom body processing.</em>
<a name="1544" href="#1544">1544</a> <em> *</em>
<a name="1545" href="#1545">1545</a> <em> * <p></em>
<a name="1546" href="#1546">1546</a> <em> * This implementation does nothing.</em>
<a name="1547" href="#1547">1547</a> <em> * </p></em>
<a name="1548" href="#1548">1548</a> <em> *</em>
<a name="1549" href="#1549">1549</a> <em> * @param state the {@link HttpState state} information associated with this method</em>
<a name="1550" href="#1550">1550</a> <em> * @param conn the {@link HttpConnection connection} used to execute</em>
<a name="1551" href="#1551">1551</a> <em> * this HTTP method</em>
<a name="1552" href="#1552">1552</a> <em> *</em>
<a name="1553" href="#1553">1553</a> <em> * @see #readResponse</em>
<a name="1554" href="#1554">1554</a> <em> * @see #readResponseBody</em>
<a name="1555" href="#1555">1555</a> <em> */</em>
<a name="1556" href="#1556">1556</a> <strong>protected</strong> <strong>void</strong> processResponseBody(<a href="../../../../org/apache/commons/httpclient/HttpState.html">HttpState</a> state, <a href="../../../../org/apache/commons/httpclient/HttpConnection.html">HttpConnection</a> conn) {
<a name="1557" href="#1557">1557</a> }
<a name="1558" href="#1558">1558</a>
<a name="1559" href="#1559">1559</a> <em>/**</em>
<a name="1560" href="#1560">1560</a> <em> * This method is invoked immediately after </em>
<a name="1561" href="#1561">1561</a> <em> * {@link #readResponseHeaders(HttpState,HttpConnection)} and can be overridden by</em>
<a name="1562" href="#1562">1562</a> <em> * sub-classes in order to provide custom response headers processing.</em>
<a name="1563" href="#1563">1563</a>
<a name="1564" href="#1564">1564</a> <em> * <p></em>
<a name="1565" href="#1565">1565</a> <em> * This implementation will handle the <tt>Set-Cookie</tt> and</em>
<a name="1566" href="#1566">1566</a> <em> * <tt>Set-Cookie2</tt> headers, if any, adding the relevant cookies to</em>
<a name="1567" href="#1567">1567</a> <em> * the given {@link HttpState}.</em>
<a name="1568" href="#1568">1568</a> <em> * </p></em>
<a name="1569" href="#1569">1569</a> <em> *</em>
<a name="1570" href="#1570">1570</a> <em> * @param state the {@link HttpState state} information associated with this method</em>
<a name="1571" href="#1571">1571</a> <em> * @param conn the {@link HttpConnection connection} used to execute</em>
<a name="1572" href="#1572">1572</a> <em> * this HTTP method</em>
<a name="1573" href="#1573">1573</a> <em> *</em>
<a name="1574" href="#1574">1574</a> <em> * @see #readResponse</em>
<a name="1575" href="#1575">1575</a> <em> * @see #readResponseHeaders</em>
<a name="1576" href="#1576">1576</a> <em> */</em>
<a name="1577" href="#1577">1577</a> <strong>protected</strong> <strong>void</strong> processResponseHeaders(<a href="../../../../org/apache/commons/httpclient/HttpState.html">HttpState</a> state,
<a name="1578" href="#1578">1578</a> <a href="../../../../org/apache/commons/httpclient/HttpConnection.html">HttpConnection</a> conn) {
<a name="1579" href="#1579">1579</a> LOG.trace(<span class="string">"enter HttpMethodBase.processResponseHeaders(HttpState, "</span>
<a name="1580" href="#1580">1580</a> + <span class="string">"HttpConnection)"</span>);
<a name="1581" href="#1581">1581</a>
<a name="1582" href="#1582">1582</a> <a href="../../../../org/apache/commons/httpclient/cookie/CookieSpec.html">CookieSpec</a> parser = getCookieSpec(state);
<a name="1583" href="#1583">1583</a>
<a name="1584" href="#1584">1584</a> <em class="comment">// process set-cookie headers</em>
<a name="1585" href="#1585">1585</a> <a href="../../../../org/apache/commons/httpclient/Header.html">Header</a>[] headers = getResponseHeaderGroup().getHeaders(<span class="string">"set-cookie"</span>);
<a name="1586" href="#1586">1586</a> processCookieHeaders(parser, headers, state, conn);
<a name="1587" href="#1587">1587</a>
<a name="1588" href="#1588">1588</a> <em class="comment">// see if the cookie spec supports cookie versioning.</em>
<a name="1589" href="#1589">1589</a> <strong>if</strong> (parser instanceof CookieVersionSupport) {
<a name="1590" href="#1590">1590</a> <a href="../../../../org/apache/commons/httpclient/cookie/CookieVersionSupport.html">CookieVersionSupport</a> versupport = (CookieVersionSupport) parser;
<a name="1591" href="#1591">1591</a> <strong>if</strong> (versupport.getVersion() > 0) {
<a name="1592" href="#1592">1592</a> <em class="comment">// process set-cookie2 headers.</em>
<a name="1593" href="#1593">1593</a> <em class="comment">// Cookie2 will replace equivalent Cookie instances</em>
<a name="1594" href="#1594">1594</a> headers = getResponseHeaderGroup().getHeaders(<span class="string">"set-cookie2"</span>);
<a name="1595" href="#1595">1595</a> processCookieHeaders(parser, headers, state, conn);
<a name="1596" href="#1596">1596</a> }
<a name="1597" href="#1597">1597</a> }
<a name="1598" href="#1598">1598</a> }
<a name="1599" href="#1599">1599</a>
<a name="1600" href="#1600">1600</a> <em>/**</em>
<a name="1601" href="#1601">1601</a> <em> * This method processes the specified cookie headers. It is invoked from</em>
<a name="1602" href="#1602">1602</a> <em> * within {@link #processResponseHeaders(HttpState,HttpConnection)}</em>
<a name="1603" href="#1603">1603</a> <em> *</em>
<a name="1604" href="#1604">1604</a> <em> * @param headers cookie {@link Header}s to be processed</em>
<a name="1605" href="#1605">1605</a> <em> * @param state the {@link HttpState state} information associated with</em>
<a name="1606" href="#1606">1606</a> <em> * this HTTP method</em>
<a name="1607" href="#1607">1607</a> <em> * @param conn the {@link HttpConnection connection} used to execute</em>
<a name="1608" href="#1608">1608</a> <em> * this HTTP method</em>
<a name="1609" href="#1609">1609</a> <em> */</em>
<a name="1610" href="#1610">1610</a> <strong>protected</strong> <strong>void</strong> processCookieHeaders(
<a name="1611" href="#1611">1611</a> <strong>final</strong> <a href="../../../../org/apache/commons/httpclient/cookie/CookieSpec.html">CookieSpec</a> parser,
<a name="1612" href="#1612">1612</a> <strong>final</strong> <a href="../../../../org/apache/commons/httpclient/Header.html">Header</a>[] headers,
<a name="1613" href="#1613">1613</a> <strong>final</strong> <a href="../../../../org/apache/commons/httpclient/HttpState.html">HttpState</a> state,
<a name="1614" href="#1614">1614</a> <strong>final</strong> <a href="../../../../org/apache/commons/httpclient/HttpConnection.html">HttpConnection</a> conn) {
<a name="1615" href="#1615">1615</a> LOG.trace(<span class="string">"enter HttpMethodBase.processCookieHeaders(Header[], HttpState, "</span>
<a name="1616" href="#1616">1616</a> + <span class="string">"HttpConnection)"</span>);
<a name="1617" href="#1617">1617</a>
<a name="1618" href="#1618">1618</a> String host = <strong>this</strong>.params.getVirtualHost();
<a name="1619" href="#1619">1619</a> <strong>if</strong> (host == <strong>null</strong>) {
<a name="1620" href="#1620">1620</a> host = conn.getHost();
<a name="1621" href="#1621">1621</a> }
<a name="1622" href="#1622">1622</a> <strong>for</strong> (<strong>int</strong> i = 0; i < headers.length; i++) {
<a name="1623" href="#1623">1623</a> <a href="../../../../org/apache/commons/httpclient/Header.html">Header</a> header = headers[i];
<a name="1624" href="#1624">1624</a> <a href="../../../../org/apache/commons/httpclient/Cookie.html">Cookie</a>[] cookies = <strong>null</strong>;
<a name="1625" href="#1625">1625</a> <strong>try</strong> {
<a name="1626" href="#1626">1626</a> cookies = parser.parse(
<a name="1627" href="#1627">1627</a> host,
<a name="1628" href="#1628">1628</a> conn.getPort(),
<a name="1629" href="#1629">1629</a> getPath(),
<a name="1630" href="#1630">1630</a> conn.isSecure(),
<a name="1631" href="#1631">1631</a> header);
<a name="1632" href="#1632">1632</a> } <strong>catch</strong> (MalformedCookieException e) {
<a name="1633" href="#1633">1633</a> <strong>if</strong> (LOG.isWarnEnabled()) {
<a name="1634" href="#1634">1634</a> LOG.warn(<span class="string">"Invalid cookie header: \""</span>
<a name="1635" href="#1635">1635</a> + header.getValue()
<a name="1636" href="#1636">1636</a> + <span class="string">"\". "</span> + e.getMessage());
<a name="1637" href="#1637">1637</a> }
<a name="1638" href="#1638">1638</a> }
<a name="1639" href="#1639">1639</a> <strong>if</strong> (cookies != <strong>null</strong>) {
<a name="1640" href="#1640">1640</a> <strong>for</strong> (<strong>int</strong> j = 0; j < cookies.length; j++) {
<a name="1641" href="#1641">1641</a> <a href="../../../../org/apache/commons/httpclient/Cookie.html">Cookie</a> cookie = cookies[j];
<a name="1642" href="#1642">1642</a> <strong>try</strong> {
<a name="1643" href="#1643">1643</a> parser.validate(
<a name="1644" href="#1644">1644</a> host,
<a name="1645" href="#1645">1645</a> conn.getPort(),
<a name="1646" href="#1646">1646</a> getPath(),
<a name="1647" href="#1647">1647</a> conn.isSecure(),
<a name="1648" href="#1648">1648</a> cookie);
<a name="1649" href="#1649">1649</a> state.addCookie(cookie);
<a name="1650" href="#1650">1650</a> <strong>if</strong> (LOG.isDebugEnabled()) {
<a name="1651" href="#1651">1651</a> LOG.debug(<span class="string">"Cookie accepted: \""</span>
<a name="1652" href="#1652">1652</a> + parser.formatCookie(cookie) + <span class="string">"\""</span>);
<a name="1653" href="#1653">1653</a> }
<a name="1654" href="#1654">1654</a> } <strong>catch</strong> (MalformedCookieException e) {
<a name="1655" href="#1655">1655</a> <strong>if</strong> (LOG.isWarnEnabled()) {
<a name="1656" href="#1656">1656</a> LOG.warn(<span class="string">"Cookie rejected: \""</span> + parser.formatCookie(cookie)
<a name="1657" href="#1657">1657</a> + <span class="string">"\". "</span> + e.getMessage());
<a name="1658" href="#1658">1658</a> }
<a name="1659" href="#1659">1659</a> }
<a name="1660" href="#1660">1660</a> }
<a name="1661" href="#1661">1661</a> }
<a name="1662" href="#1662">1662</a> }
<a name="1663" href="#1663">1663</a> }
<a name="1664" href="#1664">1664</a>
<a name="1665" href="#1665">1665</a> <em>/**</em>
<a name="1666" href="#1666">1666</a> <em> * This method is invoked immediately after </em>
<a name="1667" href="#1667">1667</a> <em> * {@link #readStatusLine(HttpState,HttpConnection)} and can be overridden by</em>
<a name="1668" href="#1668">1668</a> <em> * sub-classes in order to provide custom response status line processing.</em>
<a name="1669" href="#1669">1669</a> <em> *</em>
<a name="1670" href="#1670">1670</a> <em> * @param state the {@link HttpState state} information associated with this method</em>
<a name="1671" href="#1671">1671</a> <em> * @param conn the {@link HttpConnection connection} used to execute</em>
<a name="1672" href="#1672">1672</a> <em> * this HTTP method</em>
<a name="1673" href="#1673">1673</a> <em> *</em>
<a name="1674" href="#1674">1674</a> <em> * @see #readResponse</em>
<a name="1675" href="#1675">1675</a> <em> * @see #readStatusLine</em>
<a name="1676" href="#1676">1676</a> <em> */</em>
<a name="1677" href="#1677">1677</a> <strong>protected</strong> <strong>void</strong> processStatusLine(<a href="../../../../org/apache/commons/httpclient/HttpState.html">HttpState</a> state, <a href="../../../../org/apache/commons/httpclient/HttpConnection.html">HttpConnection</a> conn) {
<a name="1678" href="#1678">1678</a> }
<a name="1679" href="#1679">1679</a>
<a name="1680" href="#1680">1680</a> <em>/**</em>
<a name="1681" href="#1681">1681</a> <em> * Reads the response from the given {@link HttpConnection connection}.</em>
<a name="1682" href="#1682">1682</a> <em> *</em>
<a name="1683" href="#1683">1683</a> <em> * <p></em>
<a name="1684" href="#1684">1684</a> <em> * The response is processed as the following sequence of actions:</em>
<a name="1685" href="#1685">1685</a> <em> *</em>
<a name="1686" href="#1686">1686</a> <em> * <ol></em>
<a name="1687" href="#1687">1687</a> <em> * <li></em>
<a name="1688" href="#1688">1688</a> <em> * {@link #readStatusLine(HttpState,HttpConnection)} is</em>
<a name="1689" href="#1689">1689</a> <em> * invoked to read the request line.</em>
<a name="1690" href="#1690">1690</a> <em> * </li></em>
<a name="1691" href="#1691">1691</a> <em> * <li></em>
<a name="1692" href="#1692">1692</a> <em> * {@link #processStatusLine(HttpState,HttpConnection)}</em>
<a name="1693" href="#1693">1693</a> <em> * is invoked, allowing the method to process the status line if</em>
<a name="1694" href="#1694">1694</a> <em> * desired.</em>
<a name="1695" href="#1695">1695</a> <em> * </li></em>
<a name="1696" href="#1696">1696</a> <em> * <li></em>
<a name="1697" href="#1697">1697</a> <em> * {@link #readResponseHeaders(HttpState,HttpConnection)} is invoked to read</em>
<a name="1698" href="#1698">1698</a> <em> * the associated headers.</em>
<a name="1699" href="#1699">1699</a> <em> * </li></em>
<a name="1700" href="#1700">1700</a> <em> * <li></em>
<a name="1701" href="#1701">1701</a> <em> * {@link #processResponseHeaders(HttpState,HttpConnection)} is invoked, allowing</em>
<a name="1702" href="#1702">1702</a> <em> * the method to process the headers if desired.</em>
<a name="1703" href="#1703">1703</a> <em> * </li></em>
<a name="1704" href="#1704">1704</a> <em> * <li></em>
<a name="1705" href="#1705">1705</a> <em> * {@link #readResponseBody(HttpState,HttpConnection)} is</em>
<a name="1706" href="#1706">1706</a> <em> * invoked to read the associated body (if any).</em>
<a name="1707" href="#1707">1707</a> <em> * </li></em>
<a name="1708" href="#1708">1708</a> <em> * <li></em>
<a name="1709" href="#1709">1709</a> <em> * {@link #processResponseBody(HttpState,HttpConnection)} is invoked, allowing the</em>
<a name="1710" href="#1710">1710</a> <em> * method to process the response body if desired.</em>
<a name="1711" href="#1711">1711</a> <em> * </li></em>
<a name="1712" href="#1712">1712</a> <em> * </ol></em>
<a name="1713" href="#1713">1713</a> <em> *</em>
<a name="1714" href="#1714">1714</a> <em> * Subclasses may want to override one or more of the above methods to to</em>
<a name="1715" href="#1715">1715</a> <em> * customize the processing. (Or they may choose to override this method</em>
<a name="1716" href="#1716">1716</a> <em> * if dramatically different processing is required.)</em>
<a name="1717" href="#1717">1717</a> <em> * </p></em>
<a name="1718" href="#1718">1718</a> <em> *</em>
<a name="1719" href="#1719">1719</a> <em> * @param state the {@link HttpState state} information associated with this method</em>
<a name="1720" href="#1720">1720</a> <em> * @param conn the {@link HttpConnection connection} used to execute</em>
<a name="1721" href="#1721">1721</a> <em> * this HTTP method</em>
<a name="1722" href="#1722">1722</a> <em> *</em>
<a name="1723" href="#1723">1723</a> <em> * @throws IOException if an I/O (transport) error occurs. Some transport exceptions</em>
<a name="1724" href="#1724">1724</a> <em> * can be recovered from.</em>
<a name="1725" href="#1725">1725</a> <em> * @throws HttpException if a protocol exception occurs. Usually protocol exceptions </em>
<a name="1726" href="#1726">1726</a> <em> * cannot be recovered from.</em>
<a name="1727" href="#1727">1727</a> <em> */</em>
<a name="1728" href="#1728">1728</a> <strong>protected</strong> <strong>void</strong> readResponse(<a href="../../../../org/apache/commons/httpclient/HttpState.html">HttpState</a> state, <a href="../../../../org/apache/commons/httpclient/HttpConnection.html">HttpConnection</a> conn)
<a name="1729" href="#1729">1729</a> throws IOException, <a href="../../../../org/apache/commons/httpclient/HttpException.html">HttpException</a> {
<a name="1730" href="#1730">1730</a> LOG.trace(
<a name="1731" href="#1731">1731</a> <span class="string">"enter HttpMethodBase.readResponse(HttpState, HttpConnection)"</span>);
<a name="1732" href="#1732">1732</a> <em class="comment">// Status line & line may have already been received</em>
<a name="1733" href="#1733">1733</a> <em class="comment">// if 'expect - continue' handshake has been used</em>
<a name="1734" href="#1734">1734</a> <strong>while</strong> (<strong>this</strong>.statusLine == <strong>null</strong>) {
<a name="1735" href="#1735">1735</a> readStatusLine(state, conn);
<a name="1736" href="#1736">1736</a> processStatusLine(state, conn);
<a name="1737" href="#1737">1737</a> readResponseHeaders(state, conn);
<a name="1738" href="#1738">1738</a> processResponseHeaders(state, conn);
<a name="1739" href="#1739">1739</a>
<a name="1740" href="#1740">1740</a> <strong>int</strong> status = <strong>this</strong>.statusLine.getStatusCode();
<a name="1741" href="#1741">1741</a> <strong>if</strong> ((status >= 100) && (status < 200)) {
<a name="1742" href="#1742">1742</a> <strong>if</strong> (LOG.isInfoEnabled()) {
<a name="1743" href="#1743">1743</a> LOG.info(<span class="string">"Discarding unexpected response: "</span> + <strong>this</strong>.statusLine.toString());
<a name="1744" href="#1744">1744</a> }
<a name="1745" href="#1745">1745</a> <strong>this</strong>.statusLine = <strong>null</strong>;
<a name="1746" href="#1746">1746</a> }
<a name="1747" href="#1747">1747</a> }
<a name="1748" href="#1748">1748</a> readResponseBody(state, conn);
<a name="1749" href="#1749">1749</a> processResponseBody(state, conn);
<a name="1750" href="#1750">1750</a> }
<a name="1751" href="#1751">1751</a>
<a name="1752" href="#1752">1752</a> <em>/**</em>
<a name="1753" href="#1753">1753</a> <em> * Read the response body from the given {@link HttpConnection}.</em>
<a name="1754" href="#1754">1754</a> <em> *</em>
<a name="1755" href="#1755">1755</a> <em> * <p></em>
<a name="1756" href="#1756">1756</a> <em> * The current implementation wraps the socket level stream with</em>
<a name="1757" href="#1757">1757</a> <em> * an appropriate stream for the type of response (chunked, content-length,</em>
<a name="1758" href="#1758">1758</a> <em> * or auto-close). If there is no response body, the connection associated</em>
<a name="1759" href="#1759">1759</a> <em> * with the request will be returned to the connection manager.</em>
<a name="1760" href="#1760">1760</a> <em> * </p></em>
<a name="1761" href="#1761">1761</a> <em> *</em>
<a name="1762" href="#1762">1762</a> <em> * <p></em>
<a name="1763" href="#1763">1763</a> <em> * Subclasses may want to override this method to to customize the</em>
<a name="1764" href="#1764">1764</a> <em> * processing.</em>
<a name="1765" href="#1765">1765</a> <em> * </p></em>
<a name="1766" href="#1766">1766</a> <em> *</em>
<a name="1767" href="#1767">1767</a> <em> * @param state the {@link HttpState state} information associated with this method</em>
<a name="1768" href="#1768">1768</a> <em> * @param conn the {@link HttpConnection connection} used to execute</em>
<a name="1769" href="#1769">1769</a> <em> * this HTTP method</em>
<a name="1770" href="#1770">1770</a> <em> *</em>
<a name="1771" href="#1771">1771</a> <em> * @throws IOException if an I/O (transport) error occurs. Some transport exceptions</em>
<a name="1772" href="#1772">1772</a> <em> * can be recovered from.</em>
<a name="1773" href="#1773">1773</a> <em> * @throws HttpException if a protocol exception occurs. Usually protocol exceptions </em>
<a name="1774" href="#1774">1774</a> <em> * cannot be recovered from.</em>
<a name="1775" href="#1775">1775</a> <em> *</em>
<a name="1776" href="#1776">1776</a> <em> * @see #readResponse</em>
<a name="1777" href="#1777">1777</a> <em> * @see #processResponseBody</em>
<a name="1778" href="#1778">1778</a> <em> */</em>
<a name="1779" href="#1779">1779</a> <strong>protected</strong> <strong>void</strong> readResponseBody(<a href="../../../../org/apache/commons/httpclient/HttpState.html">HttpState</a> state, <a href="../../../../org/apache/commons/httpclient/HttpConnection.html">HttpConnection</a> conn)
<a name="1780" href="#1780">1780</a> throws IOException, <a href="../../../../org/apache/commons/httpclient/HttpException.html">HttpException</a> {
<a name="1781" href="#1781">1781</a> LOG.trace(
<a name="1782" href="#1782">1782</a> <span class="string">"enter HttpMethodBase.readResponseBody(HttpState, HttpConnection)"</span>);
<a name="1783" href="#1783">1783</a>
<a name="1784" href="#1784">1784</a> <em class="comment">// assume we are not done with the connection if we get a stream</em>
<a name="1785" href="#1785">1785</a> InputStream stream = readResponseBody(conn);
<a name="1786" href="#1786">1786</a> <strong>if</strong> (stream == <strong>null</strong>) {
<a name="1787" href="#1787">1787</a> <em class="comment">// done using the connection!</em>
<a name="1788" href="#1788">1788</a> responseBodyConsumed();
<a name="1789" href="#1789">1789</a> } <strong>else</strong> {
<a name="1790" href="#1790">1790</a> conn.setLastResponseInputStream(stream);
<a name="1791" href="#1791">1791</a> setResponseStream(stream);
<a name="1792" href="#1792">1792</a> }
<a name="1793" href="#1793">1793</a> }
<a name="1794" href="#1794">1794</a>
<a name="1795" href="#1795">1795</a> <em>/**</em>
<a name="1796" href="#1796">1796</a> <em> * Returns the response body as an {@link InputStream input stream}</em>
<a name="1797" href="#1797">1797</a> <em> * corresponding to the values of the <tt>Content-Length</tt> and </em>
<a name="1798" href="#1798">1798</a> <em> * <tt>Transfer-Encoding</tt> headers. If no response body is available</em>
<a name="1799" href="#1799">1799</a> <em> * returns <tt>null</tt>.</em>
<a name="1800" href="#1800">1800</a> <em> * <p></em>
<a name="1801" href="#1801">1801</a> <em> *</em>
<a name="1802" href="#1802">1802</a> <em> * @see #readResponse</em>
<a name="1803" href="#1803">1803</a> <em> * @see #processResponseBody</em>
<a name="1804" href="#1804">1804</a> <em> *</em>
<a name="1805" href="#1805">1805</a> <em> * @param conn the {@link HttpConnection connection} used to execute</em>
<a name="1806" href="#1806">1806</a> <em> * this HTTP method</em>
<a name="1807" href="#1807">1807</a> <em> *</em>
<a name="1808" href="#1808">1808</a> <em> * @throws IOException if an I/O (transport) error occurs. Some transport exceptions</em>
<a name="1809" href="#1809">1809</a> <em> * can be recovered from.</em>
<a name="1810" href="#1810">1810</a> <em> * @throws HttpException if a protocol exception occurs. Usually protocol exceptions </em>
<a name="1811" href="#1811">1811</a> <em> * cannot be recovered from.</em>
<a name="1812" href="#1812">1812</a> <em> */</em>
<a name="1813" href="#1813">1813</a> <strong>private</strong> InputStream readResponseBody(<a href="../../../../org/apache/commons/httpclient/HttpConnection.html">HttpConnection</a> conn)
<a name="1814" href="#1814">1814</a> throws HttpException, IOException {
<a name="1815" href="#1815">1815</a>
<a name="1816" href="#1816">1816</a> LOG.trace(<span class="string">"enter HttpMethodBase.readResponseBody(HttpConnection)"</span>);
<a name="1817" href="#1817">1817</a>
<a name="1818" href="#1818">1818</a> responseBody = <strong>null</strong>;
<a name="1819" href="#1819">1819</a> InputStream is = conn.getResponseInputStream();
<a name="1820" href="#1820">1820</a> <strong>if</strong> (Wire.CONTENT_WIRE.enabled()) {
<a name="1821" href="#1821">1821</a> is = <strong>new</strong> <a href="../../../../org/apache/commons/httpclient/WireLogInputStream.html">WireLogInputStream</a>(is, Wire.CONTENT_WIRE);
<a name="1822" href="#1822">1822</a> }
<a name="1823" href="#1823">1823</a> <strong>boolean</strong> canHaveBody = canResponseHaveBody(statusLine.getStatusCode());
<a name="1824" href="#1824">1824</a> InputStream result = <strong>null</strong>;
<a name="1825" href="#1825">1825</a> <a href="../../../../org/apache/commons/httpclient/Header.html">Header</a> transferEncodingHeader = responseHeaders.getFirstHeader(<span class="string">"Transfer-Encoding"</span>);
<a name="1826" href="#1826">1826</a> <em class="comment">// We use Transfer-Encoding if present and ignore Content-Length.</em>
<a name="1827" href="#1827">1827</a> <em class="comment">// RFC2616, 4.4 item number 3</em>
<a name="1828" href="#1828">1828</a> <strong>if</strong> (transferEncodingHeader != <strong>null</strong>) {
<a name="1829" href="#1829">1829</a>
<a name="1830" href="#1830">1830</a> String transferEncoding = transferEncodingHeader.getValue();
<a name="1831" href="#1831">1831</a> <strong>if</strong> (!<span class="string">"chunked"</span>.equalsIgnoreCase(transferEncoding)
<a name="1832" href="#1832">1832</a> && !<span class="string">"identity"</span>.equalsIgnoreCase(transferEncoding)) {
<a name="1833" href="#1833">1833</a> <strong>if</strong> (LOG.isWarnEnabled()) {
<a name="1834" href="#1834">1834</a> LOG.warn(<span class="string">"Unsupported transfer encoding: "</span> + transferEncoding);
<a name="1835" href="#1835">1835</a> }
<a name="1836" href="#1836">1836</a> }
<a name="1837" href="#1837">1837</a> <a href="../../../../org/apache/commons/httpclient/HeaderElement.html">HeaderElement</a>[] encodings = transferEncodingHeader.getElements();
<a name="1838" href="#1838">1838</a> <em class="comment">// The chunked encoding must be the last one applied</em>
<a name="1839" href="#1839">1839</a> <em class="comment">// RFC2616, 14.41</em>
<a name="1840" href="#1840">1840</a> <strong>int</strong> len = encodings.length;
<a name="1841" href="#1841">1841</a> <strong>if</strong> ((len > 0) && (<span class="string">"chunked"</span>.equalsIgnoreCase(encodings[len - 1].getName()))) {
<a name="1842" href="#1842">1842</a> <em class="comment">// if response body is empty</em>
<a name="1843" href="#1843">1843</a> <strong>if</strong> (conn.isResponseAvailable(conn.getParams().getSoTimeout())) {
<a name="1844" href="#1844">1844</a> result = <strong>new</strong> <a href="../../../../org/apache/commons/httpclient/ChunkedInputStream.html">ChunkedInputStream</a>(is, <strong>this</strong>);
<a name="1845" href="#1845">1845</a> } <strong>else</strong> {
<a name="1846" href="#1846">1846</a> <strong>if</strong> (getParams().isParameterTrue(HttpMethodParams.STRICT_TRANSFER_ENCODING)) {
<a name="1847" href="#1847">1847</a> <strong>throw</strong> <strong>new</strong> <a href="../../../../org/apache/commons/httpclient/ProtocolException.html">ProtocolException</a>(<span class="string">"Chunk-encoded body declared but not sent"</span>);
<a name="1848" href="#1848">1848</a> } <strong>else</strong> {
<a name="1849" href="#1849">1849</a> LOG.warn(<span class="string">"Chunk-encoded body missing"</span>);
<a name="1850" href="#1850">1850</a> }
<a name="1851" href="#1851">1851</a> }
<a name="1852" href="#1852">1852</a> } <strong>else</strong> {
<a name="1853" href="#1853">1853</a> LOG.info(<span class="string">"Response content is not chunk-encoded"</span>);
<a name="1854" href="#1854">1854</a> <em class="comment">// The connection must be terminated by closing </em>
<a name="1855" href="#1855">1855</a> <em class="comment">// the socket as per RFC 2616, 3.6</em>
<a name="1856" href="#1856">1856</a> setConnectionCloseForced(<strong>true</strong>);
<a name="1857" href="#1857">1857</a> result = is;
<a name="1858" href="#1858">1858</a> }
<a name="1859" href="#1859">1859</a> } <strong>else</strong> {
<a name="1860" href="#1860">1860</a> <strong>long</strong> expectedLength = getResponseContentLength();
<a name="1861" href="#1861">1861</a> <strong>if</strong> (expectedLength == -1) {
<a name="1862" href="#1862">1862</a> <strong>if</strong> (canHaveBody && <strong>this</strong>.effectiveVersion.greaterEquals(HttpVersion.HTTP_1_1)) {
<a name="1863" href="#1863">1863</a> <a href="../../../../org/apache/commons/httpclient/Header.html">Header</a> connectionHeader = responseHeaders.getFirstHeader(<span class="string">"Connection"</span>);
<a name="1864" href="#1864">1864</a> String connectionDirective = <strong>null</strong>;
<a name="1865" href="#1865">1865</a> <strong>if</strong> (connectionHeader != <strong>null</strong>) {
<a name="1866" href="#1866">1866</a> connectionDirective = connectionHeader.getValue();
<a name="1867" href="#1867">1867</a> }
<a name="1868" href="#1868">1868</a> <strong>if</strong> (!<span class="string">"close"</span>.equalsIgnoreCase(connectionDirective)) {
<a name="1869" href="#1869">1869</a> LOG.info(<span class="string">"Response content length is not known"</span>);
<a name="1870" href="#1870">1870</a> setConnectionCloseForced(<strong>true</strong>);
<a name="1871" href="#1871">1871</a> }
<a name="1872" href="#1872">1872</a> }
<a name="1873" href="#1873">1873</a> result = is;
<a name="1874" href="#1874">1874</a> } <strong>else</strong> {
<a name="1875" href="#1875">1875</a> result = <strong>new</strong> <a href="../../../../org/apache/commons/httpclient/ContentLengthInputStream.html">ContentLengthInputStream</a>(is, expectedLength);
<a name="1876" href="#1876">1876</a> }
<a name="1877" href="#1877">1877</a> }
<a name="1878" href="#1878">1878</a>
<a name="1879" href="#1879">1879</a> <em class="comment">// See if the response is supposed to have a response body</em>
<a name="1880" href="#1880">1880</a> <strong>if</strong> (!canHaveBody) {
<a name="1881" href="#1881">1881</a> result = <strong>null</strong>;
<a name="1882" href="#1882">1882</a> }
<a name="1883" href="#1883">1883</a> <em class="comment">// if there is a result - ALWAYS wrap it in an observer which will</em>
<a name="1884" href="#1884">1884</a> <em class="comment">// close the underlying stream as soon as it is consumed, and notify</em>
<a name="1885" href="#1885">1885</a> <em class="comment">// the watcher that the stream has been consumed.</em>
<a name="1886" href="#1886">1886</a> <strong>if</strong> (result != <strong>null</strong>) {
<a name="1887" href="#1887">1887</a>
<a name="1888" href="#1888">1888</a> result = <strong>new</strong> <a href="../../../../org/apache/commons/httpclient/AutoCloseInputStream.html">AutoCloseInputStream</a>(
<a name="1889" href="#1889">1889</a> result,
<a name="1890" href="#1890">1890</a> <strong>new</strong> <a href="../../../../org/apache/commons/httpclient/ResponseConsumedWatcher.html">ResponseConsumedWatcher</a>() {
<a name="1891" href="#1891">1891</a> <strong>public</strong> <strong>void</strong> responseConsumed() {
<a name="1892" href="#1892">1892</a> responseBodyConsumed();
<a name="1893" href="#1893">1893</a> }
<a name="1894" href="#1894">1894</a> }
<a name="1895" href="#1895">1895</a> );
<a name="1896" href="#1896">1896</a> }
<a name="1897" href="#1897">1897</a>
<a name="1898" href="#1898">1898</a> <strong>return</strong> result;
<a name="1899" href="#1899">1899</a> }
<a name="1900" href="#1900">1900</a>
<a name="1901" href="#1901">1901</a> <em>/**</em>
<a name="1902" href="#1902">1902</a> <em> * Reads the response headers from the given {@link HttpConnection connection}.</em>
<a name="1903" href="#1903">1903</a> <em> *</em>
<a name="1904" href="#1904">1904</a> <em> * <p></em>
<a name="1905" href="#1905">1905</a> <em> * Subclasses may want to override this method to to customize the</em>
<a name="1906" href="#1906">1906</a> <em> * processing.</em>
<a name="1907" href="#1907">1907</a> <em> * </p></em>
<a name="1908" href="#1908">1908</a> <em> *</em>
<a name="1909" href="#1909">1909</a> <em> * <p></em>
<a name="1910" href="#1910">1910</a> <em> * "It must be possible to combine the multiple header fields into one</em>
<a name="1911" href="#1911">1911</a> <em> * "field-name: field-value" pair, without changing the semantics of the</em>
<a name="1912" href="#1912">1912</a> <em> * message, by appending each subsequent field-value to the first, each</em>
<a name="1913" href="#1913">1913</a> <em> * separated by a comma." - HTTP/1.0 (4.3)</em>
<a name="1914" href="#1914">1914</a> <em> * </p></em>
<a name="1915" href="#1915">1915</a> <em> *</em>
<a name="1916" href="#1916">1916</a> <em> * @param state the {@link HttpState state} information associated with this method</em>
<a name="1917" href="#1917">1917</a> <em> * @param conn the {@link HttpConnection connection} used to execute</em>
<a name="1918" href="#1918">1918</a> <em> * this HTTP method</em>
<a name="1919" href="#1919">1919</a> <em> *</em>
<a name="1920" href="#1920">1920</a> <em> * @throws IOException if an I/O (transport) error occurs. Some transport exceptions</em>
<a name="1921" href="#1921">1921</a> <em> * can be recovered from.</em>
<a name="1922" href="#1922">1922</a> <em> * @throws HttpException if a protocol exception occurs. Usually protocol exceptions </em>
<a name="1923" href="#1923">1923</a> <em> * cannot be recovered from.</em>
<a name="1924" href="#1924">1924</a> <em> *</em>
<a name="1925" href="#1925">1925</a> <em> * @see #readResponse</em>
<a name="1926" href="#1926">1926</a> <em> * @see #processResponseHeaders</em>
<a name="1927" href="#1927">1927</a> <em> */</em>
<a name="1928" href="#1928">1928</a> <strong>protected</strong> <strong>void</strong> readResponseHeaders(<a href="../../../../org/apache/commons/httpclient/HttpState.html">HttpState</a> state, <a href="../../../../org/apache/commons/httpclient/HttpConnection.html">HttpConnection</a> conn)
<a name="1929" href="#1929">1929</a> throws IOException, <a href="../../../../org/apache/commons/httpclient/HttpException.html">HttpException</a> {
<a name="1930" href="#1930">1930</a> LOG.trace(<span class="string">"enter HttpMethodBase.readResponseHeaders(HttpState,"</span>
<a name="1931" href="#1931">1931</a> + <span class="string">"HttpConnection)"</span>);
<a name="1932" href="#1932">1932</a>
<a name="1933" href="#1933">1933</a> getResponseHeaderGroup().clear();
<a name="1934" href="#1934">1934</a>
<a name="1935" href="#1935">1935</a> <a href="../../../../org/apache/commons/httpclient/Header.html">Header</a>[] headers = HttpParser.parseHeaders(
<a name="1936" href="#1936">1936</a> conn.getResponseInputStream(), getParams().getHttpElementCharset());
<a name="1937" href="#1937">1937</a> <em class="comment">// Wire logging moved to HttpParser</em>
<a name="1938" href="#1938">1938</a> getResponseHeaderGroup().setHeaders(headers);
<a name="1939" href="#1939">1939</a> }
<a name="1940" href="#1940">1940</a>
<a name="1941" href="#1941">1941</a> <em>/**</em>
<a name="1942" href="#1942">1942</a> <em> * Read the status line from the given {@link HttpConnection}, setting my</em>
<a name="1943" href="#1943">1943</a> <em> * {@link #getStatusCode status code} and {@link #getStatusText status</em>
<a name="1944" href="#1944">1944</a> <em> * text}.</em>
<a name="1945" href="#1945">1945</a> <em> *</em>
<a name="1946" href="#1946">1946</a> <em> * <p></em>
<a name="1947" href="#1947">1947</a> <em> * Subclasses may want to override this method to to customize the</em>
<a name="1948" href="#1948">1948</a> <em> * processing.</em>
<a name="1949" href="#1949">1949</a> <em> * </p></em>
<a name="1950" href="#1950">1950</a> <em> *</em>
<a name="1951" href="#1951">1951</a> <em> * @param state the {@link HttpState state} information associated with this method</em>
<a name="1952" href="#1952">1952</a> <em> * @param conn the {@link HttpConnection connection} used to execute</em>
<a name="1953" href="#1953">1953</a> <em> * this HTTP method</em>
<a name="1954" href="#1954">1954</a> <em> *</em>
<a name="1955" href="#1955">1955</a> <em> * @throws IOException if an I/O (transport) error occurs. Some transport exceptions</em>
<a name="1956" href="#1956">1956</a> <em> * can be recovered from.</em>
<a name="1957" href="#1957">1957</a> <em> * @throws HttpException if a protocol exception occurs. Usually protocol exceptions </em>
<a name="1958" href="#1958">1958</a> <em> * cannot be recovered from.</em>
<a name="1959" href="#1959">1959</a> <em> *</em>
<a name="1960" href="#1960">1960</a> <em> * @see StatusLine</em>
<a name="1961" href="#1961">1961</a> <em> */</em>
<a name="1962" href="#1962">1962</a> <strong>protected</strong> <strong>void</strong> readStatusLine(<a href="../../../../org/apache/commons/httpclient/HttpState.html">HttpState</a> state, <a href="../../../../org/apache/commons/httpclient/HttpConnection.html">HttpConnection</a> conn)
<a name="1963" href="#1963">1963</a> throws IOException, <a href="../../../../org/apache/commons/httpclient/HttpException.html">HttpException</a> {
<a name="1964" href="#1964">1964</a> LOG.trace(<span class="string">"enter HttpMethodBase.readStatusLine(HttpState, HttpConnection)"</span>);
<a name="1965" href="#1965">1965</a>
<a name="1966" href="#1966">1966</a> <strong>final</strong> <strong>int</strong> maxGarbageLines = getParams().
<a name="1967" href="#1967">1967</a> getIntParameter(HttpMethodParams.STATUS_LINE_GARBAGE_LIMIT, Integer.MAX_VALUE);
<a name="1968" href="#1968">1968</a>
<a name="1969" href="#1969">1969</a> <em class="comment">//read out the HTTP status string</em>
<a name="1970" href="#1970">1970</a> <strong>int</strong> count = 0;
<a name="1971" href="#1971">1971</a> String s;
<a name="1972" href="#1972">1972</a> <strong>do</strong> {
<a name="1973" href="#1973">1973</a> s = conn.readLine(getParams().getHttpElementCharset());
<a name="1974" href="#1974">1974</a> <strong>if</strong> (s == <strong>null</strong> && count == 0) {
<a name="1975" href="#1975">1975</a> <em class="comment">// The server just dropped connection on us</em>
<a name="1976" href="#1976">1976</a> <strong>throw</strong> <strong>new</strong> <a href="../../../../org/apache/commons/httpclient/NoHttpResponseException.html">NoHttpResponseException</a>(<span class="string">"The server "</span> + conn.getHost() +
<a name="1977" href="#1977">1977</a> <span class="string">" failed to respond"</span>);
<a name="1978" href="#1978">1978</a> }
<a name="1979" href="#1979">1979</a> <strong>if</strong> (Wire.HEADER_WIRE.enabled()) {
<a name="1980" href="#1980">1980</a> Wire.HEADER_WIRE.input(s + <span class="string">"\r\n"</span>);
<a name="1981" href="#1981">1981</a> }
<a name="1982" href="#1982">1982</a> <strong>if</strong> (s != <strong>null</strong> && StatusLine.startsWithHTTP(s)) {
<a name="1983" href="#1983">1983</a> <em class="comment">// Got one</em>
<a name="1984" href="#1984">1984</a> <strong>break</strong>;
<a name="1985" href="#1985">1985</a> } <strong>else</strong> <strong>if</strong> (s == <strong>null</strong> || count >= maxGarbageLines) {
<a name="1986" href="#1986">1986</a> <em class="comment">// Giving up</em>
<a name="1987" href="#1987">1987</a> <strong>throw</strong> <strong>new</strong> <a href="../../../../org/apache/commons/httpclient/ProtocolException.html">ProtocolException</a>(<span class="string">"The server "</span> + conn.getHost() +
<a name="1988" href="#1988">1988</a> <span class="string">" failed to respond with a valid HTTP response"</span>);
<a name="1989" href="#1989">1989</a> }
<a name="1990" href="#1990">1990</a> count++;
<a name="1991" href="#1991">1991</a> } <strong>while</strong>(<strong>true</strong>);
<a name="1992" href="#1992">1992</a>
<a name="1993" href="#1993">1993</a> <em class="comment">//create the status line from the status string</em>
<a name="1994" href="#1994">1994</a> statusLine = <strong>new</strong> <a href="../../../../org/apache/commons/httpclient/StatusLine.html">StatusLine</a>(s);
<a name="1995" href="#1995">1995</a>
<a name="1996" href="#1996">1996</a> <em class="comment">//check for a valid HTTP-Version</em>
<a name="1997" href="#1997">1997</a> String versionStr = statusLine.getHttpVersion();
<a name="1998" href="#1998">1998</a> <strong>if</strong> (getParams().isParameterFalse(HttpMethodParams.UNAMBIGUOUS_STATUS_LINE)
<a name="1999" href="#1999">1999</a> && versionStr.equals(<span class="string">"HTTP"</span>)) {
<a name="2000" href="#2000">2000</a> getParams().setVersion(HttpVersion.HTTP_1_0);
<a name="2001" href="#2001">2001</a> <strong>if</strong> (LOG.isWarnEnabled()) {
<a name="2002" href="#2002">2002</a> LOG.warn(<span class="string">"Ambiguous status line (HTTP protocol version missing):"</span> +
<a name="2003" href="#2003">2003</a> statusLine.toString());
<a name="2004" href="#2004">2004</a> }
<a name="2005" href="#2005">2005</a> } <strong>else</strong> {
<a name="2006" href="#2006">2006</a> <strong>this</strong>.effectiveVersion = HttpVersion.parse(versionStr);
<a name="2007" href="#2007">2007</a> }
<a name="2008" href="#2008">2008</a>
<a name="2009" href="#2009">2009</a> }
<a name="2010" href="#2010">2010</a>
<a name="2011" href="#2011">2011</a> <em class="comment">// ------------------------------------------------------ Protected Methods</em>
<a name="2012" href="#2012">2012</a>
<a name="2013" href="#2013">2013</a> <em>/**</em>
<a name="2014" href="#2014">2014</a> <em> * <p></em>
<a name="2015" href="#2015">2015</a> <em> * Sends the request via the given {@link HttpConnection connection}.</em>
<a name="2016" href="#2016">2016</a> <em> * </p></em>
<a name="2017" href="#2017">2017</a> <em> *</em>
<a name="2018" href="#2018">2018</a> <em> * <p></em>
<a name="2019" href="#2019">2019</a> <em> * The request is written as the following sequence of actions:</em>
<a name="2020" href="#2020">2020</a> <em> * </p></em>
<a name="2021" href="#2021">2021</a> <em> *</em>
<a name="2022" href="#2022">2022</a> <em> * <ol></em>
<a name="2023" href="#2023">2023</a> <em> * <li></em>
<a name="2024" href="#2024">2024</a> <em> * {@link #writeRequestLine(HttpState, HttpConnection)} is invoked to </em>
<a name="2025" href="#2025">2025</a> <em> * write the request line.</em>
<a name="2026" href="#2026">2026</a> <em> * </li></em>
<a name="2027" href="#2027">2027</a> <em> * <li></em>
<a name="2028" href="#2028">2028</a> <em> * {@link #writeRequestHeaders(HttpState, HttpConnection)} is invoked </em>
<a name="2029" href="#2029">2029</a> <em> * to write the associated headers.</em>
<a name="2030" href="#2030">2030</a> <em> * </li></em>
<a name="2031" href="#2031">2031</a> <em> * <li></em>
<a name="2032" href="#2032">2032</a> <em> * <tt>\r\n</tt> is sent to close the head part of the request.</em>
<a name="2033" href="#2033">2033</a> <em> * </li></em>
<a name="2034" href="#2034">2034</a> <em> * <li></em>
<a name="2035" href="#2035">2035</a> <em> * {@link #writeRequestBody(HttpState, HttpConnection)} is invoked to </em>
<a name="2036" href="#2036">2036</a> <em> * write the body part of the request.</em>
<a name="2037" href="#2037">2037</a> <em> * </li></em>
<a name="2038" href="#2038">2038</a> <em> * </ol></em>
<a name="2039" href="#2039">2039</a> <em> *</em>
<a name="2040" href="#2040">2040</a> <em> * <p></em>
<a name="2041" href="#2041">2041</a> <em> * Subclasses may want to override one or more of the above methods to to</em>
<a name="2042" href="#2042">2042</a> <em> * customize the processing. (Or they may choose to override this method</em>
<a name="2043" href="#2043">2043</a> <em> * if dramatically different processing is required.)</em>
<a name="2044" href="#2044">2044</a> <em> * </p></em>
<a name="2045" href="#2045">2045</a> <em> *</em>
<a name="2046" href="#2046">2046</a> <em> * @param state the {@link HttpState state} information associated with this method</em>
<a name="2047" href="#2047">2047</a> <em> * @param conn the {@link HttpConnection connection} used to execute</em>
<a name="2048" href="#2048">2048</a> <em> * this HTTP method</em>
<a name="2049" href="#2049">2049</a> <em> *</em>
<a name="2050" href="#2050">2050</a> <em> * @throws IOException if an I/O (transport) error occurs. Some transport exceptions</em>
<a name="2051" href="#2051">2051</a> <em> * can be recovered from.</em>
<a name="2052" href="#2052">2052</a> <em> * @throws HttpException if a protocol exception occurs. Usually protocol exceptions </em>
<a name="2053" href="#2053">2053</a> <em> * cannot be recovered from.</em>
<a name="2054" href="#2054">2054</a> <em> */</em>
<a name="2055" href="#2055">2055</a> <strong>protected</strong> <strong>void</strong> writeRequest(<a href="../../../../org/apache/commons/httpclient/HttpState.html">HttpState</a> state, <a href="../../../../org/apache/commons/httpclient/HttpConnection.html">HttpConnection</a> conn)
<a name="2056" href="#2056">2056</a> throws IOException, <a href="../../../../org/apache/commons/httpclient/HttpException.html">HttpException</a> {
<a name="2057" href="#2057">2057</a> LOG.trace(
<a name="2058" href="#2058">2058</a> <span class="string">"enter HttpMethodBase.writeRequest(HttpState, HttpConnection)"</span>);
<a name="2059" href="#2059">2059</a> writeRequestLine(state, conn);
<a name="2060" href="#2060">2060</a> writeRequestHeaders(state, conn);
<a name="2061" href="#2061">2061</a> conn.writeLine(); <em class="comment">// close head</em>
<a name="2062" href="#2062">2062</a> <strong>if</strong> (Wire.HEADER_WIRE.enabled()) {
<a name="2063" href="#2063">2063</a> Wire.HEADER_WIRE.output(<span class="string">"\r\n"</span>);
<a name="2064" href="#2064">2064</a> }
<a name="2065" href="#2065">2065</a>
<a name="2066" href="#2066">2066</a> <a href="../../../../org/apache/commons/httpclient/HttpVersion.html">HttpVersion</a> ver = getParams().getVersion();
<a name="2067" href="#2067">2067</a> <a href="../../../../org/apache/commons/httpclient/Header.html">Header</a> expectheader = getRequestHeader(<span class="string">"Expect"</span>);
<a name="2068" href="#2068">2068</a> String expectvalue = <strong>null</strong>;
<a name="2069" href="#2069">2069</a> <strong>if</strong> (expectheader != <strong>null</strong>) {
<a name="2070" href="#2070">2070</a> expectvalue = expectheader.getValue();
<a name="2071" href="#2071">2071</a> }
<a name="2072" href="#2072">2072</a> <strong>if</strong> ((expectvalue != <strong>null</strong>)
<a name="2073" href="#2073">2073</a> && (expectvalue.compareToIgnoreCase(<span class="string">"100-continue"</span>) == 0)) {
<a name="2074" href="#2074">2074</a> <strong>if</strong> (ver.greaterEquals(HttpVersion.HTTP_1_1)) {
<a name="2075" href="#2075">2075</a>
<a name="2076" href="#2076">2076</a> <em class="comment">// make sure the status line and headers have been sent</em>
<a name="2077" href="#2077">2077</a> conn.flushRequestOutputStream();
<a name="2078" href="#2078">2078</a>
<a name="2079" href="#2079">2079</a> <strong>int</strong> readTimeout = conn.getParams().getSoTimeout();
<a name="2080" href="#2080">2080</a> <strong>try</strong> {
<a name="2081" href="#2081">2081</a> conn.setSocketTimeout(RESPONSE_WAIT_TIME_MS);
<a name="2082" href="#2082">2082</a> readStatusLine(state, conn);
<a name="2083" href="#2083">2083</a> processStatusLine(state, conn);
<a name="2084" href="#2084">2084</a> readResponseHeaders(state, conn);
<a name="2085" href="#2085">2085</a> processResponseHeaders(state, conn);
<a name="2086" href="#2086">2086</a>
<a name="2087" href="#2087">2087</a> <strong>if</strong> (<strong>this</strong>.statusLine.getStatusCode() == HttpStatus.SC_CONTINUE) {
<a name="2088" href="#2088">2088</a> <em class="comment">// Discard status line</em>
<a name="2089" href="#2089">2089</a> <strong>this</strong>.statusLine = <strong>null</strong>;
<a name="2090" href="#2090">2090</a> LOG.debug(<span class="string">"OK to continue received"</span>);
<a name="2091" href="#2091">2091</a> } <strong>else</strong> {
<a name="2092" href="#2092">2092</a> <strong>return</strong>;
<a name="2093" href="#2093">2093</a> }
<a name="2094" href="#2094">2094</a> } <strong>catch</strong> (InterruptedIOException e) {
<a name="2095" href="#2095">2095</a> <strong>if</strong> (!ExceptionUtil.isSocketTimeoutException(e)) {
<a name="2096" href="#2096">2096</a> <strong>throw</strong> e;
<a name="2097" href="#2097">2097</a> }
<a name="2098" href="#2098">2098</a> <em class="comment">// Most probably Expect header is not recongnized</em>
<a name="2099" href="#2099">2099</a> <em class="comment">// Remove the header to signal the method </em>
<a name="2100" href="#2100">2100</a> <em class="comment">// that it's okay to go ahead with sending data</em>
<a name="2101" href="#2101">2101</a> removeRequestHeader(<span class="string">"Expect"</span>);
<a name="2102" href="#2102">2102</a> LOG.info(<span class="string">"100 (continue) read timeout. Resume sending the request"</span>);
<a name="2103" href="#2103">2103</a> } <strong>finally</strong> {
<a name="2104" href="#2104">2104</a> conn.setSocketTimeout(readTimeout);
<a name="2105" href="#2105">2105</a> }
<a name="2106" href="#2106">2106</a>
<a name="2107" href="#2107">2107</a> } <strong>else</strong> {
<a name="2108" href="#2108">2108</a> removeRequestHeader(<span class="string">"Expect"</span>);
<a name="2109" href="#2109">2109</a> LOG.info(<span class="string">"'Expect: 100-continue' handshake is only supported by "</span>
<a name="2110" href="#2110">2110</a> + <span class="string">"HTTP/1.1 or higher"</span>);
<a name="2111" href="#2111">2111</a> }
<a name="2112" href="#2112">2112</a> }
<a name="2113" href="#2113">2113</a>
<a name="2114" href="#2114">2114</a> writeRequestBody(state, conn);
<a name="2115" href="#2115">2115</a> <em class="comment">// make sure the entire request body has been sent</em>
<a name="2116" href="#2116">2116</a> conn.flushRequestOutputStream();
<a name="2117" href="#2117">2117</a> }
<a name="2118" href="#2118">2118</a>
<a name="2119" href="#2119">2119</a> <em>/**</em>
<a name="2120" href="#2120">2120</a> <em> * Writes the request body to the given {@link HttpConnection connection}.</em>
<a name="2121" href="#2121">2121</a> <em> *</em>
<a name="2122" href="#2122">2122</a> <em> * <p></em>
<a name="2123" href="#2123">2123</a> <em> * This method should return <tt>true</tt> if the request body was actually</em>
<a name="2124" href="#2124">2124</a> <em> * sent (or is empty), or <tt>false</tt> if it could not be sent for some</em>
<a name="2125" href="#2125">2125</a> <em> * reason.</em>
<a name="2126" href="#2126">2126</a> <em> * </p></em>
<a name="2127" href="#2127">2127</a> <em> *</em>
<a name="2128" href="#2128">2128</a> <em> * <p></em>
<a name="2129" href="#2129">2129</a> <em> * This implementation writes nothing and returns <tt>true</tt>.</em>
<a name="2130" href="#2130">2130</a> <em> * </p></em>
<a name="2131" href="#2131">2131</a> <em> *</em>
<a name="2132" href="#2132">2132</a> <em> * @param state the {@link HttpState state} information associated with this method</em>
<a name="2133" href="#2133">2133</a> <em> * @param conn the {@link HttpConnection connection} used to execute</em>
<a name="2134" href="#2134">2134</a> <em> * this HTTP method</em>
<a name="2135" href="#2135">2135</a> <em> *</em>
<a name="2136" href="#2136">2136</a> <em> * @return <tt>true</tt></em>
<a name="2137" href="#2137">2137</a> <em> *</em>
<a name="2138" href="#2138">2138</a> <em> * @throws IOException if an I/O (transport) error occurs. Some transport exceptions</em>
<a name="2139" href="#2139">2139</a> <em> * can be recovered from.</em>
<a name="2140" href="#2140">2140</a> <em> * @throws HttpException if a protocol exception occurs. Usually protocol exceptions </em>
<a name="2141" href="#2141">2141</a> <em> * cannot be recovered from.</em>
<a name="2142" href="#2142">2142</a> <em> */</em>
<a name="2143" href="#2143">2143</a> <strong>protected</strong> <strong>boolean</strong> writeRequestBody(<a href="../../../../org/apache/commons/httpclient/HttpState.html">HttpState</a> state, <a href="../../../../org/apache/commons/httpclient/HttpConnection.html">HttpConnection</a> conn)
<a name="2144" href="#2144">2144</a> throws IOException, <a href="../../../../org/apache/commons/httpclient/HttpException.html">HttpException</a> {
<a name="2145" href="#2145">2145</a> <strong>return</strong> <strong>true</strong>;
<a name="2146" href="#2146">2146</a> }
<a name="2147" href="#2147">2147</a>
<a name="2148" href="#2148">2148</a> <em>/**</em>
<a name="2149" href="#2149">2149</a> <em> * Writes the request headers to the given {@link HttpConnection connection}.</em>
<a name="2150" href="#2150">2150</a> <em> *</em>
<a name="2151" href="#2151">2151</a> <em> * <p></em>
<a name="2152" href="#2152">2152</a> <em> * This implementation invokes {@link #addRequestHeaders(HttpState,HttpConnection)},</em>
<a name="2153" href="#2153">2153</a> <em> * and then writes each header to the request stream.</em>
<a name="2154" href="#2154">2154</a> <em> * </p></em>
<a name="2155" href="#2155">2155</a> <em> *</em>
<a name="2156" href="#2156">2156</a> <em> * <p></em>
<a name="2157" href="#2157">2157</a> <em> * Subclasses may want to override this method to to customize the</em>
<a name="2158" href="#2158">2158</a> <em> * processing.</em>
<a name="2159" href="#2159">2159</a> <em> * </p></em>
<a name="2160" href="#2160">2160</a> <em> *</em>
<a name="2161" href="#2161">2161</a> <em> * @param state the {@link HttpState state} information associated with this method</em>
<a name="2162" href="#2162">2162</a> <em> * @param conn the {@link HttpConnection connection} used to execute</em>
<a name="2163" href="#2163">2163</a> <em> * this HTTP method</em>
<a name="2164" href="#2164">2164</a> <em> *</em>
<a name="2165" href="#2165">2165</a> <em> * @throws IOException if an I/O (transport) error occurs. Some transport exceptions</em>
<a name="2166" href="#2166">2166</a> <em> * can be recovered from.</em>
<a name="2167" href="#2167">2167</a> <em> * @throws HttpException if a protocol exception occurs. Usually protocol exceptions </em>
<a name="2168" href="#2168">2168</a> <em> * cannot be recovered from.</em>
<a name="2169" href="#2169">2169</a> <em> *</em>
<a name="2170" href="#2170">2170</a> <em> * @see #addRequestHeaders</em>
<a name="2171" href="#2171">2171</a> <em> * @see #getRequestHeaders</em>
<a name="2172" href="#2172">2172</a> <em> */</em>
<a name="2173" href="#2173">2173</a> <strong>protected</strong> <strong>void</strong> writeRequestHeaders(<a href="../../../../org/apache/commons/httpclient/HttpState.html">HttpState</a> state, <a href="../../../../org/apache/commons/httpclient/HttpConnection.html">HttpConnection</a> conn)
<a name="2174" href="#2174">2174</a> throws IOException, <a href="../../../../org/apache/commons/httpclient/HttpException.html">HttpException</a> {
<a name="2175" href="#2175">2175</a> LOG.trace(<span class="string">"enter HttpMethodBase.writeRequestHeaders(HttpState,"</span>
<a name="2176" href="#2176">2176</a> + <span class="string">"HttpConnection)"</span>);
<a name="2177" href="#2177">2177</a> addRequestHeaders(state, conn);
<a name="2178" href="#2178">2178</a>
<a name="2179" href="#2179">2179</a> String charset = getParams().getHttpElementCharset();
<a name="2180" href="#2180">2180</a>
<a name="2181" href="#2181">2181</a> <a href="../../../../org/apache/commons/httpclient/Header.html">Header</a>[] headers = getRequestHeaders();
<a name="2182" href="#2182">2182</a> <strong>for</strong> (<strong>int</strong> i = 0; i < headers.length; i++) {
<a name="2183" href="#2183">2183</a> String s = headers[i].toExternalForm();
<a name="2184" href="#2184">2184</a> <strong>if</strong> (Wire.HEADER_WIRE.enabled()) {
<a name="2185" href="#2185">2185</a> Wire.HEADER_WIRE.output(s);
<a name="2186" href="#2186">2186</a> }
<a name="2187" href="#2187">2187</a> conn.print(s, charset);
<a name="2188" href="#2188">2188</a> }
<a name="2189" href="#2189">2189</a> }
<a name="2190" href="#2190">2190</a>
<a name="2191" href="#2191">2191</a> <em>/**</em>
<a name="2192" href="#2192">2192</a> <em> * Writes the request line to the given {@link HttpConnection connection}.</em>
<a name="2193" href="#2193">2193</a> <em> *</em>
<a name="2194" href="#2194">2194</a> <em> * <p></em>
<a name="2195" href="#2195">2195</a> <em> * Subclasses may want to override this method to to customize the</em>
<a name="2196" href="#2196">2196</a> <em> * processing.</em>
<a name="2197" href="#2197">2197</a> <em> * </p></em>
<a name="2198" href="#2198">2198</a> <em> *</em>
<a name="2199" href="#2199">2199</a> <em> * @param state the {@link HttpState state} information associated with this method</em>
<a name="2200" href="#2200">2200</a> <em> * @param conn the {@link HttpConnection connection} used to execute</em>
<a name="2201" href="#2201">2201</a> <em> * this HTTP method</em>
<a name="2202" href="#2202">2202</a> <em> *</em>
<a name="2203" href="#2203">2203</a> <em> * @throws IOException if an I/O (transport) error occurs. Some transport exceptions</em>
<a name="2204" href="#2204">2204</a> <em> * can be recovered from.</em>
<a name="2205" href="#2205">2205</a> <em> * @throws HttpException if a protocol exception occurs. Usually protocol exceptions </em>
<a name="2206" href="#2206">2206</a> <em> * cannot be recovered from.</em>
<a name="2207" href="#2207">2207</a> <em> *</em>
<a name="2208" href="#2208">2208</a> <em> * @see #generateRequestLine</em>
<a name="2209" href="#2209">2209</a> <em> */</em>
<a name="2210" href="#2210">2210</a> <strong>protected</strong> <strong>void</strong> writeRequestLine(<a href="../../../../org/apache/commons/httpclient/HttpState.html">HttpState</a> state, <a href="../../../../org/apache/commons/httpclient/HttpConnection.html">HttpConnection</a> conn)
<a name="2211" href="#2211">2211</a> throws IOException, <a href="../../../../org/apache/commons/httpclient/HttpException.html">HttpException</a> {
<a name="2212" href="#2212">2212</a> LOG.trace(
<a name="2213" href="#2213">2213</a> <span class="string">"enter HttpMethodBase.writeRequestLine(HttpState, HttpConnection)"</span>);
<a name="2214" href="#2214">2214</a> String requestLine = getRequestLine(conn);
<a name="2215" href="#2215">2215</a> <strong>if</strong> (Wire.HEADER_WIRE.enabled()) {
<a name="2216" href="#2216">2216</a> Wire.HEADER_WIRE.output(requestLine);
<a name="2217" href="#2217">2217</a> }
<a name="2218" href="#2218">2218</a> conn.print(requestLine, getParams().getHttpElementCharset());
<a name="2219" href="#2219">2219</a> }
<a name="2220" href="#2220">2220</a>
<a name="2221" href="#2221">2221</a> <em>/**</em>
<a name="2222" href="#2222">2222</a> <em> * Returns the request line.</em>
<a name="2223" href="#2223">2223</a> <em> * </em>
<a name="2224" href="#2224">2224</a> <em> * @param conn the {@link HttpConnection connection} used to execute</em>
<a name="2225" href="#2225">2225</a> <em> * this HTTP method</em>
<a name="2226" href="#2226">2226</a> <em> * </em>
<a name="2227" href="#2227">2227</a> <em> * @return The request line.</em>
<a name="2228" href="#2228">2228</a> <em> */</em>
<a name="2229" href="#2229">2229</a> <strong>private</strong> String getRequestLine(<a href="../../../../org/apache/commons/httpclient/HttpConnection.html">HttpConnection</a> conn) {
<a name="2230" href="#2230">2230</a> <strong>return</strong> HttpMethodBase.generateRequestLine(conn, getName(),
<a name="2231" href="#2231">2231</a> getPath(), getQueryString(), <strong>this</strong>.effectiveVersion.toString());
<a name="2232" href="#2232">2232</a> }
<a name="2233" href="#2233">2233</a>
<a name="2234" href="#2234">2234</a> <em>/**</em>
<a name="2235" href="#2235">2235</a> <em> * Returns {@link HttpMethodParams HTTP protocol parameters} associated with this method.</em>
<a name="2236" href="#2236">2236</a> <em> *</em>
<a name="2237" href="#2237">2237</a> <em> * @return HTTP parameters.</em>
<a name="2238" href="#2238">2238</a> <em> *</em>
<a name="2239" href="#2239">2239</a> <em> * @since 3.0</em>
<a name="2240" href="#2240">2240</a> <em> */</em>
<a name="2241" href="#2241">2241</a> <strong>public</strong> <a href="../../../../org/apache/commons/httpclient/params/HttpMethodParams.html">HttpMethodParams</a> getParams() {
<a name="2242" href="#2242">2242</a> <strong>return</strong> <strong>this</strong>.params;
<a name="2243" href="#2243">2243</a> }
<a name="2244" href="#2244">2244</a>
<a name="2245" href="#2245">2245</a> <em>/**</em>
<a name="2246" href="#2246">2246</a> <em> * Assigns {@link HttpMethodParams HTTP protocol parameters} for this method.</em>
<a name="2247" href="#2247">2247</a> <em> * </em>
<a name="2248" href="#2248">2248</a> <em> * @since 3.0</em>
<a name="2249" href="#2249">2249</a> <em> * </em>
<a name="2250" href="#2250">2250</a> <em> * @see HttpMethodParams</em>
<a name="2251" href="#2251">2251</a> <em> */</em>
<a name="2252" href="#2252">2252</a> <strong>public</strong> <strong>void</strong> setParams(<strong>final</strong> <a href="../../../../org/apache/commons/httpclient/params/HttpMethodParams.html">HttpMethodParams</a> params) {
<a name="2253" href="#2253">2253</a> <strong>if</strong> (params == <strong>null</strong>) {
<a name="2254" href="#2254">2254</a> <strong>throw</strong> <strong>new</strong> IllegalArgumentException(<span class="string">"Parameters may not be null"</span>);
<a name="2255" href="#2255">2255</a> }
<a name="2256" href="#2256">2256</a> <strong>this</strong>.params = params;
<a name="2257" href="#2257">2257</a> }
<a name="2258" href="#2258">2258</a>
<a name="2259" href="#2259">2259</a> <em>/**</em>
<a name="2260" href="#2260">2260</a> <em> * Returns the HTTP version used with this method (may be <tt>null</tt></em>
<a name="2261" href="#2261">2261</a> <em> * if undefined, that is, the method has not been executed)</em>
<a name="2262" href="#2262">2262</a> <em> *</em>
<a name="2263" href="#2263">2263</a> <em> * @return HTTP version.</em>
<a name="2264" href="#2264">2264</a> <em> *</em>
<a name="2265" href="#2265">2265</a> <em> * @since 3.0</em>
<a name="2266" href="#2266">2266</a> <em> */</em>
<a name="2267" href="#2267">2267</a> <strong>public</strong> <a href="../../../../org/apache/commons/httpclient/HttpVersion.html">HttpVersion</a> getEffectiveVersion() {
<a name="2268" href="#2268">2268</a> <strong>return</strong> <strong>this</strong>.effectiveVersion;
<a name="2269" href="#2269">2269</a> }
<a name="2270" href="#2270">2270</a>
<a name="2271" href="#2271">2271</a> <em>/**</em>
<a name="2272" href="#2272">2272</a> <em> * Per RFC 2616 section 4.3, some response can never contain a message</em>
<a name="2273" href="#2273">2273</a> <em> * body.</em>
<a name="2274" href="#2274">2274</a> <em> *</em>
<a name="2275" href="#2275">2275</a> <em> * @param status - the HTTP status code</em>
<a name="2276" href="#2276">2276</a> <em> *</em>
<a name="2277" href="#2277">2277</a> <em> * @return <tt>true</tt> if the message may contain a body, <tt>false</tt> if it can not</em>
<a name="2278" href="#2278">2278</a> <em> * contain a message body</em>
<a name="2279" href="#2279">2279</a> <em> */</em>
<a name="2280" href="#2280">2280</a> <strong>private</strong> <strong>static</strong> <strong>boolean</strong> canResponseHaveBody(<strong>int</strong> status) {
<a name="2281" href="#2281">2281</a> LOG.trace(<span class="string">"enter HttpMethodBase.canResponseHaveBody(int)"</span>);
<a name="2282" href="#2282">2282</a>
<a name="2283" href="#2283">2283</a> <strong>boolean</strong> result = <strong>true</strong>;
<a name="2284" href="#2284">2284</a>
<a name="2285" href="#2285">2285</a> <strong>if</strong> ((status >= 100 && status <= 199) || (status == 204)
<a name="2286" href="#2286">2286</a> || (status == 304)) { <em class="comment">// NOT MODIFIED</em>
<a name="2287" href="#2287">2287</a> result = false;
<a name="2288" href="#2288">2288</a> }
<a name="2289" href="#2289">2289</a>
<a name="2290" href="#2290">2290</a> <strong>return</strong> result;
<a name="2291" href="#2291">2291</a> }
<a name="2292" href="#2292">2292</a>
<a name="2293" href="#2293">2293</a> <em>/**</em>
<a name="2294" href="#2294">2294</a> <em> * Returns proxy authentication realm, if it has been used during authentication process. </em>
<a name="2295" href="#2295">2295</a> <em> * Otherwise returns <tt>null</tt>.</em>
<a name="2296" href="#2296">2296</a> <em> * </em>
<a name="2297" href="#2297">2297</a> <em> * @return proxy authentication realm</em>
<a name="2298" href="#2298">2298</a> <em> * </em>
<a name="2299" href="#2299">2299</a> <em> * @deprecated use #getProxyAuthState()</em>
<a name="2300" href="#2300">2300</a> <em> */</em>
<a name="2301" href="#2301">2301</a> <strong>public</strong> String getProxyAuthenticationRealm() {
<a name="2302" href="#2302">2302</a> <strong>return</strong> <strong>this</strong>.proxyAuthState.getRealm();
<a name="2303" href="#2303">2303</a> }
<a name="2304" href="#2304">2304</a>
<a name="2305" href="#2305">2305</a> <em>/**</em>
<a name="2306" href="#2306">2306</a> <em> * Returns authentication realm, if it has been used during authentication process. </em>
<a name="2307" href="#2307">2307</a> <em> * Otherwise returns <tt>null</tt>.</em>
<a name="2308" href="#2308">2308</a> <em> * </em>
<a name="2309" href="#2309">2309</a> <em> * @return authentication realm</em>
<a name="2310" href="#2310">2310</a> <em> * </em>
<a name="2311" href="#2311">2311</a> <em> * @deprecated use #getHostAuthState()</em>
<a name="2312" href="#2312">2312</a> <em> */</em>
<a name="2313" href="#2313">2313</a> <strong>public</strong> String getAuthenticationRealm() {
<a name="2314" href="#2314">2314</a> <strong>return</strong> <strong>this</strong>.hostAuthState.getRealm();
<a name="2315" href="#2315">2315</a> }
<a name="2316" href="#2316">2316</a>
<a name="2317" href="#2317">2317</a> <em>/**</em>
<a name="2318" href="#2318">2318</a> <em> * Returns the character set from the <tt>Content-Type</tt> header.</em>
<a name="2319" href="#2319">2319</a> <em> * </em>
<a name="2320" href="#2320">2320</a> <em> * @param contentheader The content header.</em>
<a name="2321" href="#2321">2321</a> <em> * @return String The character set.</em>
<a name="2322" href="#2322">2322</a> <em> */</em>
<a name="2323" href="#2323">2323</a> <strong>protected</strong> String getContentCharSet(<a href="../../../../org/apache/commons/httpclient/Header.html">Header</a> contentheader) {
<a name="2324" href="#2324">2324</a> LOG.trace(<span class="string">"enter getContentCharSet( Header contentheader )"</span>);
<a name="2325" href="#2325">2325</a> String charset = <strong>null</strong>;
<a name="2326" href="#2326">2326</a> <strong>if</strong> (contentheader != <strong>null</strong>) {
<a name="2327" href="#2327">2327</a> <a href="../../../../org/apache/commons/httpclient/HeaderElement.html">HeaderElement</a> values[] = contentheader.getElements();
<a name="2328" href="#2328">2328</a> <em class="comment">// I expect only one header element to be there</em>
<a name="2329" href="#2329">2329</a> <em class="comment">// No more. no less</em>
<a name="2330" href="#2330">2330</a> <strong>if</strong> (values.length == 1) {
<a name="2331" href="#2331">2331</a> <a href="../../../../org/apache/commons/httpclient/NameValuePair.html">NameValuePair</a> param = values[0].getParameterByName(<span class="string">"charset"</span>);
<a name="2332" href="#2332">2332</a> <strong>if</strong> (param != <strong>null</strong>) {
<a name="2333" href="#2333">2333</a> <em class="comment">// If I get anything "funny" </em>
<a name="2334" href="#2334">2334</a> <em class="comment">// UnsupportedEncondingException will result</em>
<a name="2335" href="#2335">2335</a> charset = param.getValue();
<a name="2336" href="#2336">2336</a> }
<a name="2337" href="#2337">2337</a> }
<a name="2338" href="#2338">2338</a> }
<a name="2339" href="#2339">2339</a> <strong>if</strong> (charset == <strong>null</strong>) {
<a name="2340" href="#2340">2340</a> charset = getParams().getContentCharset();
<a name="2341" href="#2341">2341</a> <strong>if</strong> (LOG.isDebugEnabled()) {
<a name="2342" href="#2342">2342</a> LOG.debug(<span class="string">"Default charset used: "</span> + charset);
<a name="2343" href="#2343">2343</a> }
<a name="2344" href="#2344">2344</a> }
<a name="2345" href="#2345">2345</a> <strong>return</strong> charset;
<a name="2346" href="#2346">2346</a> }
<a name="2347" href="#2347">2347</a>
<a name="2348" href="#2348">2348</a>
<a name="2349" href="#2349">2349</a> <em>/**</em>
<a name="2350" href="#2350">2350</a> <em> * Returns the character encoding of the request from the <tt>Content-Type</tt> header.</em>
<a name="2351" href="#2351">2351</a> <em> * </em>
<a name="2352" href="#2352">2352</a> <em> * @return String The character set.</em>
<a name="2353" href="#2353">2353</a> <em> */</em>
<a name="2354" href="#2354">2354</a> <strong>public</strong> String getRequestCharSet() {
<a name="2355" href="#2355">2355</a> <strong>return</strong> getContentCharSet(getRequestHeader(<span class="string">"Content-Type"</span>));
<a name="2356" href="#2356">2356</a> }
<a name="2357" href="#2357">2357</a>
<a name="2358" href="#2358">2358</a>
<a name="2359" href="#2359">2359</a> <em>/**</em><em> </em>
<a name="2360" href="#2360">2360</a> <em> * Returns the character encoding of the response from the <tt>Content-Type</tt> header.</em>
<a name="2361" href="#2361">2361</a> <em> * </em>
<a name="2362" href="#2362">2362</a> <em> * @return String The character set.</em>
<a name="2363" href="#2363">2363</a> <em> */</em>
<a name="2364" href="#2364">2364</a> <strong>public</strong> String getResponseCharSet() {
<a name="2365" href="#2365">2365</a> <strong>return</strong> getContentCharSet(getResponseHeader(<span class="string">"Content-Type"</span>));
<a name="2366" href="#2366">2366</a> }
<a name="2367" href="#2367">2367</a>
<a name="2368" href="#2368">2368</a> <em>/**</em>
<a name="2369" href="#2369">2369</a> <em> * @deprecated no longer used</em>
<a name="2370" href="#2370">2370</a> <em> * </em>
<a name="2371" href="#2371">2371</a> <em> * Returns the number of "recoverable" exceptions thrown and handled, to</em>
<a name="2372" href="#2372">2372</a> <em> * allow for monitoring the quality of the connection.</em>
<a name="2373" href="#2373">2373</a> <em> *</em>
<a name="2374" href="#2374">2374</a> <em> * @return The number of recoverable exceptions handled by the method.</em>
<a name="2375" href="#2375">2375</a> <em> */</em>
<a name="2376" href="#2376">2376</a> <strong>public</strong> <strong>int</strong> getRecoverableExceptionCount() {
<a name="2377" href="#2377">2377</a> <strong>return</strong> recoverableExceptionCount;
<a name="2378" href="#2378">2378</a> }
<a name="2379" href="#2379">2379</a>
<a name="2380" href="#2380">2380</a> <em>/**</em>
<a name="2381" href="#2381">2381</a> <em> * A response has been consumed.</em>
<a name="2382" href="#2382">2382</a> <em> *</em>
<a name="2383" href="#2383">2383</a> <em> * <p>The default behavior for this class is to check to see if the connection</em>
<a name="2384" href="#2384">2384</a> <em> * should be closed, and close if need be, and to ensure that the connection</em>
<a name="2385" href="#2385">2385</a> <em> * is returned to the connection manager - if and only if we are not still</em>
<a name="2386" href="#2386">2386</a> <em> * inside the execute call.</p></em>
<a name="2387" href="#2387">2387</a> <em> *</em>
<a name="2388" href="#2388">2388</a> <em> */</em>
<a name="2389" href="#2389">2389</a> <strong>protected</strong> <strong>void</strong> responseBodyConsumed() {
<a name="2390" href="#2390">2390</a>
<a name="2391" href="#2391">2391</a> <em class="comment">// make sure this is the initial invocation of the notification,</em>
<a name="2392" href="#2392">2392</a> <em class="comment">// ignore subsequent ones.</em>
<a name="2393" href="#2393">2393</a> responseStream = <strong>null</strong>;
<a name="2394" href="#2394">2394</a> <strong>if</strong> (responseConnection != <strong>null</strong>) {
<a name="2395" href="#2395">2395</a> responseConnection.setLastResponseInputStream(<strong>null</strong>);
<a name="2396" href="#2396">2396</a>
<a name="2397" href="#2397">2397</a> <em class="comment">// At this point, no response data should be available.</em>
<a name="2398" href="#2398">2398</a> <em class="comment">// If there is data available, regard the connection as being</em>
<a name="2399" href="#2399">2399</a> <em class="comment">// unreliable and close it.</em>
<a name="2400" href="#2400">2400</a>
<a name="2401" href="#2401">2401</a> <strong>if</strong> (shouldCloseConnection(responseConnection)) {
<a name="2402" href="#2402">2402</a> responseConnection.close();
<a name="2403" href="#2403">2403</a> } <strong>else</strong> {
<a name="2404" href="#2404">2404</a> <strong>try</strong> {
<a name="2405" href="#2405">2405</a> <strong>if</strong>(responseConnection.isResponseAvailable()) {
<a name="2406" href="#2406">2406</a> <strong>boolean</strong> logExtraInput =
<a name="2407" href="#2407">2407</a> getParams().isParameterTrue(HttpMethodParams.WARN_EXTRA_INPUT);
<a name="2408" href="#2408">2408</a>
<a name="2409" href="#2409">2409</a> <strong>if</strong>(logExtraInput) {
<a name="2410" href="#2410">2410</a> LOG.warn(<span class="string">"Extra response data detected - closing connection"</span>);
<a name="2411" href="#2411">2411</a> }
<a name="2412" href="#2412">2412</a> responseConnection.close();
<a name="2413" href="#2413">2413</a> }
<a name="2414" href="#2414">2414</a> }
<a name="2415" href="#2415">2415</a> <strong>catch</strong> (IOException e) {
<a name="2416" href="#2416">2416</a> LOG.warn(e.getMessage());
<a name="2417" href="#2417">2417</a> responseConnection.close();
<a name="2418" href="#2418">2418</a> }
<a name="2419" href="#2419">2419</a> }
<a name="2420" href="#2420">2420</a> }
<a name="2421" href="#2421">2421</a> <strong>this</strong>.connectionCloseForced = false;
<a name="2422" href="#2422">2422</a> ensureConnectionRelease();
<a name="2423" href="#2423">2423</a> }
<a name="2424" href="#2424">2424</a>
<a name="2425" href="#2425">2425</a> <em>/**</em>
<a name="2426" href="#2426">2426</a> <em> * Insure that the connection is released back to the pool.</em>
<a name="2427" href="#2427">2427</a> <em> */</em>
<a name="2428" href="#2428">2428</a> <strong>private</strong> <strong>void</strong> ensureConnectionRelease() {
<a name="2429" href="#2429">2429</a> <strong>if</strong> (responseConnection != <strong>null</strong>) {
<a name="2430" href="#2430">2430</a> responseConnection.releaseConnection();
<a name="2431" href="#2431">2431</a> responseConnection = <strong>null</strong>;
<a name="2432" href="#2432">2432</a> }
<a name="2433" href="#2433">2433</a> }
<a name="2434" href="#2434">2434</a>
<a name="2435" href="#2435">2435</a> <em>/**</em>
<a name="2436" href="#2436">2436</a> <em> * Returns the {@link HostConfiguration host configuration}.</em>
<a name="2437" href="#2437">2437</a> <em> * </em>
<a name="2438" href="#2438">2438</a> <em> * @return the host configuration</em>
<a name="2439" href="#2439">2439</a> <em> * </em>
<a name="2440" href="#2440">2440</a> <em> * @deprecated no longer applicable</em>
<a name="2441" href="#2441">2441</a> <em> */</em>
<a name="2442" href="#2442">2442</a> <strong>public</strong> <a href="../../../../org/apache/commons/httpclient/HostConfiguration.html">HostConfiguration</a> getHostConfiguration() {
<a name="2443" href="#2443">2443</a> <a href="../../../../org/apache/commons/httpclient/HostConfiguration.html">HostConfiguration</a> hostconfig = <strong>new</strong> <a href="../../../../org/apache/commons/httpclient/HostConfiguration.html">HostConfiguration</a>();
<a name="2444" href="#2444">2444</a> hostconfig.setHost(<strong>this</strong>.httphost);
<a name="2445" href="#2445">2445</a> <strong>return</strong> hostconfig;
<a name="2446" href="#2446">2446</a> }
<a name="2447" href="#2447">2447</a> <em>/**</em>
<a name="2448" href="#2448">2448</a> <em> * Sets the {@link HostConfiguration host configuration}.</em>
<a name="2449" href="#2449">2449</a> <em> * </em>
<a name="2450" href="#2450">2450</a> <em> * @param hostconfig The hostConfiguration to set</em>
<a name="2451" href="#2451">2451</a> <em> * </em>
<a name="2452" href="#2452">2452</a> <em> * @deprecated no longer applicable</em>
<a name="2453" href="#2453">2453</a> <em> */</em>
<a name="2454" href="#2454">2454</a> <strong>public</strong> <strong>void</strong> setHostConfiguration(<strong>final</strong> <a href="../../../../org/apache/commons/httpclient/HostConfiguration.html">HostConfiguration</a> hostconfig) {
<a name="2455" href="#2455">2455</a> <strong>if</strong> (hostconfig != <strong>null</strong>) {
<a name="2456" href="#2456">2456</a> <strong>this</strong>.httphost = <strong>new</strong> <a href="../../../../org/apache/commons/httpclient/HttpHost.html">HttpHost</a>(
<a name="2457" href="#2457">2457</a> hostconfig.getHost(),
<a name="2458" href="#2458">2458</a> hostconfig.getPort(),
<a name="2459" href="#2459">2459</a> hostconfig.getProtocol());
<a name="2460" href="#2460">2460</a> } <strong>else</strong> {
<a name="2461" href="#2461">2461</a> <strong>this</strong>.httphost = <strong>null</strong>;
<a name="2462" href="#2462">2462</a> }
<a name="2463" href="#2463">2463</a> }
<a name="2464" href="#2464">2464</a>
<a name="2465" href="#2465">2465</a> <em>/**</em>
<a name="2466" href="#2466">2466</a> <em> * Returns the {@link MethodRetryHandler retry handler} for this HTTP method</em>
<a name="2467" href="#2467">2467</a> <em> * </em>
<a name="2468" href="#2468">2468</a> <em> * @return the methodRetryHandler</em>
<a name="2469" href="#2469">2469</a> <em> * </em>
<a name="2470" href="#2470">2470</a> <em> * @deprecated use {@link HttpMethodParams}</em>
<a name="2471" href="#2471">2471</a> <em> */</em>
<a name="2472" href="#2472">2472</a> <strong>public</strong> <a href="../../../../org/apache/commons/httpclient/MethodRetryHandler.html">MethodRetryHandler</a> getMethodRetryHandler() {
<a name="2473" href="#2473">2473</a> <strong>return</strong> methodRetryHandler;
<a name="2474" href="#2474">2474</a> }
<a name="2475" href="#2475">2475</a>
<a name="2476" href="#2476">2476</a> <em>/**</em>
<a name="2477" href="#2477">2477</a> <em> * Sets the {@link MethodRetryHandler retry handler} for this HTTP method</em>
<a name="2478" href="#2478">2478</a> <em> * </em>
<a name="2479" href="#2479">2479</a> <em> * @param handler the methodRetryHandler to use when this method executed</em>
<a name="2480" href="#2480">2480</a> <em> * </em>
<a name="2481" href="#2481">2481</a> <em> * @deprecated use {@link HttpMethodParams}</em>
<a name="2482" href="#2482">2482</a> <em> */</em>
<a name="2483" href="#2483">2483</a> <strong>public</strong> <strong>void</strong> setMethodRetryHandler(<a href="../../../../org/apache/commons/httpclient/MethodRetryHandler.html">MethodRetryHandler</a> handler) {
<a name="2484" href="#2484">2484</a> methodRetryHandler = handler;
<a name="2485" href="#2485">2485</a> }
<a name="2486" href="#2486">2486</a>
<a name="2487" href="#2487">2487</a> <em>/**</em>
<a name="2488" href="#2488">2488</a> <em> * This method is a dirty hack intended to work around </em>
<a name="2489" href="#2489">2489</a> <em> * current (2.0) design flaw that prevents the user from</em>
<a name="2490" href="#2490">2490</a> <em> * obtaining correct status code, headers and response body from the </em>
<a name="2491" href="#2491">2491</a> <em> * preceding HTTP CONNECT method.</em>
<a name="2492" href="#2492">2492</a> <em> * </em>
<a name="2493" href="#2493">2493</a> <em> * TODO: Remove this crap as soon as possible</em>
<a name="2494" href="#2494">2494</a> <em> */</em>
<a name="2495" href="#2495">2495</a> <strong>void</strong> fakeResponse(
<a name="2496" href="#2496">2496</a> <a href="../../../../org/apache/commons/httpclient/StatusLine.html">StatusLine</a> statusline,
<a name="2497" href="#2497">2497</a> <a href="../../../../org/apache/commons/httpclient/HeaderGroup.html">HeaderGroup</a> responseheaders,
<a name="2498" href="#2498">2498</a> InputStream responseStream
<a name="2499" href="#2499">2499</a> ) {
<a name="2500" href="#2500">2500</a> <em class="comment">// set used so that the response can be read</em>
<a name="2501" href="#2501">2501</a> <strong>this</strong>.used = <strong>true</strong>;
<a name="2502" href="#2502">2502</a> <strong>this</strong>.statusLine = statusline;
<a name="2503" href="#2503">2503</a> <strong>this</strong>.responseHeaders = responseheaders;
<a name="2504" href="#2504">2504</a> <strong>this</strong>.responseBody = <strong>null</strong>;
<a name="2505" href="#2505">2505</a> <strong>this</strong>.responseStream = responseStream;
<a name="2506" href="#2506">2506</a> }
<a name="2507" href="#2507">2507</a>
<a name="2508" href="#2508">2508</a> <em>/**</em>
<a name="2509" href="#2509">2509</a> <em> * Returns the target host {@link AuthState authentication state}</em>
<a name="2510" href="#2510">2510</a> <em> * </em>
<a name="2511" href="#2511">2511</a> <em> * @return host authentication state</em>
<a name="2512" href="#2512">2512</a> <em> * </em>
<a name="2513" href="#2513">2513</a> <em> * @since 3.0</em>
<a name="2514" href="#2514">2514</a> <em> */</em>
<a name="2515" href="#2515">2515</a> <strong>public</strong> <a href="../../../../org/apache/commons/httpclient/auth/AuthState.html">AuthState</a> getHostAuthState() {
<a name="2516" href="#2516">2516</a> <strong>return</strong> <strong>this</strong>.hostAuthState;
<a name="2517" href="#2517">2517</a> }
<a name="2518" href="#2518">2518</a>
<a name="2519" href="#2519">2519</a> <em>/**</em>
<a name="2520" href="#2520">2520</a> <em> * Returns the proxy {@link AuthState authentication state}</em>
<a name="2521" href="#2521">2521</a> <em> * </em>
<a name="2522" href="#2522">2522</a> <em> * @return host authentication state</em>
<a name="2523" href="#2523">2523</a> <em> * </em>
<a name="2524" href="#2524">2524</a> <em> * @since 3.0</em>
<a name="2525" href="#2525">2525</a> <em> */</em>
<a name="2526" href="#2526">2526</a> <strong>public</strong> <a href="../../../../org/apache/commons/httpclient/auth/AuthState.html">AuthState</a> getProxyAuthState() {
<a name="2527" href="#2527">2527</a> <strong>return</strong> <strong>this</strong>.proxyAuthState;
<a name="2528" href="#2528">2528</a> }
<a name="2529" href="#2529">2529</a>
<a name="2530" href="#2530">2530</a> <em>/**</em>
<a name="2531" href="#2531">2531</a> <em> * Tests whether the execution of this method has been aborted</em>
<a name="2532" href="#2532">2532</a> <em> * </em>
<a name="2533" href="#2533">2533</a> <em> * @return <tt>true</tt> if the execution of this method has been aborted,</em>
<a name="2534" href="#2534">2534</a> <em> * <tt>false</tt> otherwise</em>
<a name="2535" href="#2535">2535</a> <em> * </em>
<a name="2536" href="#2536">2536</a> <em> * @since 3.0</em>
<a name="2537" href="#2537">2537</a> <em> */</em>
<a name="2538" href="#2538">2538</a> <strong>public</strong> <strong>boolean</strong> isAborted() {
<a name="2539" href="#2539">2539</a> <strong>return</strong> <strong>this</strong>.aborted;
<a name="2540" href="#2540">2540</a> }
<a name="2541" href="#2541">2541</a>
<a name="2542" href="#2542">2542</a> <em>/**</em>
<a name="2543" href="#2543">2543</a> <em> * Returns <tt>true</tt> if the HTTP has been transmitted to the target</em>
<a name="2544" href="#2544">2544</a> <em> * server in its entirety, <tt>false</tt> otherwise. This flag can be useful </em>
<a name="2545" href="#2545">2545</a> <em> * for recovery logic. If the request has not been transmitted in its entirety,</em>
<a name="2546" href="#2546">2546</a> <em> * it is safe to retry the failed method.</em>
<a name="2547" href="#2547">2547</a> <em> * </em>
<a name="2548" href="#2548">2548</a> <em> * @return <tt>true</tt> if the request has been sent, <tt>false</tt> otherwise</em>
<a name="2549" href="#2549">2549</a> <em> */</em>
<a name="2550" href="#2550">2550</a> <strong>public</strong> <strong>boolean</strong> isRequestSent() {
<a name="2551" href="#2551">2551</a> <strong>return</strong> <strong>this</strong>.requestSent;
<a name="2552" href="#2552">2552</a> }
<a name="2553" href="#2553">2553</a>
<a name="2554" href="#2554">2554</a> }
</pre>
<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
</html>
|
