<?xml version="1.0" encoding="UTF-8" standalone="no"?> <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>url</title><meta name="generator" content="DocBook XSL Stylesheets V1.75.2" /><link rel="home" href="index.html" title="Flood manual" /><link rel="up" href="ch06.html" title="Chapter 6. Flood Configuration Elements" /><link rel="prev" href="re05.html" title="baseurl" /><link rel="next" href="re07.html" title="sequence" /></head><body><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">url</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="re05.html">Prev</a> </td><th width="60%" align="center">Chapter 6. Flood Configuration Elements</th><td width="20%" align="right"> <a accesskey="n" href="re07.html">Next</a></td></tr></table><hr /></div><div class="refentry" title="url"><a id="url"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>url — specifies URL address for retrieval</p></div><div class="refsynopsisdiv" title="synopsis"><h2>synopsis</h2><pre class="synopsis"> <url [ method="{ GET | POST | HEAD }" ] [ payload="STRING" ] [ payloadparam="STRING" ] [ payloadparamcount="INTEGER" ] [ payloadtemplate="STRING" ] [ responsename="STRING" ] [ responsetemplate="STRING" ] [ responsescript="STRING" ] [ requesttemplate="STRING" ] [ requestparamcount="INTEGER" ] [ predelay="INTEGER" ] [ predelayprecision="INTEGER" ] [ postdelay="INTEGER" ] [ postdelayprecision="INTEGER" ] [ user="STRING" ] [ password="STRING" ] [ Content-Type="STRING" ]> [ STRING</url> ] </pre></div><div class="refsection" title="parent elements"><a id="id320005"></a><h2>parent elements</h2><pre class="synopsis"> <a class="link" href="re02.html" title="urllist"><urllist></a> </pre></div><div class="refsection" title="children elements"><a id="id320022"></a><h2>children elements</h2><p>none.</p></div><div class="refsection" title="attributes"><a id="id320031"></a><h2>attributes</h2><div class="informaltable"><table border="1"><colgroup><col /><col /><col /><col /></colgroup><thead><tr><th align="left">name</th><th align="left">type</th><th align="left">description</th><th align="left">default value</th></tr></thead><tbody><tr><td align="left">method</td><td align="left">STRING</td><td align="left"> This attribute specifies HTTP method used in request. Valid values include: GET, POST, HEAD. </td><td align="left">GET</td></tr><tr><td align="left">payload</td><td align="left">STRING</td><td align="left"> This attribute specifies POST request body. Contents of this attribute are sent raw as POST request body, so they need to be properly encoded. </td><td align="left">(empty)</td></tr><tr><td align="left">payloadparam</td><td align="left">STRING</td><td align="left"> No information available at this time </td><td align="left">(empty)</td></tr><tr><td align="left">payloadparamcount</td><td align="left">INTEGER</td><td align="left"> No information available at this time </td><td align="left">0</td></tr><tr><td align="left">payloadtemplate</td><td align="left">STRING</td><td align="left"> This attribute holds POST request body, that will be searched for variables. Every variable found will be expanded to it's value. </td><td align="left">(empty)</td></tr><tr><td align="left">responsename</td><td align="left">STRING</td><td align="left"> This attribute sets the name of variable, that will be created upon successful match of responsetemplate. </td><td align="left">(empty)</td></tr><tr><td align="left">responsetemplate</td><td align="left">STRING</td><td align="left"> This attribute holds regular expression that will be matched against response. If successful, resulting string will be placed in newly created variable, whose name is determined by responsename attribute. </td><td align="left">(empty)</td></tr><tr><td align="left">responsescript</td><td align="left">STRING</td><td align="left"> This attribute holds path to executable script, that will be used in response postprocessing. Such script schould read standard input, which will contain server response (both HTTP headers and response body). Script exit value of 0 means success, while any other value means error. </td><td align="left">(empty)</td></tr><tr><td align="left">requesttemplate</td><td align="left">STRING</td><td align="left"> This attribute holds the URL address, that will be searched for variables. Every variable found will be expanded to it's value. Presence of this attribute makes url an empty element, becasue content of this attribute is used as request URL. </td><td align="left">(empty)</td></tr><tr><td align="left">requestparamcount</td><td align="left">INTEGER</td><td align="left"> No information available at this time </td><td align="left">0</td></tr><tr><td align="left">predelay</td><td align="left">INTEGER</td><td align="left"> No information available at this time </td><td align="left">0</td></tr><tr><td align="left">predelayprecision</td><td align="left">INTEGER</td><td align="left"> No information available at this time </td><td align="left">0</td></tr><tr><td align="left">postdelay</td><td align="left">INTEGER</td><td align="left"> No information available at this time </td><td align="left">0</td></tr><tr><td align="left">postdelayprecision</td><td align="left">INTEGER</td><td align="left"> No information available at this time </td><td align="left">0</td></tr><tr><td align="left">user</td><td align="left">STRING</td><td align="left"> This attribute holds username for auth (401 header). </td><td align="left">(empty)</td></tr><tr><td align="left">password</td><td align="left">STRING</td><td align="left"> This attribute holds password for auth (401 header). </td><td align="left">(empty)</td></tr><tr><td align="left">Content-Type</td><td align="left">STRING</td><td align="left"> This attribute (when present) overrides default Content-Type header which is 'application/x-www-form-urlencoded'. </td><td align="left">(empty)</td></tr></tbody></table></div></div><div class="refsection" title="character data"><a id="id320389"></a><h2>character data</h2><p>none | specifies URL address for retrieval.</p></div><div class="refsection" title="description"><a id="id320399"></a><h2>description</h2><p> This element is the basic data unit of flood. It contains detailed description of url address scheduled for retrieval. You can specify how to perform request (method, optional payload) and how to postprocess response. </p><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p> When using responsescript attribute, please keep in mind, that the execution time of script might distort overall results. In addition, please add following element to your profile: </p><pre class="screen"> <recv_resp>generic_fullresp_recv_resp</recv_resp> </pre><p> This wil cause flood to fetch whole response every time. Without such element flood could sometimes retrieve only first chunk of data, which just isn't enough for valid postprocessing. </p></div></div><div class="refsection" title="examples"><a id="id320431"></a><h2>examples</h2><pre class="screen"> <urllist> <name>check release</name> <url responsename="filename" responsetemplate="href=(.*)">http://www.example.com/downloads/</url> <url requesttemplate="http://www.example.com/files/${filename}" requestparamcount="1"/> <!-- ... --> </urllist> </pre></div></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="re05.html">Prev</a> </td><td width="20%" align="center"><a accesskey="u" href="ch06.html">Up</a></td><td width="40%" align="right"> <a accesskey="n" href="re07.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">baseurl </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> sequence</td></tr></table></div></body></html>