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

git-svn-id: https://brutex.net/svn/xservices/trunk@159 e7e49efb-446e-492e-b9ec-fcafc1997a86

xservices-jre6
Brian Rosenberger 2014-06-15 09:43:44 +00:00
parent 7e6b6bef40
commit 3e3498e50c
26 changed files with 946 additions and 85 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

0
doc/ArchiveServices.xml → doc/ArchiveServices/ArchiveServices.xml
View File

495
doc/BruteXServices_User_Guide.dbk
View File

@ -1,7 +1,7 @@
<?xml version="1.0" encoding="UTF-8"?><book xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude" version="5.0"> <?xml version="1.0" encoding="UTF-8"?><book xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude" version="5.0">
<title>Brutex XServices Documentation</title> <title>Brutex XServices Documentation</title>
<bookinfo> <bookinfo>
<date>Januar 2012</date> <date>June 2014</date>
<author> <author>
<firstname>Brian</firstname> <firstname>Brian</firstname>
<surname>Rosenberger</surname> <surname>Rosenberger</surname>
@ -9,7 +9,7 @@
</author> </author>
<corpname>Brutex Network</corpname> <corpname>Brutex Network</corpname>
<copyright> <copyright>
<year>2012</year> <year>2014</year>
</copyright> </copyright>
<legalnotice> <legalnotice>
<para> <para>
@ -39,9 +39,26 @@
</legalnotice> </legalnotice>
<abstract xml:base="common/abstract.xml"> <abstract xml:base="common/abstract.xml">
<title>Abstract</title> <title>Abstract</title>
<para>In complex IT environments it is often necessary to integrate different information systems with each other, exchange data between software tools and automate actions based on events arising from user interaction. Web Services is a popular way to make remote functions available to a broad range of clients. A WebService is independent from platforms and programming languages. XML Messages are exchanged through common protocols like TCP/IP or SMTP, processed and returned (request/ response paradigm).</para> <para>In complex IT environments it is often necessary to integrate
<para>Because of their nature, WebServices are a great technology to overcome system boundaries and to "orchestrate" your IT environment. They make up the basis for SOA and are the pieces that assemble automated business processes.</para> different information systems with each other, exchange data between
<para>XServices is a collection of pre-build WebServices with the intention to avoid duplicate work and "re-inventing the wheel". The historical base for XServices is the 'XBridgeNG' software, which provided a set of Apache Ant Tasks with quite the same intention. The available WebService operations are most likely the "most wanted" ones, some of the for sure are "must have". This collection may overlap with other libraries. In summary the current version contains 8 WebServices with over 50 operations.</para> software tools and automate actions based on events arising from user
interaction. Web Services is a popular way to make remote functions
available to a broad range of clients. A WebService is independent
from platforms and programming languages. XML Messages are exchanged
through common protocols like TCP/IP or SMTP, processed and returned
(request/ response paradigm).</para>
<para>Because of their nature, WebServices are a great technology to
overcome system boundaries and to "orchestrate" your IT environment.
They make up the basis for SOA and are the pieces that assemble
automated business processes.</para>
<para>XServices is a collection of pre-build WebServices with the
intention to avoid duplicate work and "re-inventing the wheel". The
historical base for XServices is the 'XBridgeNG' software, which
provided a set of Apache Ant Tasks with quite the same intention. The
available WebService operations are most likely the "most wanted"
ones, some of them for sure are "must have". This collection may
overlap with other libraries. In summary the current version contains
8 WebServices with over 50 operations.</para>
</abstract> </abstract>
</bookinfo> </bookinfo>
<chapter id="installation"> <chapter id="installation">
@ -52,8 +69,7 @@
<section> <section>
<title>Installation</title> <title>Installation</title>
<para>tbd.</para> <para>As of February 2013, XServices require Java 7. Older builds run against Java 5.</para>
<para>Sun Java SE 1.6.0</para>
<para>Apache Tomcat 7</para> <para>Apache Tomcat 7</para>
<para>tbd.</para> <para>tbd.</para>
<para>In short: Deploy .WAR file to Apache Tomcat</para> <para>In short: Deploy .WAR file to Apache Tomcat</para>
@ -110,13 +126,13 @@
<beginpage/> <beginpage/>
<title>Available Services</title> <title>Available Services</title>
<para>List of available web services and their operations.</para> <para>List of available web services and their operations.</para>
<section id="archiveservices" version="5.0" xml:base="ArchiveServices.xml" xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude"> <section id="archiveservices" version="5.0" xml:base="ArchiveServices/ArchiveServices.xml" xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude">
<title>ArchiveServices</title> <title>ArchiveServices</title>
<para>The ArchiveService bundles file packing operations. Its <para>The ArchiveService bundles file packing operations. Its
WSDL is located at WSDL is located at
http://server:port/XServices/ArchiveService?wsdl</para> http://server:port/XServices/ArchiveService?wsdl</para>
</section> </section>
<section id="dateservices" version="5.0" xml:base="DateServices.xml" xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude"> <section id="dateservices" version="5.0" xml:base="DateServices/DateServices.xml" xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude">
<title>DateServices</title> <title>DateServices</title>
<para>The DateService bundles various date and time related operations. <para>The DateService bundles various date and time related operations.
</para> </para>
@ -138,7 +154,7 @@
<title>getDate</title> <title>getDate</title>
<para>Get current time and date. <para>Get current time and date.
Sample request: Sample request:
<screen><![CDATA[ <programlisting language="xml"><![CDATA[
<soapenv:Envelope <soapenv:Envelope
xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:ws="http://ws.xservices.brutex.net"> xmlns:ws="http://ws.xservices.brutex.net">
@ -147,7 +163,7 @@
<ws:getDate/> <ws:getDate/>
</soapenv:Body> </soapenv:Body>
</soapenv:Envelop </soapenv:Envelop
]]></screen> ]]></programlisting>
Sample response: Sample response:
<programlisting language="xml"><![CDATA[ <programlisting language="xml"><![CDATA[
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
@ -171,7 +187,7 @@
<title>getDateExtended</title> <title>getDateExtended</title>
<para>Get current time and date (extended Version). <para>Get current time and date (extended Version).
Sample response: Sample response:
<screen> <programlisting language="xml">
<![CDATA[ <![CDATA[
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body> <soap:Body>
@ -188,7 +204,7 @@
</soap:Body> </soap:Body>
</soap:Envelope> </soap:Envelope>
]]> ]]>
</screen> </programlisting>
</para> </para>
</section> </section>
@ -224,7 +240,8 @@
<title>getTimestamp</title> <title>getTimestamp</title>
<para>Get current timestamp in milliseconds (epoch). <para>Get current timestamp in milliseconds (epoch).
Sample request: Sample request:
<screen><![CDATA[ <programlisting language="xml">
<![CDATA[
<soapenv:Envelope <soapenv:Envelope
xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:ws="http://ws.xservices.brutex.net"> xmlns:ws="http://ws.xservices.brutex.net">
@ -233,23 +250,27 @@
<ws:getTimestamp/> <ws:getTimestamp/>
</soapenv:Body> </soapenv:Body>
</soapenv:Envelop </soapenv:Envelop
]]></screen> ]]>
</programlisting>
Sample response: Sample response:
<screen><![CDATA[ <programlisting language="xml">
<![CDATA[
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body> <soap:Body>
<ns1:getTimestampResponse xmlns:ns1="http://ws.xservices.brutex.net"> <ns1:getTimestampResponse xmlns:ns1="http://ws.xservices.brutex.net">
<ns1:return>]]><emphasis>1325488875703</emphasis><![CDATA[</ns1:return> <ns1:return>]]><emphasis>1325488875703</emphasis><![CDATA[</ns1:return>
</ns1:getTimestampResponse> </ns1:getTimestampResponse>
</soap:Body> </soap:Body>
</soap:Envelope>]]></screen> </soap:Envelope>]]>
</programlisting>
</para> </para>
</section> </section>
<section version="5.0" xml:base="DateServices/getTimestamp2.xml" xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude"> <section version="5.0" xml:base="DateServices/getTimestamp2.xml" xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude">
<title>getTimestamp2</title> <title>getTimestamp2</title>
<para>Get current timestamp in seconds (unix timestamp). <para>Get current timestamp in seconds (unix timestamp).
Sample request: Sample request:
<screen><![CDATA[ <programlisting language="xml">
<![CDATA[
<soapenv:Envelope <soapenv:Envelope
xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:ws="http://ws.xservices.brutex.net"> xmlns:ws="http://ws.xservices.brutex.net">
@ -258,16 +279,19 @@
<ws:getTimestamp2/> <ws:getTimestamp2/>
</soapenv:Body> </soapenv:Body>
</soapenv:Envelop </soapenv:Envelop
]]></screen> ]]>
</programlisting>
Sample response: Sample response:
<screen><![CDATA[ <programlisting language="xml">
<![CDATA[
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body> <soap:Body>
<ns1:getTimestamp2Response xmlns:ns1="http://ws.xservices.brutex.net"> <ns1:getTimestamp2Response xmlns:ns1="http://ws.xservices.brutex.net">
<ns1:return>]]><emphasis>1325488876</emphasis><![CDATA[</ns1:return> <ns1:return>]]><emphasis>1325488876</emphasis><![CDATA[</ns1:return>
</ns1:getTimestamp2Response> </ns1:getTimestamp2Response>
</soap:Body> </soap:Body>
</soap:Envelope>]]></screen> </soap:Envelope>]]>
</programlisting>
</para> </para>
</section> </section>
<section version="5.0" xml:base="DateServices/getTimezones.xml" xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude"> <section version="5.0" xml:base="DateServices/getTimezones.xml" xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude">
@ -3314,7 +3338,7 @@
</para> </para>
</section> </section>
</section> </section>
<section id="executeservices" version="5.0" xml:base="ExecuteServices.xml" xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude"> <section id="executeservices" version="5.0" xml:base="ExecuteServices/ExecuteServices.xml" xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude">
<title>ExecuteServices</title> <title>ExecuteServices</title>
<para>The ExecuteService bundles local and remote command <para>The ExecuteService bundles local and remote command
execution operations. Its WSDL is located at execution operations. Its WSDL is located at
@ -3362,7 +3386,7 @@
<entry>No</entry> <entry>No</entry>
<entry>Any command including arguments</entry> <entry>Any command including arguments</entry>
</row> </row>
<row xml:base="file:/C:/Users/brosenberger/workspace/XServices/doc/entities.ent"> <row xml:base="file:/C:/Users/brosenberger/workspace-XS/XServices/doc/entities.ent">
<entry>timeout</entry> <entry>timeout</entry>
<entry>Long</entry> <entry>Long</entry>
<entry>Yes</entry> <entry>Yes</entry>
@ -3376,7 +3400,7 @@
<section> <section>
<title>Output parameters <title>Output parameters
</title> </title>
<section version="5.0" xml:base="ExecuteServices/../types/ReturnCode.xml" xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude"> <section version="5.0" xml:base="./../types/ReturnCode.xml" xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude">
<title>ReturnCode type</title> <title>ReturnCode type</title>
<para> <para>
The ReturnCode type is used as the generic answer type for most of the The ReturnCode type is used as the generic answer type for most of the
@ -3466,7 +3490,7 @@
<entry>No</entry> <entry>No</entry>
<entry>Any command line arguments</entry> <entry>Any command line arguments</entry>
</row> </row>
<row xml:base="file:/C:/Users/brosenberger/workspace/XServices/doc/entities.ent"> <row xml:base="file:/C:/Users/brosenberger/workspace-XS/XServices/doc/entities.ent">
<entry>timeout</entry> <entry>timeout</entry>
<entry>Long</entry> <entry>Long</entry>
<entry>Yes</entry> <entry>Yes</entry>
@ -3480,7 +3504,7 @@
<section> <section>
<title>Output parameters <title>Output parameters
</title> </title>
<section version="5.0" xml:base="ExecuteServices/../types/ReturnCode.xml" xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude"> <section version="5.0" xml:base="./../types/ReturnCode.xml" xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude">
<title>ReturnCode type</title> <title>ReturnCode type</title>
<para> <para>
The ReturnCode type is used as the generic answer type for most of the The ReturnCode type is used as the generic answer type for most of the
@ -3571,7 +3595,7 @@
<entry>No</entry> <entry>No</entry>
<entry>The command to execute.</entry> <entry>The command to execute.</entry>
</row> </row>
<row xml:base="file:/C:/Users/brosenberger/workspace/XServices/doc/entities.ent"> <row xml:base="file:/C:/Users/brosenberger/workspace-XS/XServices/doc/entities.ent">
<entry>timeout</entry> <entry>timeout</entry>
<entry>Long</entry> <entry>Long</entry>
<entry>Yes</entry> <entry>Yes</entry>
@ -3585,7 +3609,7 @@
<section> <section>
<title>Output parameters <title>Output parameters
</title> </title>
<section version="5.0" xml:base="ExecuteServices/../types/ReturnCode.xml" xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude"> <section version="5.0" xml:base="./../types/ReturnCode.xml" xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude">
<title>ReturnCode type</title> <title>ReturnCode type</title>
<para> <para>
The ReturnCode type is used as the generic answer type for most of the The ReturnCode type is used as the generic answer type for most of the
@ -3701,7 +3725,7 @@
<entry>No</entry> <entry>No</entry>
<entry>The prompt to expect after the command has been executed successfully.</entry> <entry>The prompt to expect after the command has been executed successfully.</entry>
</row> </row>
<row xml:base="file:/C:/Users/brosenberger/workspace/XServices/doc/entities.ent"> <row xml:base="file:/C:/Users/brosenberger/workspace-XS/XServices/doc/entities.ent">
<entry>timeout</entry> <entry>timeout</entry>
<entry>Long</entry> <entry>Long</entry>
<entry>Yes</entry> <entry>Yes</entry>
@ -3714,7 +3738,7 @@
</section> </section>
<section> <section>
<title>Output parameters</title> <title>Output parameters</title>
<section version="5.0" xml:base="ExecuteServices/../types/ReturnCode.xml" xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude"> <section version="5.0" xml:base="./../types/ReturnCode.xml" xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude">
<title>ReturnCode type</title> <title>ReturnCode type</title>
<para> <para>
The ReturnCode type is used as the generic answer type for most of the The ReturnCode type is used as the generic answer type for most of the
@ -3785,12 +3809,87 @@
</section> </section>
</section> </section>
</section> </section>
<section id="fileservices" version="5.0" xml:base="FileServices.xml" xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude"> <section id="fileservices" version="5.0" xml:base="FileServices/FileServices.xml" xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude">
<title>FileServices</title> <title>FileServices</title>
<para>The FileServces bundles various file operations. Its WSDL is located at <para>The FileServces bundles various file operations. Its WSDL is located at
http://server:port/XServices/FileService?wsdl</para> http://server:port/XServices/FileService?wsdl</para>
<section version="5.0" xml:base="FileServices/downloadFile.xml" xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude">
<title>downloadFile</title>
<para>Downloads a file as base64 encoded.
Sample request:
<screen><![CDATA[
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ws="http://ws.xservices.brutex.net">
<soapenv:Header/>
<soapenv:Body>
<!-- downloads a file from the XServices server as base64 encoded -->
<ws:downloadFile>
<file>
<type>FILE</type>
<uri>c:\temp\test.docx</uri>
</file>
</ws:downloadFile>
</soapenv:Body>
</soapenv:Envelope>
]]></screen>
Sample response:
<programlisting language="xml"><![CDATA[
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<ns2:downloadFileResponse xmlns:ns2="http://ws.xservices.brutex.net">
<return>
<content>ADQBNA[... snipp ...]wAApzcAAAAA</content>
<filename>test.docx</filename>
</return>
</ns2:downloadFileResponse>
</soap:Body>
</soap:Envelope>]]></programlisting>
</para>
<para>Encoding files as base64 is very memory consuming!</para>
</section>
<section version="5.0" xml:base="FileServices/encodeFile.xml" xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude">
<title>encodeFile</title>
<para>Encodes a file as base64.
Sample request:
<screen><![CDATA[
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ws="http://ws.xservices.brutex.net">
<soapenv:Header/>
<soapenv:Body>
<ws:encodeFile>
<file>
<type>FILE</type>
<uri>c:\temp\test.docx</uri>
</file>
</ws:encodeFile>
</soapenv:Body>
</soapenv:Envelope>
]]></screen>
Sample response:
<programlisting language="xml"><![CDATA[
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<ns2:encodeFileResponse xmlns:ns2="http://ws.xservices.brutex.net">
<return>
<content>ADQBNA[... snipp ...]wAApzcAAAAA</content>
<filename>test.docx</filename>
</return>
</ns2:encodeFileResponse>
</soap:Body>
</soap:Envelope>]]></programlisting>
</para>
<para>DEPRECATED: Encoding files as base64 is very memory consuming!</para>
</section>
</section> </section>
<section id="mailservices" version="5.0" xml:base="MailServices.xml" xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude"> <section id="jobservices" version="5.0" xml:base="JobServices/JobServices.xml" xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude">
<title>JobServices</title>
<para>The JobService bundles re-occuring or scheduled operations. Its WSDL is located at
http://server:port/XServices/JobService?wsdl</para>
<!--
<xi:include href="MiscServices/generateUUID.xml" />
<xi:include href="MiscServices/getHostinfo.xml" />
<xi:include href="MiscServices/sleep.xml" />
-->
</section>
<section id="mailservices" version="5.0" xml:base="MailServices/MailServices.xml" xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude">
<title>MailServices</title> <title>MailServices</title>
<para>The MailService contains mail send and receive operations. Its WSDL is located at <para>The MailService contains mail send and receive operations. Its WSDL is located at
http://server:port/XServices/MailService?wsdl</para> http://server:port/XServices/MailService?wsdl</para>
@ -3799,7 +3898,7 @@
<para>Send email.</para> <para>Send email.</para>
</section> </section>
</section> </section>
<section id="miscservices" version="5.0" xml:base="MiscServices.xml" xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude"> <section id="miscservices" version="5.0" xml:base="MiscServices/MiscServices.xml" xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude">
<title>MiscServices</title> <title>MiscServices</title>
<para>The MiscService bundles various operations. Its WSDL is located at <para>The MiscService bundles various operations. Its WSDL is located at
http://server:port/XServices/MiscService?wsdl</para> http://server:port/XServices/MiscService?wsdl</para>
@ -3878,6 +3977,334 @@
correctly. correctly.
</para> </para>
</section> </section>
</section>
<section id="storageservices" version="5.0" xml:base="StorageServices/StorageServices.xml" xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude">
<title>StorageServices</title>
<para>The StorageService will provide get/ push operations to store and retrieve data from various backends.
This is currently under development and not yet released.
Its WSDL is located at
http://server:port/XServices/StorageService?wsdl</para>
<section version="5.0" xml:base="StorageServices/operationName.xml" xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude">
<title> ...
</title>
<para>Description here</para>
<section>
<title>Input parameters
</title>
<para/>
<table frame="all">
<title>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>host</entry>
<entry>HostConnection</entry>
<entry>Yes</entry>
<entry>
Host where to execute the command. See
<link linkend="hostconnection">HostConnection</link>
.
</entry>
</row>
<row>
<entry>command</entry>
<entry>String</entry>
<entry>No</entry>
<entry>Any command including arguments</entry>
</row>
<row xml:base="file:/C:/Users/brosenberger/workspace-XS/XServices/doc/entities.ent">
<entry>timeout</entry>
<entry>Long</entry>
<entry>Yes</entry>
<entry>Timeout in milliseconds. The command is forcefully terminated when timeout is reached.</entry>
</row>
</tbody>
</tgroup>
</table>
<para/>
</section>
<section>
<title>Output parameters
</title>
<section version="5.0" xml:base="./../types/ReturnCode.xml" xmlns="http://docbook.org/ns/docbook" 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[
<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:sequence>
</xs:complexType>]]>
</programlisting>
<bridgehead renderas="sect3">Example XML</bridgehead>
<programlisting language="xml">
&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;
<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>
</section>
</section>
</section>
<section id="stringservices" version="5.0" xml:base="StringServices/StringServices.xml" xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude">
<title>StringServices</title>
<para>The StringService provides String manipulation capabilities.
Its WSDL is located at
http://server:port/XServices/StringService?wsdl</para>
<section version="5.0" xml:base="StringServices/replaceRegEx.xml" xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude">
<title>replaceRegEx</title>
<para>Search and Replace using regular expression.
Sample request:
<screen><![CDATA[
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:ws="http://ws.xservices.brutex.net">
<soapenv:Header/>
<soapenv:Body>
<ws:replaceRegEx>
<string>Hallo Welt</string>
<search>W.*</search>
<replace>Brian</replace>
<regexflags>ig</regexflags>
</ws:replaceRegEx>
</soapenv:Body>
</soapenv:Envelope>
]]></screen>
Sample response:
<programlisting language="xml"><![CDATA[
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<ns2:replaceRegExResponse xmlns:ns2="http://ws.xservices.brutex.net">
<return>
<string>Hallo Brian</string>
<count>1</count>
</return>
</ns2:replaceRegExResponse>
</soap:Body>
</soap:Envelope>]]></programlisting>
</para>
<para>Allowed regexflags are case-insensitive (i) and global search (g).</para>
</section>
</section>
<section id="xmlservices" version="5.0" xml:base="XmlServices/XmlServices.xml" xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude">
<title>XmlServices</title>
<para>The XmlService provides operations to manipulate XML structures.
Its WSDL is located at
http://server:port/XServices/XmlService?wsdl</para>
<section version="5.0" xml:base="XmlServices/insertNodes.xml" xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude">
<title>insertNodes</title>
<para>Insert an xml fragment into other elements specified by an XPath expression.
This operation is namespace aware.
Sample request:
<programlisting language="xml"><![CDATA[
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ws="http://ws.xservices.brutex.net">
<soapenv:Header/>
<soapenv:Body>
<ws:insertNodes>
<sourcexml><![CDATA[
<books>
<author>
<name>Mensiok</name>
<surname>Bello</surname>
</author>
<author>
<name>Schwab</name>
<surname>Rumsau</surname>
</author>
<author>
<name>Dollibert</name>
<surname>Rach</surname>
</author>
</books>
]]]]><![CDATA[></sourcexml>
<encoding>utf-8</encoding>
<namespaceList>
<!--Zero or more repetitions:-->
<namespace>
<prefix></prefix>
<uri></uri>
</namespace>
</namespaceList>
<xpath>/books/author</xpath>
<!--Optional:-->
<xmldata><![CDATA[<age namespace="http://btx"/>]]]]><![CDATA[></xmldata>
</ws:insertNodes>
</soapenv:Body>
</soapenv:Envelope>
]]></programlisting>
Sample response:
<programlisting language="xml"><![CDATA[
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<ns2:insertNodesResponse xmlns:ns2="http://ws.xservices.brutex.net">
<return><![CDATA[<?xml version='1.0' encoding='UTF-8'?>
<books>
<author>
<name>Mensiok</name>
<surname>Bello</surname>
<age namespace="http://btx"/></author>
<author>
<name>Schwab</name>
<surname>Rumsau</surname>
<age namespace="http://btx"/></author>
<author>
<name>Dollibert</name>
<surname>Rach</surname>
<age namespace="http://btx"/></author>
</books>]]]]><![CDATA[></!></return>
</ns2:insertNodesResponse>
</soap:Body>
</soap:Envelope>
]]></programlisting>
</para>
</section>
<section version="5.0" xml:base="XmlServices/replaceNodes.xml" xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude">
<title>replaceNodes</title>
<para>Replace an xml fragment with another xml fragment. This operation is namespace aware.
Sample request:
<programlisting language="xml"><![CDATA[
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:ws="http://ws.xservices.brutex.net">
<soapenv:Header/>
<soapenv:Body>
<ws:replaceNodes>
<sourcexml><![CDATA[
<books>
<author>
<name>Mensiok</name>
<surname>Bello</surname>
</author>
<author>
<name>Schwab</name>
<surname>Rumsau</surname>
</author>
<author>
<name>Dollibert</name>
<surname>Rach</surname>
</author>
</books>
]]]]><![CDATA[>
</sourcexml>
<encoding>utf-8</encoding>
<namespaceList>
<!--Zero or more repetitions:-->
<namespace>
<prefix></prefix>
<uri></uri>
</namespace>
</namespaceList>
<xpath>*/name[text()='Schwab']</xpath>
<!--Optional:-->
<xmldata><![CDATA[<name>Meyer</name><age>45</age><!--edited here-->]]]]><![CDATA[></xmldata>
</ws:replaceNodes>
</soapenv:Body>
</soapenv:Envelope>
]]></programlisting>
Sample response:
<programlisting language="xml"><![CDATA[
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<ns2:replaceNodesResponse xmlns:ns2="http://ws.xservices.brutex.net">
<return><![CDATA[<?xml version='1.0' encoding='UTF-8'?>
<books>
<author>
<name>Mensiok</name>
<surname>Bello</surname>
</author>
<author>
<name>Meyer</name><age>45</age><!--edited here-->
<surname>Rumsau</surname>
</author>
<author>
<name>Dollibert</name>
<surname>Rach</surname>
</author>
</books>]]]]><![CDATA[></return>
</ns2:replaceNodesResponse>
</soap:Body>
</soap:Envelope>]]></programlisting>
</para>
</section>
<section version="5.0" xml:base="XmlServices/wrapInCDATA.xml" xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude">
<title>wrapInCDATA</title>
<para>Simply wraps any data fragment into &lt;![CDATA[ ... ]]&gt; section. This can be useful if you
want to preserve indentation or line breaks.
</para>
<para>
Sample request:
<programlisting language="xml"><![CDATA[
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:ws="http://ws.xservices.brutex.net">
<soapenv:Header/>
<soapenv:Body>
<ws:wrapInCDATA>
<data>Hello World, here is some &lt;xml&gt; data</data>
</ws:wrapInCDATA>
</soapenv:Body>
</soapenv:Envelope>
]]></programlisting>
Sample response:
<programlisting language="xml"><![CDATA[
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<ns2:wrapInCDATAResponse xmlns:ns2="http://ws.xservices.brutex.net">
<return>&lt;![CDATA[Hello World, here is some &lt;xml> data]]&gt;</return>
</ns2:wrapInCDATAResponse>
</soap:Body>
</soap:Envelope>
]]></programlisting>
</para>
</section>
</section> </section>
</chapter> </chapter>
@ -3886,7 +4313,7 @@
<title>XML Types</title> <title>XML Types</title>
<para>This chapter bundles the documentation for common XML types used <para>This chapter bundles the documentation for common XML types used
by XServices web service.</para> by XServices web service.</para>
<section version="5.0" xml:base="Types.xml" xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude"> <section version="5.0" xml:base="types/Types.xml" xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude">
<!-- Sort alphabetically --> <!-- Sort alphabetically -->
<section id="antproperty" xml:base="types/AntProperty.xml"> <section id="antproperty" xml:base="types/AntProperty.xml">
<title>AntProperty type</title> <title>AntProperty type</title>

22
doc/BruteXServices_User_Guide.xml
View File

@ -7,7 +7,7 @@
xmlns:xi="http://www.w3.org/2001/XInclude"> xmlns:xi="http://www.w3.org/2001/XInclude">
<title>Brutex XServices Documentation</title> <title>Brutex XServices Documentation</title>
<bookinfo> <bookinfo>
<date>Januar 2012</date> <date>June 2014</date>
<author> <author>
<firstname>Brian</firstname> <firstname>Brian</firstname>
<surname>Rosenberger</surname> <surname>Rosenberger</surname>
@ -15,7 +15,7 @@
</author> </author>
<corpname>Brutex Network</corpname> <corpname>Brutex Network</corpname>
<copyright> <copyright>
<year>2012</year> <year>2014</year>
</copyright> </copyright>
<legalnotice> <legalnotice>
<para> <para>
@ -55,12 +55,16 @@
<beginpage /> <beginpage />
<title>Available Services</title> <title>Available Services</title>
<para>List of available web services and their operations.</para> <para>List of available web services and their operations.</para>
<xi:include href="ArchiveServices.xml" /> <xi:include href="ArchiveServices/ArchiveServices.xml" />
<xi:include href="DateServices.xml" /> <xi:include href="DateServices/DateServices.xml" />
<xi:include href="ExecuteServices.xml" /> <xi:include href="ExecuteServices/ExecuteServices.xml" />
<xi:include href="FileServices.xml" /> <xi:include href="FileServices/FileServices.xml" />
<xi:include href="MailServices.xml" /> <xi:include href="JobServices/JobServices.xml" />
<xi:include href="MiscServices.xml" /> <xi:include href="MailServices/MailServices.xml" />
<xi:include href="MiscServices/MiscServices.xml" />
<xi:include href="StorageServices/StorageServices.xml" />
<xi:include href="StringServices/StringServices.xml" />
<xi:include href="XmlServices/XmlServices.xml" />
</chapter> </chapter>
<chapter id="xmltypes"> <chapter id="xmltypes">
@ -68,6 +72,6 @@
<title>XML Types</title> <title>XML Types</title>
<para>This chapter bundles the documentation for common XML types used <para>This chapter bundles the documentation for common XML types used
by XServices web service.</para> by XServices web service.</para>
<xi:include href="Types.xml" /> <xi:include href="types/Types.xml" />
</chapter> </chapter>
</book> </book>

14
doc/DateServices.xml → doc/DateServices/DateServices.xml
View File

@ -18,11 +18,11 @@
</listitem> </listitem>
</itemizedlist> </itemizedlist>
</para> </para>
<xi:include href="DateServices/getDate.xml" /> <xi:include href="./getDate.xml" />
<xi:include href="DateServices/getDateExtended.xml" /> <xi:include href="./getDateExtended.xml" />
<xi:include href="DateServices/formatDate.xml" /> <xi:include href="./formatDate.xml" />
<xi:include href="DateServices/getInTimezone.xml" /> <xi:include href="./getInTimezone.xml" />
<xi:include href="DateServices/getTimestamp.xml" /> <xi:include href="./getTimestamp.xml" />
<xi:include href="DateServices/getTimestamp2.xml" /> <xi:include href="./getTimestamp2.xml" />
<xi:include href="DateServices/getTimezones.xml" /> <xi:include href="./getTimezones.xml" />
</section> </section>

4
doc/DateServices/getDate.xml
View File

@ -8,7 +8,7 @@
<title>getDate</title> <title>getDate</title>
<para>Get current time and date. <para>Get current time and date.
Sample request: Sample request:
<screen><![CDATA[ <programlisting language="xml"><![CDATA[
<soapenv:Envelope <soapenv:Envelope
xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:ws="http://ws.xservices.brutex.net"> xmlns:ws="http://ws.xservices.brutex.net">
@ -17,7 +17,7 @@
<ws:getDate/> <ws:getDate/>
</soapenv:Body> </soapenv:Body>
</soapenv:Envelop </soapenv:Envelop
]]></screen> ]]></programlisting>
Sample response: Sample response:
<programlisting language="xml"><![CDATA[ <programlisting language="xml"><![CDATA[
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">

4
doc/DateServices/getDateExtended.xml
View File

@ -8,7 +8,7 @@
<title>getDateExtended</title> <title>getDateExtended</title>
<para>Get current time and date (extended Version). <para>Get current time and date (extended Version).
Sample response: Sample response:
<screen> <programlisting language="xml">
<![CDATA[ <![CDATA[
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body> <soap:Body>
@ -25,7 +25,7 @@
</soap:Body> </soap:Body>
</soap:Envelope> </soap:Envelope>
]]> ]]>
</screen> </programlisting>
</para> </para>
</section> </section>

12
doc/DateServices/getTimestamp.xml
View File

@ -8,7 +8,8 @@
<title>getTimestamp</title> <title>getTimestamp</title>
<para>Get current timestamp in milliseconds (epoch). <para>Get current timestamp in milliseconds (epoch).
Sample request: Sample request:
<screen><![CDATA[ <programlisting language="xml">
<![CDATA[
<soapenv:Envelope <soapenv:Envelope
xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:ws="http://ws.xservices.brutex.net"> xmlns:ws="http://ws.xservices.brutex.net">
@ -17,15 +18,18 @@
<ws:getTimestamp/> <ws:getTimestamp/>
</soapenv:Body> </soapenv:Body>
</soapenv:Envelop </soapenv:Envelop
]]></screen> ]]>
</programlisting>
Sample response: Sample response:
<screen><![CDATA[ <programlisting language="xml">
<![CDATA[
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body> <soap:Body>
<ns1:getTimestampResponse xmlns:ns1="http://ws.xservices.brutex.net"> <ns1:getTimestampResponse xmlns:ns1="http://ws.xservices.brutex.net">
<ns1:return>]]><emphasis>1325488875703</emphasis><![CDATA[</ns1:return> <ns1:return>]]><emphasis>1325488875703</emphasis><![CDATA[</ns1:return>
</ns1:getTimestampResponse> </ns1:getTimestampResponse>
</soap:Body> </soap:Body>
</soap:Envelope>]]></screen> </soap:Envelope>]]>
</programlisting>
</para> </para>
</section> </section>

12
doc/DateServices/getTimestamp2.xml
View File

@ -8,7 +8,8 @@
<title>getTimestamp2</title> <title>getTimestamp2</title>
<para>Get current timestamp in seconds (unix timestamp). <para>Get current timestamp in seconds (unix timestamp).
Sample request: Sample request:
<screen><![CDATA[ <programlisting language="xml">
<![CDATA[
<soapenv:Envelope <soapenv:Envelope
xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:ws="http://ws.xservices.brutex.net"> xmlns:ws="http://ws.xservices.brutex.net">
@ -17,15 +18,18 @@
<ws:getTimestamp2/> <ws:getTimestamp2/>
</soapenv:Body> </soapenv:Body>
</soapenv:Envelop </soapenv:Envelop
]]></screen> ]]>
</programlisting>
Sample response: Sample response:
<screen><![CDATA[ <programlisting language="xml">
<![CDATA[
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body> <soap:Body>
<ns1:getTimestamp2Response xmlns:ns1="http://ws.xservices.brutex.net"> <ns1:getTimestamp2Response xmlns:ns1="http://ws.xservices.brutex.net">
<ns1:return>]]><emphasis>1325488876</emphasis><![CDATA[</ns1:return> <ns1:return>]]><emphasis>1325488876</emphasis><![CDATA[</ns1:return>
</ns1:getTimestamp2Response> </ns1:getTimestamp2Response>
</soap:Body> </soap:Body>
</soap:Envelope>]]></screen> </soap:Envelope>]]>
</programlisting>
</para> </para>
</section> </section>

8
doc/ExecuteServices.xml → doc/ExecuteServices/ExecuteServices.xml
View File

@ -6,8 +6,8 @@
<para>The ExecuteService bundles local and remote command <para>The ExecuteService bundles local and remote command
execution operations. Its WSDL is located at execution operations. Its WSDL is located at
http://server:port/XServices/ExecuteService?wsdl</para> http://server:port/XServices/ExecuteService?wsdl</para>
<xi:include href="ExecuteServices/rExec.xml" /> <xi:include href="./rExec.xml" />
<xi:include href="ExecuteServices/runCommand.xml" /> <xi:include href="./runCommand.xml" />
<xi:include href="ExecuteServices/runCommandWithSSH.xml" /> <xi:include href="./runCommandWithSSH.xml" />
<xi:include href="ExecuteServices/telnet.xml" /> <xi:include href="./telnet.xml" />
</section> </section>

2
doc/FileServices.xml → doc/FileServices/FileServices.xml
View File

@ -5,4 +5,6 @@
<title>FileServices</title> <title>FileServices</title>
<para>The FileServces bundles various file operations. Its WSDL is located at <para>The FileServces bundles various file operations. Its WSDL is located at
http://server:port/XServices/FileService?wsdl</para> http://server:port/XServices/FileService?wsdl</para>
<xi:include href="./downloadFile.xml" />
<xi:include href="./encodeFile.xml" />
</section> </section>

13
doc/JobServices/JobServices.xml Normal file
View File

@ -0,0 +1,13 @@
<?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="jobservices">
<title>JobServices</title>
<para>The JobService bundles re-occuring or scheduled operations. Its WSDL is located at
http://server:port/XServices/JobService?wsdl</para>
<!--
<xi:include href="MiscServices/generateUUID.xml" />
<xi:include href="MiscServices/getHostinfo.xml" />
<xi:include href="MiscServices/sleep.xml" />
-->
</section>

2
doc/MailServices.xml → doc/MailServices/MailServices.xml
View File

@ -5,5 +5,5 @@
<title>MailServices</title> <title>MailServices</title>
<para>The MailService contains mail send and receive operations. Its WSDL is located at <para>The MailService contains mail send and receive operations. Its WSDL is located at
http://server:port/XServices/MailService?wsdl</para> http://server:port/XServices/MailService?wsdl</para>
<xi:include href="MailServices/sendMailSimple.xml" /> <xi:include href="./sendMailSimple.xml" />
</section> </section>

6
doc/MiscServices.xml → doc/MiscServices/MiscServices.xml
View File

@ -5,7 +5,7 @@
<title>MiscServices</title> <title>MiscServices</title>
<para>The MiscService bundles various operations. Its WSDL is located at <para>The MiscService bundles various operations. Its WSDL is located at
http://server:port/XServices/MiscService?wsdl</para> http://server:port/XServices/MiscService?wsdl</para>
<xi:include href="MiscServices/generateUUID.xml" /> <xi:include href="./generateUUID.xml" />
<xi:include href="MiscServices/getHostinfo.xml" /> <xi:include href="./getHostinfo.xml" />
<xi:include href="MiscServices/sleep.xml" /> <xi:include href="./sleep.xml" />
</section> </section>

12
doc/StorageServices/StorageServices.xml Normal file
View File

@ -0,0 +1,12 @@
<?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="storageservices">
<title>StorageServices</title>
<para>The StorageService will provide get/ push operations to store and retrieve data from various backends.
This is currently under development and not yet released.
Its WSDL is located at
http://server:port/XServices/StorageService?wsdl</para>
<xi:include href="./operationName.xml" />
</section>

59
doc/StorageServices/operationName.xml Normal file
View File

@ -0,0 +1,59 @@
<?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> ...
</title>
<para>Description here</para>
<section>
<title>&inp;
</title>
<para />
<table frame="all">
<title>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>host</entry>
<entry>HostConnection</entry>
<entry>Yes</entry>
<entry>
Host where to execute the command. See
<link linkend='hostconnection'>HostConnection</link>
.
</entry>
</row>
<row>
<entry>command</entry>
<entry>String</entry>
<entry>No</entry>
<entry>Any command including arguments</entry>
</row>
&param-timeout;
</tbody>
</tgroup>
</table>
<para />
</section>
<section>
<title>&outp;
</title>
<xi:include href="../types/ReturnCode.xml" />
</section>
</section>

11
doc/StringServices/StringServices.xml Normal file
View File

@ -0,0 +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="stringservices">
<title>StringServices</title>
<para>The StringService provides String manipulation capabilities.
Its WSDL is located at
http://server:port/XServices/StringService?wsdl</para>
<xi:include href="./replaceRegEx.xml" />
</section>

13
doc/Types.xml
View File

@ -1,13 +0,0 @@
<?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/DateInfoType.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>

13
doc/XmlServices/XmlServices.xml Normal file
View File

@ -0,0 +1,13 @@
<?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="xmlservices">
<title>XmlServices</title>
<para>The XmlService provides operations to manipulate XML structures.
Its WSDL is located at
http://server:port/XServices/XmlService?wsdl</para>
<xi:include href="./insertNodes.xml" />
<xi:include href="./replaceNodes.xml" />
<xi:include href="./wrapInCDATA.xml" />
</section>

74
doc/XmlServices/insertNodes.xml Normal file
View File

@ -0,0 +1,74 @@
<?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>insertNodes</title>
<para>Insert an xml fragment into other elements specified by an XPath expression.
This operation is namespace aware.
Sample request:
<programlisting language="xml"><![CDATA[
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ws="http://ws.xservices.brutex.net">
<soapenv:Header/>
<soapenv:Body>
<ws:insertNodes>
<sourcexml><![CDATA[
<books>
<author>
<name>Mensiok</name>
<surname>Bello</surname>
</author>
<author>
<name>Schwab</name>
<surname>Rumsau</surname>
</author>
<author>
<name>Dollibert</name>
<surname>Rach</surname>
</author>
</books>
]]]]><![CDATA[></sourcexml>
<encoding>utf-8</encoding>
<namespaceList>
<!--Zero or more repetitions:-->
<namespace>
<prefix></prefix>
<uri></uri>
</namespace>
</namespaceList>
<xpath>/books/author</xpath>
<!--Optional:-->
<xmldata><![CDATA[<age namespace="http://btx"/>]]]]><![CDATA[></xmldata>
</ws:insertNodes>
</soapenv:Body>
</soapenv:Envelope>
]]></programlisting>
Sample response:
<programlisting language="xml"><![CDATA[
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<ns2:insertNodesResponse xmlns:ns2="http://ws.xservices.brutex.net">
<return><![CDATA[<?xml version='1.0' encoding='UTF-8'?>
<books>
<author>
<name>Mensiok</name>
<surname>Bello</surname>
<age namespace="http://btx"/></author>
<author>
<name>Schwab</name>
<surname>Rumsau</surname>
<age namespace="http://btx"/></author>
<author>
<name>Dollibert</name>
<surname>Rach</surname>
<age namespace="http://btx"/></author>
</books>]]]]><![CDATA[></!></return>
</ns2:insertNodesResponse>
</soap:Body>
</soap:Envelope>
]]></programlisting>
</para>
</section>

59
doc/XmlServices/operationName.xml Normal file
View File

@ -0,0 +1,59 @@
<?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> ...
</title>
<para>Description here</para>
<section>
<title>&inp;
</title>
<para />
<table frame="all">
<title>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>host</entry>
<entry>HostConnection</entry>
<entry>Yes</entry>
<entry>
Host where to execute the command. See
<link linkend='hostconnection'>HostConnection</link>
.
</entry>
</row>
<row>
<entry>command</entry>
<entry>String</entry>
<entry>No</entry>
<entry>Any command including arguments</entry>
</row>
&param-timeout;
</tbody>
</tgroup>
</table>
<para />
</section>
<section>
<title>&outp;
</title>
<xi:include href="../types/ReturnCode.xml" />
</section>
</section>

74
doc/XmlServices/replaceNodes.xml Normal file
View File

@ -0,0 +1,74 @@
<?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>replaceNodes</title>
<para>Replace an xml fragment with another xml fragment. This operation is namespace aware.
Sample request:
<programlisting language="xml"><![CDATA[
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:ws="http://ws.xservices.brutex.net">
<soapenv:Header/>
<soapenv:Body>
<ws:replaceNodes>
<sourcexml><![CDATA[
<books>
<author>
<name>Mensiok</name>
<surname>Bello</surname>
</author>
<author>
<name>Schwab</name>
<surname>Rumsau</surname>
</author>
<author>
<name>Dollibert</name>
<surname>Rach</surname>
</author>
</books>
]]]]><![CDATA[>
</sourcexml>
<encoding>utf-8</encoding>
<namespaceList>
<!--Zero or more repetitions:-->
<namespace>
<prefix></prefix>
<uri></uri>
</namespace>
</namespaceList>
<xpath>*/name[text()='Schwab']</xpath>
<!--Optional:-->
<xmldata><![CDATA[<name>Meyer</name><age>45</age><!--edited here-->]]]]><![CDATA[></xmldata>
</ws:replaceNodes>
</soapenv:Body>
</soapenv:Envelope>
]]></programlisting>
Sample response:
<programlisting language="xml"><![CDATA[
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<ns2:replaceNodesResponse xmlns:ns2="http://ws.xservices.brutex.net">
<return><![CDATA[<?xml version='1.0' encoding='UTF-8'?>
<books>
<author>
<name>Mensiok</name>
<surname>Bello</surname>
</author>
<author>
<name>Meyer</name><age>45</age><!--edited here-->
<surname>Rumsau</surname>
</author>
<author>
<name>Dollibert</name>
<surname>Rach</surname>
</author>
</books>]]]]><![CDATA[></return>
</ns2:replaceNodesResponse>
</soap:Body>
</soap:Envelope>]]></programlisting>
</para>
</section>

36
doc/XmlServices/wrapInCDATA.xml Normal file
View File

@ -0,0 +1,36 @@
<?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>wrapInCDATA</title>
<para>Simply wraps any data fragment into &lt;![CDATA[ ... ]]&gt; section. This can be useful if you
want to preserve indentation or line breaks.
</para>
<para>
Sample request:
<programlisting language="xml"><![CDATA[
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:ws="http://ws.xservices.brutex.net">
<soapenv:Header/>
<soapenv:Body>
<ws:wrapInCDATA>
<data>Hello World, here is some &lt;xml&gt; data</data>
</ws:wrapInCDATA>
</soapenv:Body>
</soapenv:Envelope>
]]></programlisting>
Sample response:
<programlisting language="xml"><![CDATA[
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<ns2:wrapInCDATAResponse xmlns:ns2="http://ws.xservices.brutex.net">
<return>&lt;![CDATA[Hello World, here is some &lt;xml> data]]&gt;</return>
</ns2:wrapInCDATAResponse>
</soap:Body>
</soap:Envelope>
]]></programlisting>
</para>
</section>

11
doc/_template/_templateServices.xml vendored Normal file
View File

@ -0,0 +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="templateservices">
<title>TemplateServices</title>
<para>The TemplateService bundles ...
Its WSDL is located at
http://server:port/XServices/TemplateService?wsdl</para>
<xi:include href="./operationName.xml" />
</section>

59
doc/_template/operationName.xml vendored Normal file
View File

@ -0,0 +1,59 @@
<?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> ...
</title>
<para>Description here</para>
<section>
<title>&inp;
</title>
<para />
<table frame="all">
<title>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>host</entry>
<entry>HostConnection</entry>
<entry>Yes</entry>
<entry>
Host where to execute the command. See
<link linkend='hostconnection'>HostConnection</link>
.
</entry>
</row>
<row>
<entry>command</entry>
<entry>String</entry>
<entry>No</entry>
<entry>Any command including arguments</entry>
</row>
&param-timeout;
</tbody>
</tgroup>
</table>
<para />
</section>
<section>
<title>&outp;
</title>
<xi:include href="../types/ReturnCode.xml" />
</section>
</section>

3
doc/common/installation.xml
View File

@ -5,8 +5,7 @@
<section> <section>
<title>Installation</title> <title>Installation</title>
<para>tbd.</para> <para>As of February 2013, XServices require Java 7. Older builds run against Java 5.</para>
<para>Sun Java SE 1.6.0</para>
<para>Apache Tomcat 7</para> <para>Apache Tomcat 7</para>
<para>tbd.</para> <para>tbd.</para>
<para>In short: Deploy .WAR file to Apache Tomcat</para> <para>In short: Deploy .WAR file to Apache Tomcat</para>

13
doc/types/Types.xml Normal file
View File

@ -0,0 +1,13 @@
<?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="./AntProperty.xml" />
<xi:include href="./DateInfoType.xml" />
<xi:include href="./FileResource.xml" />
<xi:include href="./HostConnection.xml" />
<xi:include href="./PatternElement.xml" />
<xi:include href="./PatternSetType.xml" />
<xi:include href="./ReturnCode.xml" />
<xi:include href="./SelectorType.xml" />
</section>