diff options
| author | mattinger <[email protected]> | 2006-08-22 18:56:57 +0000 |
|---|---|---|
| committer | mattinger <[email protected]> | 2006-08-22 18:56:57 +0000 |
| commit | 684bc9c13521c42eaf7a1dbdcf8104429c5861b2 (patch) | |
| tree | d16442d471d1b66d7d47040c50e4a59c6d41187d | |
| parent | 260ae98045a4048cb420cbf0ee4a385a8f994578 (diff) | |
Adding httpclient tasks documentation.
git-svn-id: file:///home/sven/projects/JOGL/temp/ant-contrib/svn/ant-contrib-code/trunk/ant-contrib@34 32d7a393-a5a9-423c-abd3-5d954feb1f2f
| -rw-r--r-- | docs/manual/tasks/get-cookie_task.html | 77 | ||||
| -rw-r--r-- | docs/manual/tasks/get-method_task.html | 178 | ||||
| -rw-r--r-- | docs/manual/tasks/head-method_task.html | 176 | ||||
| -rw-r--r-- | docs/manual/tasks/http-client_type.html | 124 | ||||
| -rw-r--r-- | docs/manual/tasks/http-state_type.html | 178 | ||||
| -rw-r--r-- | docs/manual/tasks/method_task_common.html | 230 | ||||
| -rw-r--r-- | docs/manual/tasks/post-method_task.html | 186 | ||||
| -rw-r--r-- | docs/manual/tasks/toc.html | 8 |
8 files changed, 609 insertions, 548 deletions
diff --git a/docs/manual/tasks/get-cookie_task.html b/docs/manual/tasks/get-cookie_task.html new file mode 100644 index 0000000..83fc326 --- /dev/null +++ b/docs/manual/tasks/get-cookie_task.html @@ -0,0 +1,77 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> + <head> + <title>Ant-contrib Tasks: Http Tasks</title> + </head> + + <body> + <h1>GetCookie</h1>
+ The <getCookie> task allows the caller to retrieve one or + more cookies from an <httpState> reference.
+
+ <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">realm</td> + <td valign="top">The realm of the cookie(s) to retrieve.</td> + <td align="center" valign="top">Yes.</td> + </tr> + <tr> + <td valign="top">port</td> + <td valign="top">The port of the cookie(s) to retrieve.</td> + <td align="center" valign="top">No. defaults to 80</td> + </tr> + <tr> + <td valign="top">path</td> + <td valign="top">The path of the cookie(s) to retrieve.</td> + <td align="center" valign="top">Yes.</td> + </tr> + <tr> + <td valign="top">secure</td> + <td valign="top">The secure flag of the cookie(s) to retrieve.</td> + <td align="center" valign="top">No. Default to false.</td> + </tr> + <tr> + <td valign="top">name</td> + <td valign="top">The name of the cookie to retrieve.</td> + <td align="center" valign="top">No. If not specified, + multiple cookies may be found.</td> + </tr> + <tr> + <td valign="top">cookiePolicy</td> + <td valign="top">The cookiePolicy to use to match cookies.</td> + <td align="center" valign="top">No. Default to 'rfc2109'.</td> + </tr> + <tr> + <td valign="top">property</td> + <td valign="top">The property to retrieve the cookie into. + This will only retrieve + the first cookie found which matches the query. If no 'name' + attribute is specified, there is no guarantee you will get + the cookie you are expecting.</td> + <td align="center" valign="top">No, unless 'prefix' is not specified.</td> + </tr> + <tr> + <td valign="top">prefix</td> + <td valign="top">The prefix to use when settings properties for + the cookies. One property will be set for each cookie, where + the property name will be of the pattern: ${prefix}${cookie.name} + where ${cookie.name} is the name of the cookie.</td> + <td align="center" valign="top">No, unless 'property' is not specified.</td> + </tr> + </table> + + <h2>Examples</h2> + + + <hr> + <p align="center">Copyright © 2002-2003 Ant-Contrib Project. All + rights Reserved.</p> + + </body> +</html> diff --git a/docs/manual/tasks/get-method_task.html b/docs/manual/tasks/get-method_task.html index ddf3659..abb4f76 100644 --- a/docs/manual/tasks/get-method_task.html +++ b/docs/manual/tasks/get-method_task.html @@ -5,181 +5,11 @@ </head> <body> - <h1>Get-Method</h1>
- The <get-method> task allows the caller to use the HTTP GET
- method.
- - - <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>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>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>params - create http method params.</caption>
- <tr>
- <th>Attribute</th>
- <th>Description</th>
- <th>Required</th>
- </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>
+ <h1>GetMethod</h1>
+ The <getMethod> task allows the caller to use the HTTP GET
+ method. This method inherits the <a href="method_task_common.html"> + Common Method</a> attributes and subelements.
-
<h2>Examples</h2> diff --git a/docs/manual/tasks/head-method_task.html b/docs/manual/tasks/head-method_task.html index 6b4df29..34a4f27 100644 --- a/docs/manual/tasks/head-method_task.html +++ b/docs/manual/tasks/head-method_task.html @@ -6,179 +6,9 @@ <body> <h1>Head-Method</h1>
- The <head-method> task allows the caller to use the HTTP HEAD
- method.
- - - <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>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>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>params - create http method params.</caption>
- <tr>
- <th>Attribute</th>
- <th>Description</th>
- <th>Required</th>
- </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>
-
+ The <headMethod> task allows the caller to use the HTTP HEAD
+ method. This method inherits the <a href="method_task_common.html"> + Common Method</a> attributes and subelements.
<h2>Examples</h2> diff --git a/docs/manual/tasks/http-client_type.html b/docs/manual/tasks/http-client_type.html index 3a139ca..a55aac1 100644 --- a/docs/manual/tasks/http-client_type.html +++ b/docs/manual/tasks/http-client_type.html @@ -5,9 +5,10 @@ </head> <body> - <h1>Http-Client</h1>
- The <http-client> type allows the caller to create an HttpClient
- instance, and add it as a reference.
+ <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"> @@ -16,6 +17,16 @@ <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>
@@ -25,8 +36,13 @@ <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">
- <caption>clientPrams - create http client params.</caption>
<tr>
<th>Attribute</th>
<th>Description</th>
@@ -79,9 +95,13 @@ </tr>
</table>
- Additional <clientParams> subelements:
+ 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">
- <caption>double,int,long,boolean,string - create a method parameter.</caption>
<tr>
<th>Attribute</th>
<th>Description</th>
@@ -99,62 +119,88 @@ </tr>
</table>
+ <br /> + <br /> + <b><hostConfig></b><br /> + <p> + Create a host configuration. + </p> + <table border="1" cellpadding="2" cellspacing="0">
- <caption>hostConfig - create host configuration</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 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>credentialCharSet</i></td>
+ <td valign="top"><i>port</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"><i>protocol</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"><i>address</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>
-
+ <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 diff --git a/docs/manual/tasks/http-state_type.html b/docs/manual/tasks/http-state_type.html new file mode 100644 index 0000000..48031ee --- /dev/null +++ b/docs/manual/tasks/http-state_type.html @@ -0,0 +1,178 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> + <head> + <title>Ant-contrib Tasks: Http Tasks</title> + </head> + + <body> + <h1>HttpState</h1>
+ The <httpState> type allows the caller to create an HttpState
+ instance, and add it as a reference, or be nested as a subelement of + an <httpClient> element.
+
+ <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 HttpState 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 HttpState which this element references.</td>
+ <td align="center" valign="top">No.</td>
+ </tr>
+ </table>
+ + <h2>Parameters specified as Nested Elements</h2>
+
+ <br /> + <br /> + <b><cookie></b><br /> + <p> + Create a cookie. + </p> + <table border="1" cellpadding="2" cellspacing="0">
+ <tr>
+ <th>Attribute</th>
+ <th>Description</th>
+ <th>Required</th>
+ </tr>
+ <tr>
+ <td valign="top"><i>domain</i></td>
+ <td valign="top"></td>
+ <td align="center" valign="top">No.</td>
+ </tr>
+ <tr> + <td valign="top"><i>path</i></td> + <td valign="top"></td> + <td align="center" valign="top">No.</td> + </tr> + <tr> + <td valign="top"><i>name</i></td> + <td valign="top"></td> + <td align="center" valign="top">No.</td> + </tr> + <tr> + <td valign="top"><i>value</i></td> + <td valign="top"></td> + <td align="center" valign="top">No.</td> + </tr> + <tr> + <td valign="top"><i>secure</i></td> + <td valign="top"></td> + <td align="center" valign="top">No.</td> + </tr> + <tr> + <td valign="top"><i>comment</i></td> + <td valign="top"></td> + <td align="center" valign="top">No.</td> + </tr> + <tr> + <td valign="top"><i>expiryDate</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"></td> + <td align="center" valign="top">No.</td> + </tr> + <tr> + <td valign="top"><i>domainAttributeSpecified</i></td> + <td valign="top"></td> + <td align="center" valign="top">No.</td> + </tr> + <tr> + <td valign="top"><i>pathAttributeSpecified</i></td> + <td valign="top"></td> + <td align="center" valign="top">No.</td> + </tr> + </table>
+
+ <br /> + <br /> + <b><credentials></b><br /> + <p> + Create authentication credentials. + </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.</td> + <td align="center" valign="top">No.</td> + </tr> + <tr> + <td valign="top"><i>port</i></td> + <td valign="top">The port.</td> + <td align="center" valign="top">No.</td> + </tr> + <tr> + <td valign="top"><i>realm</i></td> + <td valign="top">The realm.</td> + <td align="center" valign="top">No.</td> + </tr> + <tr> + <td valign="top"><i>scheme</i></td> + <td valign="top">The scheme.</td> + <td align="center" valign="top">No.</td> + </tr> + <tr> + <td valign="top"><i>username</i></td> + <td valign="top">The username.</td> + <td align="center" valign="top">No.</td> + </tr> + <tr> + <td valign="top"><i>password</i></td> + <td valign="top">The password.</td> + <td align="center" valign="top">No.</td> + </tr> + </table> +
+
+ <br /> + <br /> + <b><proxyCredentials></b><br /> + <p> + Create proxy authentication credentials. + </p> + <table border="1" cellpadding="2" cellspacing="0"> + <tr> + <th>Identitical to <credentials> element.</th> + </tr> + </table> + + <h2>Examples</h2> + + + <hr> + <p align="center">Copyright © 2002-2003 Ant-Contrib Project. All + rights Reserved.</p> + + <pre> + <code> + <httpState id="myState"> + <cookie name="loginId" value="username" realm="sourceforge.net" /> + </httpState> + + <httpClient id="myClient" stateRefId="myState" /> + + <httpClient id="myClient> + <httpState > + <cookie name="loginId" value="username" realm="sourceforge.net" /> + </httpState> + </httpClient> + </code> + </pre> + </body> +</html> diff --git a/docs/manual/tasks/method_task_common.html b/docs/manual/tasks/method_task_common.html new file mode 100644 index 0000000..d6053f3 --- /dev/null +++ b/docs/manual/tasks/method_task_common.html @@ -0,0 +1,230 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> + <head> + <title>Ant-contrib Tasks: Http Tasks</title> + </head> + + <body> + <h1>*Method</h1> + The <method> tasks allows the caller to use the various + HTTP methods (current GET, HEAD and POST are supported). These + methods have some common attributes, and sub-elements which are + are as shown below: + + + <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 that is being called.</td> + <td align="center" valign="top">No, if the client host configuration is + defined, and the path attribute is specified.</td> + </tr> + <tr> + <td valign="top"><i>path</i></td> + <td valign="top">The path which we are going to connect to. If this is used, + you must declare an httpClient subelement, or set the clientRefId attribute + for an HttpClient instance with configured host parameters.</td> + <td align="center" valign="top">No.</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 declare an httpClient subelement, or set the clientRefId attribute + for an HttpClient instance with configured host parameters.</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 + <httpClient> data type instance. This is necessary + if you want to retain state (cookies) across multiple requests, + or you want specific client configuration and host configuration + parameters. 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>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 + either declare an <httpClient> instance, or set the + clientRefId attribute for an HttpClient which has credentials + installed into it.</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> + + <br /> + <br /> + + <b><httpClient></b> <br /> + <p> + Create (or reference an existing) HttpClient + for use with this HTTP method call. This is necessary if you wish + to configure the client beyond the default settings, 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-client_type.html">httpClient</a> + documentation for more details on this element</th> + </tr> + </table> + + <br /> + <br /> + <b><header></b><br /> + <p> + Create a request header to be sent. + </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 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> + + <br /> + <br /> + <b><responseHeader></b><br /> + <p> + Specify a response header to be retrieved into a property. + </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 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> + + <br /> + <br /> + <b><params></b><br /> + <p> + Create http method paramaters. + </p> + <table border="1" cellpadding="2" cellspacing="0"> + <tr> + <th>Attribute</th> + <th>Description</th> + <th>Required</th> + </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> + + <br /> + <br /> + + Additional <b><params></b> subelements:<br /> + <double>,<int>,<long>,<boolean> + ,<string> <br /> + <p> + Create a method 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> + + + <h2>Examples</h2> + + + <hr> + <p align="center">Copyright © 2002-2003 Ant-Contrib Project. All + rights Reserved.</p> + + </body> +</html> diff --git a/docs/manual/tasks/post-method_task.html b/docs/manual/tasks/post-method_task.html index 23ea284..0d9cb3c 100644 --- a/docs/manual/tasks/post-method_task.html +++ b/docs/manual/tasks/post-method_task.html @@ -14,7 +14,10 @@ <li>File content</li>
<li>Text content</li>
<li>Multi-part content</li>
- </ul>
+ </ul> + This method inherits the <a href="method_task_common.html"> + Common Method</a> attributes and subelements. It also contains + the following additional attributes and subelements:
<h2>Parameters</h2> @@ -25,121 +28,28 @@ <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>
+ <br /> + <br /> + <b><parameter></b><br /> + <p> + Create a text post parameter. + </p> <table border="1" cellpadding="2" cellspacing="0">
- <caption>parameter - create a request parameter to be sent.</caption>
<tr>
<th>Attribute</th>
<th>Description</th>
@@ -157,8 +67,13 @@ </tr>
</table>
+ <br /> + <br /> + <b><file></b><br /> + <p> + Add a File part to the request. + </p> <table border="1" cellpadding="2" cellspacing="0">
- <caption>file - add a File part to the request.</caption>
<tr>
<th>Attribute</th>
<th>Description</th>
@@ -186,8 +101,13 @@ </tr>
</table>
+ <br /> + <br /> + <b><text></b><br /> + <p> + Add a Text part to the request. + </p> <table border="1" cellpadding="2" cellspacing="0">
- <caption>text - add a text part to the request.</caption>
<tr>
<th>Attribute</th>
<th>Description</th>
@@ -200,7 +120,8 @@ </tr>
<tr>
<td valign="top"><i>value</i></td>
- <td valign="top">The string value to send.</td>
+ <td valign="top">The string value to send. This may + also be specified as nested text to this element.</td>
<td align="center" valign="top">Yes.</td>
</tr>
<tr>
@@ -215,65 +136,6 @@ </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>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> diff --git a/docs/manual/tasks/toc.html b/docs/manual/tasks/toc.html index 2a14f69..3910de1 100644 --- a/docs/manual/tasks/toc.html +++ b/docs/manual/tasks/toc.html @@ -27,6 +27,14 @@ <li><a href="server_tasks.html" target="mainFrame">AntServer / RemoteAnt</a></li>
<li><a href="importurl.html" target="mainFrame">ImportURL</a></li> </ul> + <h2>Http Tasks and Types</h2> + <ul> + <li><a href="http-client_type.html" target="mainFrame">HttpClient</a></li> + <li><a href="http-state_type.html" target="mainFrame">HttpState</a></li> + <li><a href="post-method_task.html" target="mainFrame">PostMethod</a></li> + <li><a href="get-Method_task.html" target="mainFrame">GetMethod</a></li> + <li><a href="head-method_task.html" target="mainFrame">HeadMethod</a></li> + </ul> <h2>Performance Monitoring and Tasks</h2> <ul> <li><a href="performance_monitor.html" target="mainFrame">Performance Monitor</a></li> |