diff options
| author | mattinger <[email protected]> | 2006-08-17 05:52:42 +0000 |
|---|---|---|
| committer | mattinger <[email protected]> | 2006-08-17 05:52:42 +0000 |
| commit | 2f043df017029699bd2d103308a586314bcca9ee (patch) | |
| tree | 256d64a572424cf04b22d8df604f82446ddd5925 /docs/manual/tasks/get-method_task.html | |
| parent | 871350dd27dfbb12c0fd6dd6b7424260309b318c (diff) | |
adding manuals
git-svn-id: file:///home/sven/projects/JOGL/temp/ant-contrib/svn/ant-contrib-code/trunk/ant-contrib@22 32d7a393-a5a9-423c-abd3-5d954feb1f2f
Diffstat (limited to 'docs/manual/tasks/get-method_task.html')
| -rw-r--r-- | docs/manual/tasks/get-method_task.html | 206 |
1 files changed, 206 insertions, 0 deletions
diff --git a/docs/manual/tasks/get-method_task.html b/docs/manual/tasks/get-method_task.html new file mode 100644 index 0000000..fd4f90f --- /dev/null +++ b/docs/manual/tasks/get-method_task.html @@ -0,0 +1,206 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> + <head> + <title>Ant-contrib Tasks: Http Tasks</title> + </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>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> |