| 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"> |
| <title>Brutex XServices Documentation</title> |
| <bookinfo> |
| <date>Januar 2012</date> |
| <date>June 2014</date> |
| <author> |
| <firstname>Brian</firstname> |
| <surname>Rosenberger</surname> |
| 9,7 → 9,7 |
|---|
| </author> |
| <corpname>Brutex Network</corpname> |
| <copyright> |
| <year>2012</year> |
| <year>2014</year> |
| </copyright> |
| <legalnotice> |
| <para> |
| 39,9 → 39,26 |
|---|
| </legalnotice> |
| <abstract xml:base="common/abstract.xml"> |
| <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>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 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> |
| <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>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> |
| </bookinfo> |
| <chapter id="installation"> |
| 52,8 → 69,7 |
|---|
| |
| <section> |
| <title>Installation</title> |
| <para>tbd.</para> |
| <para>Sun Java SE 1.6.0</para> |
| <para>As of February 2013, XServices require Java 7. Older builds run against Java 5.</para> |
| <para>Apache Tomcat 7</para> |
| <para>tbd.</para> |
| <para>In short: Deploy .WAR file to Apache Tomcat</para> |
| 110,13 → 126,13 |
|---|
| <beginpage/> |
| <title>Available Services</title> |
| <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> |
| <para>The ArchiveService bundles file packing operations. Its |
| WSDL is located at |
| http://server:port/XServices/ArchiveService?wsdl</para> |
| </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> |
| <para>The DateService bundles various date and time related operations. |
| </para> |
| 138,7 → 154,7 |
|---|
| <title>getDate</title> |
| <para>Get current time and date. |
| Sample request: |
| <screen><![CDATA[ |
| <programlisting language="xml"><![CDATA[ |
| <soapenv:Envelope |
| xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" |
| xmlns:ws="http://ws.xservices.brutex.net"> |
| 147,7 → 163,7 |
|---|
| <ws:getDate/> |
| </soapenv:Body> |
| </soapenv:Envelop |
| ]]></screen> |
| ]]></programlisting> |
| Sample response: |
| <programlisting language="xml"><![CDATA[ |
| <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> |
| 171,7 → 187,7 |
|---|
| <title>getDateExtended</title> |
| <para>Get current time and date (extended Version). |
| Sample response: |
| <screen> |
| <programlisting language="xml"> |
| <![CDATA[ |
| <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> |
| <soap:Body> |
| 188,7 → 204,7 |
|---|
| </soap:Body> |
| </soap:Envelope> |
| ]]> |
| </screen> |
| </programlisting> |
| |
| </para> |
| </section> |
| 224,7 → 240,8 |
|---|
| <title>getTimestamp</title> |
| <para>Get current timestamp in milliseconds (epoch). |
| Sample request: |
| <screen><![CDATA[ |
| <programlisting language="xml"> |
| <![CDATA[ |
| <soapenv:Envelope |
| xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" |
| xmlns:ws="http://ws.xservices.brutex.net"> |
| 233,9 → 250,11 |
|---|
| <ws:getTimestamp/> |
| </soapenv:Body> |
| </soapenv:Envelop |
| ]]></screen> |
| ]]> |
| </programlisting> |
| Sample response: |
| <screen><![CDATA[ |
| <programlisting language="xml"> |
| <![CDATA[ |
| <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> |
| <soap:Body> |
| <ns1:getTimestampResponse xmlns:ns1="http://ws.xservices.brutex.net"> |
| 242,7 → 261,8 |
|---|
| <ns1:return>]]><emphasis>1325488875703</emphasis><![CDATA[</ns1:return> |
| </ns1:getTimestampResponse> |
| </soap:Body> |
| </soap:Envelope>]]></screen> |
| </soap:Envelope>]]> |
| </programlisting> |
| </para> |
| </section> |
| <section version="5.0" xml:base="DateServices/getTimestamp2.xml" xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude"> |
| 249,7 → 269,8 |
|---|
| <title>getTimestamp2</title> |
| <para>Get current timestamp in seconds (unix timestamp). |
| Sample request: |
| <screen><![CDATA[ |
| <programlisting language="xml"> |
| <![CDATA[ |
| <soapenv:Envelope |
| xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" |
| xmlns:ws="http://ws.xservices.brutex.net"> |
| 258,9 → 279,11 |
|---|
| <ws:getTimestamp2/> |
| </soapenv:Body> |
| </soapenv:Envelop |
| ]]></screen> |
| ]]> |
| </programlisting> |
| Sample response: |
| <screen><![CDATA[ |
| <programlisting language="xml"> |
| <![CDATA[ |
| <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> |
| <soap:Body> |
| <ns1:getTimestamp2Response xmlns:ns1="http://ws.xservices.brutex.net"> |
| 267,7 → 290,8 |
|---|
| <ns1:return>]]><emphasis>1325488876</emphasis><![CDATA[</ns1:return> |
| </ns1:getTimestamp2Response> |
| </soap:Body> |
| </soap:Envelope>]]></screen> |
| </soap:Envelope>]]> |
| </programlisting> |
| </para> |
| </section> |
| <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> |
| </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> |
| <para>The ExecuteService bundles local and remote command |
| execution operations. Its WSDL is located at |
| 3362,7 → 3386,7 |
|---|
| <entry>No</entry> |
| <entry>Any command including arguments</entry> |
| </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>Long</entry> |
| <entry>Yes</entry> |
| 3376,7 → 3400,7 |
|---|
| <section> |
| <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> |
| <para> |
| The ReturnCode type is used as the generic answer type for most of the |
| 3466,7 → 3490,7 |
|---|
| <entry>No</entry> |
| <entry>Any command line arguments</entry> |
| </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>Long</entry> |
| <entry>Yes</entry> |
| 3480,7 → 3504,7 |
|---|
| <section> |
| <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> |
| <para> |
| The ReturnCode type is used as the generic answer type for most of the |
| 3571,7 → 3595,7 |
|---|
| <entry>No</entry> |
| <entry>The command to execute.</entry> |
| </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>Long</entry> |
| <entry>Yes</entry> |
| 3585,7 → 3609,7 |
|---|
| <section> |
| <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> |
| <para> |
| The ReturnCode type is used as the generic answer type for most of the |
| 3701,7 → 3725,7 |
|---|
| <entry>No</entry> |
| <entry>The prompt to expect after the command has been executed successfully.</entry> |
| </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>Long</entry> |
| <entry>Yes</entry> |
| 3714,7 → 3738,7 |
|---|
| </section> |
| <section> |
| <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> |
| <para> |
| The ReturnCode type is used as the generic answer type for most of the |
| 3785,12 → 3809,87 |
|---|
| </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> |
| <para>The FileServces bundles various file operations. Its WSDL is located at |
| 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 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> |
| <para>The MailService contains mail send and receive operations. Its WSDL is located at |
| http://server:port/XServices/MailService?wsdl</para> |
| 3799,7 → 3898,7 |
|---|
| <para>Send email.</para> |
| </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> |
| <para>The MiscService bundles various operations. Its WSDL is located at |
| http://server:port/XServices/MiscService?wsdl</para> |
| 3879,6 → 3978,334 |
|---|
| </para> |
| </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"> |
| <ReturnCode |
| xmlns:ns2="http://ws.xservices.brutex.net"> |
| <returnCode>0</returnCode> |
| <stdOut/> |
| <stdErr/> |
| <propertyList> |
| <lineannotation> |
| See |
| <link linkend="antproperty">tns:antProperty</link> |
| for details about the <propertyList> elements. |
| </lineannotation> |
| <name>key1</name> |
| <value>value1</value> |
| </propertyList> |
| <propertyList> |
| <name>key2</name> |
| <value>value2</value> |
| </propertyList> |
| </ReturnCode> |
| </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 <![CDATA[ ... ]]> 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 <xml> 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><![CDATA[Hello World, here is some <xml> data]]></return> |
| </ns2:wrapInCDATAResponse> |
| </soap:Body> |
| </soap:Envelope> |
| ]]></programlisting> |
| </para> |
| </section> |
| |
| </section> |
| </chapter> |
| |
| <chapter id="xmltypes"> |
| 3886,7 → 4313,7 |
|---|
| <title>XML Types</title> |
| <para>This chapter bundles the documentation for common XML types used |
| 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 --> |
| <section id="antproperty" xml:base="types/AntProperty.xml"> |
| <title>AntProperty type</title> |