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
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<title>Ant-contrib Tasks: Http Tasks</title>
</head>
<body>
<h1>HttpClient</h1>
The <httpClient> type allows the caller to create an HttpClient
instance, and add it as a reference, or be nested as a subelement of
an HTTP method call.
<h2>Parameters</h2>
<table border="1" cellpadding="2" cellspacing="0">
<tr>
<th>Attribute</th>
<th>Description</th>
<th>Required</th>
</tr>
<tr>
<td valign="top"><i>id</i></td>
<td valign="top">The reference id to store this HttpClient under.</td>
<td align="center" valign="top">No.</td>
</tr>
<tr>
<td valign="top"><i>refId</i></td>
<td valign="top">The reference id of the HttpClient this element refers to.</td>
<td align="center" valign="top">No.</td>
</tr>
<tr>
<td valign="top"><i>stateRefId</i></td>
<td valign="top">The HttpState object to use.</td>
<td align="center" valign="top">No. Uses a default HttpState.</td>
</tr>
</table>
<h2>Parameters specified as Nested Elements</h2>
<br />
<br />
<b><clientParams></b><br />
<p>
Create http client params.
</p>
<table border="1" cellpadding="2" cellspacing="0">
<tr>
<th>Attribute</th>
<th>Description</th>
<th>Required</th>
</tr>
<tr>
<td valign="top"><i>strict</i></td>
<td valign="top">Should we be strict on the protocol.</td>
<td align="center" valign="top">No.</td>
</tr>
<tr>
<td valign="top"><i>authenticationPreemptive</i></td>
<td valign="top">Should we pre-emptively try to authenticate?</td>
<td align="center" valign="top">No.</td>
</tr>
<tr>
<td valign="top"><i>connectionManagerTimeout</i></td>
<td valign="top">The timeout for the connection manager.</td>
<td align="center" valign="top">No.</td>
</tr>
<tr>
<td valign="top"><i>contentCharSet</i></td>
<td valign="top">The content character set</td>
<td align="center" valign="top">No.</td>
</tr>
<tr>
<td valign="top"><i>cookiePolicy</i></td>
<td valign="top">The cookie policy (IGNORE_COOKIES, RFC_2109, NETSCAPE or DEFAULT)</td>
<td align="center" valign="top">No.</td>
</tr>
<tr>
<td valign="top"><i>credentialCharSet</i></td>
<td valign="top"></td>
<td align="center" valign="top">No.</td>
</tr>
<tr>
<td valign="top"><i>httpElementCharSet</i></td>
<td valign="top"></td>
<td align="center" valign="top">No.</td>
</tr>
<tr>
<td valign="top"><i>soTimeout</i></td>
<td valign="top"></td>
<td align="center" valign="top">No.</td>
</tr>
<tr>
<td valign="top"><i>version</i></td>
<td valign="top">The HTTP version.</td>
<td align="center" valign="top">No.</td>
</tr>
</table>
Additional <b><clientParams></b> subelements:<br />
<double>,<int>,<long>,<boolean>
,<string> <br />
<p>
Create a client parameter.
</p>
<table border="1" cellpadding="2" cellspacing="0">
<tr>
<th>Attribute</th>
<th>Description</th>
<th>Required</th>
</tr>
<tr>
<td valign="top"><i>name</i></td>
<td valign="top">The parameter name</td>
<td align="center" valign="top">Yes.</td>
</tr>
<tr>
<td valign="top"><i>value</i></td>
<td valign="top">The parameter value.</td>
<td align="center" valign="top">Yes.</td>
</tr>
</table>
<br />
<br />
<b><hostConfig></b><br />
<p>
Create a host configuration.
</p>
<table border="1" cellpadding="2" cellspacing="0">
<tr>
<th>Attribute</th>
<th>Description</th>
<th>Required</th>
</tr>
<tr>
<td valign="top"><i>host</i></td>
<td valign="top">The host to connect to.</td>
<td align="center" valign="top">No.</td>
</tr>
<tr>
<td valign="top"><i>port</i></td>
<td valign="top"></td>
<td align="center" valign="top">No.</td>
</tr>
<tr>
<td valign="top"><i>protocol</i></td>
<td valign="top"></td>
<td align="center" valign="top">No.</td>
</tr>
<tr>
<td valign="top"><i>address</i></td>
<td valign="top"></td>
<td align="center" valign="top">No.</td>
</tr>
<tr>
<td valign="top"><i>proxyHost</i></td>
<td valign="top">The proxyHost to connect to.</td>
<td align="center" valign="top">No.</td>
</tr>
<tr>
<td valign="top"><i>proxyPort</i></td>
<td valign="top"></td>
<td align="center" valign="top">No.</td>
</tr>
</table>
<br />
<br />
Additional <b><hostConfig></b> subelements:<br />
<hostParams><br />
<p>
Specify HostParams.
</p>
<table border="1" cellpadding="2" cellspacing="0">
<tr>
<th><hostParams> subelements are identical to those of
<clientParams></th>
</tr>
</table>
<br />
<br />
<b><httpState></b> <br />
<p>
Create (or reference an existing) HttpState
for use with this HTTP client. This is necessary if you wish
to enable authentication, or retain state across multiple method calls.
</p>
<table border="1" cellpadding="2" cellspacing="0">
<tr>
<th>Please see the <a href="http-state_type.html">httpState</a>
documentation for more details on this element</th>
</tr>
</table>
<h2>Examples</h2>
<pre>
<code>
<httpClient id="client1">
<clientParams cookiePolicy="RFC_2109" />
</httpClient>
</code>
</pre>
<hr>
<p align="center">Copyright © 2002-2003 Ant-Contrib Project. All
rights Reserved.</p>
</body>
</html>
|