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
|
<!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>HttpConnection xref</title>
<link type="text/css" rel="stylesheet" href="../../../../stylesheet.css" />
</head>
<body>
<div id="overview"><a href="../../../../../apidocs/org/apache/commons/httpclient/HttpConnection.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/HttpConnection.java,v 1.107 2005/01/14 21:30:59 olegk Exp $</em>
<a name="3" href="#3">3</a> <em class="comment"> * $Revision: 480424 $</em>
<a name="4" href="#4">4</a> <em class="comment"> * $Date: 2006-11-29 06:56:49 +0100 (Wed, 29 Nov 2006) $</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.BufferedInputStream;
<a name="34" href="#34">34</a> <strong>import</strong> java.io.BufferedOutputStream;
<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.io.OutputStream;
<a name="39" href="#39">39</a> <strong>import</strong> java.lang.reflect.Method;
<a name="40" href="#40">40</a> <strong>import</strong> java.net.InetAddress;
<a name="41" href="#41">41</a> <strong>import</strong> java.net.Socket;
<a name="42" href="#42">42</a> <strong>import</strong> java.net.SocketException;
<a name="43" href="#43">43</a>
<a name="44" href="#44">44</a> <strong>import</strong> org.apache.commons.httpclient.params.HttpConnectionParams;
<a name="45" href="#45">45</a> <strong>import</strong> org.apache.commons.httpclient.protocol.Protocol;
<a name="46" href="#46">46</a> <strong>import</strong> org.apache.commons.httpclient.protocol.ProtocolSocketFactory;
<a name="47" href="#47">47</a> <strong>import</strong> org.apache.commons.httpclient.protocol.SecureProtocolSocketFactory;
<a name="48" href="#48">48</a> <strong>import</strong> org.apache.commons.httpclient.util.EncodingUtil;
<a name="49" href="#49">49</a> <strong>import</strong> org.apache.commons.httpclient.util.ExceptionUtil;
<a name="50" href="#50">50</a> <strong>import</strong> org.apache.commons.logging.Log;
<a name="51" href="#51">51</a> <strong>import</strong> org.apache.commons.logging.LogFactory;
<a name="52" href="#52">52</a>
<a name="53" href="#53">53</a> <em>/**</em>
<a name="54" href="#54">54</a> <em> * An abstraction of an HTTP {@link InputStream} and {@link OutputStream}</em>
<a name="55" href="#55">55</a> <em> * pair, together with the relevant attributes.</em>
<a name="56" href="#56">56</a> <em> * <p></em>
<a name="57" href="#57">57</a> <em> * The following options are set on the socket before getting the input/output </em>
<a name="58" href="#58">58</a> <em> * streams in the {@link #open()} method:</em>
<a name="59" href="#59">59</a> <em> * <table border=1><tr></em>
<a name="60" href="#60">60</a> <em> * <th>Socket Method</em>
<a name="61" href="#61">61</a> <em> * <th>Sockets Option</em>
<a name="62" href="#62">62</a> <em> * <th>Configuration</em>
<a name="63" href="#63">63</a> <em> * </tr><tr></em>
<a name="64" href="#64">64</a> <em> * <td>{@link java.net.Socket#setTcpNoDelay(boolean)}</em>
<a name="65" href="#65">65</a> <em> * <td>SO_NODELAY</em>
<a name="66" href="#66">66</a> <em> * <td>{@link HttpConnectionParams#setTcpNoDelay(boolean)}</em>
<a name="67" href="#67">67</a> <em> * </tr><tr></em>
<a name="68" href="#68">68</a> <em> * <td>{@link java.net.Socket#setSoTimeout(int)}</em>
<a name="69" href="#69">69</a> <em> * <td>SO_TIMEOUT</em>
<a name="70" href="#70">70</a> <em> * <td>{@link HttpConnectionParams#setSoTimeout(int)}</em>
<a name="71" href="#71">71</a> <em> * </tr><tr></em>
<a name="72" href="#72">72</a> <em> * <td>{@link java.net.Socket#setSendBufferSize(int)}</em>
<a name="73" href="#73">73</a> <em> * <td>SO_SNDBUF</em>
<a name="74" href="#74">74</a> <em> * <td>{@link HttpConnectionParams#setSendBufferSize(int)}</em>
<a name="75" href="#75">75</a> <em> * </tr><tr></em>
<a name="76" href="#76">76</a> <em> * <td>{@link java.net.Socket#setReceiveBufferSize(int)}</em>
<a name="77" href="#77">77</a> <em> * <td>SO_RCVBUF</em>
<a name="78" href="#78">78</a> <em> * <td>{@link HttpConnectionParams#setReceiveBufferSize(int)}</em>
<a name="79" href="#79">79</a> <em> * </tr></table></em>
<a name="80" href="#80">80</a> <em> *</em>
<a name="81" href="#81">81</a> <em> * @author Rod Waldhoff</em>
<a name="82" href="#82">82</a> <em> * @author Sean C. Sullivan</em>
<a name="83" href="#83">83</a> <em> * @author Ortwin Glueck</em>
<a name="84" href="#84">84</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="85" href="#85">85</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="86" href="#86">86</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="87" href="#87">87</a> <em> * @author Michael Becke</em>
<a name="88" href="#88">88</a> <em> * @author Eric E Johnson</em>
<a name="89" href="#89">89</a> <em> * @author Laura Werner</em>
<a name="90" href="#90">90</a> <em> * </em>
<a name="91" href="#91">91</a> <em> * @version $Revision: 480424 $ $Date: 2006-11-29 06:56:49 +0100 (Wed, 29 Nov 2006) $</em>
<a name="92" href="#92">92</a> <em> */</em>
<a name="93" href="#93">93</a> <strong>public</strong> <strong>class</strong> <a href="../../../../org/apache/commons/httpclient/HttpConnection.html">HttpConnection</a> {
<a name="94" href="#94">94</a>
<a name="95" href="#95">95</a> <em class="comment">// ----------------------------------------------------------- Constructors</em>
<a name="96" href="#96">96</a>
<a name="97" href="#97">97</a> <em>/**</em>
<a name="98" href="#98">98</a> <em> * Creates a new HTTP connection for the given host and port.</em>
<a name="99" href="#99">99</a> <em> *</em>
<a name="100" href="#100">100</a> <em> * @param host the host to connect to</em>
<a name="101" href="#101">101</a> <em> * @param port the port to connect to</em>
<a name="102" href="#102">102</a> <em> */</em>
<a name="103" href="#103">103</a> <strong>public</strong> <a href="../../../../org/apache/commons/httpclient/HttpConnection.html">HttpConnection</a>(String host, <strong>int</strong> port) {
<a name="104" href="#104">104</a> <strong>this</strong>(<strong>null</strong>, -1, host, <strong>null</strong>, port, Protocol.getProtocol(<span class="string">"http"</span>));
<a name="105" href="#105">105</a> }
<a name="106" href="#106">106</a>
<a name="107" href="#107">107</a> <em>/**</em>
<a name="108" href="#108">108</a> <em> * Creates a new HTTP connection for the given host and port</em>
<a name="109" href="#109">109</a> <em> * using the given protocol.</em>
<a name="110" href="#110">110</a> <em> *</em>
<a name="111" href="#111">111</a> <em> * @param host the host to connect to</em>
<a name="112" href="#112">112</a> <em> * @param port the port to connect to</em>
<a name="113" href="#113">113</a> <em> * @param protocol the protocol to use</em>
<a name="114" href="#114">114</a> <em> */</em>
<a name="115" href="#115">115</a> <strong>public</strong> <a href="../../../../org/apache/commons/httpclient/HttpConnection.html">HttpConnection</a>(String host, <strong>int</strong> port, <a href="../../../../org/apache/commons/httpclient/protocol/Protocol.html">Protocol</a> protocol) {
<a name="116" href="#116">116</a> <strong>this</strong>(<strong>null</strong>, -1, host, <strong>null</strong>, port, protocol);
<a name="117" href="#117">117</a> }
<a name="118" href="#118">118</a>
<a name="119" href="#119">119</a> <em>/**</em>
<a name="120" href="#120">120</a> <em> * Creates a new HTTP connection for the given host with the virtual </em>
<a name="121" href="#121">121</a> <em> * alias and port using given protocol.</em>
<a name="122" href="#122">122</a> <em> *</em>
<a name="123" href="#123">123</a> <em> * @param host the host to connect to</em>
<a name="124" href="#124">124</a> <em> * @param virtualHost the virtual host requests will be sent to</em>
<a name="125" href="#125">125</a> <em> * @param port the port to connect to</em>
<a name="126" href="#126">126</a> <em> * @param protocol the protocol to use</em>
<a name="127" href="#127">127</a> <em> */</em>
<a name="128" href="#128">128</a> <strong>public</strong> <a href="../../../../org/apache/commons/httpclient/HttpConnection.html">HttpConnection</a>(String host, String virtualHost, <strong>int</strong> port, <a href="../../../../org/apache/commons/httpclient/protocol/Protocol.html">Protocol</a> protocol) {
<a name="129" href="#129">129</a> <strong>this</strong>(<strong>null</strong>, -1, host, virtualHost, port, protocol);
<a name="130" href="#130">130</a> }
<a name="131" href="#131">131</a>
<a name="132" href="#132">132</a> <em>/**</em>
<a name="133" href="#133">133</a> <em> * Creates a new HTTP connection for the given host and port via the </em>
<a name="134" href="#134">134</a> <em> * given proxy host and port using the default protocol.</em>
<a name="135" href="#135">135</a> <em> *</em>
<a name="136" href="#136">136</a> <em> * @param proxyHost the host to proxy via</em>
<a name="137" href="#137">137</a> <em> * @param proxyPort the port to proxy via</em>
<a name="138" href="#138">138</a> <em> * @param host the host to connect to</em>
<a name="139" href="#139">139</a> <em> * @param port the port to connect to</em>
<a name="140" href="#140">140</a> <em> */</em>
<a name="141" href="#141">141</a> <strong>public</strong> <a href="../../../../org/apache/commons/httpclient/HttpConnection.html">HttpConnection</a>(
<a name="142" href="#142">142</a> String proxyHost,
<a name="143" href="#143">143</a> <strong>int</strong> proxyPort,
<a name="144" href="#144">144</a> String host,
<a name="145" href="#145">145</a> <strong>int</strong> port) {
<a name="146" href="#146">146</a> <strong>this</strong>(proxyHost, proxyPort, host, <strong>null</strong>, port, Protocol.getProtocol(<span class="string">"http"</span>));
<a name="147" href="#147">147</a> }
<a name="148" href="#148">148</a>
<a name="149" href="#149">149</a> <em>/**</em>
<a name="150" href="#150">150</a> <em> * Creates a new HTTP connection for the given host configuration.</em>
<a name="151" href="#151">151</a> <em> * </em>
<a name="152" href="#152">152</a> <em> * @param hostConfiguration the host/proxy/protocol to use</em>
<a name="153" href="#153">153</a> <em> */</em>
<a name="154" href="#154">154</a> <strong>public</strong> <a href="../../../../org/apache/commons/httpclient/HttpConnection.html">HttpConnection</a>(<a href="../../../../org/apache/commons/httpclient/HostConfiguration.html">HostConfiguration</a> hostConfiguration) {
<a name="155" href="#155">155</a> <strong>this</strong>(hostConfiguration.getProxyHost(),
<a name="156" href="#156">156</a> hostConfiguration.getProxyPort(),
<a name="157" href="#157">157</a> hostConfiguration.getHost(),
<a name="158" href="#158">158</a> hostConfiguration.getPort(),
<a name="159" href="#159">159</a> hostConfiguration.getProtocol());
<a name="160" href="#160">160</a> <strong>this</strong>.localAddress = hostConfiguration.getLocalAddress();
<a name="161" href="#161">161</a> }
<a name="162" href="#162">162</a>
<a name="163" href="#163">163</a> <em>/**</em>
<a name="164" href="#164">164</a> <em> * Creates a new HTTP connection for the given host with the virtual </em>
<a name="165" href="#165">165</a> <em> * alias and port via the given proxy host and port using the given </em>
<a name="166" href="#166">166</a> <em> * protocol.</em>
<a name="167" href="#167">167</a> <em> * </em>
<a name="168" href="#168">168</a> <em> * @param proxyHost the host to proxy via</em>
<a name="169" href="#169">169</a> <em> * @param proxyPort the port to proxy via</em>
<a name="170" href="#170">170</a> <em> * @param host the host to connect to. Parameter value must be non-null.</em>
<a name="171" href="#171">171</a> <em> * @param virtualHost No longer applicable. </em>
<a name="172" href="#172">172</a> <em> * @param port the port to connect to</em>
<a name="173" href="#173">173</a> <em> * @param protocol The protocol to use. Parameter value must be non-null.</em>
<a name="174" href="#174">174</a> <em> * </em>
<a name="175" href="#175">175</a> <em> * @deprecated use #HttpConnection(String, int, String, int, Protocol)</em>
<a name="176" href="#176">176</a> <em> */</em>
<a name="177" href="#177">177</a> <strong>public</strong> <a href="../../../../org/apache/commons/httpclient/HttpConnection.html">HttpConnection</a>(
<a name="178" href="#178">178</a> String proxyHost,
<a name="179" href="#179">179</a> <strong>int</strong> proxyPort,
<a name="180" href="#180">180</a> String host,
<a name="181" href="#181">181</a> String virtualHost,
<a name="182" href="#182">182</a> <strong>int</strong> port,
<a name="183" href="#183">183</a> <a href="../../../../org/apache/commons/httpclient/protocol/Protocol.html">Protocol</a> protocol) {
<a name="184" href="#184">184</a> <strong>this</strong>(proxyHost, proxyPort, host, port, protocol);
<a name="185" href="#185">185</a> }
<a name="186" href="#186">186</a>
<a name="187" href="#187">187</a> <em>/**</em>
<a name="188" href="#188">188</a> <em> * Creates a new HTTP connection for the given host with the virtual </em>
<a name="189" href="#189">189</a> <em> * alias and port via the given proxy host and port using the given </em>
<a name="190" href="#190">190</a> <em> * protocol.</em>
<a name="191" href="#191">191</a> <em> * </em>
<a name="192" href="#192">192</a> <em> * @param proxyHost the host to proxy via</em>
<a name="193" href="#193">193</a> <em> * @param proxyPort the port to proxy via</em>
<a name="194" href="#194">194</a> <em> * @param host the host to connect to. Parameter value must be non-null.</em>
<a name="195" href="#195">195</a> <em> * @param port the port to connect to</em>
<a name="196" href="#196">196</a> <em> * @param protocol The protocol to use. Parameter value must be non-null.</em>
<a name="197" href="#197">197</a> <em> */</em>
<a name="198" href="#198">198</a> <strong>public</strong> <a href="../../../../org/apache/commons/httpclient/HttpConnection.html">HttpConnection</a>(
<a name="199" href="#199">199</a> String proxyHost,
<a name="200" href="#200">200</a> <strong>int</strong> proxyPort,
<a name="201" href="#201">201</a> String host,
<a name="202" href="#202">202</a> <strong>int</strong> port,
<a name="203" href="#203">203</a> <a href="../../../../org/apache/commons/httpclient/protocol/Protocol.html">Protocol</a> protocol) {
<a name="204" href="#204">204</a>
<a name="205" href="#205">205</a> <strong>if</strong> (host == <strong>null</strong>) {
<a name="206" href="#206">206</a> <strong>throw</strong> <strong>new</strong> IllegalArgumentException(<span class="string">"host parameter is null"</span>);
<a name="207" href="#207">207</a> }
<a name="208" href="#208">208</a> <strong>if</strong> (protocol == <strong>null</strong>) {
<a name="209" href="#209">209</a> <strong>throw</strong> <strong>new</strong> IllegalArgumentException(<span class="string">"protocol is null"</span>);
<a name="210" href="#210">210</a> }
<a name="211" href="#211">211</a>
<a name="212" href="#212">212</a> proxyHostName = proxyHost;
<a name="213" href="#213">213</a> proxyPortNumber = proxyPort;
<a name="214" href="#214">214</a> hostName = host;
<a name="215" href="#215">215</a> portNumber = protocol.resolvePort(port);
<a name="216" href="#216">216</a> protocolInUse = protocol;
<a name="217" href="#217">217</a> }
<a name="218" href="#218">218</a>
<a name="219" href="#219">219</a> <em class="comment">// ------------------------------------------ Attribute Setters and Getters</em>
<a name="220" href="#220">220</a>
<a name="221" href="#221">221</a> <em>/**</em>
<a name="222" href="#222">222</a> <em> * Returns the connection socket.</em>
<a name="223" href="#223">223</a> <em> *</em>
<a name="224" href="#224">224</a> <em> * @return the socket.</em>
<a name="225" href="#225">225</a> <em> * </em>
<a name="226" href="#226">226</a> <em> * @since 3.0</em>
<a name="227" href="#227">227</a> <em> */</em>
<a name="228" href="#228">228</a> <strong>protected</strong> Socket getSocket() {
<a name="229" href="#229">229</a> <strong>return</strong> <strong>this</strong>.socket;
<a name="230" href="#230">230</a> }
<a name="231" href="#231">231</a>
<a name="232" href="#232">232</a> <em>/**</em>
<a name="233" href="#233">233</a> <em> * Returns the host.</em>
<a name="234" href="#234">234</a> <em> *</em>
<a name="235" href="#235">235</a> <em> * @return the host.</em>
<a name="236" href="#236">236</a> <em> */</em>
<a name="237" href="#237">237</a> <strong>public</strong> String getHost() {
<a name="238" href="#238">238</a> <strong>return</strong> hostName;
<a name="239" href="#239">239</a> }
<a name="240" href="#240">240</a>
<a name="241" href="#241">241</a> <em>/**</em>
<a name="242" href="#242">242</a> <em> * Sets the host to connect to.</em>
<a name="243" href="#243">243</a> <em> *</em>
<a name="244" href="#244">244</a> <em> * @param host the host to connect to. Parameter value must be non-null.</em>
<a name="245" href="#245">245</a> <em> * @throws IllegalStateException if the connection is already open</em>
<a name="246" href="#246">246</a> <em> */</em>
<a name="247" href="#247">247</a> <strong>public</strong> <strong>void</strong> setHost(String host) throws IllegalStateException {
<a name="248" href="#248">248</a> <strong>if</strong> (host == <strong>null</strong>) {
<a name="249" href="#249">249</a> <strong>throw</strong> <strong>new</strong> IllegalArgumentException(<span class="string">"host parameter is null"</span>);
<a name="250" href="#250">250</a> }
<a name="251" href="#251">251</a> assertNotOpen();
<a name="252" href="#252">252</a> hostName = host;
<a name="253" href="#253">253</a> }
<a name="254" href="#254">254</a>
<a name="255" href="#255">255</a> <em>/**</em>
<a name="256" href="#256">256</a> <em> * Returns the target virtual host.</em>
<a name="257" href="#257">257</a> <em> *</em>
<a name="258" href="#258">258</a> <em> * @return the virtual host.</em>
<a name="259" href="#259">259</a> <em> * </em>
<a name="260" href="#260">260</a> <em> * @deprecated no longer applicable</em>
<a name="261" href="#261">261</a> <em> */</em>
<a name="262" href="#262">262</a>
<a name="263" href="#263">263</a> <strong>public</strong> String getVirtualHost() {
<a name="264" href="#264">264</a> <strong>return</strong> <strong>this</strong>.hostName;
<a name="265" href="#265">265</a> }
<a name="266" href="#266">266</a>
<a name="267" href="#267">267</a> <em>/**</em>
<a name="268" href="#268">268</a> <em> * Sets the virtual host to target.</em>
<a name="269" href="#269">269</a> <em> *</em>
<a name="270" href="#270">270</a> <em> * @param host the virtual host name that should be used instead of </em>
<a name="271" href="#271">271</a> <em> * physical host name when sending HTTP requests. Virtual host </em>
<a name="272" href="#272">272</a> <em> * name can be set to <tt> null</tt> if virtual host name is not</em>
<a name="273" href="#273">273</a> <em> * to be used</em>
<a name="274" href="#274">274</a> <em> * </em>
<a name="275" href="#275">275</a> <em> * @throws IllegalStateException if the connection is already open</em>
<a name="276" href="#276">276</a> <em> * </em>
<a name="277" href="#277">277</a> <em> * @deprecated no longer applicable</em>
<a name="278" href="#278">278</a> <em> */</em>
<a name="279" href="#279">279</a>
<a name="280" href="#280">280</a> <strong>public</strong> <strong>void</strong> setVirtualHost(String host) throws IllegalStateException {
<a name="281" href="#281">281</a> assertNotOpen();
<a name="282" href="#282">282</a> }
<a name="283" href="#283">283</a>
<a name="284" href="#284">284</a> <em>/**</em>
<a name="285" href="#285">285</a> <em> * Returns the port of the host.</em>
<a name="286" href="#286">286</a> <em> *</em>
<a name="287" href="#287">287</a> <em> * If the port is -1 (or less than 0) the default port for</em>
<a name="288" href="#288">288</a> <em> * the current protocol is returned.</em>
<a name="289" href="#289">289</a> <em> *</em>
<a name="290" href="#290">290</a> <em> * @return the port.</em>
<a name="291" href="#291">291</a> <em> */</em>
<a name="292" href="#292">292</a> <strong>public</strong> <strong>int</strong> getPort() {
<a name="293" href="#293">293</a> <strong>if</strong> (portNumber < 0) {
<a name="294" href="#294">294</a> <strong>return</strong> isSecure() ? 443 : 80;
<a name="295" href="#295">295</a> } <strong>else</strong> {
<a name="296" href="#296">296</a> <strong>return</strong> portNumber;
<a name="297" href="#297">297</a> }
<a name="298" href="#298">298</a> }
<a name="299" href="#299">299</a>
<a name="300" href="#300">300</a> <em>/**</em>
<a name="301" href="#301">301</a> <em> * Sets the port to connect to.</em>
<a name="302" href="#302">302</a> <em> *</em>
<a name="303" href="#303">303</a> <em> * @param port the port to connect to</em>
<a name="304" href="#304">304</a> <em> * </em>
<a name="305" href="#305">305</a> <em> * @throws IllegalStateException if the connection is already open</em>
<a name="306" href="#306">306</a> <em> */</em>
<a name="307" href="#307">307</a> <strong>public</strong> <strong>void</strong> setPort(<strong>int</strong> port) throws IllegalStateException {
<a name="308" href="#308">308</a> assertNotOpen();
<a name="309" href="#309">309</a> portNumber = port;
<a name="310" href="#310">310</a> }
<a name="311" href="#311">311</a>
<a name="312" href="#312">312</a> <em>/**</em>
<a name="313" href="#313">313</a> <em> * Returns the proxy host.</em>
<a name="314" href="#314">314</a> <em> *</em>
<a name="315" href="#315">315</a> <em> * @return the proxy host.</em>
<a name="316" href="#316">316</a> <em> */</em>
<a name="317" href="#317">317</a> <strong>public</strong> String getProxyHost() {
<a name="318" href="#318">318</a> <strong>return</strong> proxyHostName;
<a name="319" href="#319">319</a> }
<a name="320" href="#320">320</a>
<a name="321" href="#321">321</a> <em>/**</em>
<a name="322" href="#322">322</a> <em> * Sets the host to proxy through.</em>
<a name="323" href="#323">323</a> <em> *</em>
<a name="324" href="#324">324</a> <em> * @param host the host to proxy through.</em>
<a name="325" href="#325">325</a> <em> * </em>
<a name="326" href="#326">326</a> <em> * @throws IllegalStateException if the connection is already open</em>
<a name="327" href="#327">327</a> <em> */</em>
<a name="328" href="#328">328</a> <strong>public</strong> <strong>void</strong> setProxyHost(String host) throws IllegalStateException {
<a name="329" href="#329">329</a> assertNotOpen();
<a name="330" href="#330">330</a> proxyHostName = host;
<a name="331" href="#331">331</a> }
<a name="332" href="#332">332</a>
<a name="333" href="#333">333</a> <em>/**</em>
<a name="334" href="#334">334</a> <em> * Returns the port of the proxy host.</em>
<a name="335" href="#335">335</a> <em> *</em>
<a name="336" href="#336">336</a> <em> * @return the proxy port.</em>
<a name="337" href="#337">337</a> <em> */</em>
<a name="338" href="#338">338</a> <strong>public</strong> <strong>int</strong> getProxyPort() {
<a name="339" href="#339">339</a> <strong>return</strong> proxyPortNumber;
<a name="340" href="#340">340</a> }
<a name="341" href="#341">341</a>
<a name="342" href="#342">342</a> <em>/**</em>
<a name="343" href="#343">343</a> <em> * Sets the port of the host to proxy through.</em>
<a name="344" href="#344">344</a> <em> *</em>
<a name="345" href="#345">345</a> <em> * @param port the port of the host to proxy through.</em>
<a name="346" href="#346">346</a> <em> * </em>
<a name="347" href="#347">347</a> <em> * @throws IllegalStateException if the connection is already open</em>
<a name="348" href="#348">348</a> <em> */</em>
<a name="349" href="#349">349</a> <strong>public</strong> <strong>void</strong> setProxyPort(<strong>int</strong> port) throws IllegalStateException {
<a name="350" href="#350">350</a> assertNotOpen();
<a name="351" href="#351">351</a> proxyPortNumber = port;
<a name="352" href="#352">352</a> }
<a name="353" href="#353">353</a>
<a name="354" href="#354">354</a> <em>/**</em>
<a name="355" href="#355">355</a> <em> * Returns <tt>true</tt> if the connection is established over </em>
<a name="356" href="#356">356</a> <em> * a secure protocol.</em>
<a name="357" href="#357">357</a> <em> *</em>
<a name="358" href="#358">358</a> <em> * @return <tt>true</tt> if connected over a secure protocol.</em>
<a name="359" href="#359">359</a> <em> */</em>
<a name="360" href="#360">360</a> <strong>public</strong> <strong>boolean</strong> isSecure() {
<a name="361" href="#361">361</a> <strong>return</strong> protocolInUse.isSecure();
<a name="362" href="#362">362</a> }
<a name="363" href="#363">363</a>
<a name="364" href="#364">364</a> <em>/**</em>
<a name="365" href="#365">365</a> <em> * Returns the protocol used to establish the connection.</em>
<a name="366" href="#366">366</a> <em> * @return The protocol</em>
<a name="367" href="#367">367</a> <em> */</em>
<a name="368" href="#368">368</a> <strong>public</strong> <a href="../../../../org/apache/commons/httpclient/protocol/Protocol.html">Protocol</a> getProtocol() {
<a name="369" href="#369">369</a> <strong>return</strong> protocolInUse;
<a name="370" href="#370">370</a> }
<a name="371" href="#371">371</a>
<a name="372" href="#372">372</a> <em>/**</em>
<a name="373" href="#373">373</a> <em> * Sets the protocol used to establish the connection</em>
<a name="374" href="#374">374</a> <em> * </em>
<a name="375" href="#375">375</a> <em> * @param protocol The protocol to use.</em>
<a name="376" href="#376">376</a> <em> * </em>
<a name="377" href="#377">377</a> <em> * @throws IllegalStateException if the connection is already open</em>
<a name="378" href="#378">378</a> <em> */</em>
<a name="379" href="#379">379</a> <strong>public</strong> <strong>void</strong> setProtocol(<a href="../../../../org/apache/commons/httpclient/protocol/Protocol.html">Protocol</a> protocol) {
<a name="380" href="#380">380</a> assertNotOpen();
<a name="381" href="#381">381</a>
<a name="382" href="#382">382</a> <strong>if</strong> (protocol == <strong>null</strong>) {
<a name="383" href="#383">383</a> <strong>throw</strong> <strong>new</strong> IllegalArgumentException(<span class="string">"protocol is null"</span>);
<a name="384" href="#384">384</a> }
<a name="385" href="#385">385</a>
<a name="386" href="#386">386</a> protocolInUse = protocol;
<a name="387" href="#387">387</a>
<a name="388" href="#388">388</a> }
<a name="389" href="#389">389</a>
<a name="390" href="#390">390</a> <em>/**</em>
<a name="391" href="#391">391</a> <em> * Return the local address used when creating the connection.</em>
<a name="392" href="#392">392</a> <em> * If <tt>null</tt>, the default address is used.</em>
<a name="393" href="#393">393</a> <em> * </em>
<a name="394" href="#394">394</a> <em> * @return InetAddress the local address to be used when creating Sockets</em>
<a name="395" href="#395">395</a> <em> */</em>
<a name="396" href="#396">396</a> <strong>public</strong> InetAddress getLocalAddress() {
<a name="397" href="#397">397</a> <strong>return</strong> <strong>this</strong>.localAddress;
<a name="398" href="#398">398</a> }
<a name="399" href="#399">399</a>
<a name="400" href="#400">400</a> <em>/**</em>
<a name="401" href="#401">401</a> <em> * Set the local address used when creating the connection.</em>
<a name="402" href="#402">402</a> <em> * If unset or <tt>null</tt>, the default address is used.</em>
<a name="403" href="#403">403</a> <em> * </em>
<a name="404" href="#404">404</a> <em> * @param localAddress the local address to use</em>
<a name="405" href="#405">405</a> <em> */</em>
<a name="406" href="#406">406</a> <strong>public</strong> <strong>void</strong> setLocalAddress(InetAddress localAddress) {
<a name="407" href="#407">407</a> assertNotOpen();
<a name="408" href="#408">408</a> <strong>this</strong>.localAddress = localAddress;
<a name="409" href="#409">409</a> }
<a name="410" href="#410">410</a>
<a name="411" href="#411">411</a> <em>/**</em>
<a name="412" href="#412">412</a> <em> * Tests if the connection is open. </em>
<a name="413" href="#413">413</a> <em> *</em>
<a name="414" href="#414">414</a> <em> * @return <code>true</code> if the connection is open</em>
<a name="415" href="#415">415</a> <em> */</em>
<a name="416" href="#416">416</a> <strong>public</strong> <strong>boolean</strong> isOpen() {
<a name="417" href="#417">417</a> <strong>return</strong> isOpen;
<a name="418" href="#418">418</a> }
<a name="419" href="#419">419</a>
<a name="420" href="#420">420</a> <em>/**</em>
<a name="421" href="#421">421</a> <em> * Closes the connection if stale.</em>
<a name="422" href="#422">422</a> <em> * </em>
<a name="423" href="#423">423</a> <em> * @return <code>true</code> if the connection was stale and therefore closed, </em>
<a name="424" href="#424">424</a> <em> * <code>false</code> otherwise.</em>
<a name="425" href="#425">425</a> <em> * </em>
<a name="426" href="#426">426</a> <em> * @see #isStale()</em>
<a name="427" href="#427">427</a> <em> * </em>
<a name="428" href="#428">428</a> <em> * @since 3.0</em>
<a name="429" href="#429">429</a> <em> */</em>
<a name="430" href="#430">430</a> <strong>public</strong> <strong>boolean</strong> closeIfStale() throws IOException {
<a name="431" href="#431">431</a> <strong>if</strong> (isOpen && isStale()) {
<a name="432" href="#432">432</a> LOG.debug(<span class="string">"Connection is stale, closing..."</span>);
<a name="433" href="#433">433</a> close();
<a name="434" href="#434">434</a> <strong>return</strong> <strong>true</strong>;
<a name="435" href="#435">435</a> }
<a name="436" href="#436">436</a> <strong>return</strong> false;
<a name="437" href="#437">437</a> }
<a name="438" href="#438">438</a>
<a name="439" href="#439">439</a> <em>/**</em>
<a name="440" href="#440">440</a> <em> * Tests if stale checking is enabled.</em>
<a name="441" href="#441">441</a> <em> * </em>
<a name="442" href="#442">442</a> <em> * @return <code>true</code> if enabled</em>
<a name="443" href="#443">443</a> <em> * </em>
<a name="444" href="#444">444</a> <em> * @see #isStale()</em>
<a name="445" href="#445">445</a> <em> * </em>
<a name="446" href="#446">446</a> <em> * @deprecated Use {@link HttpConnectionParams#isStaleCheckingEnabled()},</em>
<a name="447" href="#447">447</a> <em> * {@link HttpConnection#getParams()}.</em>
<a name="448" href="#448">448</a> <em> */</em>
<a name="449" href="#449">449</a> <strong>public</strong> <strong>boolean</strong> isStaleCheckingEnabled() {
<a name="450" href="#450">450</a> <strong>return</strong> <strong>this</strong>.params.isStaleCheckingEnabled();
<a name="451" href="#451">451</a> }
<a name="452" href="#452">452</a>
<a name="453" href="#453">453</a> <em>/**</em>
<a name="454" href="#454">454</a> <em> * Sets whether or not isStale() will be called when testing if this connection is open.</em>
<a name="455" href="#455">455</a> <em> * </em>
<a name="456" href="#456">456</a> <em> * <p>Setting this flag to <code>false</code> will increase performance when reusing</em>
<a name="457" href="#457">457</a> <em> * connections, but it will also make them less reliable. Stale checking ensures that</em>
<a name="458" href="#458">458</a> <em> * connections are viable before they are used. When set to <code>false</code> some</em>
<a name="459" href="#459">459</a> <em> * method executions will result in IOExceptions and they will have to be retried.</p></em>
<a name="460" href="#460">460</a> <em> * </em>
<a name="461" href="#461">461</a> <em> * @param staleCheckEnabled <code>true</code> to enable isStale()</em>
<a name="462" href="#462">462</a> <em> * </em>
<a name="463" href="#463">463</a> <em> * @see #isStale()</em>
<a name="464" href="#464">464</a> <em> * @see #isOpen()</em>
<a name="465" href="#465">465</a> <em> * </em>
<a name="466" href="#466">466</a> <em> * @deprecated Use {@link HttpConnectionParams#setStaleCheckingEnabled(boolean)},</em>
<a name="467" href="#467">467</a> <em> * {@link HttpConnection#getParams()}.</em>
<a name="468" href="#468">468</a> <em> */</em>
<a name="469" href="#469">469</a> <strong>public</strong> <strong>void</strong> setStaleCheckingEnabled(<strong>boolean</strong> staleCheckEnabled) {
<a name="470" href="#470">470</a> <strong>this</strong>.params.setStaleCheckingEnabled(staleCheckEnabled);
<a name="471" href="#471">471</a> }
<a name="472" href="#472">472</a>
<a name="473" href="#473">473</a> <em>/**</em>
<a name="474" href="#474">474</a> <em> * Determines whether this connection is "stale", which is to say that either</em>
<a name="475" href="#475">475</a> <em> * it is no longer open, or an attempt to read the connection would fail.</em>
<a name="476" href="#476">476</a> <em> *</em>
<a name="477" href="#477">477</a> <em> * <p>Unfortunately, due to the limitations of the JREs prior to 1.4, it is</em>
<a name="478" href="#478">478</a> <em> * not possible to test a connection to see if both the read and write channels</em>
<a name="479" href="#479">479</a> <em> * are open - except by reading and writing. This leads to a difficulty when</em>
<a name="480" href="#480">480</a> <em> * some connections leave the "write" channel open, but close the read channel</em>
<a name="481" href="#481">481</a> <em> * and ignore the request. This function attempts to ameliorate that</em>
<a name="482" href="#482">482</a> <em> * problem by doing a test read, assuming that the caller will be doing a</em>
<a name="483" href="#483">483</a> <em> * write followed by a read, rather than the other way around.</em>
<a name="484" href="#484">484</a> <em> * </p></em>
<a name="485" href="#485">485</a> <em> *</em>
<a name="486" href="#486">486</a> <em> * <p>To avoid side-effects, the underlying connection is wrapped by a</em>
<a name="487" href="#487">487</a> <em> * {@link BufferedInputStream}, so although data might be read, what is visible</em>
<a name="488" href="#488">488</a> <em> * to clients of the connection will not change with this call.</p.</em>
<a name="489" href="#489">489</a> <em> *</em>
<a name="490" href="#490">490</a> <em> * @throws IOException if the stale connection test is interrupted.</em>
<a name="491" href="#491">491</a> <em> * </em>
<a name="492" href="#492">492</a> <em> * @return <tt>true</tt> if the connection is already closed, or a read would</em>
<a name="493" href="#493">493</a> <em> * fail.</em>
<a name="494" href="#494">494</a> <em> */</em>
<a name="495" href="#495">495</a> <strong>protected</strong> <strong>boolean</strong> isStale() throws IOException {
<a name="496" href="#496">496</a> <strong>boolean</strong> isStale = <strong>true</strong>;
<a name="497" href="#497">497</a> <strong>if</strong> (isOpen) {
<a name="498" href="#498">498</a> <em class="comment">// the connection is open, but now we have to see if we can read it</em>
<a name="499" href="#499">499</a> <em class="comment">// assume the connection is not stale.</em>
<a name="500" href="#500">500</a> isStale = false;
<a name="501" href="#501">501</a> <strong>try</strong> {
<a name="502" href="#502">502</a> <strong>if</strong> (inputStream.available() <= 0) {
<a name="503" href="#503">503</a> <strong>try</strong> {
<a name="504" href="#504">504</a> socket.setSoTimeout(1);
<a name="505" href="#505">505</a> inputStream.mark(1);
<a name="506" href="#506">506</a> <strong>int</strong> byteRead = inputStream.read();
<a name="507" href="#507">507</a> <strong>if</strong> (byteRead == -1) {
<a name="508" href="#508">508</a> <em class="comment">// again - if the socket is reporting all data read,</em>
<a name="509" href="#509">509</a> <em class="comment">// probably stale</em>
<a name="510" href="#510">510</a> isStale = <strong>true</strong>;
<a name="511" href="#511">511</a> } <strong>else</strong> {
<a name="512" href="#512">512</a> inputStream.reset();
<a name="513" href="#513">513</a> }
<a name="514" href="#514">514</a> } <strong>finally</strong> {
<a name="515" href="#515">515</a> socket.setSoTimeout(<strong>this</strong>.params.getSoTimeout());
<a name="516" href="#516">516</a> }
<a name="517" href="#517">517</a> }
<a name="518" href="#518">518</a> } <strong>catch</strong> (InterruptedIOException e) {
<a name="519" href="#519">519</a> <strong>if</strong> (!ExceptionUtil.isSocketTimeoutException(e)) {
<a name="520" href="#520">520</a> <strong>throw</strong> e;
<a name="521" href="#521">521</a> }
<a name="522" href="#522">522</a> <em class="comment">// aha - the connection is NOT stale - continue on!</em>
<a name="523" href="#523">523</a> } <strong>catch</strong> (IOException e) {
<a name="524" href="#524">524</a> <em class="comment">// oops - the connection is stale, the read or soTimeout failed.</em>
<a name="525" href="#525">525</a> LOG.debug(
<a name="526" href="#526">526</a> <span class="string">"An error occurred while reading from the socket, is appears to be stale"</span>,
<a name="527" href="#527">527</a> e
<a name="528" href="#528">528</a> );
<a name="529" href="#529">529</a> isStale = <strong>true</strong>;
<a name="530" href="#530">530</a> }
<a name="531" href="#531">531</a> }
<a name="532" href="#532">532</a>
<a name="533" href="#533">533</a> <strong>return</strong> isStale;
<a name="534" href="#534">534</a> }
<a name="535" href="#535">535</a>
<a name="536" href="#536">536</a> <em>/**</em>
<a name="537" href="#537">537</a> <em> * Returns <tt>true</tt> if the connection is established via a proxy,</em>
<a name="538" href="#538">538</a> <em> * <tt>false</tt> otherwise.</em>
<a name="539" href="#539">539</a> <em> *</em>
<a name="540" href="#540">540</a> <em> * @return <tt>true</tt> if a proxy is used to establish the connection, </em>
<a name="541" href="#541">541</a> <em> * <tt>false</tt> otherwise.</em>
<a name="542" href="#542">542</a> <em> */</em>
<a name="543" href="#543">543</a> <strong>public</strong> <strong>boolean</strong> isProxied() {
<a name="544" href="#544">544</a> <strong>return</strong> (!(<strong>null</strong> == proxyHostName || 0 >= proxyPortNumber));
<a name="545" href="#545">545</a> }
<a name="546" href="#546">546</a>
<a name="547" href="#547">547</a> <em>/**</em>
<a name="548" href="#548">548</a> <em> * Set the state to keep track of the last response for the last request.</em>
<a name="549" href="#549">549</a> <em> *</em>
<a name="550" href="#550">550</a> <em> * <p>The connection managers use this to ensure that previous requests are</em>
<a name="551" href="#551">551</a> <em> * properly closed before a new request is attempted. That way, a GET</em>
<a name="552" href="#552">552</a> <em> * request need not be read in its entirety before a new request is issued.</em>
<a name="553" href="#553">553</a> <em> * Instead, this stream can be closed as appropriate.</p></em>
<a name="554" href="#554">554</a> <em> *</em>
<a name="555" href="#555">555</a> <em> * @param inStream The stream associated with an HttpMethod.</em>
<a name="556" href="#556">556</a> <em> */</em>
<a name="557" href="#557">557</a> <strong>public</strong> <strong>void</strong> setLastResponseInputStream(InputStream inStream) {
<a name="558" href="#558">558</a> lastResponseInputStream = inStream;
<a name="559" href="#559">559</a> }
<a name="560" href="#560">560</a>
<a name="561" href="#561">561</a> <em>/**</em>
<a name="562" href="#562">562</a> <em> * Returns the stream used to read the last response's body.</em>
<a name="563" href="#563">563</a> <em> *</em>
<a name="564" href="#564">564</a> <em> * <p>Clients will generally not need to call this function unless</em>
<a name="565" href="#565">565</a> <em> * using HttpConnection directly, instead of calling {@link HttpClient#executeMethod}.</em>
<a name="566" href="#566">566</a> <em> * For those clients, call this function, and if it returns a non-null stream,</em>
<a name="567" href="#567">567</a> <em> * close the stream before attempting to execute a method. Note that</em>
<a name="568" href="#568">568</a> <em> * calling "close" on the stream returned by this function <i>may</i> close</em>
<a name="569" href="#569">569</a> <em> * the connection if the previous response contained a "Connection: close" header. </p></em>
<a name="570" href="#570">570</a> <em> *</em>
<a name="571" href="#571">571</a> <em> * @return An {@link InputStream} corresponding to the body of the last</em>
<a name="572" href="#572">572</a> <em> * response.</em>
<a name="573" href="#573">573</a> <em> */</em>
<a name="574" href="#574">574</a> <strong>public</strong> InputStream getLastResponseInputStream() {
<a name="575" href="#575">575</a> <strong>return</strong> lastResponseInputStream;
<a name="576" href="#576">576</a> }
<a name="577" href="#577">577</a>
<a name="578" href="#578">578</a> <em class="comment">// --------------------------------------------------- Other Public Methods</em>
<a name="579" href="#579">579</a>
<a name="580" href="#580">580</a> <em>/**</em>
<a name="581" href="#581">581</a> <em> * Returns {@link HttpConnectionParams HTTP protocol parameters} associated with this method.</em>
<a name="582" href="#582">582</a> <em> *</em>
<a name="583" href="#583">583</a> <em> * @return HTTP parameters.</em>
<a name="584" href="#584">584</a> <em> *</em>
<a name="585" href="#585">585</a> <em> * @since 3.0</em>
<a name="586" href="#586">586</a> <em> */</em>
<a name="587" href="#587">587</a> <strong>public</strong> <a href="../../../../org/apache/commons/httpclient/params/HttpConnectionParams.html">HttpConnectionParams</a> getParams() {
<a name="588" href="#588">588</a> <strong>return</strong> <strong>this</strong>.params;
<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> * Assigns {@link HttpConnectionParams HTTP protocol parameters} for this method.</em>
<a name="593" href="#593">593</a> <em> * </em>
<a name="594" href="#594">594</a> <em> * @since 3.0</em>
<a name="595" href="#595">595</a> <em> * </em>
<a name="596" href="#596">596</a> <em> * @see HttpConnectionParams</em>
<a name="597" href="#597">597</a> <em> */</em>
<a name="598" href="#598">598</a> <strong>public</strong> <strong>void</strong> setParams(<strong>final</strong> <a href="../../../../org/apache/commons/httpclient/params/HttpConnectionParams.html">HttpConnectionParams</a> params) {
<a name="599" href="#599">599</a> <strong>if</strong> (params == <strong>null</strong>) {
<a name="600" href="#600">600</a> <strong>throw</strong> <strong>new</strong> IllegalArgumentException(<span class="string">"Parameters may not be null"</span>);
<a name="601" href="#601">601</a> }
<a name="602" href="#602">602</a> <strong>this</strong>.params = params;
<a name="603" href="#603">603</a> }
<a name="604" href="#604">604</a>
<a name="605" href="#605">605</a> <em>/**</em>
<a name="606" href="#606">606</a> <em> * Set the {@link Socket}'s timeout, via {@link Socket#setSoTimeout}. If the</em>
<a name="607" href="#607">607</a> <em> * connection is already open, the SO_TIMEOUT is changed. If no connection</em>
<a name="608" href="#608">608</a> <em> * is open, then subsequent connections will use the timeout value.</em>
<a name="609" href="#609">609</a> <em> * <p></em>
<a name="610" href="#610">610</a> <em> * Note: This is not a connection timeout but a timeout on network traffic!</em>
<a name="611" href="#611">611</a> <em> *</em>
<a name="612" href="#612">612</a> <em> * @param timeout the timeout value</em>
<a name="613" href="#613">613</a> <em> * @throws SocketException - if there is an error in the underlying</em>
<a name="614" href="#614">614</a> <em> * protocol, such as a TCP error.</em>
<a name="615" href="#615">615</a> <em> * </em>
<a name="616" href="#616">616</a> <em> * @deprecated Use {@link HttpConnectionParams#setSoTimeout(int)},</em>
<a name="617" href="#617">617</a> <em> * {@link HttpConnection#getParams()}.</em>
<a name="618" href="#618">618</a> <em> */</em>
<a name="619" href="#619">619</a> <strong>public</strong> <strong>void</strong> setSoTimeout(<strong>int</strong> timeout)
<a name="620" href="#620">620</a> throws SocketException, IllegalStateException {
<a name="621" href="#621">621</a> <strong>this</strong>.params.setSoTimeout(timeout);
<a name="622" href="#622">622</a> <strong>if</strong> (<strong>this</strong>.socket != <strong>null</strong>) {
<a name="623" href="#623">623</a> <strong>this</strong>.socket.setSoTimeout(timeout);
<a name="624" href="#624">624</a> }
<a name="625" href="#625">625</a> }
<a name="626" href="#626">626</a>
<a name="627" href="#627">627</a> <em>/**</em>
<a name="628" href="#628">628</a> <em> * Sets <code>SO_TIMEOUT</code> value directly on the underlying {@link Socket socket}. </em>
<a name="629" href="#629">629</a> <em> * This method does not change the default read timeout value set via </em>
<a name="630" href="#630">630</a> <em> * {@link HttpConnectionParams}.</em>
<a name="631" href="#631">631</a> <em> *</em>
<a name="632" href="#632">632</a> <em> * @param timeout the timeout value</em>
<a name="633" href="#633">633</a> <em> * @throws SocketException - if there is an error in the underlying</em>
<a name="634" href="#634">634</a> <em> * protocol, such as a TCP error.</em>
<a name="635" href="#635">635</a> <em> * @throws IllegalStateException if not connected</em>
<a name="636" href="#636">636</a> <em> * </em>
<a name="637" href="#637">637</a> <em> * @since 3.0</em>
<a name="638" href="#638">638</a> <em> */</em>
<a name="639" href="#639">639</a> <strong>public</strong> <strong>void</strong> setSocketTimeout(<strong>int</strong> timeout)
<a name="640" href="#640">640</a> throws SocketException, IllegalStateException {
<a name="641" href="#641">641</a> assertOpen();
<a name="642" href="#642">642</a> <strong>if</strong> (<strong>this</strong>.socket != <strong>null</strong>) {
<a name="643" href="#643">643</a> <strong>this</strong>.socket.setSoTimeout(timeout);
<a name="644" href="#644">644</a> }
<a name="645" href="#645">645</a> }
<a name="646" href="#646">646</a>
<a name="647" href="#647">647</a> <em>/**</em>
<a name="648" href="#648">648</a> <em> * Returns the {@link Socket}'s timeout, via {@link Socket#getSoTimeout}, if the</em>
<a name="649" href="#649">649</a> <em> * connection is already open. If no connection is open, return the value subsequent </em>
<a name="650" href="#650">650</a> <em> * connection will use.</em>
<a name="651" href="#651">651</a> <em> * <p></em>
<a name="652" href="#652">652</a> <em> * Note: This is not a connection timeout but a timeout on network traffic!</em>
<a name="653" href="#653">653</a> <em> *</em>
<a name="654" href="#654">654</a> <em> * @return the timeout value</em>
<a name="655" href="#655">655</a> <em> * </em>
<a name="656" href="#656">656</a> <em> * @deprecated Use {@link HttpConnectionParams#getSoTimeout()},</em>
<a name="657" href="#657">657</a> <em> * {@link HttpConnection#getParams()}.</em>
<a name="658" href="#658">658</a> <em> */</em>
<a name="659" href="#659">659</a> <strong>public</strong> <strong>int</strong> getSoTimeout() throws SocketException {
<a name="660" href="#660">660</a> <strong>return</strong> <strong>this</strong>.params.getSoTimeout();
<a name="661" href="#661">661</a> }
<a name="662" href="#662">662</a>
<a name="663" href="#663">663</a> <em>/**</em>
<a name="664" href="#664">664</a> <em> * Sets the connection timeout. This is the maximum time that may be spent</em>
<a name="665" href="#665">665</a> <em> * until a connection is established. The connection will fail after this</em>
<a name="666" href="#666">666</a> <em> * amount of time.</em>
<a name="667" href="#667">667</a> <em> * @param timeout The timeout in milliseconds. 0 means timeout is not used.</em>
<a name="668" href="#668">668</a> <em> * </em>
<a name="669" href="#669">669</a> <em> * @deprecated Use {@link HttpConnectionParams#setConnectionTimeout(int)},</em>
<a name="670" href="#670">670</a> <em> * {@link HttpConnection#getParams()}.</em>
<a name="671" href="#671">671</a> <em> */</em>
<a name="672" href="#672">672</a> <strong>public</strong> <strong>void</strong> setConnectionTimeout(<strong>int</strong> timeout) {
<a name="673" href="#673">673</a> <strong>this</strong>.params.setConnectionTimeout(timeout);
<a name="674" href="#674">674</a> }
<a name="675" href="#675">675</a>
<a name="676" href="#676">676</a> <em>/**</em>
<a name="677" href="#677">677</a> <em> * Establishes a connection to the specified host and port</em>
<a name="678" href="#678">678</a> <em> * (via a proxy if specified).</em>
<a name="679" href="#679">679</a> <em> * The underlying socket is created from the {@link ProtocolSocketFactory}.</em>
<a name="680" href="#680">680</a> <em> *</em>
<a name="681" href="#681">681</a> <em> * @throws IOException if an attempt to establish the connection results in an</em>
<a name="682" href="#682">682</a> <em> * I/O error.</em>
<a name="683" href="#683">683</a> <em> */</em>
<a name="684" href="#684">684</a> <strong>public</strong> <strong>void</strong> open() throws IOException {
<a name="685" href="#685">685</a> LOG.trace(<span class="string">"enter HttpConnection.open()"</span>);
<a name="686" href="#686">686</a>
<a name="687" href="#687">687</a> <strong>final</strong> String host = (proxyHostName == <strong>null</strong>) ? hostName : proxyHostName;
<a name="688" href="#688">688</a> <strong>final</strong> <strong>int</strong> port = (proxyHostName == <strong>null</strong>) ? portNumber : proxyPortNumber;
<a name="689" href="#689">689</a> assertNotOpen();
<a name="690" href="#690">690</a>
<a name="691" href="#691">691</a> <strong>if</strong> (LOG.isDebugEnabled()) {
<a name="692" href="#692">692</a> LOG.debug(<span class="string">"Open connection to "</span> + host + <span class="string">":"</span> + port);
<a name="693" href="#693">693</a> }
<a name="694" href="#694">694</a>
<a name="695" href="#695">695</a> <strong>try</strong> {
<a name="696" href="#696">696</a> <strong>if</strong> (<strong>this</strong>.socket == <strong>null</strong>) {
<a name="697" href="#697">697</a> usingSecureSocket = isSecure() && !isProxied();
<a name="698" href="#698">698</a> <em class="comment">// use the protocol's socket factory unless this is a secure</em>
<a name="699" href="#699">699</a> <em class="comment">// proxied connection</em>
<a name="700" href="#700">700</a> <a href="../../../../org/apache/commons/httpclient/protocol/ProtocolSocketFactory.html">ProtocolSocketFactory</a> socketFactory = <strong>null</strong>;
<a name="701" href="#701">701</a> <strong>if</strong> (isSecure() && isProxied()) {
<a name="702" href="#702">702</a> <a href="../../../../org/apache/commons/httpclient/protocol/Protocol.html">Protocol</a> defaultprotocol = Protocol.getProtocol(<span class="string">"http"</span>);
<a name="703" href="#703">703</a> socketFactory = defaultprotocol.getSocketFactory();
<a name="704" href="#704">704</a> } <strong>else</strong> {
<a name="705" href="#705">705</a> socketFactory = <strong>this</strong>.protocolInUse.getSocketFactory();
<a name="706" href="#706">706</a> }
<a name="707" href="#707">707</a> <strong>this</strong>.socket = socketFactory.createSocket(
<a name="708" href="#708">708</a> host, port,
<a name="709" href="#709">709</a> localAddress, 0,
<a name="710" href="#710">710</a> <strong>this</strong>.params);
<a name="711" href="#711">711</a> }
<a name="712" href="#712">712</a>
<a name="713" href="#713">713</a> <em class="comment">/*</em>
<a name="714" href="#714">714</a> <em class="comment"> "Nagling has been broadly implemented across networks, </em>
<a name="715" href="#715">715</a> <em class="comment"> including the Internet, and is generally performed by default </em>
<a name="716" href="#716">716</a> <em class="comment"> - although it is sometimes considered to be undesirable in </em>
<a name="717" href="#717">717</a> <em class="comment"> highly interactive environments, such as some client/server </em>
<a name="718" href="#718">718</a> <em class="comment"> situations. In such cases, nagling may be turned off through </em>
<a name="719" href="#719">719</a> <em class="comment"> use of the TCP_NODELAY sockets option." */</em>
<a name="720" href="#720">720</a>
<a name="721" href="#721">721</a> socket.setTcpNoDelay(<strong>this</strong>.params.getTcpNoDelay());
<a name="722" href="#722">722</a> socket.setSoTimeout(<strong>this</strong>.params.getSoTimeout());
<a name="723" href="#723">723</a>
<a name="724" href="#724">724</a> <strong>int</strong> linger = <strong>this</strong>.params.getLinger();
<a name="725" href="#725">725</a> <strong>if</strong> (linger >= 0) {
<a name="726" href="#726">726</a> socket.setSoLinger(linger > 0, linger);
<a name="727" href="#727">727</a> }
<a name="728" href="#728">728</a>
<a name="729" href="#729">729</a> <strong>int</strong> sndBufSize = <strong>this</strong>.params.getSendBufferSize();
<a name="730" href="#730">730</a> <strong>if</strong> (sndBufSize >= 0) {
<a name="731" href="#731">731</a> socket.setSendBufferSize(sndBufSize);
<a name="732" href="#732">732</a> }
<a name="733" href="#733">733</a> <strong>int</strong> rcvBufSize = <strong>this</strong>.params.getReceiveBufferSize();
<a name="734" href="#734">734</a> <strong>if</strong> (rcvBufSize >= 0) {
<a name="735" href="#735">735</a> socket.setReceiveBufferSize(rcvBufSize);
<a name="736" href="#736">736</a> }
<a name="737" href="#737">737</a> <strong>int</strong> outbuffersize = socket.getSendBufferSize();
<a name="738" href="#738">738</a> <strong>if</strong> ((outbuffersize > 2048) || (outbuffersize <= 0)) {
<a name="739" href="#739">739</a> outbuffersize = 2048;
<a name="740" href="#740">740</a> }
<a name="741" href="#741">741</a> <strong>int</strong> inbuffersize = socket.getReceiveBufferSize();
<a name="742" href="#742">742</a> <strong>if</strong> ((inbuffersize > 2048) || (inbuffersize <= 0)) {
<a name="743" href="#743">743</a> inbuffersize = 2048;
<a name="744" href="#744">744</a> }
<a name="745" href="#745">745</a> inputStream = <strong>new</strong> BufferedInputStream(socket.getInputStream(), inbuffersize);
<a name="746" href="#746">746</a> outputStream = <strong>new</strong> BufferedOutputStream(socket.getOutputStream(), outbuffersize);
<a name="747" href="#747">747</a> isOpen = <strong>true</strong>;
<a name="748" href="#748">748</a> } <strong>catch</strong> (IOException e) {
<a name="749" href="#749">749</a> <em class="comment">// Connection wasn't opened properly</em>
<a name="750" href="#750">750</a> <em class="comment">// so close everything out</em>
<a name="751" href="#751">751</a> closeSocketAndStreams();
<a name="752" href="#752">752</a> <strong>throw</strong> e;
<a name="753" href="#753">753</a> }
<a name="754" href="#754">754</a> }
<a name="755" href="#755">755</a>
<a name="756" href="#756">756</a> <em>/**</em>
<a name="757" href="#757">757</a> <em> * Instructs the proxy to establish a secure tunnel to the host. The socket will </em>
<a name="758" href="#758">758</a> <em> * be switched to the secure socket. Subsequent communication is done via the secure </em>
<a name="759" href="#759">759</a> <em> * socket. The method can only be called once on a proxied secure connection.</em>
<a name="760" href="#760">760</a> <em> *</em>
<a name="761" href="#761">761</a> <em> * @throws IllegalStateException if connection is not secure and proxied or</em>
<a name="762" href="#762">762</a> <em> * if the socket is already secure.</em>
<a name="763" href="#763">763</a> <em> * @throws IOException if an attempt to establish the secure tunnel results in an</em>
<a name="764" href="#764">764</a> <em> * I/O error.</em>
<a name="765" href="#765">765</a> <em> */</em>
<a name="766" href="#766">766</a> <strong>public</strong> <strong>void</strong> tunnelCreated() throws IllegalStateException, IOException {
<a name="767" href="#767">767</a> LOG.trace(<span class="string">"enter HttpConnection.tunnelCreated()"</span>);
<a name="768" href="#768">768</a>
<a name="769" href="#769">769</a> <strong>if</strong> (!isSecure() || !isProxied()) {
<a name="770" href="#770">770</a> <strong>throw</strong> <strong>new</strong> IllegalStateException(
<a name="771" href="#771">771</a> <span class="string">"Connection must be secure "</span>
<a name="772" href="#772">772</a> + <span class="string">"and proxied to use this feature"</span>);
<a name="773" href="#773">773</a> }
<a name="774" href="#774">774</a>
<a name="775" href="#775">775</a> <strong>if</strong> (usingSecureSocket) {
<a name="776" href="#776">776</a> <strong>throw</strong> <strong>new</strong> IllegalStateException(<span class="string">"Already using a secure socket"</span>);
<a name="777" href="#777">777</a> }
<a name="778" href="#778">778</a>
<a name="779" href="#779">779</a> <strong>if</strong> (LOG.isDebugEnabled()) {
<a name="780" href="#780">780</a> LOG.debug(<span class="string">"Secure tunnel to "</span> + <strong>this</strong>.hostName + <span class="string">":"</span> + <strong>this</strong>.portNumber);
<a name="781" href="#781">781</a> }
<a name="782" href="#782">782</a>
<a name="783" href="#783">783</a> <a href="../../../../org/apache/commons/httpclient/protocol/SecureProtocolSocketFactory.html">SecureProtocolSocketFactory</a> socketFactory =
<a name="784" href="#784">784</a> (<a href="../../../../org/apache/commons/httpclient/protocol/SecureProtocolSocketFactory.html">SecureProtocolSocketFactory</a>) protocolInUse.getSocketFactory();
<a name="785" href="#785">785</a>
<a name="786" href="#786">786</a> socket = socketFactory.createSocket(socket, hostName, portNumber, <strong>true</strong>);
<a name="787" href="#787">787</a> <strong>int</strong> sndBufSize = <strong>this</strong>.params.getSendBufferSize();
<a name="788" href="#788">788</a> <strong>if</strong> (sndBufSize >= 0) {
<a name="789" href="#789">789</a> socket.setSendBufferSize(sndBufSize);
<a name="790" href="#790">790</a> }
<a name="791" href="#791">791</a> <strong>int</strong> rcvBufSize = <strong>this</strong>.params.getReceiveBufferSize();
<a name="792" href="#792">792</a> <strong>if</strong> (rcvBufSize >= 0) {
<a name="793" href="#793">793</a> socket.setReceiveBufferSize(rcvBufSize);
<a name="794" href="#794">794</a> }
<a name="795" href="#795">795</a> <strong>int</strong> outbuffersize = socket.getSendBufferSize();
<a name="796" href="#796">796</a> <strong>if</strong> (outbuffersize > 2048) {
<a name="797" href="#797">797</a> outbuffersize = 2048;
<a name="798" href="#798">798</a> }
<a name="799" href="#799">799</a> <strong>int</strong> inbuffersize = socket.getReceiveBufferSize();
<a name="800" href="#800">800</a> <strong>if</strong> (inbuffersize > 2048) {
<a name="801" href="#801">801</a> inbuffersize = 2048;
<a name="802" href="#802">802</a> }
<a name="803" href="#803">803</a> inputStream = <strong>new</strong> BufferedInputStream(socket.getInputStream(), inbuffersize);
<a name="804" href="#804">804</a> outputStream = <strong>new</strong> BufferedOutputStream(socket.getOutputStream(), outbuffersize);
<a name="805" href="#805">805</a> usingSecureSocket = <strong>true</strong>;
<a name="806" href="#806">806</a> tunnelEstablished = <strong>true</strong>;
<a name="807" href="#807">807</a> }
<a name="808" href="#808">808</a>
<a name="809" href="#809">809</a> <em>/**</em>
<a name="810" href="#810">810</a> <em> * Indicates if the connection is completely transparent from end to end.</em>
<a name="811" href="#811">811</a> <em> *</em>
<a name="812" href="#812">812</a> <em> * @return true if conncetion is not proxied or tunneled through a transparent</em>
<a name="813" href="#813">813</a> <em> * proxy; false otherwise.</em>
<a name="814" href="#814">814</a> <em> */</em>
<a name="815" href="#815">815</a> <strong>public</strong> <strong>boolean</strong> isTransparent() {
<a name="816" href="#816">816</a> <strong>return</strong> !isProxied() || tunnelEstablished;
<a name="817" href="#817">817</a> }
<a name="818" href="#818">818</a>
<a name="819" href="#819">819</a> <em>/**</em>
<a name="820" href="#820">820</a> <em> * Flushes the output request stream. This method should be called to </em>
<a name="821" href="#821">821</a> <em> * ensure that data written to the request OutputStream is sent to the server.</em>
<a name="822" href="#822">822</a> <em> * </em>
<a name="823" href="#823">823</a> <em> * @throws IOException if an I/O problem occurs</em>
<a name="824" href="#824">824</a> <em> */</em>
<a name="825" href="#825">825</a> <strong>public</strong> <strong>void</strong> flushRequestOutputStream() throws IOException {
<a name="826" href="#826">826</a> LOG.trace(<span class="string">"enter HttpConnection.flushRequestOutputStream()"</span>);
<a name="827" href="#827">827</a> assertOpen();
<a name="828" href="#828">828</a> outputStream.flush();
<a name="829" href="#829">829</a> }
<a name="830" href="#830">830</a>
<a name="831" href="#831">831</a> <em>/**</em>
<a name="832" href="#832">832</a> <em> * Returns an {@link OutputStream} suitable for writing the request.</em>
<a name="833" href="#833">833</a> <em> *</em>
<a name="834" href="#834">834</a> <em> * @throws IllegalStateException if the connection is not open</em>
<a name="835" href="#835">835</a> <em> * @throws IOException if an I/O problem occurs</em>
<a name="836" href="#836">836</a> <em> * @return a stream to write the request to</em>
<a name="837" href="#837">837</a> <em> */</em>
<a name="838" href="#838">838</a> <strong>public</strong> OutputStream getRequestOutputStream()
<a name="839" href="#839">839</a> throws IOException, IllegalStateException {
<a name="840" href="#840">840</a> LOG.trace(<span class="string">"enter HttpConnection.getRequestOutputStream()"</span>);
<a name="841" href="#841">841</a> assertOpen();
<a name="842" href="#842">842</a> OutputStream out = <strong>this</strong>.outputStream;
<a name="843" href="#843">843</a> <strong>if</strong> (Wire.CONTENT_WIRE.enabled()) {
<a name="844" href="#844">844</a> out = <strong>new</strong> <a href="../../../../org/apache/commons/httpclient/WireLogOutputStream.html">WireLogOutputStream</a>(out, Wire.CONTENT_WIRE);
<a name="845" href="#845">845</a> }
<a name="846" href="#846">846</a> <strong>return</strong> out;
<a name="847" href="#847">847</a> }
<a name="848" href="#848">848</a>
<a name="849" href="#849">849</a> <em>/**</em>
<a name="850" href="#850">850</a> <em> * Return a {@link InputStream} suitable for reading the response.</em>
<a name="851" href="#851">851</a> <em> * @return InputStream The response input stream.</em>
<a name="852" href="#852">852</a> <em> * @throws IOException If an IO problem occurs</em>
<a name="853" href="#853">853</a> <em> * @throws IllegalStateException If the connection isn't open.</em>
<a name="854" href="#854">854</a> <em> */</em>
<a name="855" href="#855">855</a> <strong>public</strong> InputStream getResponseInputStream()
<a name="856" href="#856">856</a> throws IOException, IllegalStateException {
<a name="857" href="#857">857</a> LOG.trace(<span class="string">"enter HttpConnection.getResponseInputStream()"</span>);
<a name="858" href="#858">858</a> assertOpen();
<a name="859" href="#859">859</a> <strong>return</strong> inputStream;
<a name="860" href="#860">860</a> }
<a name="861" href="#861">861</a>
<a name="862" href="#862">862</a> <em>/**</em>
<a name="863" href="#863">863</a> <em> * Tests if input data avaialble. This method returns immediately</em>
<a name="864" href="#864">864</a> <em> * and does not perform any read operations on the input socket</em>
<a name="865" href="#865">865</a> <em> * </em>
<a name="866" href="#866">866</a> <em> * @return boolean <tt>true</tt> if input data is available, </em>
<a name="867" href="#867">867</a> <em> * <tt>false</tt> otherwise.</em>
<a name="868" href="#868">868</a> <em> * </em>
<a name="869" href="#869">869</a> <em> * @throws IOException If an IO problem occurs</em>
<a name="870" href="#870">870</a> <em> * @throws IllegalStateException If the connection isn't open.</em>
<a name="871" href="#871">871</a> <em> */</em>
<a name="872" href="#872">872</a> <strong>public</strong> <strong>boolean</strong> isResponseAvailable()
<a name="873" href="#873">873</a> throws IOException {
<a name="874" href="#874">874</a> LOG.trace(<span class="string">"enter HttpConnection.isResponseAvailable()"</span>);
<a name="875" href="#875">875</a> <strong>if</strong> (<strong>this</strong>.isOpen) {
<a name="876" href="#876">876</a> <strong>return</strong> <strong>this</strong>.inputStream.available() > 0;
<a name="877" href="#877">877</a> } <strong>else</strong> {
<a name="878" href="#878">878</a> <strong>return</strong> false;
<a name="879" href="#879">879</a> }
<a name="880" href="#880">880</a> }
<a name="881" href="#881">881</a>
<a name="882" href="#882">882</a> <em>/**</em>
<a name="883" href="#883">883</a> <em> * Tests if input data becomes available within the given period time in milliseconds.</em>
<a name="884" href="#884">884</a> <em> * </em>
<a name="885" href="#885">885</a> <em> * @param timeout The number milliseconds to wait for input data to become available </em>
<a name="886" href="#886">886</a> <em> * @return boolean <tt>true</tt> if input data is availble, </em>
<a name="887" href="#887">887</a> <em> * <tt>false</tt> otherwise.</em>
<a name="888" href="#888">888</a> <em> * </em>
<a name="889" href="#889">889</a> <em> * @throws IOException If an IO problem occurs</em>
<a name="890" href="#890">890</a> <em> * @throws IllegalStateException If the connection isn't open.</em>
<a name="891" href="#891">891</a> <em> */</em>
<a name="892" href="#892">892</a> <strong>public</strong> <strong>boolean</strong> isResponseAvailable(<strong>int</strong> timeout)
<a name="893" href="#893">893</a> throws IOException {
<a name="894" href="#894">894</a> LOG.trace(<span class="string">"enter HttpConnection.isResponseAvailable(int)"</span>);
<a name="895" href="#895">895</a> assertOpen();
<a name="896" href="#896">896</a> <strong>boolean</strong> result = false;
<a name="897" href="#897">897</a> <strong>if</strong> (<strong>this</strong>.inputStream.available() > 0) {
<a name="898" href="#898">898</a> result = <strong>true</strong>;
<a name="899" href="#899">899</a> } <strong>else</strong> {
<a name="900" href="#900">900</a> <strong>try</strong> {
<a name="901" href="#901">901</a> <strong>this</strong>.socket.setSoTimeout(timeout);
<a name="902" href="#902">902</a> inputStream.mark(1);
<a name="903" href="#903">903</a> <strong>int</strong> byteRead = inputStream.read();
<a name="904" href="#904">904</a> <strong>if</strong> (byteRead != -1) {
<a name="905" href="#905">905</a> inputStream.reset();
<a name="906" href="#906">906</a> LOG.debug(<span class="string">"Input data available"</span>);
<a name="907" href="#907">907</a> result = <strong>true</strong>;
<a name="908" href="#908">908</a> } <strong>else</strong> {
<a name="909" href="#909">909</a> LOG.debug(<span class="string">"Input data not available"</span>);
<a name="910" href="#910">910</a> }
<a name="911" href="#911">911</a> } <strong>catch</strong> (InterruptedIOException e) {
<a name="912" href="#912">912</a> <strong>if</strong> (!ExceptionUtil.isSocketTimeoutException(e)) {
<a name="913" href="#913">913</a> <strong>throw</strong> e;
<a name="914" href="#914">914</a> }
<a name="915" href="#915">915</a> <strong>if</strong> (LOG.isDebugEnabled()) {
<a name="916" href="#916">916</a> LOG.debug(<span class="string">"Input data not available after "</span> + timeout + <span class="string">" ms"</span>);
<a name="917" href="#917">917</a> }
<a name="918" href="#918">918</a> } <strong>finally</strong> {
<a name="919" href="#919">919</a> <strong>try</strong> {
<a name="920" href="#920">920</a> socket.setSoTimeout(<strong>this</strong>.params.getSoTimeout());
<a name="921" href="#921">921</a> } <strong>catch</strong> (IOException ioe) {
<a name="922" href="#922">922</a> LOG.debug(<span class="string">"An error ocurred while resetting soTimeout, we will assume that"</span>
<a name="923" href="#923">923</a> + <span class="string">" no response is available."</span>,
<a name="924" href="#924">924</a> ioe);
<a name="925" href="#925">925</a> result = false;
<a name="926" href="#926">926</a> }
<a name="927" href="#927">927</a> }
<a name="928" href="#928">928</a> }
<a name="929" href="#929">929</a> <strong>return</strong> result;
<a name="930" href="#930">930</a> }
<a name="931" href="#931">931</a>
<a name="932" href="#932">932</a> <em>/**</em>
<a name="933" href="#933">933</a> <em> * Writes the specified bytes to the output stream.</em>
<a name="934" href="#934">934</a> <em> *</em>
<a name="935" href="#935">935</a> <em> * @param data the data to be written</em>
<a name="936" href="#936">936</a> <em> * @throws IllegalStateException if not connected</em>
<a name="937" href="#937">937</a> <em> * @throws IOException if an I/O problem occurs</em>
<a name="938" href="#938">938</a> <em> * @see #write(byte[],int,int)</em>
<a name="939" href="#939">939</a> <em> */</em>
<a name="940" href="#940">940</a> <strong>public</strong> <strong>void</strong> write(byte[] data)
<a name="941" href="#941">941</a> throws IOException, IllegalStateException {
<a name="942" href="#942">942</a> LOG.trace(<span class="string">"enter HttpConnection.write(byte[])"</span>);
<a name="943" href="#943">943</a> <strong>this</strong>.write(data, 0, data.length);
<a name="944" href="#944">944</a> }
<a name="945" href="#945">945</a>
<a name="946" href="#946">946</a> <em>/**</em>
<a name="947" href="#947">947</a> <em> * Writes <i>length</i> bytes in <i>data</i> starting at</em>
<a name="948" href="#948">948</a> <em> * <i>offset</i> to the output stream.</em>
<a name="949" href="#949">949</a> <em> *</em>
<a name="950" href="#950">950</a> <em> * The general contract for</em>
<a name="951" href="#951">951</a> <em> * write(b, off, len) is that some of the bytes in the array b are written</em>
<a name="952" href="#952">952</a> <em> * to the output stream in order; element b[off] is the first byte written</em>
<a name="953" href="#953">953</a> <em> * and b[off+len-1] is the last byte written by this operation.</em>
<a name="954" href="#954">954</a> <em> *</em>
<a name="955" href="#955">955</a> <em> * @param data array containing the data to be written.</em>
<a name="956" href="#956">956</a> <em> * @param offset the start offset in the data.</em>
<a name="957" href="#957">957</a> <em> * @param length the number of bytes to write.</em>
<a name="958" href="#958">958</a> <em> * @throws IllegalStateException if not connected</em>
<a name="959" href="#959">959</a> <em> * @throws IOException if an I/O problem occurs</em>
<a name="960" href="#960">960</a> <em> */</em>
<a name="961" href="#961">961</a> <strong>public</strong> <strong>void</strong> write(byte[] data, <strong>int</strong> offset, <strong>int</strong> length)
<a name="962" href="#962">962</a> throws IOException, IllegalStateException {
<a name="963" href="#963">963</a> LOG.trace(<span class="string">"enter HttpConnection.write(byte[], int, int)"</span>);
<a name="964" href="#964">964</a>
<a name="965" href="#965">965</a> <strong>if</strong> (offset < 0) {
<a name="966" href="#966">966</a> <strong>throw</strong> <strong>new</strong> IllegalArgumentException(<span class="string">"Array offset may not be negative"</span>);
<a name="967" href="#967">967</a> }
<a name="968" href="#968">968</a> <strong>if</strong> (length < 0) {
<a name="969" href="#969">969</a> <strong>throw</strong> <strong>new</strong> IllegalArgumentException(<span class="string">"Array length may not be negative"</span>);
<a name="970" href="#970">970</a> }
<a name="971" href="#971">971</a> <strong>if</strong> (offset + length > data.length) {
<a name="972" href="#972">972</a> <strong>throw</strong> <strong>new</strong> IllegalArgumentException(<span class="string">"Given offset and length exceed the array length"</span>);
<a name="973" href="#973">973</a> }
<a name="974" href="#974">974</a> assertOpen();
<a name="975" href="#975">975</a> <strong>this</strong>.outputStream.write(data, offset, length);
<a name="976" href="#976">976</a> }
<a name="977" href="#977">977</a>
<a name="978" href="#978">978</a> <em>/**</em>
<a name="979" href="#979">979</a> <em> * Writes the specified bytes, followed by <tt>"\r\n".getBytes()</tt> to the</em>
<a name="980" href="#980">980</a> <em> * output stream.</em>
<a name="981" href="#981">981</a> <em> *</em>
<a name="982" href="#982">982</a> <em> * @param data the bytes to be written</em>
<a name="983" href="#983">983</a> <em> * @throws IllegalStateException if the connection is not open</em>
<a name="984" href="#984">984</a> <em> * @throws IOException if an I/O problem occurs</em>
<a name="985" href="#985">985</a> <em> */</em>
<a name="986" href="#986">986</a> <strong>public</strong> <strong>void</strong> writeLine(byte[] data)
<a name="987" href="#987">987</a> throws IOException, IllegalStateException {
<a name="988" href="#988">988</a> LOG.trace(<span class="string">"enter HttpConnection.writeLine(byte[])"</span>);
<a name="989" href="#989">989</a> write(data);
<a name="990" href="#990">990</a> writeLine();
<a name="991" href="#991">991</a> }
<a name="992" href="#992">992</a>
<a name="993" href="#993">993</a> <em>/**</em>
<a name="994" href="#994">994</a> <em> * Writes <tt>"\r\n".getBytes()</tt> to the output stream.</em>
<a name="995" href="#995">995</a> <em> *</em>
<a name="996" href="#996">996</a> <em> * @throws IllegalStateException if the connection is not open</em>
<a name="997" href="#997">997</a> <em> * @throws IOException if an I/O problem occurs</em>
<a name="998" href="#998">998</a> <em> */</em>
<a name="999" href="#999">999</a> <strong>public</strong> <strong>void</strong> writeLine()
<a name="1000" href="#1000">1000</a> throws IOException, IllegalStateException {
<a name="1001" href="#1001">1001</a> LOG.trace(<span class="string">"enter HttpConnection.writeLine()"</span>);
<a name="1002" href="#1002">1002</a> write(CRLF);
<a name="1003" href="#1003">1003</a> }
<a name="1004" href="#1004">1004</a>
<a name="1005" href="#1005">1005</a> <em>/**</em>
<a name="1006" href="#1006">1006</a> <em> * @deprecated Use {@link #print(String, String)}</em>
<a name="1007" href="#1007">1007</a> <em> * </em>
<a name="1008" href="#1008">1008</a> <em> * Writes the specified String (as bytes) to the output stream.</em>
<a name="1009" href="#1009">1009</a> <em> *</em>
<a name="1010" href="#1010">1010</a> <em> * @param data the string to be written</em>
<a name="1011" href="#1011">1011</a> <em> * @throws IllegalStateException if the connection is not open</em>
<a name="1012" href="#1012">1012</a> <em> * @throws IOException if an I/O problem occurs</em>
<a name="1013" href="#1013">1013</a> <em> */</em>
<a name="1014" href="#1014">1014</a> <strong>public</strong> <strong>void</strong> print(String data)
<a name="1015" href="#1015">1015</a> throws IOException, IllegalStateException {
<a name="1016" href="#1016">1016</a> LOG.trace(<span class="string">"enter HttpConnection.print(String)"</span>);
<a name="1017" href="#1017">1017</a> write(EncodingUtil.getBytes(data, <span class="string">"ISO-8859-1"</span>));
<a name="1018" href="#1018">1018</a> }
<a name="1019" href="#1019">1019</a>
<a name="1020" href="#1020">1020</a> <em>/**</em>
<a name="1021" href="#1021">1021</a> <em> * Writes the specified String (as bytes) to the output stream.</em>
<a name="1022" href="#1022">1022</a> <em> *</em>
<a name="1023" href="#1023">1023</a> <em> * @param data the string to be written</em>
<a name="1024" href="#1024">1024</a> <em> * @param charset the charset to use for writing the data</em>
<a name="1025" href="#1025">1025</a> <em> * @throws IllegalStateException if the connection is not open</em>
<a name="1026" href="#1026">1026</a> <em> * @throws IOException if an I/O problem occurs</em>
<a name="1027" href="#1027">1027</a> <em> * </em>
<a name="1028" href="#1028">1028</a> <em> * @since 3.0</em>
<a name="1029" href="#1029">1029</a> <em> */</em>
<a name="1030" href="#1030">1030</a> <strong>public</strong> <strong>void</strong> print(String data, String charset)
<a name="1031" href="#1031">1031</a> throws IOException, IllegalStateException {
<a name="1032" href="#1032">1032</a> LOG.trace(<span class="string">"enter HttpConnection.print(String)"</span>);
<a name="1033" href="#1033">1033</a> write(EncodingUtil.getBytes(data, charset));
<a name="1034" href="#1034">1034</a> }
<a name="1035" href="#1035">1035</a>
<a name="1036" href="#1036">1036</a> <em>/**</em>
<a name="1037" href="#1037">1037</a> <em> * @deprecated Use {@link #printLine(String, String)}</em>
<a name="1038" href="#1038">1038</a> <em> * </em>
<a name="1039" href="#1039">1039</a> <em> * Writes the specified String (as bytes), followed by</em>
<a name="1040" href="#1040">1040</a> <em> * <tt>"\r\n".getBytes()</tt> to the output stream.</em>
<a name="1041" href="#1041">1041</a> <em> *</em>
<a name="1042" href="#1042">1042</a> <em> * @param data the data to be written</em>
<a name="1043" href="#1043">1043</a> <em> * @throws IllegalStateException if the connection is not open</em>
<a name="1044" href="#1044">1044</a> <em> * @throws IOException if an I/O problem occurs</em>
<a name="1045" href="#1045">1045</a> <em> */</em>
<a name="1046" href="#1046">1046</a> <strong>public</strong> <strong>void</strong> printLine(String data)
<a name="1047" href="#1047">1047</a> throws IOException, IllegalStateException {
<a name="1048" href="#1048">1048</a> LOG.trace(<span class="string">"enter HttpConnection.printLine(String)"</span>);
<a name="1049" href="#1049">1049</a> writeLine(EncodingUtil.getBytes(data, <span class="string">"ISO-8859-1"</span>));
<a name="1050" href="#1050">1050</a> }
<a name="1051" href="#1051">1051</a>
<a name="1052" href="#1052">1052</a> <em>/**</em>
<a name="1053" href="#1053">1053</a> <em> * Writes the specified String (as bytes), followed by</em>
<a name="1054" href="#1054">1054</a> <em> * <tt>"\r\n".getBytes()</tt> to the output stream.</em>
<a name="1055" href="#1055">1055</a> <em> *</em>
<a name="1056" href="#1056">1056</a> <em> * @param data the data to be written</em>
<a name="1057" href="#1057">1057</a> <em> * @param charset the charset to use for writing the data</em>
<a name="1058" href="#1058">1058</a> <em> * @throws IllegalStateException if the connection is not open</em>
<a name="1059" href="#1059">1059</a> <em> * @throws IOException if an I/O problem occurs</em>
<a name="1060" href="#1060">1060</a> <em> * </em>
<a name="1061" href="#1061">1061</a> <em> * @since 3.0</em>
<a name="1062" href="#1062">1062</a> <em> */</em>
<a name="1063" href="#1063">1063</a> <strong>public</strong> <strong>void</strong> printLine(String data, String charset)
<a name="1064" href="#1064">1064</a> throws IOException, IllegalStateException {
<a name="1065" href="#1065">1065</a> LOG.trace(<span class="string">"enter HttpConnection.printLine(String)"</span>);
<a name="1066" href="#1066">1066</a> writeLine(EncodingUtil.getBytes(data, charset));
<a name="1067" href="#1067">1067</a> }
<a name="1068" href="#1068">1068</a>
<a name="1069" href="#1069">1069</a> <em>/**</em>
<a name="1070" href="#1070">1070</a> <em> * Writes <tt>"\r\n".getBytes()</tt> to the output stream.</em>
<a name="1071" href="#1071">1071</a> <em> *</em>
<a name="1072" href="#1072">1072</a> <em> * @throws IllegalStateException if the connection is not open</em>
<a name="1073" href="#1073">1073</a> <em> * @throws IOException if an I/O problem occurs</em>
<a name="1074" href="#1074">1074</a> <em> */</em>
<a name="1075" href="#1075">1075</a> <strong>public</strong> <strong>void</strong> printLine()
<a name="1076" href="#1076">1076</a> throws IOException, IllegalStateException {
<a name="1077" href="#1077">1077</a> LOG.trace(<span class="string">"enter HttpConnection.printLine()"</span>);
<a name="1078" href="#1078">1078</a> writeLine();
<a name="1079" href="#1079">1079</a> }
<a name="1080" href="#1080">1080</a>
<a name="1081" href="#1081">1081</a> <em>/**</em>
<a name="1082" href="#1082">1082</a> <em> * Reads up to <tt>"\n"</tt> from the (unchunked) input stream.</em>
<a name="1083" href="#1083">1083</a> <em> * If the stream ends before the line terminator is found,</em>
<a name="1084" href="#1084">1084</a> <em> * the last part of the string will still be returned.</em>
<a name="1085" href="#1085">1085</a> <em> *</em>
<a name="1086" href="#1086">1086</a> <em> * @throws IllegalStateException if the connection is not open</em>
<a name="1087" href="#1087">1087</a> <em> * @throws IOException if an I/O problem occurs</em>
<a name="1088" href="#1088">1088</a> <em> * @return a line from the response</em>
<a name="1089" href="#1089">1089</a> <em> * </em>
<a name="1090" href="#1090">1090</a> <em> * @deprecated use #readLine(String)</em>
<a name="1091" href="#1091">1091</a> <em> */</em>
<a name="1092" href="#1092">1092</a> <strong>public</strong> String readLine() throws IOException, IllegalStateException {
<a name="1093" href="#1093">1093</a> LOG.trace(<span class="string">"enter HttpConnection.readLine()"</span>);
<a name="1094" href="#1094">1094</a>
<a name="1095" href="#1095">1095</a> assertOpen();
<a name="1096" href="#1096">1096</a> <strong>return</strong> HttpParser.readLine(inputStream);
<a name="1097" href="#1097">1097</a> }
<a name="1098" href="#1098">1098</a>
<a name="1099" href="#1099">1099</a> <em>/**</em>
<a name="1100" href="#1100">1100</a> <em> * Reads up to <tt>"\n"</tt> from the (unchunked) input stream.</em>
<a name="1101" href="#1101">1101</a> <em> * If the stream ends before the line terminator is found,</em>
<a name="1102" href="#1102">1102</a> <em> * the last part of the string will still be returned.</em>
<a name="1103" href="#1103">1103</a> <em> * </em>
<a name="1104" href="#1104">1104</a> <em> * @param charset the charset to use for reading the data</em>
<a name="1105" href="#1105">1105</a> <em> *</em>
<a name="1106" href="#1106">1106</a> <em> * @throws IllegalStateException if the connection is not open</em>
<a name="1107" href="#1107">1107</a> <em> * @throws IOException if an I/O problem occurs</em>
<a name="1108" href="#1108">1108</a> <em> * @return a line from the response</em>
<a name="1109" href="#1109">1109</a> <em> * </em>
<a name="1110" href="#1110">1110</a> <em> * @since 3.0</em>
<a name="1111" href="#1111">1111</a> <em> */</em>
<a name="1112" href="#1112">1112</a> <strong>public</strong> String readLine(<strong>final</strong> String charset) throws IOException, IllegalStateException {
<a name="1113" href="#1113">1113</a> LOG.trace(<span class="string">"enter HttpConnection.readLine()"</span>);
<a name="1114" href="#1114">1114</a>
<a name="1115" href="#1115">1115</a> assertOpen();
<a name="1116" href="#1116">1116</a> <strong>return</strong> HttpParser.readLine(inputStream, charset);
<a name="1117" href="#1117">1117</a> }
<a name="1118" href="#1118">1118</a>
<a name="1119" href="#1119">1119</a> <em>/**</em>
<a name="1120" href="#1120">1120</a> <em> * Attempts to shutdown the {@link Socket}'s output, via Socket.shutdownOutput()</em>
<a name="1121" href="#1121">1121</a> <em> * when running on JVM 1.3 or higher.</em>
<a name="1122" href="#1122">1122</a> <em> * </em>
<a name="1123" href="#1123">1123</a> <em> * @deprecated unused</em>
<a name="1124" href="#1124">1124</a> <em> */</em>
<a name="1125" href="#1125">1125</a> <strong>public</strong> <strong>void</strong> shutdownOutput() {
<a name="1126" href="#1126">1126</a> LOG.trace(<span class="string">"enter HttpConnection.shutdownOutput()"</span>);
<a name="1127" href="#1127">1127</a>
<a name="1128" href="#1128">1128</a> <strong>try</strong> {
<a name="1129" href="#1129">1129</a> <em class="comment">// Socket.shutdownOutput is a JDK 1.3</em>
<a name="1130" href="#1130">1130</a> <em class="comment">// method. We'll use reflection in case</em>
<a name="1131" href="#1131">1131</a> <em class="comment">// we're running in an older VM</em>
<a name="1132" href="#1132">1132</a> Class[] paramsClasses = <strong>new</strong> Class[0];
<a name="1133" href="#1133">1133</a> Method shutdownOutput =
<a name="1134" href="#1134">1134</a> socket.getClass().getMethod(<span class="string">"shutdownOutput"</span>, paramsClasses);
<a name="1135" href="#1135">1135</a> Object[] params = <strong>new</strong> Object[0];
<a name="1136" href="#1136">1136</a> shutdownOutput.invoke(socket, params);
<a name="1137" href="#1137">1137</a> } <strong>catch</strong> (Exception ex) {
<a name="1138" href="#1138">1138</a> LOG.debug(<span class="string">"Unexpected Exception caught"</span>, ex);
<a name="1139" href="#1139">1139</a> <em class="comment">// Ignore, and hope everything goes right</em>
<a name="1140" href="#1140">1140</a> }
<a name="1141" href="#1141">1141</a> <em class="comment">// close output stream?</em>
<a name="1142" href="#1142">1142</a> }
<a name="1143" href="#1143">1143</a>
<a name="1144" href="#1144">1144</a> <em>/**</em>
<a name="1145" href="#1145">1145</a> <em> * Closes the socket and streams.</em>
<a name="1146" href="#1146">1146</a> <em> */</em>
<a name="1147" href="#1147">1147</a> <strong>public</strong> <strong>void</strong> close() {
<a name="1148" href="#1148">1148</a> LOG.trace(<span class="string">"enter HttpConnection.close()"</span>);
<a name="1149" href="#1149">1149</a> closeSocketAndStreams();
<a name="1150" href="#1150">1150</a> }
<a name="1151" href="#1151">1151</a>
<a name="1152" href="#1152">1152</a> <em>/**</em>
<a name="1153" href="#1153">1153</a> <em> * Returns the httpConnectionManager.</em>
<a name="1154" href="#1154">1154</a> <em> * @return HttpConnectionManager</em>
<a name="1155" href="#1155">1155</a> <em> */</em>
<a name="1156" href="#1156">1156</a> <strong>public</strong> <a href="../../../../org/apache/commons/httpclient/HttpConnectionManager.html">HttpConnectionManager</a> getHttpConnectionManager() {
<a name="1157" href="#1157">1157</a> <strong>return</strong> httpConnectionManager;
<a name="1158" href="#1158">1158</a> }
<a name="1159" href="#1159">1159</a>
<a name="1160" href="#1160">1160</a> <em>/**</em>
<a name="1161" href="#1161">1161</a> <em> * Sets the httpConnectionManager.</em>
<a name="1162" href="#1162">1162</a> <em> * @param httpConnectionManager The httpConnectionManager to set</em>
<a name="1163" href="#1163">1163</a> <em> */</em>
<a name="1164" href="#1164">1164</a> <strong>public</strong> <strong>void</strong> setHttpConnectionManager(<a href="../../../../org/apache/commons/httpclient/HttpConnectionManager.html">HttpConnectionManager</a> httpConnectionManager) {
<a name="1165" href="#1165">1165</a> <strong>this</strong>.httpConnectionManager = httpConnectionManager;
<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. If the connection is locked or does not have a connection</em>
<a name="1170" href="#1170">1170</a> <em> * manager associated with it, this method has no effect. Note that it is completely safe </em>
<a name="1171" href="#1171">1171</a> <em> * to call this method multiple times.</em>
<a name="1172" href="#1172">1172</a> <em> */</em>
<a name="1173" href="#1173">1173</a> <strong>public</strong> <strong>void</strong> releaseConnection() {
<a name="1174" href="#1174">1174</a> LOG.trace(<span class="string">"enter HttpConnection.releaseConnection()"</span>);
<a name="1175" href="#1175">1175</a> <strong>if</strong> (locked) {
<a name="1176" href="#1176">1176</a> LOG.debug(<span class="string">"Connection is locked. Call to releaseConnection() ignored."</span>);
<a name="1177" href="#1177">1177</a> } <strong>else</strong> <strong>if</strong> (httpConnectionManager != <strong>null</strong>) {
<a name="1178" href="#1178">1178</a> LOG.debug(<span class="string">"Releasing connection back to connection manager."</span>);
<a name="1179" href="#1179">1179</a> httpConnectionManager.releaseConnection(<strong>this</strong>);
<a name="1180" href="#1180">1180</a> } <strong>else</strong> {
<a name="1181" href="#1181">1181</a> LOG.warn(<span class="string">"HttpConnectionManager is null. Connection cannot be released."</span>);
<a name="1182" href="#1182">1182</a> }
<a name="1183" href="#1183">1183</a> }
<a name="1184" href="#1184">1184</a>
<a name="1185" href="#1185">1185</a> <em>/**</em>
<a name="1186" href="#1186">1186</a> <em> * Tests if the connection is locked. Locked connections cannot be released. </em>
<a name="1187" href="#1187">1187</a> <em> * An attempt to release a locked connection will have no effect.</em>
<a name="1188" href="#1188">1188</a> <em> * </em>
<a name="1189" href="#1189">1189</a> <em> * @return <tt>true</tt> if the connection is locked, <tt>false</tt> otherwise.</em>
<a name="1190" href="#1190">1190</a> <em> * </em>
<a name="1191" href="#1191">1191</a> <em> * @since 3.0</em>
<a name="1192" href="#1192">1192</a> <em> */</em>
<a name="1193" href="#1193">1193</a> <strong>protected</strong> <strong>boolean</strong> isLocked() {
<a name="1194" href="#1194">1194</a> <strong>return</strong> locked;
<a name="1195" href="#1195">1195</a> }
<a name="1196" href="#1196">1196</a>
<a name="1197" href="#1197">1197</a> <em>/**</em>
<a name="1198" href="#1198">1198</a> <em> * Locks or unlocks the connection. Locked connections cannot be released. </em>
<a name="1199" href="#1199">1199</a> <em> * An attempt to release a locked connection will have no effect.</em>
<a name="1200" href="#1200">1200</a> <em> * </em>
<a name="1201" href="#1201">1201</a> <em> * @param locked <tt>true</tt> to lock the connection, <tt>false</tt> to unlock</em>
<a name="1202" href="#1202">1202</a> <em> * the connection.</em>
<a name="1203" href="#1203">1203</a> <em> * </em>
<a name="1204" href="#1204">1204</a> <em> * @since 3.0</em>
<a name="1205" href="#1205">1205</a> <em> */</em>
<a name="1206" href="#1206">1206</a> <strong>protected</strong> <strong>void</strong> setLocked(<strong>boolean</strong> locked) {
<a name="1207" href="#1207">1207</a> <strong>this</strong>.locked = locked;
<a name="1208" href="#1208">1208</a> }
<a name="1209" href="#1209">1209</a> <em class="comment">// ------------------------------------------------------ Protected Methods</em>
<a name="1210" href="#1210">1210</a>
<a name="1211" href="#1211">1211</a> <em>/**</em>
<a name="1212" href="#1212">1212</a> <em> * Closes everything out.</em>
<a name="1213" href="#1213">1213</a> <em> */</em>
<a name="1214" href="#1214">1214</a> <strong>protected</strong> <strong>void</strong> closeSocketAndStreams() {
<a name="1215" href="#1215">1215</a> LOG.trace(<span class="string">"enter HttpConnection.closeSockedAndStreams()"</span>);
<a name="1216" href="#1216">1216</a>
<a name="1217" href="#1217">1217</a> isOpen = false;
<a name="1218" href="#1218">1218</a>
<a name="1219" href="#1219">1219</a> <em class="comment">// no longer care about previous responses...</em>
<a name="1220" href="#1220">1220</a> lastResponseInputStream = <strong>null</strong>;
<a name="1221" href="#1221">1221</a>
<a name="1222" href="#1222">1222</a> <strong>if</strong> (<strong>null</strong> != outputStream) {
<a name="1223" href="#1223">1223</a> OutputStream temp = outputStream;
<a name="1224" href="#1224">1224</a> outputStream = <strong>null</strong>;
<a name="1225" href="#1225">1225</a> <strong>try</strong> {
<a name="1226" href="#1226">1226</a> temp.close();
<a name="1227" href="#1227">1227</a> } <strong>catch</strong> (Exception ex) {
<a name="1228" href="#1228">1228</a> LOG.debug(<span class="string">"Exception caught when closing output"</span>, ex);
<a name="1229" href="#1229">1229</a> <em class="comment">// ignored</em>
<a name="1230" href="#1230">1230</a> }
<a name="1231" href="#1231">1231</a> }
<a name="1232" href="#1232">1232</a>
<a name="1233" href="#1233">1233</a> <strong>if</strong> (<strong>null</strong> != inputStream) {
<a name="1234" href="#1234">1234</a> InputStream temp = inputStream;
<a name="1235" href="#1235">1235</a> inputStream = <strong>null</strong>;
<a name="1236" href="#1236">1236</a> <strong>try</strong> {
<a name="1237" href="#1237">1237</a> temp.close();
<a name="1238" href="#1238">1238</a> } <strong>catch</strong> (Exception ex) {
<a name="1239" href="#1239">1239</a> LOG.debug(<span class="string">"Exception caught when closing input"</span>, ex);
<a name="1240" href="#1240">1240</a> <em class="comment">// ignored</em>
<a name="1241" href="#1241">1241</a> }
<a name="1242" href="#1242">1242</a> }
<a name="1243" href="#1243">1243</a>
<a name="1244" href="#1244">1244</a> <strong>if</strong> (<strong>null</strong> != socket) {
<a name="1245" href="#1245">1245</a> Socket temp = socket;
<a name="1246" href="#1246">1246</a> socket = <strong>null</strong>;
<a name="1247" href="#1247">1247</a> <strong>try</strong> {
<a name="1248" href="#1248">1248</a> temp.close();
<a name="1249" href="#1249">1249</a> } <strong>catch</strong> (Exception ex) {
<a name="1250" href="#1250">1250</a> LOG.debug(<span class="string">"Exception caught when closing socket"</span>, ex);
<a name="1251" href="#1251">1251</a> <em class="comment">// ignored</em>
<a name="1252" href="#1252">1252</a> }
<a name="1253" href="#1253">1253</a> }
<a name="1254" href="#1254">1254</a>
<a name="1255" href="#1255">1255</a> tunnelEstablished = false;
<a name="1256" href="#1256">1256</a> usingSecureSocket = false;
<a name="1257" href="#1257">1257</a> }
<a name="1258" href="#1258">1258</a>
<a name="1259" href="#1259">1259</a> <em>/**</em>
<a name="1260" href="#1260">1260</a> <em> * Throws an {@link IllegalStateException} if the connection is already open.</em>
<a name="1261" href="#1261">1261</a> <em> *</em>
<a name="1262" href="#1262">1262</a> <em> * @throws IllegalStateException if connected</em>
<a name="1263" href="#1263">1263</a> <em> */</em>
<a name="1264" href="#1264">1264</a> <strong>protected</strong> <strong>void</strong> assertNotOpen() throws IllegalStateException {
<a name="1265" href="#1265">1265</a> <strong>if</strong> (isOpen) {
<a name="1266" href="#1266">1266</a> <strong>throw</strong> <strong>new</strong> IllegalStateException(<span class="string">"Connection is open"</span>);
<a name="1267" href="#1267">1267</a> }
<a name="1268" href="#1268">1268</a> }
<a name="1269" href="#1269">1269</a>
<a name="1270" href="#1270">1270</a> <em>/**</em>
<a name="1271" href="#1271">1271</a> <em> * Throws an {@link IllegalStateException} if the connection is not open.</em>
<a name="1272" href="#1272">1272</a> <em> *</em>
<a name="1273" href="#1273">1273</a> <em> * @throws IllegalStateException if not connected</em>
<a name="1274" href="#1274">1274</a> <em> */</em>
<a name="1275" href="#1275">1275</a> <strong>protected</strong> <strong>void</strong> assertOpen() throws IllegalStateException {
<a name="1276" href="#1276">1276</a> <strong>if</strong> (!isOpen) {
<a name="1277" href="#1277">1277</a> <strong>throw</strong> <strong>new</strong> IllegalStateException(<span class="string">"Connection is not open"</span>);
<a name="1278" href="#1278">1278</a> }
<a name="1279" href="#1279">1279</a> }
<a name="1280" href="#1280">1280</a>
<a name="1281" href="#1281">1281</a> <em>/**</em>
<a name="1282" href="#1282">1282</a> <em> * Gets the socket's sendBufferSize.</em>
<a name="1283" href="#1283">1283</a> <em> * </em>
<a name="1284" href="#1284">1284</a> <em> * @return the size of the buffer for the socket OutputStream, -1 if the value</em>
<a name="1285" href="#1285">1285</a> <em> * has not been set and the socket has not been opened</em>
<a name="1286" href="#1286">1286</a> <em> * </em>
<a name="1287" href="#1287">1287</a> <em> * @throws SocketException if an error occurs while getting the socket value</em>
<a name="1288" href="#1288">1288</a> <em> * </em>
<a name="1289" href="#1289">1289</a> <em> * @see Socket#getSendBufferSize()</em>
<a name="1290" href="#1290">1290</a> <em> */</em>
<a name="1291" href="#1291">1291</a> <strong>public</strong> <strong>int</strong> getSendBufferSize() throws SocketException {
<a name="1292" href="#1292">1292</a> <strong>if</strong> (socket == <strong>null</strong>) {
<a name="1293" href="#1293">1293</a> <strong>return</strong> -1;
<a name="1294" href="#1294">1294</a> } <strong>else</strong> {
<a name="1295" href="#1295">1295</a> <strong>return</strong> socket.getSendBufferSize();
<a name="1296" href="#1296">1296</a> }
<a name="1297" href="#1297">1297</a> }
<a name="1298" href="#1298">1298</a>
<a name="1299" href="#1299">1299</a> <em>/**</em>
<a name="1300" href="#1300">1300</a> <em> * Sets the socket's sendBufferSize.</em>
<a name="1301" href="#1301">1301</a> <em> * </em>
<a name="1302" href="#1302">1302</a> <em> * @param sendBufferSize the size to set for the socket OutputStream</em>
<a name="1303" href="#1303">1303</a> <em> * </em>
<a name="1304" href="#1304">1304</a> <em> * @throws SocketException if an error occurs while setting the socket value</em>
<a name="1305" href="#1305">1305</a> <em> * </em>
<a name="1306" href="#1306">1306</a> <em> * @see Socket#setSendBufferSize(int)</em>
<a name="1307" href="#1307">1307</a> <em> * </em>
<a name="1308" href="#1308">1308</a> <em> * @deprecated Use {@link HttpConnectionParams#setSendBufferSize(int)},</em>
<a name="1309" href="#1309">1309</a> <em> * {@link HttpConnection#getParams()}.</em>
<a name="1310" href="#1310">1310</a> <em> */</em>
<a name="1311" href="#1311">1311</a> <strong>public</strong> <strong>void</strong> setSendBufferSize(<strong>int</strong> sendBufferSize) throws SocketException {
<a name="1312" href="#1312">1312</a> <strong>this</strong>.params.setSendBufferSize(sendBufferSize);
<a name="1313" href="#1313">1313</a> }
<a name="1314" href="#1314">1314</a>
<a name="1315" href="#1315">1315</a> <em class="comment">// ------------------------------------------------------- Static Variable</em>
<a name="1316" href="#1316">1316</a>
<a name="1317" href="#1317">1317</a> <em>/**</em><em> <tt>"\r\n"</tt>, as bytes. */</em>
<a name="1318" href="#1318">1318</a> <strong>private</strong> <strong>static</strong> <strong>final</strong> byte[] CRLF = <strong>new</strong> byte[] {(byte) 13, (byte) 10};
<a name="1319" href="#1319">1319</a>
<a name="1320" href="#1320">1320</a> <em>/**</em><em> Log object for this class. */</em>
<a name="1321" href="#1321">1321</a> <strong>private</strong> <strong>static</strong> <strong>final</strong> Log LOG = LogFactory.getLog(HttpConnection.<strong>class</strong>);
<a name="1322" href="#1322">1322</a>
<a name="1323" href="#1323">1323</a> <em class="comment">// ----------------------------------------------------- Instance Variables</em>
<a name="1324" href="#1324">1324</a>
<a name="1325" href="#1325">1325</a> <em>/**</em><em> My host. */</em>
<a name="1326" href="#1326">1326</a> <strong>private</strong> String hostName = <strong>null</strong>;
<a name="1327" href="#1327">1327</a>
<a name="1328" href="#1328">1328</a> <em>/**</em><em> My port. */</em>
<a name="1329" href="#1329">1329</a> <strong>private</strong> <strong>int</strong> portNumber = -1;
<a name="1330" href="#1330">1330</a>
<a name="1331" href="#1331">1331</a> <em>/**</em><em> My proxy host. */</em>
<a name="1332" href="#1332">1332</a> <strong>private</strong> String proxyHostName = <strong>null</strong>;
<a name="1333" href="#1333">1333</a>
<a name="1334" href="#1334">1334</a> <em>/**</em><em> My proxy port. */</em>
<a name="1335" href="#1335">1335</a> <strong>private</strong> <strong>int</strong> proxyPortNumber = -1;
<a name="1336" href="#1336">1336</a>
<a name="1337" href="#1337">1337</a> <em>/**</em><em> My client Socket. */</em>
<a name="1338" href="#1338">1338</a> <strong>private</strong> Socket socket = <strong>null</strong>;
<a name="1339" href="#1339">1339</a>
<a name="1340" href="#1340">1340</a> <em>/**</em><em> My InputStream. */</em>
<a name="1341" href="#1341">1341</a> <strong>private</strong> InputStream inputStream = <strong>null</strong>;
<a name="1342" href="#1342">1342</a>
<a name="1343" href="#1343">1343</a> <em>/**</em><em> My OutputStream. */</em>
<a name="1344" href="#1344">1344</a> <strong>private</strong> OutputStream outputStream = <strong>null</strong>;
<a name="1345" href="#1345">1345</a>
<a name="1346" href="#1346">1346</a> <em>/**</em><em> An {@link InputStream} for the response to an individual request. */</em>
<a name="1347" href="#1347">1347</a> <strong>private</strong> InputStream lastResponseInputStream = <strong>null</strong>;
<a name="1348" href="#1348">1348</a>
<a name="1349" href="#1349">1349</a> <em>/**</em><em> Whether or not the connection is connected. */</em>
<a name="1350" href="#1350">1350</a> <strong>protected</strong> <strong>boolean</strong> isOpen = false;
<a name="1351" href="#1351">1351</a>
<a name="1352" href="#1352">1352</a> <em>/**</em><em> the protocol being used */</em>
<a name="1353" href="#1353">1353</a> <strong>private</strong> <a href="../../../../org/apache/commons/httpclient/protocol/Protocol.html">Protocol</a> protocolInUse;
<a name="1354" href="#1354">1354</a>
<a name="1355" href="#1355">1355</a> <em>/**</em><em> Collection of HTTP parameters associated with this HTTP connection*/</em>
<a name="1356" href="#1356">1356</a> <strong>private</strong> <a href="../../../../org/apache/commons/httpclient/params/HttpConnectionParams.html">HttpConnectionParams</a> params = <strong>new</strong> <a href="../../../../org/apache/commons/httpclient/params/HttpConnectionParams.html">HttpConnectionParams</a>();
<a name="1357" href="#1357">1357</a>
<a name="1358" href="#1358">1358</a> <em>/**</em><em> flag to indicate if this connection can be released, if locked the connection cannot be </em>
<a name="1359" href="#1359">1359</a> <em> * released */</em>
<a name="1360" href="#1360">1360</a> <strong>private</strong> <strong>boolean</strong> locked = false;
<a name="1361" href="#1361">1361</a>
<a name="1362" href="#1362">1362</a> <em>/**</em><em> Whether or not the socket is a secure one. */</em>
<a name="1363" href="#1363">1363</a> <strong>private</strong> <strong>boolean</strong> usingSecureSocket = false;
<a name="1364" href="#1364">1364</a>
<a name="1365" href="#1365">1365</a> <em>/**</em><em> Whether the connection is open via a secure tunnel or not */</em>
<a name="1366" href="#1366">1366</a> <strong>private</strong> <strong>boolean</strong> tunnelEstablished = false;
<a name="1367" href="#1367">1367</a>
<a name="1368" href="#1368">1368</a> <em>/**</em><em> the connection manager that created this connection or null */</em>
<a name="1369" href="#1369">1369</a> <strong>private</strong> <a href="../../../../org/apache/commons/httpclient/HttpConnectionManager.html">HttpConnectionManager</a> httpConnectionManager;
<a name="1370" href="#1370">1370</a>
<a name="1371" href="#1371">1371</a> <em>/**</em><em> The local interface on which the connection is created, or null for the default */</em>
<a name="1372" href="#1372">1372</a> <strong>private</strong> InetAddress localAddress;
<a name="1373" href="#1373">1373</a> }
</pre>
<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
</html>
|
