dion 02/01/24 22:19:54
Modified: latka/doc index.xml
Log:
Split off XML Reference into a separate chapter
Revision Changes Path
1.10 +1 -956 jakarta-commons/latka/doc/index.xml
Index: index.xml
===================================================================
RCS file: /home/cvs/jakarta-commons/latka/doc/index.xml,v
retrieving revision 1.9
retrieving revision 1.10
diff -u -r1.9 -r1.10
--- index.xml 23 Jan 2002 08:05:01 -0000 1.9
+++ index.xml 25 Jan 2002 06:19:54 -0000 1.10
@@ -5,7 +5,7 @@
<!--
Author: Morgan Delagrange
- Version: $Id: index.xml,v 1.9 2002/01/23 08:05:01 dion Exp $
+ Version: $Id: index.xml,v 1.10 2002/01/25 06:19:54 dion Exp $
-->
<chapter id="latka">
<chapterinfo>
@@ -177,960 +177,5 @@
</section>
</section>
- <section>
- <title>Latka XML Reference</title>
-
- <!-- REFENTRY: byteLength -->
- <section id="latka.ref.byteLength" xreflabel="byteLength">
- <title>byteLength</title>
- <para>
- validates the length of an HTTP(S) response
- </para>
- <section>
- <title>DTD</title>
- <programlisting><!ELEMENT byteLength EMPTY>
-<!ATTLIST byteLength min CDATA "0"
- max CDATA #IMPLIED
- label CDATA #IMPLIED></programlisting>
- </section>
- <section>
- <title>Attributes</title>
- <informaltable colsep="1" rowsep="1">
- <tgroup cols="4">
- <colspec colwidth="1in"/>
- <colspec colwidth="1in"/>
- <colspec colwidth="1in"/>
- <colspec colwidth="2in"/>
- <thead>
- <row>
- <entry>Name</entry>
- <entry>Type</entry>
- <entry>Default</entry>
- <entry>Description</entry>
- </row>
- </thead>
- <tbody>
- <row>
- <entry><sgmltag class="attribute">min</sgmltag></entry>
- <entry>NUMBER</entry>
- <entry><sgmltag class="attvalue">0</sgmltag></entry>
- <entry>
- Minimum number of bytes required for a valid
- response. Implied. Defaults to
- <sgmltag class="attvalue">0</sgmltag>.
- </entry>
- </row>
- <row>
- <entry><sgmltag class="attribute">max</sgmltag></entry>
- <entry>NUMBER</entry>
- <entry><emphasis>none</emphasis></entry>
- <entry>
- Maximum number of bytes required for a valid
- response. Optional. When absent, there is no
- upper limit on the number of bytes in a valid
- response.
- </entry>
- </row>
- <row>
- <entry><sgmltag class="attribute">label</sgmltag></entry>
- <entry>CDATA</entry>
- <entry><emphasis>none</emphasis></entry>
- <entry>
- Label associated with this validation, which may
- be used in programatically generated documentation
- or reports. Optional.
- </entry>
- </row>
- </tbody>
- </tgroup>
- </informaltable>
- </section>
- <section>
- <title>Parents</title>
- <simplelist type="inline">
- <member><xref linkend="latka.ref.validate"/></member>
- </simplelist>
- </section>
- <section>
- <title>Description</title>
- <para>
- A <sgmltag>byteLength</sgmltag> validation
- passes if the HTTP(S) response is at least
- <sgmltag class="attribute">min</sgmltag>
- bytes long, and (when specified) at most
- <sgmltag class="attribute">max</sgmltag> bytes long.
- </para>
- </section>
- </section>
-
- <!-- REFENTRY: COOKIE -->
- <section id="latka.ref.cookie" xreflabel="cookie">
- <title>cookie</title>
- <para>
- validates the presence of an HTTP(S) cookie in a response
- </para>
- <section>
- <title>DTD</title>
- <programlisting><![CDATA[<!ELEMENT cookie EMPTY>
-<!ATTLIST cookie name CDATA #REQUIRED
- value CDATA #IMPLIED
- label CDATA #IMPLIED>]]></programlisting>
- </section>
- <section>
- <title>Attributes</title>
- <informaltable colsep="1" rowsep="1">
- <tgroup cols="4">
- <colspec colwidth="1in"/>
- <colspec colwidth="1in"/>
- <colspec colwidth="1in"/>
- <colspec colwidth="2in"/>
- <thead>
- <row>
- <entry>Name</entry>
- <entry>Type</entry>
- <entry>Default</entry>
- <entry>Description</entry>
- </row>
- </thead>
- <tbody>
- <row>
- <entry><sgmltag class="attribute">name</sgmltag></entry>
- <entry>CDATA</entry>
- <entry><emphasis>none, but required</emphasis></entry>
- <entry>
- The name of the cookie to look for.
- Required.
- </entry>
- </row>
- <row>
- <entry><sgmltag class="attribute">value</sgmltag></entry>
- <entry>CDATA</entry>
- <entry><emphasis>none, optional</emphasis></entry>
- <entry>
- The value that the cookie with the specified name should
- have (if any).
- </entry>
- </row>
- <row>
- <entry><sgmltag class="attribute">label</sgmltag></entry>
- <entry>CDATA</entry>
- <entry><emphasis>none</emphasis></entry>
- <entry>
- Label associated with this validation, which may
- be used in programatically generated documentation
- or reports. Optional.
- </entry>
- </row>
- </tbody>
- </tgroup>
- </informaltable>
- </section>
- <section>
- <title>Parents</title>
- <simplelist type="inline">
- <member><xref linkend="latka.ref.validate"/></member>
- </simplelist>
- </section>
- <section>
- <title>Description</title>
- <para>
- A <sgmltag>cookie</sgmltag> validation
- passes if the HTTP(S) response contains a cookie with the
- specified <sgmltag class="attribute">name</sgmltag>.
- If a <sgmltag class="attribute">value</sgmltag> is provided,
- the cookie must also have the specified value.
- </para>
- </section>
- </section>
-
- <!-- REFENTRY: CREDENTIALS -->
- <section id="latka.ref.credentials" xreflabel="credentials">
- <title>credentials</title>
- <para>
- username/password credentials for Basic HTTP authentication.
- </para>
- <section>
- <title>DTD</title>
- <programlisting><![CDATA[<!ELEMENT credentials EMPTY>
-<!ATTLIST credentials userName CDATA #REQUIRED
- password CDATA #REQUIRED>]]></programlisting>
- </section>
- <section>
- <title>Attributes</title>
- <informaltable colsep="1" rowsep="1">
- <tgroup cols="4">
- <colspec colwidth="1in"/>
- <colspec colwidth="1in"/>
- <colspec colwidth="1in"/>
- <colspec colwidth="2in"/>
- <thead>
- <row>
- <entry>Name</entry>
- <entry>Type</entry>
- <entry>Default</entry>
- <entry>Description</entry>
- </row>
- </thead>
- <tbody>
- <row>
- <entry><sgmltag class="attribute">userName</sgmltag></entry>
- <entry>CDATA</entry>
- <entry><emphasis>none, required</emphasis></entry>
- <entry>User name. Required.</entry>
- </row>
- <row>
- <entry><sgmltag class="attribute">password</sgmltag></entry>
- <entry>CDATA</entry>
- <entry><emphasis>none, required</emphasis></entry>
- <entry>Password. Required.</entry>
- </row>
- </tbody>
- </tgroup>
- </informaltable>
- </section>
- <section>
- <title>Parents</title>
- <simplelist type="inline">
- <member><xref linkend="latka.ref.request"/></member>
- </simplelist>
- </section>
- <section>
- <title>Description</title>
- <para>
- Contains credentials for HTTP Basic Authentication.
- </para>
- </section>
- </section>
-
- <!-- REFENTRY: maxRequestTime -->
- <section id="latka.ref.maxRequestTime" xreflabel="maxRequestTime">
- <title>maxRequestTime</title>
- <para>validates the response time for an HTTP(S) request</para>
- <section>
- <title>DTD</title>
- <programlisting><![CDATA[<!ELEMENT maxRequestTime EMPTY>
-<!ATTLIST maxRequestTime millis CDATA "30000"
- message CDATA #IMPLIED>]]></programlisting>
- </section>
- <section>
- <title>Attributes</title>
- <informaltable colsep="1" rowsep="1">
- <tgroup cols="4">
- <colspec colwidth="1in"/>
- <colspec colwidth="1in"/>
- <colspec colwidth="1in"/>
- <colspec colwidth="2in"/>
- <thead>
- <row>
- <entry>Name</entry>
- <entry>Type</entry>
- <entry>Default</entry>
- <entry>Description</entry>
- </row>
- </thead>
- <tbody>
- <row>
- <entry><sgmltag class="attribute">millis</sgmltag></entry>
- <entry>NUMBER</entry>
- <entry><sgmltag class="attvalue">30000</sgmltag></entry>
- <entry>
- Maximum amount of time, in milliseconds, in which
- a response must be returned to be considered a
- valid response. Implied. Defaults to
- <sgmltag class="attvalue">30000</sgmltag> milliseconds,
- or 30 seconds.
- </entry>
- </row>
- <row>
- <entry><sgmltag class="attribute">label</sgmltag></entry>
- <entry>CDATA</entry>
- <entry><emphasis>none</emphasis></entry>
- <entry>
- Label associated with this validation, which may
- be used in programatically generated documentation
- or reports. Optional.
- </entry>
- </row>
- </tbody>
- </tgroup>
- </informaltable>
- </section>
- <section>
- <title>Parents</title>
- <simplelist type="inline">
- <member><xref linkend="latka.ref.validate"/></member>
- </simplelist>
- </section>
- <section>
- <title>Description</title>
- <para>
- A <sgmltag>maxRequestTime</sgmltag> validation
- passes if the HTTP(S) response is obtained in no more than
- <sgmltag class="attribute">millis</sgmltag> milliseconds.
- </para>
- </section>
- </section>
-
- <!-- REFENTRY: PARAM -->
- <section id="latka.ref.param" xreflabel="param">
- <title>param</title>
- <para>indicates a request parameter as part of an HTTP(S) request to be
executed</para>
- <section>
- <title>DTD</title>
- <programlisting><!ELEMENT request (<xref
linkend="latka.ref.paramName"/>, <xref
linkend="latka.ref.paramValue"/>)></programlisting>
- </section>
- <section>
- <title>Attributes</title>
- <para>
- <emphasis>None.</emphasis>
- </para>
- </section>
- <section>
- <title>Parents</title>
- <simplelist type="inline">
- <member><xref linkend="latka.ref.request"/></member>
- </simplelist>
- </section>
- <section>
- <title>Description</title>
- <para>
- A parameter to be submitted as part of a <xref
linkend="latka.ref.request"/>.
- </para>
- </section>
- </section>
-
- <!-- REFENTRY: paramName -->
- <section id="latka.ref.paramName" xreflabel="paramName">
- <title>paramName</title>
- <para>the name part of a name/value pair parameter</para>
- <section>
- <title>DTD</title>
- <programlisting><!ELEMENT paramName (#PCDATA)></programlisting>
- </section>
- <section>
- <title>Attributes</title>
- <para>
- <emphasis>None.</emphasis>
- </para>
- </section>
- <section>
- <title>Parents</title>
- <simplelist type="inline">
- <member><xref linkend="latka.ref.param"/></member>
- </simplelist>
- </section>
- <section>
- <title>Description</title>
- <para>
- The name part of <xref linkend="latka.ref.param"/>
- to be submitted as part of a <xref linkend="latka.ref.request"/>.
- </para>
- </section>
- </section>
-
- <!-- REFENTRY: paramValue -->
- <section id="latka.ref.paramValue" xreflabel="paramValue">
- <title>paramValue</title>
- <para>the value part of a name/value pair parameter</para>
- <section>
- <title>DTD</title>
- <programlisting><!ELEMENT paramValue (#PCDATA)></programlisting>
- </section>
- <section>
- <title>Attributes</title>
- <para>
- <emphasis>None.</emphasis>
- </para>
- </section>
- <section>
- <title>Parents</title>
- <simplelist type="inline">
- <member><xref linkend="latka.ref.param"/></member>
- </simplelist>
- </section>
- <section>
- <title>Description</title>
- <para>
- The value part of <xref linkend="latka.ref.param"/>
- to be submitted as part of a <xref linkend="latka.ref.request"/>.
- </para>
- </section>
- </section>
-
- <!-- REFENTRY: REGEXP -->
- <section id="latka.ref.regexp" xreflabel="regexp">
- <title>regexp</title>
- <para>
- validates the presence or absence of a regular expression within an
HTTP(S) response
- </para>
- <section>
- <title>DTD</title>
- <programlisting><![CDATA[<!ELEMENT regexp EMPTY>
-<!ATTLIST regexp pattern CDATA #REQUIRED
- cond (true | false) "true"
- ignoreCase (true | false) "false"
- label CDATA #IMPLIED>]]></programlisting>
- </section>
- <section>
- <title>Attributes</title>
- <informaltable colsep="1" rowsep="1">
- <tgroup cols="4">
- <colspec colwidth="1in"/>
- <colspec colwidth="1in"/>
- <colspec colwidth="1in"/>
- <colspec colwidth="2in"/>
- <thead>
- <row>
- <entry>Name</entry>
- <entry>Type</entry>
- <entry>Default</entry>
- <entry>Description</entry>
- </row>
- </thead>
- <tbody>
- <row>
- <entry><sgmltag class="attribute">pattern</sgmltag></entry>
- <entry>CDATA</entry>
- <entry><emphasis>none, but required.</emphasis></entry>
- <entry>
- The regular expression to look for.
- </entry>
- </row>
- <row>
- <entry><sgmltag class="attribute">cond</sgmltag></entry>
- <entry>
- <emphasis>Enumeration:</emphasis>
- <simplelist>
- <member><sgmltag
class="attvalue">true</sgmltag></member>
- <member><sgmltag
class="attvalue">false</sgmltag></member>
- </simplelist>
- </entry>
- <entry><sgmltag class="attvalue">true</sgmltag></entry>
- <entry>
- When <sgmltag class="attvalue">true</sgmltag>,
- the given <sgmltag class="attribute">pattern</sgmltag>
- must match within the response.
- When <sgmltag class="attvalue">false</sgmltag>,
- the given <sgmltag class="attribute">pattern</sgmltag>
- must not match within the response.
- </entry>
- </row>
- <row>
- <entry><sgmltag
class="attribute">ignoreCase</sgmltag></entry>
- <entry>
- <emphasis>Enumeration:</emphasis>
- <simplelist>
- <member><sgmltag
class="attvalue">true</sgmltag></member>
- <member><sgmltag
class="attvalue">false</sgmltag></member>
- </simplelist>
- </entry>
- <entry><sgmltag class="attvalue">false</sgmltag></entry>
- <entry>
- When <sgmltag class="attvalue">true</sgmltag>,
- case is ignored within the
- given <sgmltag class="attribute">pattern</sgmltag>.
- </entry>
- </row>
- <row>
- <entry><sgmltag class="attribute">label</sgmltag></entry>
- <entry>CDATA</entry>
- <entry><emphasis>none</emphasis></entry>
- <entry>
- Label associated with this validation, which may
- be used in programatically generated documentation
- or reports. Optional.
- </entry>
- </row>
- </tbody>
- </tgroup>
- </informaltable>
- </section>
- <section>
- <title>Parents</title>
- <simplelist type="inline">
- <member><xref linkend="latka.ref.validate"/></member>
- </simplelist>
- </section>
- <section>
- <title>Description</title>
- <para>
- A <sgmltag>maxRequestTime</sgmltag> validation
- passes if the HTTP(S) response is obtained in no more than
- <sgmltag class="attribute">millis</sgmltag> milliseconds.
- </para>
- </section>
- </section>
-
- <!-- REFENTRY: REQUEST -->
- <section id="latka.ref.request" xreflabel="request">
- <title>request</title>
-
-
- <para>indicates an HTTP(S) request to be executed</para>
-
- <section>
- <title>DTD</title>
- <programlisting><!ELEMENT request (<xref
linkend="latka.ref.credentials"/>?, <xref linkend="latka.ref.param"/>*, <xref
linkend="latka.ref.validate"/>?)>
-<!ATTLIST request path CDATA #REQUIRED
- method (post | get) "get"
- host CDATA #IMPLIED
- port CDATA #IMPLIED
- label CDATA #IMPLIED></programlisting>
- </section>
- <section>
- <title>Attributes</title>
- <para>
- <informaltable colsep="1" rowsep="1">
- <tgroup cols="4">
- <colspec colwidth="1in"/>
- <colspec colwidth="1in"/>
- <colspec colwidth="1in"/>
- <colspec colwidth="2in"/>
- <thead>
- <row>
- <entry>Name</entry>
- <entry>Type</entry>
- <entry>Default</entry>
- <entry>Description</entry>
- </row>
- </thead>
- <tbody>
- <row>
- <entry><sgmltag class="attribute">path</sgmltag></entry>
- <entry>CDATA</entry>
- <entry><emphasis>none, but required</emphasis></entry>
- <entry>Request path. Required.</entry>
- </row>
- <row>
- <entry><sgmltag
class="attribute">method</sgmltag></entry>
- <entry>
- <emphasis>enumeration:</emphasis>
- <simplelist>
- <member><sgmltag
class="attvalue">get</sgmltag></member>
- <member><sgmltag
class="attvalue">post</sgmltag></member>
- </simplelist>
- </entry>
- <entry><sgmltag class="attvalue">get</sgmltag></entry>
- <entry>HTTP method. Implied. Defaults to <sgmltag
class="attvalue">get</sgmltag>.</entry>
- </row>
- <row>
- <entry><sgmltag class="attribute">host</sgmltag></entry>
- <entry>CDATA</entry>
- <entry><emphasis>none</emphasis></entry>
- <entry>
- Host to submit request to.
- Optional.
- When absent, uses default from <xref
linkend="latka.ref.suite"/>.
- </entry>
- </row>
- <row>
- <entry><sgmltag class="attribute">port</sgmltag></entry>
- <entry>NUMBER</entry>
- <entry><emphasis>depends upon protocol</emphasis></entry>
- <entry>
- Port to submit request to.
- Optional.
- When absent, uses default from <xref
linkend="latka.ref.suite"/>.
- </entry>
- </row>
- <row>
- <entry><sgmltag class="attribute">label</sgmltag></entry>
- <entry>CDATA</entry>
- <entry><emphasis>none</emphasis></entry>
- <entry>
- Label associated with this validation, which may
- be used in programatically generated documentation
- or reports. Optional.
- </entry>
- </row>
- </tbody>
- </tgroup>
- </informaltable>
- </para>
- </section>
- <section>
- <title>Parents</title>
- <simplelist type="inline">
- <member><xref linkend="latka.ref.suite"/></member>
- <member><xref linkend="latka.ref.session"/></member>
- </simplelist>
- </section>
- <section>
- <title>Description</title>
- <para>
- An HTTP(S) request to be executed.
- </para>
- </section>
- </section>
-
- <!-- REFENTRY: SESSION -->
- <section id="latka.ref.session" xreflabel="session">
- <title>session</title>
-
-
- <para>wrapper for a sequence of <xref linkend="latka.ref.request"/>s
associated with the same state (session)</para>
-
- <section>
- <title>DTD</title>
- <programlisting><!ELEMENT session (<xref
linkend="latka.ref.request"/>+)>
-<!ATTLIST session sessionId CDATA #IMPLIED
- label CDATA #IMPLIED></programlisting>
- </section>
- <section>
- <title>Attributes</title>
- <informaltable colsep="1" rowsep="1">
- <tgroup cols="4">
- <colspec colwidth="1in"/>
- <colspec colwidth="1in"/>
- <colspec colwidth="1in"/>
- <colspec colwidth="2in"/>
- <thead>
- <row>
- <entry>Name</entry>
- <entry>Type</entry>
- <entry>Default</entry>
- <entry>Description</entry>
- </row>
- </thead>
- <tbody>
- <row>
- <entry><sgmltag
class="attribute">sessionId</sgmltag></entry>
- <entry>CDATA</entry>
- <entry><emphasis>none</emphasis></entry>
- <entry>
- Unique identifier for this <sgmltag>session</sgmltag>.
- Sessions with the same <sgmltag
class="attribute">sessionId</sgmltag>
- will share the same underlying state (e.g., cookies,
etc.)
- </entry>
- </row>
- <row>
- <entry><sgmltag class="attribute">label</sgmltag></entry>
- <entry>CDATA</entry>
- <entry><emphasis>none</emphasis></entry>
- <entry>
- Label associated with this <sgmltag>session</sgmltag>,
which may
- be used in programatically generated documentation
- or reports. Optional.
- </entry>
- </row>
- </tbody>
- </tgroup>
- </informaltable>
- </section>
- <section>
- <title>Parents</title>
- <simplelist type="inline">
- <member><xref linkend="latka.ref.suite"/></member>
- </simplelist>
- </section>
- <section>
- <title>Description</title>
- <para>
- A <sgmltag>session</sgmltag> is a collection of
- <xref linkend="latka.ref.request"/>s
- that share the same underlying state. For example,
- a cookie that returned in the response to one
- <xref linkend="latka.ref.request"/>
- will be included in subsequent
- <xref linkend="latka.ref.request"/>s.
- </para>
- </section>
- </section>
-
- <!-- REFENTRY: statusCode -->
- <section id="latka.ref.statusCode" xreflabel="statusCode">
- <title>statusCode</title>
-
-
- <para>validates an HTTP response code</para>
-
- <section>
- <title>DTD</title>
- <programlisting><![CDATA[<!ELEMENT statusCode EMPTY>
-<!ATTLIST statusCode code CDATA "200"
- label CDATA #IMPLIED>]]></programlisting>
- </section>
- <section>
- <title>Attributes</title>
- <informaltable colsep="1" rowsep="1">
- <tgroup cols="4">
- <colspec colwidth="1in"/>
- <colspec colwidth="1in"/>
- <colspec colwidth="1in"/>
- <colspec colwidth="2in"/>
- <thead>
- <row>
- <entry>Name</entry>
- <entry>Type</entry>
- <entry>Default</entry>
- <entry>Description</entry>
- </row>
- </thead>
- <tbody>
- <row>
- <entry><sgmltag class="attribute">code</sgmltag></entry>
- <entry>NUMBER</entry>
- <entry><sgmltag class="attvalue">200</sgmltag></entry>
- <entry>
- Numeric HTTP response code to expect.
- Implied. Defaults to
- <sgmltag class="attvalue">200</sgmltag>.
- </entry>
- </row>
- <row>
- <entry><sgmltag class="attribute">label</sgmltag></entry>
- <entry>CDATA</entry>
- <entry><emphasis>none</emphasis></entry>
- <entry>
- Label associated with this validation, which may
- be used in programatically generated documentation
- or reports. Optional.
- </entry>
- </row>
- </tbody>
- </tgroup>
- </informaltable>
- </section>
- <section>
- <title>Parents</title>
- <simplelist type="inline">
- <member><xref linkend="latka.ref.validate"/></member>
- </simplelist>
- </section>
- <section>
- <title>Description</title>
- <para>
- A <sgmltag>statusCode</sgmltag> validation
- passes if the HTTP(S) response code for the given request
- matches the value specified by
- <sgmltag class="attribute">code</sgmltag>.
- </para>
- </section>
- </section>
-
- <!-- REFENTRY: SUITE -->
- <section id="latka.ref.suite" xreflabel="suite">
- <title>suite</title>
-
-
- <para>root element for a suite of tests</para>
-
- <section>
- <title>DTD</title>
- <programlisting><!ELEMENT suite ( (<xref
linkend="latka.ref.session"/> | <xref linkend="latka.ref.request"/>)+ )>
-<!ATTLIST suite defaultHost CDATA #IMPLIED
- defaultPort CDATA #IMPLIED
- label CDATA #IMPLIED></programlisting>
- </section>
- <section>
- <title>Attributes</title>
- <informaltable colsep="1" rowsep="1">
- <tgroup cols="4">
- <colspec colwidth="1in"/>
- <colspec colwidth="1in"/>
- <colspec colwidth="1in"/>
- <colspec colwidth="2in"/>
- <thead>
- <row>
- <entry>Name</entry>
- <entry>Type</entry>
- <entry>Default</entry>
- <entry>Description</entry>
- </row>
- </thead>
- <tbody>
- <row>
- <entry><sgmltag
class="attribute">defaultHost</sgmltag></entry>
- <entry>CDATA</entry>
- <entry><emphasis>none</emphasis></entry>
- <entry>
- Default hostname for <xref
linkend="latka.ref.request"/>s. Optional.
- </entry>
- </row>
- <row>
- <entry><sgmltag
class="attribute">defaultPort</sgmltag></entry>
- <entry>NUMBER</entry>
- <entry><emphasis>none</emphasis></entry>
- <entry>
- Default port for <xref linkend="latka.ref.request"/>s.
Optional.
- </entry>
- </row>
- <row>
- <entry><sgmltag class="attribute">label</sgmltag></entry>
- <entry>CDATA</entry>
- <entry><emphasis>none</emphasis></entry>
- <entry>
- Label associated with this <sgmltag>suite</sgmltag>,
which may
- be used in programatically generated documentation
- or reports. Optional.
- </entry>
- </row>
- </tbody>
- </tgroup>
- </informaltable>
- </section>
- <section>
- <title>Parents</title>
- <para>
- <emphasis>None.</emphasis>
- </para>
- </section>
- <section>
- <title>Description</title>
- <para>
- A <sgmltag>suite</sgmltag> is a collection of
- <xref linkend="latka.ref.request"/>s
- and <xref linkend="latka.ref.session"/>s
- to execute.
- </para>
- </section>
- </section>
-
-
- <!-- REFENTRY: VALIDATE -->
- <section id="latka.ref.validate" xreflabel="validate">
- <title>validate</title>
-
-
- <para>
- indicates the suite of validations to apply to the
- current <xref linkend="latka.ref.request"/> (and its response)
- </para>
-
- <section>
- <title>DTD</title>
- <programlisting><!ELEMENT validate (<xref
linkend="latka.ref.byteLength"/> | <xref linkend="latka.ref.cookie"/> | <xref
linkend="latka.ref.maxRequestTime"/> | <xref linkend="latka.ref.regexp"/> | <xref
linkend="latka.ref.statusCode"/> | <xref linkend="latka.ref.xpath"/>
)+></programlisting>
- </section>
- <section>
- <title>Attributes</title>
- <para>
- <emphasis>None.</emphasis>
- </para>
- </section>
- <section>
- <title>Parents</title>
- <simplelist type="inline">
- <member><xref linkend="latka.ref.request"/></member>
- </simplelist>
- </section>
- <section>
- <title>Description</title>
- <para>
- Contains the set of validations to apply to the
- current <xref linkend="latka.ref.request"/>
- (and its response).
- </para>
- </section>
- </section>
-
- <!-- REFENTRY: xpath -->
- <section id="latka.ref.xpath" xreflabel="xpath">
- <title>xpath</title>
-
- <para>
- xpath - assuming the HTTP(s) response contains XML, checks if an
- <ulink url="http://www.w3.org/TR/xpath";>XPath</ulink> expression matches
- </para>
-
-
- <section>
- <title>DTD</title>
- <programlisting><!ELEMENT xpath EMPTY>
-<!ATTLIST xpath select CDATA #REQUIRED
- cond (true | false) "true"
- value CDATA #IMPLIED
- label CDATA #IMPLIED></programlisting>
- </section>
-
- <section>
- <title>Attributes</title>
- <informaltable colsep="1" rowsep="1">
- <tgroup cols="4">
- <colspec colwidth="1in"/>
- <colspec colwidth="1in"/>
- <colspec colwidth="1in"/>
- <colspec colwidth="2in"/>
- <thead>
- <row>
- <entry>Name</entry>
- <entry>Type</entry>
- <entry>Default</entry>
- <entry>Description</entry>
- </row>
- </thead>
- <tbody>
- <row>
- <entry><sgmltag class="attribute">select</sgmltag></entry>
- <entry>CDATA</entry>
- <entry><emphasis>none</emphasis></entry>
- <entry>
- An XPath expression, designed to match a node in the
- XML body of the response.
- </entry>
- </row>
- <row>
- <entry><sgmltag class="attribute">cond</sgmltag></entry>
- <entry>
- <emphasis>Enumeration:</emphasis>
- <simplelist>
- <member><sgmltag
class="attvalue">true</sgmltag></member>
- <member><sgmltag
class="attvalue">false</sgmltag></member>
- </simplelist>
- </entry>
- <entry>
- <sgmltag class="attvalue">true</sgmltag>
- </entry>
- <entry>
- When <sgmltag class="attvalue">true</sgmltag>, the given
XPath expression must match within the
- response. When <sgmltag class="attvalue">false</sgmltag>,
the given XPath expression must not
- match within the response.
- </entry>
- </row>
-
- <row>
- <entry><sgmltag class="attribute">value</sgmltag></entry>
- <entry>
- CDATA
- </entry>
- <entry>
- <emphasis>none, optional</emphasis>
- </entry>
- <entry>
- The value that the matched node should have, if any.
- </entry>
- </row>
-
- <row>
- <entry><sgmltag class="attribute">label</sgmltag></entry>
- <entry>
- CDATA
- </entry>
- <entry>
- <emphasis>none</emphasis>
- </entry>
- <entry>
- Label associated with this validation, which may be used
- in programatically generated documentation or reports.
Optional.
- </entry>
- </row>
- </tbody>
- </tgroup>
- </informaltable>
- </section>
- <section>
- <title>Parents</title>
- <simplelist type="inline">
- <member><xref linkend="latka.ref.validate"/></member>
- </simplelist>
- </section>
- <section>
- <title>Description</title>
- <para>
- A xpath validation passes if the HTTP(S) response body contains XML,
- and the specified XPath expression matches (or not, depending on
cond)
- </para>
- </section>
- </section>
- </section>
</chapter>
--
To unsubscribe, e-mail: <mailto:[EMAIL PROTECTED]>
For additional commands, e-mail: <mailto:[EMAIL PROTECTED]>
