summaryrefslogtreecommitdiffstats
path: root/docs/manual/tasks/get-cookie_task.html
diff options
context:
space:
mode:
Diffstat (limited to 'docs/manual/tasks/get-cookie_task.html')
-rw-r--r--docs/manual/tasks/get-cookie_task.html77
1 files changed, 77 insertions, 0 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 &lt;getCookie&gt; task allows the caller to retrieve one or
+ more cookies from an &lt;httpState&gt; 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 &copy; 2002-2003 Ant-Contrib Project. All
+ rights Reserved.</p>
+
+ </body>
+</html>