Subversion Repositories XServices

Compare Revisions

No changes between revisions

Ignore whitespace Rev 59 → Rev 58

/xservices/trunk/doc/MiscServices.xml
File deleted
\ No newline at end of file
Property changes:
Deleted: svn:mime-type
-text/plain
\ No newline at end of property
/xservices/trunk/doc/common/installation.xml
File deleted
\ No newline at end of file
Property changes:
Deleted: svn:mime-type
-text/plain
\ No newline at end of property
/xservices/trunk/doc/common/abstract.xml
File deleted
Property changes:
Deleted: svn:mime-type
-text/plain
\ No newline at end of property
/xservices/trunk/doc/FileServices.xml
File deleted
\ No newline at end of file
Property changes:
Deleted: svn:mime-type
-text/plain
\ No newline at end of property
/xservices/trunk/doc/BruteXServices_User_Guide.dbk
File deleted
\ No newline at end of file
/xservices/trunk/doc/BruteXServices_User_Guide.xml
1,57 → 1,178
<?xml version='1.0'?>
<!DOCTYPE book [
<!ENTITY % myent SYSTEM "entities.ent">
%myent;
]>
<book xmlns="http://docbook.org/ns/docbook" version="5.0"
xmlns:xi="http://www.w3.org/2001/XInclude">
<title>Brutex XServices Documentation</title>
<bookinfo>
<date>February, 16th 2010</date>
<author>
<firstname>Brian</firstname>
<surname>Rosenberger</surname>
<email>bru@brutex.de</email>
</author>
<corpname>Brutex Network</corpname>
<copyright>
<year>2011</year>
</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>
<xi:include href="common/abstract.xml" />
</bookinfo>
<chapter id="installation">
<beginpage />
<title>Getting started</title>
<para>This chapter describes the installation.</para>
<xi:include href="common/installation.xml"/>
</chapter>
<chapter id="services">
<beginpage />
<title>Available Services</title>
<para>List of available web services and their operations.</para>
<xi:include href="ArchiveServices.xml" />
<xi:include href="ExecuteServices.xml" />
<xi:include href="FileServices.xml" />
<xi:include href="MiscServices.xml" />
</chapter>
 
<chapter id="xmltypes">
<beginpage />
<title>XML Types</title>
<para>This chapter bundles the documentation for common XML types used
by XServices web service.</para>
<xi:include href="Types.xml" />
</chapter>
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">
<book>
<title>User Guide</title>
<bookinfo>
<date>February, 16th 2010</date>
<author>
<firstname>Brian</firstname>
<surname>Rosenberger</surname>
<email>bru@brutex.de</email>
</author>
<corpname>Brutex Network</corpname>
<pubdate>1997</pubdate>
<copyright><year>2010</year></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>
<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>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>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>is an add-on to XBridgeNG 2.0. It runs standalone or in
combination with XBridgeNG. Pure XBridgeNG has two
components:</para>
<para>
<itemizedlist>
<listitem>
<para>XML Schema for item based data types (e.g. tickets
from a bug tracker system or a database record)</para>
</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>
</listitem>
<listitem>
<para>The add Web Services (SOAP) wrapper around Apache Ant
tasks (since XBridgeNG 2.0)</para>
</listitem>
</itemizedlist>
</para>
<para>The current focus is on file-based operations. do not
contain an integration server or a process execution
engine.</para>
</abstract>
</bookinfo>
<chapter>
<beginpage />
<title>Getting started</title>
<para>This chapter describes the installation.</para>
<sect1>
<title>Prerequisites</title>
<para>tbd.</para>
<para>Sun Java SE 1.6.0</para>
<para>Apache Tomcat 6</para>
</sect1>
<sect1>
<title>Installation</title>
<para>tbd.</para>
<para>In short: Deploy .WAR file to Apache Tomcat</para>
<sect2>
<title>Securing with Basic Authentication</title>
<para>There is a quick guide explaining Basic Authentication
for Tomcat here:</para>
<para>
<ulink url="http://oreilly.com/pub/a/java/archive/tomcat-tips.html?page=1"/></para>
</sect2>
<sect2>
<title>Limit access to</title>
<para>Sometimes you&apos;ll only want to restrict access to to
only specified host names or IP addresses. This way, only
clients at those specified addresses can use the web services.
Tomcat provides two configuration values for that:
RemoteHostValve and RemoteAddrValve.</para>
<para>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.</para>
<programlisting language="xml">&lt;Context path=&quot;/XService/ArchiveService&quot; ...&gt;
&lt;Valve className=&quot;org.apache.catalina.valves.RemoteAddrValve&quot;
allow=&quot;127.0.0.1&quot; deny=&quot;&quot;/&gt;
&lt;/Context&gt;</programlisting>
<para>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.</para>
<para>The &lt;context&gt; element must be placed into the
server.xml file (into &lt;engine&gt;&lt;host&gt;).</para>
</sect2>
</sect1>
</chapter>
<chapter>
<title />
<section>
<title>ArchiveServices</title>
<para>The ArchiveService bundles file packing operations. Its
WSDL is located at
http://server:port/XServices/ArchiveService?wsdl</para>
</section>
<section>
<title>ExecuteServices</title>
<para>The ExecuteService bundles local and remote command
execution operations. Its WSDL is located at
http://server:port/XServices/ExecuteService?wsdl</para>
<section>
<title>runCommand</title>
<para>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.</para>
<section>
<title />
<para />
<table frame="all">
<title>runCommand input parameters</title>
<tgroup cols="4">
<colspec colname="parameter" colnum="1"/>
<colspec colname="type" colnum="2"/>
<colspec colname="required" colnum="3"/>
<colspec colname="description" colnum="4"/>
<thead>
<row>
<entry>parameter</entry>
<entry>type</entry>
<entry>required</entry>
<entry>description</entry>
</row>
</thead>
<tbody>
<row>
<entry>executable</entry>
<entry>String</entry>
<entry>Yes</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>
<entry>argline</entry>
<entry>String</entry>
<entry>No</entry>
<entry>Any command line arguments</entry>
</row>
</tbody>
</tgroup>
</table>
<para />
</section>
</section>
</section>
</chapter>
<chapter>
<title>XML Types</title>
<para>This chapter bundles the documentation for common xml types
used by XServices web service.</para>
</chapter>
</book>
/xservices/trunk/doc/abstract.xml
0,0 → 1,20
<?xml version='1.0' encoding='UTF-8'?>
<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>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; is an add-on to XBridgeNG 2.0. It runs standalone or in combination with XBridgeNG. Pure XBridgeNG has two components:</para>
<para><itemizedlist>
<listitem>
<para>XML Schema for item based data types (e.g. tickets from a bug tracker system or a database record)</para>
</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>
</listitem>
<listitem>
<para>The &brs; add
Web Services (SOAP) wrapper around Apache Ant tasks (since XBridgeNG 2.0)</para>
</listitem>
</itemizedlist>
</para>
<para>The current focus is on file-based operations. &brs; do not contain an integration server or a process execution engine.</para>
/xservices/trunk/doc/Types.xml
1,12 → 1,4
<?xml version='1.0' encoding='UTF-8'?>
<section xmlns="http://docbook.org/ns/docbook" version="5.0"
xmlns:xi="http://www.w3.org/2001/XInclude">
<!-- Sort alphabetically -->
<xi:include href="types/AntProperty.xml" />
<xi:include href="types/FileResource.xml" />
<xi:include href="types/HostConnection.xml" />
<xi:include href="types/PatternElement.xml" />
<xi:include href="types/PatternSetType.xml" />
<xi:include href="types/ReturnCode.xml" />
<xi:include href="types/SelectorType.xml" />
</section>
<?xml version='1.0' encoding='UTF-8'?><chapter>
<title>XML Types</title>
<para>This chapter bundles the documentation for common xml types used by XServices web service.</para>
&returncode;&patternsettype;&selectortype;&antproperty;&patternelement;</chapter>
/xservices/trunk/doc/getting-started.xml
0,0 → 1,32
<?xml version='1.0' encoding='UTF-8'?><chapter>
<beginpage/>
<title>Getting started</title>
<para>This chapter describes the installation.</para>
<sect1>
<title>Prerequisites</title>
<para>tbd.</para>
<para>Sun Java SE 1.6.0</para>
<para>Apache Tomcat 6</para>
</sect1>
<sect1>
<title>Installation</title>
<para>tbd.</para>
<para>In short: Deploy .WAR file to Apache Tomcat</para>
<sect2>
<title>Securing &brs; with Basic Authentication</title>
<para>There is a quick guide explaining Basic Authentication for Tomcat here: </para>
<para><ulink url="http://oreilly.com/pub/a/java/archive/tomcat-tips.html?page=1"/></para>
</sect2>
<sect2>
<title>Limit access to &brs;</title>
<para>Sometimes you&apos;ll only want to restrict access to &brs; to only specified host names or IP addresses. This way, only clients at those specified addresses can use the &brs; web services. Tomcat provides two configuration values for that: RemoteHostValve and RemoteAddrValve.</para>
<para>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.</para>
<programlisting language="xml">&lt;Context path=&quot;/XService/ArchiveService&quot; ...&gt;
&lt;Valve className=&quot;org.apache.catalina.valves.RemoteAddrValve&quot;
allow=&quot;127.0.0.1&quot; deny=&quot;&quot;/&gt;
&lt;/Context&gt;</programlisting>
<para>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.</para>
<para>The &lt;context&gt; element must be placed into the server.xml file (into &lt;engine&gt;&lt;host&gt;).</para>
</sect2>
</sect1>
</chapter>
/xservices/trunk/doc/types/FileResource.xml
File deleted
\ No newline at end of file
Property changes:
Deleted: svn:mime-type
-text/plain
\ No newline at end of property
/xservices/trunk/doc/types/HostConnection.xml
File deleted
Property changes:
Deleted: svn:mime-type
-text/plain
\ No newline at end of property
/xservices/trunk/doc/types/SelectorType.xml
1,13 → 1,11
<?xml version="1.0" encoding="UTF-8"?>
<section xmlns="http://docbook.org/ns/docbook"
version="5.0"
xmlns:xi="http://www.w3.org/2001/XInclude" id="selectortype">
<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>
<bridgehead renderas='sect3'>Schema definition</bridgehead>
&schemadefinition;
<programlisting language="xml"><![CDATA[
<xs:complexType abstract="true" name="selectorType">
<xs:sequence>
15,7 → 13,7
</xs:sequence>
</xs:complexType>]]>
</programlisting>
<bridgehead renderas='sect3'>Example XML</bridgehead>
&examplexml;
<programlisting language="xml"><![CDATA[
tbd.]]>
</programlisting>
/xservices/trunk/doc/types/AntProperty.xml
1,31 → 1,24
<?xml version="1.0" encoding="UTF-8"?>
<section>
<title>AntProperty type</title>
<para>The AntProperty type defines a list of key/value pairs.</para>
<para>
The defining Java class is
<ulink
url="javadoc/net/brutex/xservices/types/AntProperty.html">
<classname>net.brutex.xservices.types.AntProperty</classname>
</ulink>
.
</para>
 
<programlisting
language="xml"><![CDATA[
<xs:complexType name="antProperty">
<xs:sequence>
<xs:element name="name" type="xs:string"/>
<xs:element name="value" type="xs:string"/>
</xs:sequence>
</xs:complexType>]]>
</programlisting>
<programlisting
language="xml"><![CDATA[
<AntProperty>
<name>key2</name>
<value>value2</value>
</AntProperty>]]>
</programlisting>
</section>
<?xml version='1.0' encoding='UTF-8'?><section id="antproperty">
<title>AntProperty type</title>
<para>The AntProperty type defines a list of key/value pairs.</para>
<para>The defining Java class is
<ulink url="javadoc/net/brutex/xservices/types/AntProperty.html">
<classname>net.brutex.xservices.types.AntProperty</classname></ulink>.</para>
&schemadefinition;
<programlisting language="xml"><![CDATA[
<xs:complexType name="antProperty">
<xs:sequence>
<xs:element name="name" type="xs:string"/>
<xs:element name="value" type="xs:string"/>
</xs:sequence>
</xs:complexType>]]>
</programlisting>
&examplexml;
<programlisting language="xml"><![CDATA[
<AntProperty>
<name>key2</name>
<value>value2</value>
</AntProperty>]]>
</programlisting>
 
</section>
/xservices/trunk/doc/types/PatternElement.xml
1,52 → 1,31
<?xml version='1.0' encoding='UTF-8'?>
<section xmlns="http://docbook.org/ns/docbook" version="5.0"
xmlns:xi="http://www.w3.org/2001/XInclude" id="patternelement">
<title>PatternElement type</title>
<para>The PatternElement type defines single string pattern for file/
directory matching.</para>
<para>
The defining Java class is
<ulink url="javadoc/net/brutex/xservices/types/PatternElement.html">
<classname>net.brutex.xservices.types.PatternElement</classname>
</ulink>
.
</para>
<para>
These patterns look exactly like those used in Apache Ant
<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>
<bridgehead renderas='sect3'>Schema definition</bridgehead>
<programlisting language="xml"><![CDATA[<xs:simpleType name="patternElement">
<?xml version='1.0' encoding='UTF-8'?><section id="patternelement">
<title>PatternElement type</title>
<para>The PatternElement type defines single string pattern for file/ directory matching.</para>
<para>The defining Java class is
<ulink url="javadoc/net/brutex/xservices/types/PatternElement.html">
<classname>net.brutex.xservices.types.PatternElement</classname>
</ulink>.
</para>
<para>These patterns look exactly like those used in Apache Ant
<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:simpleType>]]></programlisting>
 
<bridgehead renderas='sect3'>Example XML</bridgehead>
<programlisting language="xml"><![CDATA[<PatternElement>**/*</PatternElement>]]></programlisting>
&examplexml;
<programlisting language="xml"><![CDATA[<PatternElement>**/*</PatternElement>]]></programlisting>
 
</section>
/xservices/trunk/doc/types/ReturnCode.xml
1,53 → 1,34
<?xml version='1.0' encoding='UTF-8'?>
<section xmlns="http://docbook.org/ns/docbook" version="5.0"
xmlns:xi="http://www.w3.org/2001/XInclude">
<title>ReturnCode type</title>
<para>
The ReturnCode type is used as the generic answer type for most of the
<application class='software'>BruteXservices</application>
operations.
</para>
<para>
The defining Java class is
<ulink url="javadoc/net/brutex/xservices/types/ReturnCode.html">
<classname>net.brutex.xservices.types.ReturnCode</classname>
</ulink>
.
</para>
<bridgehead renderas='sect3'>Schema definition</bridgehead>
<programlisting language="xml"><![CDATA[
<?xml version='1.0' encoding='UTF-8'?><section>
<title>ReturnCode type</title>
<para>The ReturnCode type is used as the generic answer type for most of the &brs; operations.</para>
<para>The defining Java class is
<ulink url="&javadoc-base;javadoc/net/brutex/xservices/types/ReturnCode.html">
<classname>net.brutex.xservices.types.ReturnCode</classname></ulink>.</para>
&schemadefinition;
<programlisting language="xml"><![CDATA[
<xs:complexType name="ReturnCodeType">
<xs:sequence>
<xs:element name="returnCode" type="xs:int"/>
<xs:element minOccurs="0" name="stdOut" 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:complexType>]]>
</programlisting>
</programlisting>
 
<bridgehead renderas='sect3'>Example XML</bridgehead>
<programlisting language="xml">
&lt;ReturnCode
xmlns:ns2=&quot;http://ws.xservices.brutex.net&quot;&gt;
&lt;returnCode&gt;0&lt;/returnCode&gt;
&lt;stdOut/&gt;
&lt;stdErr/&gt;
&lt;propertyList&gt;
<lineannotation>
See
<link linkend="antproperty">tns:antProperty</link>
for details about the &lt;propertyList&gt; elements.
</lineannotation>
&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;
</programlisting>
&examplexml;
<programlisting language="xml">&lt;ReturnCode xmlns:ns2=&quot;http://ws.xservices.brutex.net&quot;&gt;
&lt;returnCode&gt;0&lt;/returnCode&gt;
&lt;stdOut/&gt;
&lt;stdErr/&gt;
&lt;propertyList&gt; <lineannotation>See <link linkend="antproperty">tns:antProperty</link> for details about the &lt;propertyList&gt; elements.</lineannotation>
&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;</programlisting>
 
</section>
/xservices/trunk/doc/types/PatternSetType.xml
1,32 → 1,23
<?xml version="1.0" encoding="UTF-8"?>
<section xmlns="http://docbook.org/ns/docbook" version="5.0"
xmlns:xi="http://www.w3.org/2001/XInclude" 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>
<bridgehead renderas='sect3'>Schema definition</bridgehead>
<programlisting language="xml"><![CDATA[
<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: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>
<bridgehead renderas='sect3'>Example XML</bridgehead>
<programlisting language="xml"><![CDATA[
</programlisting>
&examplexml;
<programlisting language="xml"><![CDATA[
tbd.]]>
</programlisting>
</programlisting>
</section>
 
/xservices/trunk/doc/ExecuteServices/runCommandWithSSH.xml
File deleted
\ No newline at end of file
Property changes:
Deleted: svn:mime-type
-text/plain
\ No newline at end of property
/xservices/trunk/doc/ExecuteServices/rExec.xml
File deleted
\ No newline at end of file
Property changes:
Deleted: svn:mime-type
-text/plain
\ No newline at end of property
/xservices/trunk/doc/ExecuteServices/telnet.xml
File deleted
\ No newline at end of file
Property changes:
Deleted: svn:mime-type
-text/plain
\ No newline at end of property
/xservices/trunk/doc/ExecuteServices/runCommand.xml
1,56 → 1,42
<?xml version='1.0' encoding='utf-8'?>
<!DOCTYPE section [
<!ENTITY % myent SYSTEM "../entities.ent">
%myent;
]>
<section xmlns="http://docbook.org/ns/docbook" version="5.0"
xmlns:xi="http://www.w3.org/2001/XInclude">
<title>runCommand</title>
<para>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.</para>
<section>
<title>&inp;
</title>
<para />
<table frame="all">
<title>runCommand input parameters</title>
<tgroup cols="4">
<colspec colnum="1" colname="parameter" />
<colspec colnum="2" colname="type" />
<colspec colnum="3" colname="required" />
<colspec colnum="4" colname="description" />
<thead>
<row>
<entry>parameter</entry>
<entry>type</entry>
<entry>required</entry>
<entry>description</entry>
</row>
</thead>
<tbody>
<row>
<entry>executable</entry>
<entry>String</entry>
<entry>Yes</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>
<entry>argline</entry>
<entry>String</entry>
<entry>No</entry>
<entry>Any command line arguments</entry>
</row>
<?xml version='1.0' encoding='UTF-8'?><section>
<title>runCommand</title>
<para>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.</para>
<section>
<title>&inp;</title>
<para/>
<table frame="all">
<title>runCommand input parameters</title>
<tgroup cols="4">
<colspec colnum="1" colname="parameter"/>
<colspec colnum="2" colname="type"/>
<colspec colnum="3" colname="required"/>
<colspec colnum="4" colname="description"/>
<thead>
<row>
<entry>parameter</entry>
<entry>type</entry>
<entry>required</entry>
<entry>description</entry>
</row>
</thead>
<tbody>
<row>
<entry>executable</entry>
<entry>String</entry>
<entry>Yes</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>
<entry>argline</entry>
<entry>String</entry>
<entry>No</entry>
<entry>Any command line arguments</entry>
</row>
&param-timeout;
</tbody>
</tgroup>
</table>
<para />
</section>
<section>
<title>&outp;
</title>
<xi:include href="../types/ReturnCode.xml" />
</section>
</tbody>
</tgroup>
</table>
<para/>
&returncode;
</section>
</section>
/xservices/trunk/doc/entities.ent
1,6 → 1,6
<!ENTITY inp "Input parameters">
<!ENTITY outp "Output parameters">
<!ENTITY brs "">
<!ENTITY brs "<application class='software'>BruteXservices</application>">
<!ENTITY param-timeout "<row>
<entry>timeout</entry>
<entry>Long</entry>
12,4 → 12,9
<!ENTITY schemadefinition "<bridgehead renderas='sect3'>Schema definition</bridgehead>">
 
 
<!ENTITY returncode SYSTEM "types/ReturnCode.xml">
<!ENTITY antproperty SYSTEM "types/AntProperty.xml">
<!ENTITY patternelement SYSTEM "types/PatternElement.xml">
<!ENTITY patternsettype SYSTEM "types/PatternSetType.xml">
<!ENTITY selectortype SYSTEM "types/SelectorType.xml">
 
/xservices/trunk/doc/ArchiveServices.xml
1,9 → 1,5
<?xml version='1.0' encoding='utf-8'?>
<section xmlns="http://docbook.org/ns/docbook" version="5.0" xmlns:xi="http://www.w3.org/2001/XInclude"
id="archiveservices">
<title>ArchiveServices</title>
<para>The ArchiveService bundles file packing operations. Its
WSDL is
located at
http://server:port/XServices/ArchiveService?wsdl</para>
</section>
<?xml version='1.0' encoding='UTF-8'?><section>
<title>ArchiveServices</title>
<para>The ArchiveService bundles file packing operations. Its WSDL is located at
http://server:port/XServices/ArchiveService?wsdl</para>
</section>
/xservices/trunk/doc/ExecuteServices.xml
1,13 → 1,5
<?xml version='1.0' encoding="utf-8"?>
<section xmlns="http://docbook.org/ns/docbook" version="5.0"
xmlns:xi="http://www.w3.org/2001/XInclude"
id="executeservices">
<title>ExecuteServices</title>
<para>The ExecuteService bundles local and remote command
execution operations. Its WSDL is located at
http://server:port/XServices/ExecuteService?wsdl</para>
<xi:include href="ExecuteServices/rExec.xml" />
<xi:include href="ExecuteServices/runCommand.xml" />
<xi:include href="ExecuteServices/runCommandWithSSH.xml" />
<xi:include href="ExecuteServices/telnet.xml" />
</section>
<?xml version='1.0' encoding='UTF-8'?><section>
<title>ExecuteServices</title>
<para>The ExecuteService bundles local and remote command execution operations. Its WSDL is located at
http://server:port/XServices/ExecuteService?wsdl</para>
&runCommand;</section>
/xservices/trunk/doc/XServices.xml
0,0 → 1,3
<?xml version='1.0' encoding='UTF-8'?><chapter>
<title>&brs;</title>
&ArchiveServices;&ExecuteServices;</chapter>
/xservices/trunk/doc/XServices_V1.0-User_Guide.odt
Cannot display: file marked as a binary type.
svn:mime-type = application/octet-stream
Property changes:
Added: svn:mime-type
+application/octet-stream
\ No newline at end of property