morgand 02/01/15 14:29:14
Modified: latka/doc index.xml
Log:
xpath validator doco
Revision Changes Path
1.2 +126 -13 jakarta-commons/latka/doc/index.xml
Index: index.xml
===================================================================
RCS file: /home/cvs/jakarta-commons/latka/doc/index.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- index.xml 15 Jan 2002 21:56:02 -0000 1.1
+++ index.xml 15 Jan 2002 22:29:13 -0000 1.2
@@ -33,7 +33,7 @@
</listitem>
<listitem>
(for optional SSL support)
- Sun JSSE library
+ <ulink url="http://java.sun.com/security/index.html";>Sun JSSE
library</ulink>
</listitem>
</itemizedlist>
</sect2>
@@ -41,10 +41,14 @@
<sect2>
<title>General installation</title>
<orderedlist>
- <listitem>Download and uncompress the Latka distribution.</listitem>
+ <listitem>
+ Download and uncompress the
+ <ulink
url="http://jakarta.apache.org/builds/jakarta-commons/release/commons-latka";>Latka
distribution</ulink>.
+ </listitem>
<listitem>
If you wish to perform Latka test over SSL,
- you need to configure your JVM with the Sun JSSE library.
+ you need to configure your JVM with the
+ <ulink url="http://java.sun.com/security/index.html";>Sun JSSE
library</ulink>.
</listitem>
</orderedlist>
</sect2>
@@ -304,7 +308,7 @@
<sect3>
<title>DTD</title>
<programlisting><![CDATA[<!ELEMENT credentials EMPTY>
-<!ATTLIST credentials user_name CDATA #REQUIRED
+<!ATTLIST credentials userName CDATA #REQUIRED
password CDATA #REQUIRED>]]></programlisting>
</sect3>
<sect3>
@@ -325,7 +329,7 @@
</thead>
<tbody>
<row>
- <entry><sgmltag
class="attribute">user_name</sgmltag></entry>
+ <entry><sgmltag class="attribute">userName</sgmltag></entry>
<entry>CDATA</entry>
<entry><emphasis>none, required</emphasis></entry>
<entry>User name. Required.</entry>
@@ -725,7 +729,7 @@
<sect3>
<title>DTD</title>
<programlisting><!ELEMENT session (<xref
linkend="latka.ref.request"/>+)>
-<!ATTLIST session session_id CDATA #IMPLIED
+<!ATTLIST session sessionId CDATA #IMPLIED
label CDATA #IMPLIED></programlisting>
</sect3>
<sect3>
@@ -746,12 +750,12 @@
</thead>
<tbody>
<row>
- <entry><sgmltag
class="attribute">session_id</sgmltag></entry>
+ <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">session_id</sgmltag>
+ Sessions with the same <sgmltag
class="attribute">sessionId</sgmltag>
will share the same underlying state (e.g., cookies,
etc.)
</entry>
</row>
@@ -870,8 +874,8 @@
<sect3>
<title>DTD</title>
<programlisting><!ELEMENT suite ( (<xref
linkend="latka.ref.session"/> | <xref linkend="latka.ref.request"/>)+ )>
-<!ATTLIST suite default_host CDATA #IMPLIED
- default_port CDATA #IMPLIED
+<!ATTLIST suite defaultHost CDATA #IMPLIED
+ defaultPort CDATA #IMPLIED
label CDATA #IMPLIED></programlisting>
</sect3>
<sect3>
@@ -892,7 +896,7 @@
</thead>
<tbody>
<row>
- <entry><sgmltag
class="attribute">default_host</sgmltag></entry>
+ <entry><sgmltag
class="attribute">defaultHost</sgmltag></entry>
<entry>CDATA</entry>
<entry><emphasis>none</emphasis></entry>
<entry>
@@ -900,7 +904,7 @@
</entry>
</row>
<row>
- <entry><sgmltag
class="attribute">default_port</sgmltag></entry>
+ <entry><sgmltag
class="attribute">defaultPort</sgmltag></entry>
<entry>NUMBER</entry>
<entry><emphasis>none</emphasis></entry>
<entry>
@@ -951,7 +955,7 @@
<sect3>
<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"/> )+></programlisting>
+ <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>
</sect3>
<sect3>
<title>Attributes</title>
@@ -974,6 +978,115 @@
</para>
</sect3>
</sect2>
+
+ <!-- REFENTRY: xpath -->
+ <sect2 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>
+
+
+ <sect3>
+ <title>DTD</title>
+ <programlisting><!ELEMENT xpath EMPTY>
+<!ATTLIST xpath select CDATA #REQUIRED
+ cond (true | false) "true"
+ value CDATA #IMPLIED
+ label CDATA #IMPLIED></programlisting>
+ </sect3>
+
+ <sect3>
+ <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>
+ </sect3>
+ <sect3>
+ <title>Parents</title>
+ <simplelist type="inline">
+ <member><sgmltag><xref
linkend="latka.ref.validate"/></sgmltag></member>
+ </simplelist>
+ </sect3>
+ <sect3>
+ <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>
+ </sect3>
+ </sect2>
</sect1>
</chapter>
--
To unsubscribe, e-mail: <mailto:[EMAIL PROTECTED]>
For additional commands, e-mail: <mailto:[EMAIL PROTECTED]>
