Subversion Repositories XServices

Compare Revisions

Ignore whitespace Rev 165 → Rev 166

/xservices/trunk/doc/BruteXServices_User_Guide.dbk
67,7 → 67,7
<para>This chapter describes the installation process.</para>
<section xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0" xml:base="common/installation.xml" xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude">
 
<section>
 
<title>Installation</title>
<para>As of February 2013, XServices require Java 7. Older builds run against Java 5.</para>
<para>Apache Tomcat 7</para>
119,12 → 119,12
server.xml
file (into &lt;engine&gt;&lt;host&gt;).</para>
</section>
</section>
 
</section>
</chapter>
<chapter id="services">
<chapter id="soapservices">
<beginpage/>
<title>Available Services</title>
<title>Available SOAP Services</title>
<para>List of available web services and their operations.</para>
<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>
131,7 → 131,193
<para>The ArchiveService bundles file packing operations. Its
WSDL is located at
http://server:port/XServices/ArchiveService?wsdl</para>
<section version="5.0" xml:base="ArchiveServices/bzip2.xml" xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude">
<title>gzip</title>
<para>Create a GNU zip archive.
Sample request:
<screen><![CDATA[
...
]]></screen>
Sample response:
<programlisting language="xml"><![CDATA[
...
]]></programlisting>
</para>
<para/>
</section>
<section version="5.0" xml:base="ArchiveServices/bzip2FromArchive.xml" xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude">
<title>bzip2FromArchive</title>
<para>Create a new bzip2 archive from files located within another archive.
Sample request:
<screen><![CDATA[
...
]]></screen>
Sample response:
<programlisting language="xml"><![CDATA[
...
]]></programlisting>
</para>
<para/>
</section>
<section version="5.0" xml:base="ArchiveServices/gzip.xml" xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude">
<title>bzip2</title>
<para>Create a bzip2 archive.
Sample request:
<screen><![CDATA[
...
]]></screen>
Sample response:
<programlisting language="xml"><![CDATA[
...
]]></programlisting>
</para>
<para/>
</section>
<section version="5.0" xml:base="ArchiveServices/gzipFromArchive.xml" xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude">
<title>gzipFromArchive</title>
<para>Create a new GNU zip archive from files located within another archive.
Sample request:
<screen><![CDATA[
...
]]></screen>
Sample response:
<programlisting language="xml"><![CDATA[
...
]]></programlisting>
</para>
<para/>
</section>
<section version="5.0" xml:base="ArchiveServices/gunzip.xml" xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude">
<title>gunzip</title>
<para>Extract files from a GNU zip archive.
Sample request:
<screen><![CDATA[
...
]]></screen>
Sample response:
<programlisting language="xml"><![CDATA[
...
]]></programlisting>
</para>
<para/>
</section>
<section version="5.0" xml:base="ArchiveServices/bunzip2.xml" xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude">
<title>bunzip2</title>
<para>Extract files from a bzip2 archive.
Sample request:
<screen><![CDATA[
...
]]></screen>
Sample response:
<programlisting language="xml"><![CDATA[
...
]]></programlisting>
</para>
<para/>
</section>
<section version="5.0" xml:base="ArchiveServices/gunzipFromURL.xml" xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude">
<title>gunzipFromURL</title>
<para>Extract files from a GNU zip archive. The archive is located on the web (http/ https)
and will be downloaded automatically.
Sample request:
<screen><![CDATA[
...
]]></screen>
Sample response:
<programlisting language="xml"><![CDATA[
...
]]></programlisting>
</para>
<para/>
</section>
<section version="5.0" xml:base="ArchiveServices/bunzip2FromURL.xml" xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude">
<title>bunzip2FromURL</title>
<para>Extract files from a bzip2 archive. The archive is located on the web (http/ https)
and will be downloaded automatically.
Sample request:
<screen><![CDATA[
...
]]></screen>
Sample response:
<programlisting language="xml"><![CDATA[
...
]]></programlisting>
</para>
<para/>
</section>
<section version="5.0" xml:base="ArchiveServices/zip.xml" xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude">
<title>zip</title>
<para>Compress files and store them in a ZIP archive.
Sample request:
<screen><![CDATA[
...
]]></screen>
Sample response:
<programlisting language="xml"><![CDATA[
...
]]></programlisting>
</para>
<para/>
</section>
<section version="5.0" xml:base="ArchiveServices/zipFromArchive.xml" xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude">
<title>zipFromArchive</title>
<para>Create a new ZIP archive from files located within another archive.
Sample request:
<screen><![CDATA[
...
]]></screen>
Sample response:
<programlisting language="xml"><![CDATA[
...
]]></programlisting>
</para>
<para/>
</section>
<section version="5.0" xml:base="ArchiveServices/unzip.xml" xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude">
<title>unzip</title>
<para>Extract files from a zip archive.
Sample request:
<screen><![CDATA[
...
]]></screen>
Sample response:
<programlisting language="xml"><![CDATA[
...
]]></programlisting>
</para>
<para/>
</section>
<section version="5.0" xml:base="ArchiveServices/unrar.xml" xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude">
<title>untar</title>
<para>Extract files from a tarball archive.
Sample request:
<screen><![CDATA[
...
]]></screen>
Sample response:
<programlisting language="xml"><![CDATA[
...
]]></programlisting>
</para>
<para/>
</section>
<section version="5.0" xml:base="ArchiveServices/untar.xml" xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude">
<title>unrar</title>
<para>Extract files from a RAR archive.
Sample request:
<screen><![CDATA[
...
]]></screen>
Sample response:
<programlisting language="xml"><![CDATA[
...
]]></programlisting>
</para>
<para/>
</section>
 
</section>
<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>
<para>The DateService bundles various date and time related operations.
150,6 → 336,48
</listitem>
</itemizedlist>
</para>
<section version="5.0" xml:base="DateServices/dateAdd.xml" xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude">
<title>dateAdd</title>
<para>Add or substract a time span from/ to a date.
Sample request:
<screen><![CDATA[
...
]]></screen>
Sample response:
<programlisting language="xml"><![CDATA[
...
]]></programlisting>
</para>
<para>Hints here</para>
</section>
<section version="5.0" xml:base="DateServices/dateTimeDiff.xml" xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude">
<title>dateTimeDiff</title>
<para>Calculate elapsed time between two dates. Returns the elapsed time in milliseconds.
Sample request:
<screen><![CDATA[
...
]]></screen>
Sample response:
<programlisting language="xml"><![CDATA[
...
]]></programlisting>
</para>
<para>Hints here</para>
</section>
<section version="5.0" xml:base="DateServices/dateTimeDiff2.xml" xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude">
<title>dateTimeDiff</title>
<para>Calculate Fully elapsed units between two dates. Example: 4:15:10-4:15:55 in minutes = 0 and in seconds = 45.
Sample request:
<screen><![CDATA[
...
]]></screen>
Sample response:
<programlisting language="xml"><![CDATA[
...
]]></programlisting>
</para>
<para>Hints here</para>
</section>
<section version="5.0" xml:base="DateServices/getDate.xml" xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude">
<title>getDate</title>
<para>Get current time and date.
228,6 → 456,37
</itemizedlist>
</para>
</section>
<section version="5.0" xml:base="DateServices/formatDateAdvanced.xml" xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude">
<title>formatDateAdvanced</title>
<para>
Transform Time/ Date representation. Formats a date with a free form pattern. Uses SimpleDateFormat patterns.
</para>
<para>
The following pattern letters are defined (all other characters from 'A' to 'Z' and from 'a' to 'z' are reserved):
<programlisting><![CDATA[
Letter Date or Time Component Presentation Examples
G Era designator Text AD
y Year Year 1996; 96
M Month in year Month July; Jul; 07
w Week in year Number 27
W Week in month Number 2
D Day in year Number 189
d Day in month Number 10
F Day of week in month Number 2
E Day in week Text Tuesday; Tue
a Am/pm marker Text PM
H Hour in day (0-23) Number 0
k Hour in day (1-24) Number 24
K Hour in am/pm (0-11) Number 0
h Hour in am/pm (1-12) Number 12
m Minute in hour Number 30
s Second in minute Number 55
S Millisecond Number 978
z Time zone General time zone Pacific Standard Time; PST; GMT-08:00
Z Time zone RFC 822 time zone -0800
]]></programlisting>
</para>
</section>
<section version="5.0" xml:base="DateServices/getInTimezone.xml" xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude">
<title>getInTimezone</title>
<para>
3337,7 → 3596,34
]]></programlisting>
</para>
</section>
<section version="5.0" xml:base="DateServices/parseDate.xml" xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude">
<title>parseDate</title>
<para>
Converts a string into date using pre-defined date formats
<itemizedlist>
<listitem>
<para>ISO8601 (example: "2012-01-17T23:50:00+01:00")</para>
</listitem>
<listitem>
<para>RFC822 (example: "2012-01-17T23:50:00+0100")</para>
</listitem>
<listitem>
<para>YYYYMMDD (example: "2012/01/17")</para>
</listitem>
<listitem>
<para>DDMMYYYY (example: "17.01.2012")</para>
</listitem>
</itemizedlist>
</para>
</section>
<section version="5.0" xml:base="DateServices/parseDateAdvanced.xml" xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude">
<title>parseDateAdvanced</title>
<para>
Converts a string into date using any format.
</para>
</section>
</section>
<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>
<para>The ExecuteService bundles local and remote command
3611,6 → 3897,26
</soapenv:Body>
</soapenv:Envelope>]]></programlisting></para></section>
</section>
<section version="5.0" xml:base="ExecuteServices/runCommandAsync.xml" xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude">
<title>runCommandAsync</title>
<para>Run an executable with arguments on the server providing the web
service and don't wait for the executable to finish.
The command is run within the environment and under the user
privileges of the user who is running the Tomcat Server.</para>
</section>
<section version="5.0" xml:base="ExecuteServices/runCommandAsyncWithArgs.xml" xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude">
<title>runCommandAsyncWithArgs</title>
<para>Run an executable with arguments on the server providing the web
service and don't wait for the executable to finish.
The command is run within the environment and under the user
privileges of the user who is running the Tomcat Server.</para>
</section>
<section version="5.0" xml:base="ExecuteServices/runCommandWithArgs.xml" xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude">
<title>runCommandWithArgs</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>
<section version="5.0" xml:base="ExecuteServices/runCommandWithSSH.xml" xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude">
<title>runCommandWithSSH</title>
<para>Executes a command through a SSH session.</para>
3732,6 → 4038,15
]]></programlisting>
</section>
</section>
<section version="5.0" xml:base="ExecuteServices/runCommandWithSSHKeyAuth.xml" xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude">
<title>runCommandWithSSHKeyAuth</title>
<para>Executes a command through a SSH session.</para>
</section>
<section version="5.0" xml:base="ExecuteServices/runJavaScript.xml" xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude">
<title>runJavaScript</title>
<para>Execute a JavaScript and or Java program using Mozilla Rhino JIT-Compiler.</para>
</section>
<section version="5.0" xml:base="ExecuteServices/telnet.xml" xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude">
<title>telnet</title>
<para>Runs a telnet session with an "expect shell" like behaviour.</para>
4527,6 → 4842,38
</section>
</chapter>
 
<chapter id="restservices">
<beginpage/>
<title>Available RESTful Services</title>
<para>List of available web services and their operations.</para>
<section id="cvsinfoservices" version="5.0" xml:base="CVSInfoService/CVSInfoService.xml" xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude">
<title>CVSInfoService</title>
<para>RESTful service to query a CVS repository, search files and content. Includes caching mechanism.
</para>
<para>Endpoint address: http://localhost:8080/XServices/cvsinfo</para>
<para>WADL : http://localhost:8080/XServices/cvsinfo?_wadl</para>
 
 
 
<!--
<xi:include href="./dateAdd.xml" />
 
-->
</section>
<section id="fileinfoservices" version="5.0" xml:base="FileInfoService/FileInfoService.xml" xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude">
<title>FileInfoService</title>
<para>The FileInfoService allows listing/ searching/ browsing and download of files and directories. Includes caching mechanism.
</para>
<para>Endpoint address: http://localhost:8080/XServices/fileinfo</para>
<para>WADL : http://localhost:8080/XServices/fileinfo?_wadl</para>
<!--
<xi:include href="./dateAdd.xml" />
 
-->
</section>
 
</chapter>
<chapter id="xmltypes">
<beginpage/>
<title>XML Types</title>