Brutex
/
XServices
1
0
Fork 0
Code Issues 2 Pull Requests Actions Projects Releases 4 Wiki Activity

Moving to docbook style documentation 

git-svn-id: https://brutex.net/svn/xservices/trunk@25 e7e49efb-446e-492e-b9ec-fcafc1997a86
tag-20130205r
Brian Rosenberger 2010-02-16 11:20:25 +00:00
parent 84243b901d
commit 812e24bec2
12 changed files with 128 additions and 421 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
doc/buch.xml → doc/BruteXServices_User_Guide.xml
View File

@ -13,14 +13,28 @@
<book> <book>
<title>&brs; User Guide</title> <title>&brs; User Guide</title>
<bookinfo> <bookinfo>
<date>February, 16th 2010</date>
<author> <author>
<firstname>Brian</firstname> <firstname>Brian</firstname>
<surname>Rosenberger</surname> <surname>Rosenberger</surname>
<email>bru@brutex.de</email> <email>bru@brutex.de</email>
</author> </author>
<corpname>Brutex Network</corpname> <corpname>Brutex Network</corpname>
<pubdate>1997</pubdate>
<copyright> <copyright>
<year>2010</year> <year>2010</year>
</copyright> </copyright>
<legalnotice>
<para>The copyright holders make no representation about the suitability of
this document for any purpose. It is provided <quote>as is</quote> without expressed
or implied warranty.</para>
</legalnotice>
<legalnotice>
<para>
Apache Tomcat and Apache Ant are trademarks of the Apache Software Foundation.
</para>
</legalnotice>
<abstract>
&abstract; </abstract>
</bookinfo> </bookinfo>
&abstract;&getting-started;&xservices;&types;</book> &getting-started;&xservices;&types;</book>

2
doc/ExecuteServices/runCommand.xml
View File

@ -24,7 +24,7 @@
<entry>executable</entry> <entry>executable</entry>
<entry>String</entry> <entry>String</entry>
<entry>Yes</entry> <entry>Yes</entry>
<entry>Command to be run. The command may be specified with full path using forward slash “/” as path separator.</entry> <entry>Command to be run. The command may be specified with full path using forward slash &quot;/&quot; as path separator.</entry>
</row> </row>
<row> <row>
<entry>argline</entry> <entry>argline</entry>

2
doc/Types.xml
View File

@ -1,4 +1,4 @@
<?xml version='1.0' encoding='UTF-8'?><chapter> <?xml version='1.0' encoding='UTF-8'?><chapter>
<title>XML Types</title> <title>XML Types</title>
<para>This chapter bundles the documentation for common xml types used by XServices web service.</para> <para>This chapter bundles the documentation for common xml types used by XServices web service.</para>
&returncode;&antproperty;&patternelement;</chapter> &returncode;&patternsettype;&selectortype;&antproperty;&patternelement;</chapter>

21
doc/abstract.xml
View File

@ -1,21 +1,20 @@
<?xml version='1.0' encoding='UTF-8'?><chapter> <?xml version='1.0' encoding='UTF-8'?>
<title>Abstract</title> <title>Abstract</title>
<para>In complex IT environments it is necessary to integrate different information systems with each other, exchange data between tools and automate actions and function calls depending on events arising from user interaction. To meet the requirements of integration building usually means to implement APIs and to create tool-to-tool bridges. Web Services can help to clean up bridges into interfaces as well as to abstract functions from their underlying platform and implementation.</para> <para>In complex IT environments it is necessary to integrate different information systems with each other, exchange data between tools and automate actions and function calls depending on events arising from user interaction. To meet the requirements of integration building usually means to implement APIs and to create tool-to-tool bridges. Web Services can help to clean up bridges into interfaces as well as to abstract functions from their underlying platform and implementation.</para>
<para>These are the major goals of the loosely coupled integration strategy which is in turn one essential idea of a service-oriented architecture (SOA).</para> <para>These are the major goals of the loosely coupled integration strategy which is in turn one essential idea of a service-oriented architecture (SOA).</para>
<para>&brs; provide a low level set of functions and web services. These can be orchestrated into services and used in business processes which make up the execution part of a SOA environment.</para> <para>&brs; provide a low level set of functions and web services. These can be orchestrated into services and used in business processes which make up the execution part of a SOA environment.</para>
<para>&brs; is an add-on to XBridgeNG 2.0. It runs standalone or in combination with XBridgeNG. Pure XBridgeNG has two components:</para> <para>&brs; is an add-on to XBridgeNG 2.0. It runs standalone or in combination with XBridgeNG. Pure XBridgeNG has two components:</para>
<itemizedlist> <para><itemizedlist>
<listitem> <listitem>
<para>XML Schema for item based data types (e.g. tickets from a bug tracker system or a database record)</para> <para>XML Schema for item based data types (e.g. tickets from a bug tracker system or a database record)</para>
</listitem> </listitem>
<listitem> <listitem>
<para>Set of Apache Ant tasks to function as a bridge between the XBridgeNG XML format at legacy 3rd party software (e.g. HP Quality Center, Serena TeamTrack, …) <para>Set of Apache Ant tasks to function as a bridge between the XBridgeNG XML format at legacy 3rd party software (e.g. HP Quality Center, Serena TeamTrack, ...)</para>
</para>
</listitem> </listitem>
<listitem> <listitem>
<para>The &brs; add <para>The &brs; add
Web Services (SOAP) wrapper around Apache Ant tasks (since XBridgeNG 2.0)</para> Web Services (SOAP) wrapper around Apache Ant tasks (since XBridgeNG 2.0)</para>
</listitem> </listitem>
</itemizedlist> </itemizedlist>
<para>The current focus is on file-based operations. &brs; do not contain an integration server or a process execution engine.</para> </para>
</chapter> <para>The current focus is on file-based operations. &brs; do not contain an integration server or a process execution engine.</para>

361
doc/buch.html
View File

@ -1,361 +0,0 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>BruteXservices User Guide</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.68.1">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="book" lang="en">
<div class="titlepage">
<div>
<div><h1 class="title">
<a name="id2521065"></a><span class="application">BruteXservices</span> User Guide</h1></div>
<div><div class="author">
<h3 class="author">
<span class="firstname">Brian</span> <span class="surname">Rosenberger</span>
</h3>
<code class="email">&lt;<a href="mailto:bru@brutex.de">bru@brutex.de</a>&gt;</code>
</div></div>
<div><p class="copyright">Copyright © 2010 </p></div>
</div>
<hr>
</div>
<div class="toc">
<p><b>Table of Contents</b></p>
<dl>
<dt><span class="chapter"><a href="#id2530556">1. Abstract</a></span></dt>
<dt><span class="chapter"><a href="#id2521271">2. Getting startet</a></span></dt>
<dd><dl>
<dt><span class="sect1"><a href="#id2521225">Prerequisites</a></span></dt>
<dt><span class="sect1"><a href="#id2521243">Installation</a></span></dt>
<dd><dl>
<dt><span class="sect2"><a href="#id2521256">Securing <span class="application">BruteXservices</span> with Basic Authentication</a></span></dt>
<dt><span class="sect2"><a href="#id2520669">Limit access to <span class="application">BruteXservices</span></a></span></dt>
</dl></dd>
</dl></dd>
<dt><span class="chapter"><a href="#id2520743">3. <span class="application">BruteXservices</span></a></span></dt>
<dd><dl>
<dt><span class="section"><a href="#id2535352">ArchiveServices</a></span></dt>
<dt><span class="section"><a href="#id2520621">ExecuteServices</a></span></dt>
<dd><dl><dt><span class="section"><a href="#id2521931">runCommand</a></span></dt></dl></dd>
</dl></dd>
<dt><span class="chapter"><a href="#id2521830">4. XML Types</a></span></dt>
<dd><dl>
<dt><span class="section"><a href="#id2576253">ReturnCode type</a></span></dt>
<dd><dl>
<dt><span class="section"><a href="#id2576303">Schema description</a></span></dt>
<dt><span class="section"><a href="#id2576332">Example XML </a></span></dt>
</dl></dd>
<dt><span class="section"><a href="#antproperty">AntProperty type</a></span></dt>
<dd><dl>
<dt><span class="section"><a href="#id2535328">Schema description</a></span></dt>
<dt><span class="section"><a href="#id2535342">Example XML </a></span></dt>
</dl></dd>
<dt><span class="section"><a href="#patternelement">PatternElement type</a></span></dt>
<dd><dl>
<dt><span class="section"><a href="#id2534657">Schema description</a></span></dt>
<dt><span class="section"><a href="#id2534676">Example XML</a></span></dt>
</dl></dd>
</dl></dd>
</dl>
</div>
<div class="list-of-tables">
<p><b>List of Tables</b></p>
<dl><dt>3.1. <a href="#id2521913">runCommand input parameters</a>
</dt></dl>
</div>
<div class="chapter" lang="en">
<div class="titlepage"><div><div><h2 class="title">
<a name="id2530556"></a>Chapter 1. Abstract</h2></div></div></div>
<p>In complex IT environments it is necessary to integrate different information systems with each other, exchange data between tools and automate actions and function calls depending on events arising from user interaction. To meet the requirements of integration building usually means to implement APIs and to create tool-to-tool bridges. Web Services can help to clean up bridges into interfaces as well as to abstract functions from their underlying platform and implementation.</p>
<p>These are the major goals of the loosely coupled integration strategy which is in turn one essential idea of a service-oriented architecture (SOA).</p>
<p><span class="application">BruteXservices</span> provide a low level set of functions and web services. These can be orchestrated into services and used in business processes which make up the execution part of a SOA environment.</p>
<p><span class="application">BruteXservices</span> is an add-on to XBridgeNG 2.0. It runs standalone or in combination with XBridgeNG. Pure XBridgeNG has two components:</p>
<div class="itemizedlist"><ul type="disc">
<li><p>XML Schema for item based data types (e.g. tickets from a bug tracker system or a database record)</p></li>
<li><p>Set of Apache Ant tasks to function as a bridge between the XBridgeNG XML format at legacy 3rd party software (e.g. HP Quality Center, Serena TeamTrack, &#8230;)
</p></li>
<li><p>The <span class="application">BruteXservices</span> add
Web Services (SOAP) wrapper around Apache Ant tasks (since XBridgeNG 2.0)</p></li>
</ul></div>
<p>The current focus is on file-based operations. <span class="application">BruteXservices</span> do not contain an integration server or a process execution engine.</p>
</div>
<div class="chapter" lang="en">
<div class="titlepage"><div><div><h2 class="title">
<a name="id2521271"></a>Chapter 2. Getting startet</h2></div></div></div>
<div class="toc">
<p><b>Table of Contents</b></p>
<dl>
<dt><span class="sect1"><a href="#id2521225">Prerequisites</a></span></dt>
<dt><span class="sect1"><a href="#id2521243">Installation</a></span></dt>
<dd><dl>
<dt><span class="sect2"><a href="#id2521256">Securing <span class="application">BruteXservices</span> with Basic Authentication</a></span></dt>
<dt><span class="sect2"><a href="#id2520669">Limit access to <span class="application">BruteXservices</span></a></span></dt>
</dl></dd>
</dl>
</div>
<p>This chapter describes the installation.</p>
<div class="sect1" lang="en">
<div class="titlepage"><div><div><h2 class="title" style="clear: both">
<a name="id2521225"></a>Prerequisites</h2></div></div></div>
<p>tbd.</p>
<p>Sun Java SE 1.6.0</p>
<p>Apache Tomcat 6</p>
</div>
<div class="sect1" lang="en">
<div class="titlepage"><div><div><h2 class="title" style="clear: both">
<a name="id2521243"></a>Installation</h2></div></div></div>
<p>tbd.</p>
<p>In short: Deploy .WAR file to Apache Tomcat</p>
<div class="sect2" lang="en">
<div class="titlepage"><div><div><h3 class="title">
<a name="id2521256"></a>Securing <span class="application">BruteXservices</span> with Basic Authentication</h3></div></div></div>
<p>There is a quick guide explaining Basic Authentication for Tomcat here: </p>
<p><a href="http://oreilly.com/pub/a/java/archive/tomcat-tips.html?page=1" target="_top">http://oreilly.com/pub/a/java/archive/tomcat-tips.html?page=1</a></p>
</div>
<div class="sect2" lang="en">
<div class="titlepage"><div><div><h3 class="title">
<a name="id2520669"></a>Limit access to <span class="application">BruteXservices</span>
</h3></div></div></div>
<p>Sometimes you'll only want to restrict access to <span class="application">BruteXservices</span> to only specified host names or IP addresses. This way, only clients at those specified addresses can use the <span class="application">BruteXservices</span> web services. Tomcat provides two configuration values for that: RemoteHostValve and RemoteAddrValve.</p>
<p>These Valves allow you to filter requests by host name or by IP address, and to allow or deny hosts that match. The example below restricts access to the ArchiveService from any machine that is not the local host.</p>
<pre class="programlisting">&lt;Context path="/XService/ArchiveService" ...&gt;
&lt;Valve className="org.apache.catalina.valves.RemoteAddrValve"
allow="127.0.0.1" deny=""/&gt;
&lt;/Context&gt;</pre>
<p>If no allow pattern is given, then patterns that match the deny attribute patterns will be rejected, and all others will be allowed. Similarly, if no deny pattern is given, patterns that match the allow attribute will be allowed, and all others will be denied.</p>
<p>The &lt;context&gt; element must be placed into the server.xml file (into &lt;engine&gt;&lt;host&gt;).</p>
</div>
</div>
</div>
<div class="chapter" lang="en">
<div class="titlepage"><div><div><h2 class="title">
<a name="id2520743"></a>Chapter 3. <span class="application">BruteXservices</span>
</h2></div></div></div>
<div class="toc">
<p><b>Table of Contents</b></p>
<dl>
<dt><span class="section"><a href="#id2535352">ArchiveServices</a></span></dt>
<dt><span class="section"><a href="#id2520621">ExecuteServices</a></span></dt>
<dd><dl><dt><span class="section"><a href="#id2521931">runCommand</a></span></dt></dl></dd>
</dl>
</div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h2 class="title" style="clear: both">
<a name="id2535352"></a>ArchiveServices</h2></div></div></div>
<p>The ArchiveService bundles file packing operations. Its WSDL is located at
http://server:port/XServices/ArchiveService?wsdl</p>
</div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h2 class="title" style="clear: both">
<a name="id2520621"></a>ExecuteServices</h2></div></div></div>
<p>The ExecuteService bundles local and remote command execution operations. Its WSDL is located at
http://server:port/XServices/ExecuteService?wsdl</p>
<div class="section" lang="en">
<div class="titlepage"><div><div><h3 class="title">
<a name="id2521931"></a>runCommand</h3></div></div></div>
<p>Run an executable with arguments on the server providing the web service. The command is run within the environment and under the user privileges of the user who is running the Tomcat Server.</p>
<div class="section" lang="en">
<div class="titlepage"><div><div><h4 class="title">
<a name="id2521943"></a>Input parameters</h4></div></div></div>
<p></p>
<div class="table">
<a name="id2521913"></a><p class="title"><b>Table 3.1. runCommand input parameters</b></p>
<table summary="runCommand input parameters" border="1">
<colgroup>
<col>
<col>
<col>
<col>
</colgroup>
<thead><tr>
<th>parameter</th>
<th>type</th>
<th>required</th>
<th>description</th>
</tr></thead>
<tbody>
<tr>
<td>executable</td>
<td>String</td>
<td>Yes</td>
<td>Command to be run. The command may be specified with full path using forward slash &#8220;/&#8221; as path separator.</td>
</tr>
<tr>
<td>argline</td>
<td>String</td>
<td>No</td>
<td>Any command line arguments</td>
</tr>
<tr>
<td>timeout</td>
<td>Long</td>
<td>Yes</td>
<td>Timeout in milliseconds. The command is forcefully terminated when timeout is reached.</td>
</tr>
</tbody>
</table>
</div>
<p></p>
<div class="section" lang="en">
<div class="titlepage"><div><div><h5 class="title">
<a name="id2576228"></a>ReturnCode type</h5></div></div></div>
<p>The ReturnCode type is used as the generic answer type for most of the <span class="application">BruteXservices</span> operations.</p>
<p>The defining Java class is
<a href="javadoc/net/brutex/xservices/types/ReturnCode.html" target="_top">
<code class="classname">net.brutex.xservices.types.ReturnCode</code></a>.</p>
<div class="section" lang="en">
<div class="titlepage"><div><div><h6 class="title">
<a name="id2576194"></a>Schema description</h6></div></div></div>
<pre class="programlisting">
&lt;xs:complexType name="ReturnCodeType"&gt;
&lt;xs:sequence&gt;
&lt;xs:element name="returnCode" type="xs:int"/&gt;
&lt;xs:element minOccurs="0" name="stdOut" type="xs:string"/&gt;
&lt;xs:element minOccurs="0" name="stdErr" type="xs:string"/&gt;
&lt;xs:element maxOccurs="unbounded" minOccurs="0" name="propertyList" nillable="true" type="<a href="#antproperty" title="AntProperty type">tns:antProperty</a>"/&gt;
&lt;/xs:sequence&gt;
&lt;/xs:complexType&gt;
</pre>
</div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h6 class="title">
<a name="id2576265"></a>Example XML </h6></div></div></div>
<pre class="programlisting">&lt;ReturnCode xmlns:ns2="http://ws.xservices.brutex.net"&gt;
&lt;returnCode&gt;0&lt;/returnCode&gt;
&lt;stdOut/&gt;
&lt;stdErr/&gt;
&lt;propertyList&gt; <em class="lineannotation"><span class="lineannotation">See <a href="#antproperty" title="AntProperty type">tns:antProperty</a> for details about the &lt;propertyList&gt; elements.</span></em>
&lt;name&gt;key1&lt;/name&gt;
&lt;value&gt;value1&lt;/value&gt;
&lt;/propertyList&gt;
&lt;propertyList&gt;
&lt;name&gt;key2&lt;/name&gt;
&lt;value&gt;value2&lt;/value&gt;
&lt;/propertyList&gt;
&lt;/ReturnCode&gt;</pre>
</div>
</div>
</div>
</div>
</div>
</div>
<div class="chapter" lang="en">
<div class="titlepage"><div><div><h2 class="title">
<a name="id2521830"></a>Chapter 4. XML Types</h2></div></div></div>
<div class="toc">
<p><b>Table of Contents</b></p>
<dl>
<dt><span class="section"><a href="#id2576253">ReturnCode type</a></span></dt>
<dd><dl>
<dt><span class="section"><a href="#id2576303">Schema description</a></span></dt>
<dt><span class="section"><a href="#id2576332">Example XML </a></span></dt>
</dl></dd>
<dt><span class="section"><a href="#antproperty">AntProperty type</a></span></dt>
<dd><dl>
<dt><span class="section"><a href="#id2535328">Schema description</a></span></dt>
<dt><span class="section"><a href="#id2535342">Example XML </a></span></dt>
</dl></dd>
<dt><span class="section"><a href="#patternelement">PatternElement type</a></span></dt>
<dd><dl>
<dt><span class="section"><a href="#id2534657">Schema description</a></span></dt>
<dt><span class="section"><a href="#id2534676">Example XML</a></span></dt>
</dl></dd>
</dl>
</div>
<p>This chapter bundles the documentation for common xml types used by XServices web service.</p>
<div class="section" lang="en">
<div class="titlepage"><div><div><h2 class="title" style="clear: both">
<a name="id2576253"></a>ReturnCode type</h2></div></div></div>
<p>The ReturnCode type is used as the generic answer type for most of the <span class="application">BruteXservices</span> operations.</p>
<p>The defining Java class is
<a href="javadoc/net/brutex/xservices/types/ReturnCode.html" target="_top">
<code class="classname">net.brutex.xservices.types.ReturnCode</code></a>.</p>
<div class="section" lang="en">
<div class="titlepage"><div><div><h3 class="title">
<a name="id2576303"></a>Schema description</h3></div></div></div>
<pre class="programlisting">
&lt;xs:complexType name="ReturnCodeType"&gt;
&lt;xs:sequence&gt;
&lt;xs:element name="returnCode" type="xs:int"/&gt;
&lt;xs:element minOccurs="0" name="stdOut" type="xs:string"/&gt;
&lt;xs:element minOccurs="0" name="stdErr" type="xs:string"/&gt;
&lt;xs:element maxOccurs="unbounded" minOccurs="0" name="propertyList" nillable="true" type="<a href="#antproperty" title="AntProperty type">tns:antProperty</a>"/&gt;
&lt;/xs:sequence&gt;
&lt;/xs:complexType&gt;
</pre>
</div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h3 class="title">
<a name="id2576332"></a>Example XML </h3></div></div></div>
<pre class="programlisting">&lt;ReturnCode xmlns:ns2="http://ws.xservices.brutex.net"&gt;
&lt;returnCode&gt;0&lt;/returnCode&gt;
&lt;stdOut/&gt;
&lt;stdErr/&gt;
&lt;propertyList&gt; <em class="lineannotation"><span class="lineannotation">See <a href="#antproperty" title="AntProperty type">tns:antProperty</a> for details about the &lt;propertyList&gt; elements.</span></em>
&lt;name&gt;key1&lt;/name&gt;
&lt;value&gt;value1&lt;/value&gt;
&lt;/propertyList&gt;
&lt;propertyList&gt;
&lt;name&gt;key2&lt;/name&gt;
&lt;value&gt;value2&lt;/value&gt;
&lt;/propertyList&gt;
&lt;/ReturnCode&gt;</pre>
</div>
</div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h2 class="title" style="clear: both">
<a name="antproperty"></a>AntProperty type</h2></div></div></div>
<p>The AntProperty type defines a list of key/value pairs.</p>
<p>The defining Java class is
<a href="javadoc/net/brutex/xservices/types/AntProperty.html" target="_top">
<code class="classname">net.brutex.xservices.types.AntProperty</code></a>.</p>
<div class="section" lang="en">
<div class="titlepage"><div><div><h3 class="title">
<a name="id2535328"></a>Schema description</h3></div></div></div>
<pre class="programlisting">
&lt;xs:complexType name="antProperty"&gt;
&lt;xs:sequence&gt;
&lt;xs:element name="name" type="xs:string"/&gt;
&lt;xs:element name="value" type="xs:string"/&gt;
&lt;/xs:sequence&gt;
&lt;/xs:complexType&gt;
</pre>
</div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h3 class="title">
<a name="id2535342"></a>Example XML </h3></div></div></div>
<pre class="programlisting">
&lt;AntProperty&gt;
&lt;name&gt;key2&lt;/name&gt;
&lt;value&gt;value2&lt;/value&gt;
&lt;/AntProperty&gt;
</pre>
</div>
</div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h2 class="title" style="clear: both">
<a name="patternelement"></a>PatternElement type</h2></div></div></div>
<p>The PatternElement type defines single string pattern.</p>
<p>The defining Java class is
<a href="javadoc/net/brutex/xservices/types/PatternElement.html" target="_top">
<code class="classname">net.brutex.xservices.types.PatternElement</code></a>.</p>
<div class="section" lang="en">
<div class="titlepage"><div><div><h3 class="title">
<a name="id2534657"></a>Schema description</h3></div></div></div>
<pre class="programlisting">
&lt;xs:simpleType name="patternElement"&gt;
&lt;xs:restriction base="xs:string"/&gt;
&lt;/xs:simpleType&gt;
</pre>
</div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h3 class="title">
<a name="id2534676"></a>Example XML</h3></div></div></div>
<pre class="programlisting">
&lt;PatternElement&gt;**/*&lt;/PatternElement&gt;
</pre>
</div>
</div>
</div>
</div></body>
</html>

7
doc/entities.ent
View File

@ -7,7 +7,14 @@
<entry>Yes</entry> <entry>Yes</entry>
<entry>Timeout in milliseconds. The command is forcefully terminated when timeout is reached.</entry> <entry>Timeout in milliseconds. The command is forcefully terminated when timeout is reached.</entry>
</row>"> </row>">
<!ENTITY javadoc-base "file:///home/brian/NetBeansProjects/XServices/dist/">
<!ENTITY examplexml "<bridgehead renderas='sect3'>Example XML</bridgehead>">
<!ENTITY schemadefinition "<bridgehead renderas='sect3'>Schema definition</bridgehead>">
<!ENTITY returncode SYSTEM "types/ReturnCode.xml"> <!ENTITY returncode SYSTEM "types/ReturnCode.xml">
<!ENTITY antproperty SYSTEM "types/AntProperty.xml"> <!ENTITY antproperty SYSTEM "types/AntProperty.xml">
<!ENTITY patternelement SYSTEM "types/PatternElement.xml"> <!ENTITY patternelement SYSTEM "types/PatternElement.xml">
<!ENTITY patternsettype SYSTEM "types/PatternSetType.xml">
<!ENTITY selectortype SYSTEM "types/SelectorType.xml">

2
doc/getting-started.xml
View File

@ -1,6 +1,6 @@
<?xml version='1.0' encoding='UTF-8'?><chapter> <?xml version='1.0' encoding='UTF-8'?><chapter>
<beginpage/> <beginpage/>
<title>Getting startet</title> <title>Getting started</title>
<para>This chapter describes the installation.</para> <para>This chapter describes the installation.</para>
<sect1> <sect1>
<title>Prerequisites</title> <title>Prerequisites</title>

9
doc/types/AntProperty.xml
View File

@ -4,8 +4,7 @@
<para>The defining Java class is <para>The defining Java class is
<ulink url="javadoc/net/brutex/xservices/types/AntProperty.html"> <ulink url="javadoc/net/brutex/xservices/types/AntProperty.html">
<classname>net.brutex.xservices.types.AntProperty</classname></ulink>.</para> <classname>net.brutex.xservices.types.AntProperty</classname></ulink>.</para>
<section> &schemadefinition;
<title>Schema description</title>
<programlisting language="xml"><![CDATA[ <programlisting language="xml"><![CDATA[
<xs:complexType name="antProperty"> <xs:complexType name="antProperty">
<xs:sequence> <xs:sequence>
@ -14,14 +13,12 @@
</xs:sequence> </xs:sequence>
</xs:complexType>]]> </xs:complexType>]]>
</programlisting> </programlisting>
</section> &examplexml;
<section>
<title>Example XML </title>
<programlisting language="xml"><![CDATA[ <programlisting language="xml"><![CDATA[
<AntProperty> <AntProperty>
<name>key2</name> <name>key2</name>
<value>value2</value> <value>value2</value>
</AntProperty>]]> </AntProperty>]]>
</programlisting> </programlisting>
</section>
</section> </section>

40
doc/types/PatternElement.xml
View File

@ -1,21 +1,31 @@
<?xml version='1.0' encoding='UTF-8'?><section id="patternelement"> <?xml version='1.0' encoding='UTF-8'?><section id="patternelement">
<title>PatternElement type</title> <title>PatternElement type</title>
<para>The PatternElement type defines single string pattern.</para> <para>The PatternElement type defines single string pattern for file/ directory matching.</para>
<para>The defining Java class is <para>The defining Java class is
<ulink url="javadoc/net/brutex/xservices/types/PatternElement.html"> <ulink url="javadoc/net/brutex/xservices/types/PatternElement.html">
<classname>net.brutex.xservices.types.PatternElement</classname></ulink>.</para> <classname>net.brutex.xservices.types.PatternElement</classname>
<section> </ulink>.
<title>Schema description</title> </para>
<programlisting language="xml"><![CDATA[ <para>These patterns look exactly like those used in Apache Ant
<xs:simpleType name="patternElement"> <ulink url="http://ant.apache.org/manual/dirtasks.html#patterns">Patterns</ulink>.
The &apos;*&apos; matches zero or more characters and the &apos;?&apos; will match a single character.
Both symbols can be combined in one pattern. The &apos;**&apos;
symbol can be used to match any directory deepth.
</para>
<para>Some example patterns:</para>
<para><parameter>**/mydir/**</parameter></para>
<para>Match all file that are located in any directory that has &quot;mydir&quot; string in its pathname. Also applies to files with &quot;mydir&quot; in their name.</para>
<para><parameter>/mydir/</parameter></para>
<para>The parser will automatically append an &apos;**&apos; symbol, thus the resulting pattern is <parameter>/mydir/**</parameter>. All files below the &quot;/mydir/&quot; directory (including its sub-directories will be chosen.</para>
<note>
<para>The pattern is OS independent. You should always use &quot;/&quot; as path separator, even on windows based systems.</para>
</note>
&schemadefinition;
<programlisting language="xml"><![CDATA[<xs:simpleType name="patternElement">
<xs:restriction base="xs:string"/> <xs:restriction base="xs:string"/>
</xs:simpleType>]]> </xs:simpleType>]]></programlisting>
</programlisting>
</section> &examplexml;
<section> <programlisting language="xml"><![CDATA[<PatternElement>**/*</PatternElement>]]></programlisting>
<title>Example XML</title>
<programlisting language="xml"><![CDATA[
<PatternElement>**/*</PatternElement>]]>
</programlisting>
</section>
</section> </section>

23
doc/types/PatternSetType.xml Normal file
View File

@ -0,0 +1,23 @@
<?xml version="1.0" encoding="UTF-8"?>
<section id="patternsettype">
<title>PatternSetType type</title>
<para>The PatternSetType exposes various filters/ selectors for the selection of resources (files).</para>
<para>The defining Java class is
<ulink url="javadoc/net/brutex/xservices/types/PatternSetType.html">
<classname>net.brutex.xservices.types.PatternSetType</classname></ulink>.</para>
&schemadefinition;
<programlisting language="xml"><![CDATA[
<xs:complexType name="patternSetType">
<xs:sequence>
<xs:element default="**/*" maxOccurs="unbounded" minOccurs="0" name="include" type="]]><link linkend="patternelement">tns:patternElement</link><![CDATA["/>
<xs:element maxOccurs="unbounded" minOccurs="0" name="exclude" type="]]><link linkend="patternelement">tns:patternElement</link><![CDATA["/>
<xs:element minOccurs="0" name="selector" nillable="true" type="]]><link linkend="selectortype">tns:selectorType</link><![CDATA["/>
</xs:sequence>
</xs:complexType>]]>
</programlisting>
&examplexml;
<programlisting language="xml"><![CDATA[
tbd.]]>
</programlisting>
</section>

14
doc/types/ReturnCode.xml
View File

@ -2,10 +2,9 @@
<title>ReturnCode type</title> <title>ReturnCode type</title>
<para>The ReturnCode type is used as the generic answer type for most of the &brs; operations.</para> <para>The ReturnCode type is used as the generic answer type for most of the &brs; operations.</para>
<para>The defining Java class is <para>The defining Java class is
<ulink url="javadoc/net/brutex/xservices/types/ReturnCode.html"> <ulink url="&javadoc-base;javadoc/net/brutex/xservices/types/ReturnCode.html">
<classname>net.brutex.xservices.types.ReturnCode</classname></ulink>.</para> <classname>net.brutex.xservices.types.ReturnCode</classname></ulink>.</para>
<section> &schemadefinition;
<title>Schema description</title>
<programlisting language="xml"><![CDATA[ <programlisting language="xml"><![CDATA[
<xs:complexType name="ReturnCodeType"> <xs:complexType name="ReturnCodeType">
<xs:sequence> <xs:sequence>
@ -14,11 +13,10 @@
<xs:element minOccurs="0" name="stdErr" type="xs:string"/> <xs:element minOccurs="0" name="stdErr" type="xs:string"/>
<xs:element maxOccurs="unbounded" minOccurs="0" name="propertyList" nillable="true" type="]]><link linkend="antproperty">tns:antProperty</link><![CDATA["/> <xs:element maxOccurs="unbounded" minOccurs="0" name="propertyList" nillable="true" type="]]><link linkend="antproperty">tns:antProperty</link><![CDATA["/>
</xs:sequence> </xs:sequence>
</xs:complexType>]]> </xs:complexType>]]>
</programlisting> </programlisting>
</section>
<section> &examplexml;
<title>Example XML </title>
<programlisting language="xml">&lt;ReturnCode xmlns:ns2=&quot;http://ws.xservices.brutex.net&quot;&gt; <programlisting language="xml">&lt;ReturnCode xmlns:ns2=&quot;http://ws.xservices.brutex.net&quot;&gt;
&lt;returnCode&gt;0&lt;/returnCode&gt; &lt;returnCode&gt;0&lt;/returnCode&gt;
&lt;stdOut/&gt; &lt;stdOut/&gt;
@ -32,5 +30,5 @@
&lt;value&gt;value2&lt;/value&gt; &lt;value&gt;value2&lt;/value&gt;
&lt;/propertyList&gt; &lt;/propertyList&gt;
&lt;/ReturnCode&gt;</programlisting> &lt;/ReturnCode&gt;</programlisting>
</section>
</section> </section>

20
doc/types/SelectorType.xml Normal file
View File

@ -0,0 +1,20 @@
<?xml version="1.0" encoding="UTF-8"?>
<section id="selectortype">
<title>SelectorType type</title>
<para>The SelectorType exposes various selectors for the selection of resources (files).</para>
<para>The defining Java class is
<ulink url="javadoc/net/brutex/xservices/types/SelectorType.html">
<classname>net.brutex.xservices.types.SelectorType</classname></ulink>.</para>
&schemadefinition;
<programlisting language="xml"><![CDATA[
<xs:complexType abstract="true" name="selectorType">
<xs:sequence>
<xs:element maxOccurs="unbounded" minOccurs="0" name="contains" nillable="true" type="tns:containsSelectorType"/>
</xs:sequence>
</xs:complexType>]]>
</programlisting>
&examplexml;
<programlisting language="xml"><![CDATA[
tbd.]]>
</programlisting>
</section>