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
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<title>Ant-contrib Tasks: Http Tasks</title>
</head>
<body>
<h1>Post-Method</h1>
The <post-method> task allows the caller to use the HTTP POST
method to send data to an arbitrary url. This data can be one of the
following:
<ul>
<li>Name/Value pairs</li>
<li>File content</li>
<li>Text content</li>
<li>Multi-part content</li>
</ul>
<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>url</i></td>
<td valign="top">The url which we are posting to.</td>
<td align="center" valign="top">No.</td>
</tr>
<tr>
<td valign="top"><i>path</i></td>
<td valign="top">The path which we are posting to. If this is used,
you must previously declare a <http-client> instance
configured with host parameters, and set the clientRefId property
on this task.</td>
<td align="center" valign="top">No, provided the clientRefId property
is set to a reference to an http-client which has host parameters
configured</td>
</tr>
<tr>
<td valign="top"><i>queryString</i></td>
<td valign="top">The queryString which we are posting to. If this is used,
you must previously declare a <http-client> instance
configured with host parameters, and set the clientRefId property
on this task, as well as specifying the path attribute.</td>
<td align="center" valign="top">No, provided the clientRefId property
is set to a reference to an http-client which has host parameters
configured</td>
</tr>
<tr>
<td valign="top"><i>multipart</i></td>
<td valign="top">Should multipart content be forced, even if
only a single file or text part is specified.</td>
<td align="center" valign="top">No.</td>
</tr>
<tr>
<td valign="top"><i>clientRefId</i></td>
<td valign="top">The reference id of a previously declared
<http-client> data type instance. This is necessary
if you want to retain state across multiple requests. If
not specified, we create a new HttpClient with the default
settings.</td>
<td align="center" valign="top">No.</td>
</tr>
<tr>
<td valign="top"><i>parameters</td>
<td valign="top">A java .properties file which contains post parameters.</td>
<td align="center" valign="top">No.</td>
</tr>
<tr>
<td valign="top"><i>responseDataFile</td>
<td valign="top">The path of the file where the response data will be placed.</td>
<td align="center" valign="top">No.</td>
</tr>
<tr>
<td valign="top"><i>responseDataProperty</td>
<td valign="top">The property where the response data will be placed.</td>
<td align="center" valign="top">No.</td>
</tr>
<tr>
<td valign="top"><i>statusCodeProperty</i></td>
<td valign="top">The name of the property to set with the HTTP response status code.</td>
<td align="center" valign="top">No.</td>
</tr>
<tr>
<td valign="top"><i>doAuthentication</i></td>
<td valign="top">Should we perform authentication.</td>
<td align="center" valign="top">No. If set, you must use
a custom <http-state> and <http-client> object
on which the credentials have been set.</td>
</tr>
<tr>
<td valign="top"><i>followRedirects</i></td>
<td valign="top">Should we automatically follow redirects.</td>
<td align="center" valign="top">No.</td>
</tr>
</table>
<h2>Parameters specified as Nested Elements</h2>
<table border="1" cellpadding="2" cellspacing="0">
<caption>Header - create a request header to be sent.</caption>
<tr>
<th>Attribute</th>
<th>Description</th>
<th>Required</th>
</tr>
<tr>
<td valign="top"><i>name</i></td>
<td valign="top">The header name.</td>
<td align="center" valign="top">Yes.</td>
</tr>
<tr>
<td valign="top"><i>value</i></td>
<td valign="top">The header value.</td>
<td align="center" valign="top">Yes.</td>
</tr>
</table>
<table border="1" cellpadding="2" cellspacing="0">
<caption>Response-Header - specify a response header to be retrieve.</caption>
<tr>
<th>Attribute</th>
<th>Description</th>
<th>Required</th>
</tr>
<tr>
<td valign="top"><i>name</i></td>
<td valign="top">The header name.</td>
<td align="center" valign="top">Yes.</td>
</tr>
<tr>
<td valign="top"><i>property</i></td>
<td valign="top">The property to be set with the header value.</td>
<td align="center" valign="top">Yes.</td>
</tr>
</table>
<table border="1" cellpadding="2" cellspacing="0">
<caption>parameter - create a request parameter to be sent.</caption>
<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>
<table border="1" cellpadding="2" cellspacing="0">
<caption>file - add a File part to the request.</caption>
<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>path</i></td>
<td valign="top">The file path to send.</td>
<td align="center" valign="top">Yes.</td>
</tr>
<tr>
<td valign="top"><i>contentType</i></td>
<td valign="top">The content type of the file.</td>
<td align="center" valign="top">No.</td>
</tr>
<tr>
<td valign="top"><i>charSet</i></td>
<td valign="top">The character set.</td>
<td align="center" valign="top">No.</td>
</tr>
</table>
<table border="1" cellpadding="2" cellspacing="0">
<caption>text - add a text part to the request.</caption>
<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 string value to send.</td>
<td align="center" valign="top">Yes.</td>
</tr>
<tr>
<td valign="top"><i>contentType</i></td>
<td valign="top">The content type of the file.</td>
<td align="center" valign="top">No.</td>
</tr>
<tr>
<td valign="top"><i>charSet</i></td>
<td valign="top">The character set.</td>
<td align="center" valign="top">No.</td>
</tr>
</table>
<table border="1" cellpadding="2" cellspacing="0">
<caption>params - create http method params.</caption>
<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 <params> subelements:
<table border="1" cellpadding="2" cellspacing="0">
<caption>double,int,long,boolean,string - create a method parameter.</caption>
<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>
<h2>Examples</h2>
<hr>
<p align="center">Copyright © 2002-2003 Ant-Contrib Project. All
rights Reserved.</p>
</body>
</html>
|
