Subversion Repositories XServices

Rev

Rev 117 | Rev 160 | Go to most recent revision | Show entire file | Ignore whitespace | Details | Blame | Last modification | View Log | RSS feed

Rev 117 Rev 159
Line 1... Line 1...
1 
<?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">
 1 
<?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">
2 
	<title>Brutex XServices Documentation</title>
 2 
	<title>Brutex XServices Documentation</title>
3 
	<bookinfo>
 3 
	<bookinfo>
4 
		<date>Januar 2012</date>
 4 
		<date>June 2014</date>
5 
		<author>
 5 
		<author>
6 
			<firstname>Brian</firstname>
 6 
			<firstname>Brian</firstname>
7 
			<surname>Rosenberger</surname>
 7 
			<surname>Rosenberger</surname>
8 
			<email>bru@brutex.de</email>
 8 
			<email>bru@brutex.de</email>
9 
		</author>
 9 
		</author>
10 
		<corpname>Brutex Network</corpname>
 10 
		<corpname>Brutex Network</corpname>
11 
		<copyright>
 11 
		<copyright>
12 
			<year>2012</year>
 12 
			<year>2014</year>
13 
		</copyright>
 13 
		</copyright>
14 
		<legalnotice>
 14 
		<legalnotice>
15 
			<para>
 15 
			<para>
16 
				The copyright holders make no representation about the suitability
 16 
				The copyright holders make no representation about the suitability
17 
				of this document for any purpose. It is provided
 17 
				of this document for any purpose. It is provided
Line 37... Line 37...
37 
			<para>Apache Tomcat and Apache Ant are trademarks of the Apache
 37 
			<para>Apache Tomcat and Apache Ant are trademarks of the Apache
38 
				Software Foundation.</para>
 38 
				Software Foundation.</para>
39 
		</legalnotice>
 39 
		</legalnotice>
40 
		<abstract xml:base="common/abstract.xml">
 40 
		<abstract xml:base="common/abstract.xml">
41 
	<title>Abstract</title>
 41 
	<title>Abstract</title>
42 
	<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>
 42 
	<para>In complex IT environments it is often necessary to integrate
- 
 
 43 
		different information systems with each other, exchange data between
- 
 
 44 
		software tools and automate actions based on events arising from user
- 
 
 45 
		interaction. Web Services is a popular way to make remote functions
- 
 
 46 
		available to a broad range of clients. A WebService is independent
- 
 
 47 
		from platforms and programming languages. XML Messages are exchanged
- 
 
 48 
		through common protocols like TCP/IP or SMTP, processed and returned
- 
 
 49 
		(request/ response paradigm).</para>
- 
 
 50 
	<para>Because of their nature, WebServices are a great technology to
43 
	<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>
 51 
		overcome system boundaries and to "orchestrate" your IT environment.
- 
 
 52 
		They make up the basis for SOA and are the pieces that assemble
- 
 
 53 
		automated business processes.</para>
- 
 
 54 
	<para>XServices is a collection of pre-build WebServices with the
- 
 
 55 
		intention to avoid duplicate work and "re-inventing the wheel". The
- 
 
 56 
		historical base for XServices is the 'XBridgeNG' software, which
44 
	<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>
 57 
		provided a set of Apache Ant Tasks with quite the same intention. The
- 
 
 58 
		available WebService operations are most likely the "most wanted"
- 
 
 59 
		ones, some of them for sure are "must have". This collection may
- 
 
 60 
		overlap with other libraries. In summary the current version contains
- 
 
 61 
		8 WebServices with over 50 operations.</para>
45 
</abstract>
 62 
</abstract>
46 
	</bookinfo>
 63 
	</bookinfo>
47 
	<chapter id="installation">
 64 
	<chapter id="installation">
48 
		<beginpage/>
 65 
		<beginpage/>
49 
		<title>Getting started</title>
 66 
		<title>Getting started</title>
50 
		<para>This chapter describes the installation process.</para>
 67 
		<para>This chapter describes the installation process.</para>
51 
		<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">
 68 
		<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">
Line 52... Line 69...
52 
 
 69 
 
53 
	<section>
 70 
	<section>
54 
		<title>Installation</title>
 - 
 
55 
		<para>tbd.</para>
 71 
		<title>Installation</title>
56 
		<para>Sun Java SE 1.6.0</para>
 72 
		<para>As of February 2013, XServices require Java 7. Older builds run against Java 5.</para>
57 
		<para>Apache Tomcat 7</para>
 73 
		<para>Apache Tomcat 7</para>
58 
		<para>tbd.</para>
 74 
		<para>tbd.</para>
59 
		<para>In short: Deploy .WAR file to Apache Tomcat</para>
 75 
		<para>In short: Deploy .WAR file to Apache Tomcat</para>
60 
		<section>
 76 
		<section>
Line 108... Line 124...
108 
	</chapter>
 124 
	</chapter>
109 
	<chapter id="services">
 125 
	<chapter id="services">
110 
		<beginpage/>
 126 
		<beginpage/>
111 
		<title>Available Services</title>
 127 
		<title>Available Services</title>
112 
		<para>List of available web services and their operations.</para>
 128 
		<para>List of available web services and their operations.</para>
113 
		<section id="archiveservices" version="5.0" xml:base="ArchiveServices.xml" xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude">
 129 
		<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">
114 
	<title>ArchiveServices</title>
 130 
	<title>ArchiveServices</title>
115 
	<para>The ArchiveService bundles file packing operations. Its
 131 
	<para>The ArchiveService bundles file packing operations. Its
116 
		WSDL is located at
 132 
		WSDL is located at
117 
		http://server:port/XServices/ArchiveService?wsdl</para>
 133 
		http://server:port/XServices/ArchiveService?wsdl</para>
118 
</section>
 134 
</section>
119 
		<section id="dateservices" version="5.0" xml:base="DateServices.xml" xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude">
 135 
		<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">
120 
	<title>DateServices</title>
 136 
	<title>DateServices</title>
121 
	<para>The DateService bundles various date and time related operations.
 137 
	<para>The DateService bundles various date and time related operations.
122 
		</para>
 138 
		</para>
123 
	<para>Its WSDL is located at http://server:port/XServices/DateService?wsdl</para>
 139 
	<para>Its WSDL is located at http://server:port/XServices/DateService?wsdl</para>
Line 136... Line 152...
136 
	</para>
 152 
	</para>
137 
	<section version="5.0" xml:base="DateServices/getDate.xml" xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude">
 153 
	<section version="5.0" xml:base="DateServices/getDate.xml" xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude">
138 
	<title>getDate</title>
 154 
	<title>getDate</title>
139 
	<para>Get current time and date.
 155 
	<para>Get current time and date.
140 
	Sample request:
 156 
	Sample request:
141 
<screen><![CDATA[
 157 
<programlisting language="xml"><![CDATA[
142 
<soapenv:Envelope
158 
<soapenv:Envelope
143 
	xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
159 
	xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
144 
	xmlns:ws="http://ws.xservices.brutex.net">
 160 
	xmlns:ws="http://ws.xservices.brutex.net">
145 
   <soapenv:Header/>
 161 
   <soapenv:Header/>
146 
   <soapenv:Body>
 162 
   <soapenv:Body>
147 
      <ws:getDate/>
 163 
      <ws:getDate/>
148 
   </soapenv:Body>
 164 
   </soapenv:Body>
149 
</soapenv:Envelop
 165 
</soapenv:Envelop
150 
]]></screen>
 166 
]]></programlisting>
151 
	Sample response:
 167 
	Sample response:
152 
	<programlisting language="xml"><![CDATA[
 168 
	<programlisting language="xml"><![CDATA[
153 
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
 169 
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
154 
   <soap:Body>
 170 
   <soap:Body>
155 
      <ns1:getDateResponse xmlns:ns1="http://ws.xservices.brutex.net">
 171 
      <ns1:getDateResponse xmlns:ns1="http://ws.xservices.brutex.net">
Line 169... Line 185...
169 
</section>
 185 
</section>
170 
	<section version="5.0" xml:base="DateServices/getDateExtended.xml" xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude">
 186 
	<section version="5.0" xml:base="DateServices/getDateExtended.xml" xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude">
171 
	<title>getDateExtended</title>
 187 
	<title>getDateExtended</title>
172 
	<para>Get current time and date (extended Version).
 188 
	<para>Get current time and date (extended Version).
173 
		Sample response:
 189 
		Sample response:
174 
		<screen>
 190 
		<programlisting language="xml">
175 
<![CDATA[
 191 
<![CDATA[
176 
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
 192 
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
177 
   <soap:Body>
 193 
   <soap:Body>
178 
      <ns2:getDateExtendedResponse xmlns:ns2="http://ws.xservices.brutex.net">
 194 
      <ns2:getDateExtendedResponse xmlns:ns2="http://ws.xservices.brutex.net">
179 
         <return>
 195 
         <return>
Line 186... Line 202...
186 
         </return>
 202 
         </return>
187 
      </ns2:getDateExtendedResponse>
 203 
      </ns2:getDateExtendedResponse>
188 
   </soap:Body>
 204 
   </soap:Body>
189 
</soap:Envelope>
 205 
</soap:Envelope>
190 
]]>
 206 
]]>
191 
</screen>
 207 
</programlisting>
Line 192... Line 208...
192 
 
 208 
 
193 
</para>
 209 
</para>
194 
</section>
 210 
</section>
195 
	<section version="5.0" xml:base="DateServices/formatDate.xml" xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude">
 211 
	<section version="5.0" xml:base="DateServices/formatDate.xml" xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude">
Line 222... Line 238...
222 
</section>
 238 
</section>
223 
	<section version="5.0" xml:base="DateServices/getTimestamp.xml" xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude">
 239 
	<section version="5.0" xml:base="DateServices/getTimestamp.xml" xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude">
224 
	<title>getTimestamp</title>
 240 
	<title>getTimestamp</title>
225 
	<para>Get current timestamp in milliseconds (epoch).
 241 
	<para>Get current timestamp in milliseconds (epoch).
226 
	Sample request:
 242 
	Sample request:
- 
 
 243 
<programlisting language="xml">
227 
<screen><![CDATA[
 244 
<![CDATA[
228 
<soapenv:Envelope
245 
<soapenv:Envelope
229 
	xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
246 
	xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
230 
	xmlns:ws="http://ws.xservices.brutex.net">
 247 
	xmlns:ws="http://ws.xservices.brutex.net">
231 
   <soapenv:Header/>
 248 
   <soapenv:Header/>
232 
   <soapenv:Body>
 249 
   <soapenv:Body>
233 
      <ws:getTimestamp/>
 250 
      <ws:getTimestamp/>
234 
   </soapenv:Body>
 251 
   </soapenv:Body>
235 
</soapenv:Envelop
 252 
</soapenv:Envelop
- 
 
 253 
]]>
236 
]]></screen>
 254 
</programlisting>
237 
	Sample response:
 255 
	Sample response:
- 
 
 256 
<programlisting language="xml">
238 
<screen><![CDATA[
 257 
<![CDATA[
239 
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
 258 
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
240 
   <soap:Body>
 259 
   <soap:Body>
241 
      <ns1:getTimestampResponse xmlns:ns1="http://ws.xservices.brutex.net">
 260 
      <ns1:getTimestampResponse xmlns:ns1="http://ws.xservices.brutex.net">
242 
         <ns1:return>]]><emphasis>1325488875703</emphasis><![CDATA[</ns1:return>
 261 
         <ns1:return>]]><emphasis>1325488875703</emphasis><![CDATA[</ns1:return>
243 
      </ns1:getTimestampResponse>
 262 
      </ns1:getTimestampResponse>
244 
   </soap:Body>
 263 
   </soap:Body>
245 
</soap:Envelope>]]></screen>
 264 
</soap:Envelope>]]>
- 
 
 265 
</programlisting>
246 
</para>
 266 
</para>
247 
</section>
 267 
</section>
248 
	<section version="5.0" xml:base="DateServices/getTimestamp2.xml" xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude">
 268 
	<section version="5.0" xml:base="DateServices/getTimestamp2.xml" xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude">
249 
	<title>getTimestamp2</title>
 269 
	<title>getTimestamp2</title>
250 
	<para>Get current timestamp in seconds (unix timestamp).
 270 
	<para>Get current timestamp in seconds (unix timestamp).
251 
	Sample request:
 271 
	Sample request:
- 
 
 272 
<programlisting language="xml">
252 
<screen><![CDATA[
 273 
<![CDATA[
253 
<soapenv:Envelope
274 
<soapenv:Envelope
254 
	xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
275 
	xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
255 
	xmlns:ws="http://ws.xservices.brutex.net">
 276 
	xmlns:ws="http://ws.xservices.brutex.net">
256 
   <soapenv:Header/>
 277 
   <soapenv:Header/>
257 
   <soapenv:Body>
 278 
   <soapenv:Body>
258 
      <ws:getTimestamp2/>
 279 
      <ws:getTimestamp2/>
259 
   </soapenv:Body>
 280 
   </soapenv:Body>
260 
</soapenv:Envelop
 281 
</soapenv:Envelop
- 
 
 282 
]]>
261 
]]></screen>
 283 
</programlisting>
262 
	Sample response:
 284 
	Sample response:
- 
 
 285 
<programlisting language="xml">
263 
<screen><![CDATA[
 286 
<![CDATA[
264 
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
 287 
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
265 
   <soap:Body>
 288 
   <soap:Body>
266 
      <ns1:getTimestamp2Response xmlns:ns1="http://ws.xservices.brutex.net">
 289 
      <ns1:getTimestamp2Response xmlns:ns1="http://ws.xservices.brutex.net">
267 
         <ns1:return>]]><emphasis>1325488876</emphasis><![CDATA[</ns1:return>
 290 
         <ns1:return>]]><emphasis>1325488876</emphasis><![CDATA[</ns1:return>
268 
      </ns1:getTimestamp2Response>
 291 
      </ns1:getTimestamp2Response>
269 
   </soap:Body>
 292 
   </soap:Body>
270 
</soap:Envelope>]]></screen>
 293 
</soap:Envelope>]]>
- 
 
 294 
</programlisting>
271 
</para>
 295 
</para>
272 
</section>
 296 
</section>
273 
	<section version="5.0" xml:base="DateServices/getTimezones.xml" xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude">
 297 
	<section version="5.0" xml:base="DateServices/getTimezones.xml" xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude">
274 
	<title>getTimezones</title>
 298 
	<title>getTimezones</title>
275 
	<para>
 299 
	<para>
Line 3312... Line 3336...
3312 
</soap:Envelope>
 3336 
</soap:Envelope>
3313 
]]></programlisting>
 3337 
]]></programlisting>
3314 
</para>
 3338 
</para>
3315 
</section>
 3339 
</section>
3316 
</section>
 3340 
</section>
3317 
		<section id="executeservices" version="5.0" xml:base="ExecuteServices.xml" xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude">
 3341 
		<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">
3318 
	<title>ExecuteServices</title>
 3342 
	<title>ExecuteServices</title>
3319 
	<para>The ExecuteService bundles local and remote command
 3343 
	<para>The ExecuteService bundles local and remote command
3320 
		execution operations. Its WSDL is located at
 3344 
		execution operations. Its WSDL is located at
3321 
		http://server:port/XServices/ExecuteService?wsdl</para>
 3345 
		http://server:port/XServices/ExecuteService?wsdl</para>
3322 
		<section version="5.0" xml:base="ExecuteServices/rExec.xml" xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude">
 3346 
		<section version="5.0" xml:base="ExecuteServices/rExec.xml" xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude">
Line 3360... Line 3384...
3360 
						<entry>command</entry>
 3384 
						<entry>command</entry>
3361 
						<entry>String</entry>
 3385 
						<entry>String</entry>
3362 
						<entry>No</entry>
 3386 
						<entry>No</entry>
3363 
						<entry>Any command including arguments</entry>
 3387 
						<entry>Any command including arguments</entry>
3364 
					</row>
 3388 
					</row>
3365 
          <row xml:base="file:/C:/Users/brosenberger/workspace/XServices/doc/entities.ent">
 3389 
          <row xml:base="file:/C:/Users/brosenberger/workspace-XS/XServices/doc/entities.ent">
3366 
            <entry>timeout</entry>
 3390 
            <entry>timeout</entry>
3367 
            <entry>Long</entry>
 3391 
            <entry>Long</entry>
3368 
            <entry>Yes</entry>
 3392 
            <entry>Yes</entry>
3369 
            <entry>Timeout in milliseconds. The command is forcefully terminated when timeout is reached.</entry>
 3393 
            <entry>Timeout in milliseconds. The command is forcefully terminated when timeout is reached.</entry>
3370 
          </row>
 3394 
          </row>
Line 3374... Line 3398...
3374 
		<para/>
 3398 
		<para/>
3375 
	</section>
 3399 
	</section>
3376 
	<section>
 3400 
	<section>
3377 
		<title>Output parameters
 3401 
		<title>Output parameters
3378 
		</title>
 3402 
		</title>
3379 
		<section version="5.0" xml:base="ExecuteServices/../types/ReturnCode.xml" xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude">
 3403 
		<section version="5.0" xml:base="./../types/ReturnCode.xml" xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude">
3380 
	<title>ReturnCode type</title>
 3404 
	<title>ReturnCode type</title>
3381 
	<para>
 3405 
	<para>
3382 
		The ReturnCode type is used as the generic answer type for most of the
 3406 
		The ReturnCode type is used as the generic answer type for most of the
3383 
		<application class="software">BruteXservices</application>
 3407 
		<application class="software">BruteXservices</application>
3384 
		operations.
 3408 
		operations.
Line 3464... Line 3488...
3464 
						<entry>argline</entry>
 3488 
						<entry>argline</entry>
3465 
						<entry>String</entry>
 3489 
						<entry>String</entry>
3466 
						<entry>No</entry>
 3490 
						<entry>No</entry>
3467 
						<entry>Any command line arguments</entry>
 3491 
						<entry>Any command line arguments</entry>
3468 
					</row>
 3492 
					</row>
3469 
          <row xml:base="file:/C:/Users/brosenberger/workspace/XServices/doc/entities.ent">
 3493 
          <row xml:base="file:/C:/Users/brosenberger/workspace-XS/XServices/doc/entities.ent">
3470 
            <entry>timeout</entry>
 3494 
            <entry>timeout</entry>
3471 
            <entry>Long</entry>
 3495 
            <entry>Long</entry>
3472 
            <entry>Yes</entry>
 3496 
            <entry>Yes</entry>
3473 
            <entry>Timeout in milliseconds. The command is forcefully terminated when timeout is reached.</entry>
 3497 
            <entry>Timeout in milliseconds. The command is forcefully terminated when timeout is reached.</entry>
3474 
          </row>
 3498 
          </row>
Line 3478... Line 3502...
3478 
		<para/>
 3502 
		<para/>
3479 
	</section>
 3503 
	</section>
3480 
	<section>
 3504 
	<section>
3481 
		<title>Output parameters
 3505 
		<title>Output parameters
3482 
		</title>
 3506 
		</title>
3483 
		<section version="5.0" xml:base="ExecuteServices/../types/ReturnCode.xml" xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude">
 3507 
		<section version="5.0" xml:base="./../types/ReturnCode.xml" xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude">
3484 
	<title>ReturnCode type</title>
 3508 
	<title>ReturnCode type</title>
3485 
	<para>
 3509 
	<para>
3486 
		The ReturnCode type is used as the generic answer type for most of the
 3510 
		The ReturnCode type is used as the generic answer type for most of the
3487 
		<application class="software">BruteXservices</application>
 3511 
		<application class="software">BruteXservices</application>
3488 
		operations.
 3512 
		operations.
Line 3569... Line 3593...
3569 
						<entry>command</entry>
 3593 
						<entry>command</entry>
3570 
						<entry>String</entry>
 3594 
						<entry>String</entry>
3571 
						<entry>No</entry>
 3595 
						<entry>No</entry>
3572 
						<entry>The command to execute.</entry>
 3596 
						<entry>The command to execute.</entry>
3573 
					</row>
 3597 
					</row>
3574 
          <row xml:base="file:/C:/Users/brosenberger/workspace/XServices/doc/entities.ent">
 3598 
          <row xml:base="file:/C:/Users/brosenberger/workspace-XS/XServices/doc/entities.ent">
3575 
            <entry>timeout</entry>
 3599 
            <entry>timeout</entry>
3576 
            <entry>Long</entry>
 3600 
            <entry>Long</entry>
3577 
            <entry>Yes</entry>
 3601 
            <entry>Yes</entry>
3578 
            <entry>Timeout in milliseconds. The command is forcefully terminated when timeout is reached.</entry>
 3602 
            <entry>Timeout in milliseconds. The command is forcefully terminated when timeout is reached.</entry>
3579 
          </row>
 3603 
          </row>
Line 3583... Line 3607...
3583 
		<para/>
 3607 
		<para/>
3584 
	</section>
 3608 
	</section>
3585 
	<section>
 3609 
	<section>
3586 
		<title>Output parameters
 3610 
		<title>Output parameters
3587 
		</title>
 3611 
		</title>
3588 
		<section version="5.0" xml:base="ExecuteServices/../types/ReturnCode.xml" xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude">
 3612 
		<section version="5.0" xml:base="./../types/ReturnCode.xml" xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude">
3589 
	<title>ReturnCode type</title>
 3613 
	<title>ReturnCode type</title>
3590 
	<para>
 3614 
	<para>
3591 
		The ReturnCode type is used as the generic answer type for most of the
 3615 
		The ReturnCode type is used as the generic answer type for most of the
3592 
		<application class="software">BruteXservices</application>
 3616 
		<application class="software">BruteXservices</application>
3593 
		operations.
 3617 
		operations.
Line 3699... Line 3723...
3699 
						<entry>expect</entry>
 3723 
						<entry>expect</entry>
3700 
						<entry>String</entry>
 3724 
						<entry>String</entry>
3701 
						<entry>No</entry>
 3725 
						<entry>No</entry>
3702 
						<entry>The prompt to expect after the command has been executed successfully.</entry>
 3726 
						<entry>The prompt to expect after the command has been executed successfully.</entry>
3703 
					</row>
 3727 
					</row>
3704 
          <row xml:base="file:/C:/Users/brosenberger/workspace/XServices/doc/entities.ent">
 3728 
          <row xml:base="file:/C:/Users/brosenberger/workspace-XS/XServices/doc/entities.ent">
3705 
            <entry>timeout</entry>
 3729 
            <entry>timeout</entry>
3706 
            <entry>Long</entry>
 3730 
            <entry>Long</entry>
3707 
            <entry>Yes</entry>
 3731 
            <entry>Yes</entry>
3708 
            <entry>Timeout in milliseconds. The command is forcefully terminated when timeout is reached.</entry>
 3732 
            <entry>Timeout in milliseconds. The command is forcefully terminated when timeout is reached.</entry>
3709 
          </row>
 3733 
          </row>
Line 3712... Line 3736...
3712 
		</table>
 3736 
		</table>
3713 
		<para/>
 3737 
		<para/>
3714 
	</section>
 3738 
	</section>
3715 
	<section>
 3739 
	<section>
3716 
		<title>Output parameters</title>
 3740 
		<title>Output parameters</title>
3717 
		<section version="5.0" xml:base="ExecuteServices/../types/ReturnCode.xml" xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude">
 3741 
		<section version="5.0" xml:base="./../types/ReturnCode.xml" xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude">
3718 
	<title>ReturnCode type</title>
 3742 
	<title>ReturnCode type</title>
3719 
	<para>
 3743 
	<para>
3720 
		The ReturnCode type is used as the generic answer type for most of the
 3744 
		The ReturnCode type is used as the generic answer type for most of the
3721 
		<application class="software">BruteXservices</application>
 3745 
		<application class="software">BruteXservices</application>
3722 
		operations.
 3746 
		operations.
Line 3783... Line 3807...
3783 
      </ws:telnet>
 3807 
      </ws:telnet>
3784 
	]]></programlisting>
 3808 
	]]></programlisting>
3785 
	</section>
 3809 
	</section>
3786 
</section>
3810 
</section>
3787 
</section>
 3811 
</section>
3788 
		<section id="fileservices" version="5.0" xml:base="FileServices.xml" xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude">
 3812 
		<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">
3789 
	<title>FileServices</title>
 3813 
	<title>FileServices</title>
3790 
	<para>The FileServces bundles various file operations. Its WSDL is located at
 3814 
	<para>The FileServces bundles various file operations. Its WSDL is located at
3791 
		http://server:port/XServices/FileService?wsdl</para>
 3815 
		http://server:port/XServices/FileService?wsdl</para>
- 
 
 3816 
				<section version="5.0" xml:base="FileServices/downloadFile.xml" xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude">
- 
 
 3817 
	<title>downloadFile</title>
- 
 
 3818 
	<para>Downloads a file as base64 encoded.
- 
 
 3819 
	Sample request:
- 
 
 3820 
<screen><![CDATA[
- 
 
 3821 
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ws="http://ws.xservices.brutex.net">
- 
 
 3822 
   <soapenv:Header/>
- 
 
 3823 
   <soapenv:Body>
- 
 
 3824 
<!-- downloads a file from the XServices server as base64 encoded -->
- 
 
 3825 
      <ws:downloadFile>
- 
 
 3826 
         <file>
- 
 
 3827 
            <type>FILE</type>
- 
 
 3828 
            <uri>c:\temp\test.docx</uri>
- 
 
 3829 
         </file>
- 
 
 3830 
      </ws:downloadFile>
- 
 
 3831 
   </soapenv:Body>
- 
 
 3832 
</soapenv:Envelope>
- 
 
 3833 
]]></screen>
- 
 
 3834 
	Sample response:
- 
 
 3835 
	<programlisting language="xml"><![CDATA[
- 
 
 3836 
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
- 
 
 3837 
   <soap:Body>
- 
 
 3838 
      <ns2:downloadFileResponse xmlns:ns2="http://ws.xservices.brutex.net">
- 
 
 3839 
         <return>
- 
 
 3840 
            <content>ADQBNA[... snipp ...]wAApzcAAAAA</content>
- 
 
 3841 
            <filename>test.docx</filename>
- 
 
 3842 
         </return>
- 
 
 3843 
      </ns2:downloadFileResponse>
- 
 
 3844 
   </soap:Body>
- 
 
 3845 
</soap:Envelope>]]></programlisting>
- 
 
 3846 
</para>
- 
 
 3847 
<para>Encoding files as base64 is very memory consuming!</para>
- 
 
 3848 
</section>
- 
 
 3849 
				<section version="5.0" xml:base="FileServices/encodeFile.xml" xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude">
- 
 
 3850 
	<title>encodeFile</title>
- 
 
 3851 
	<para>Encodes a file as base64.
- 
 
 3852 
	Sample request:
- 
 
 3853 
<screen><![CDATA[
- 
 
 3854 
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ws="http://ws.xservices.brutex.net">
- 
 
 3855 
   <soapenv:Header/>
- 
 
 3856 
   <soapenv:Body>
- 
 
 3857 
      <ws:encodeFile>
- 
 
 3858 
         <file>
- 
 
 3859 
            <type>FILE</type>
- 
 
 3860 
            <uri>c:\temp\test.docx</uri>
- 
 
 3861 
         </file>
- 
 
 3862 
      </ws:encodeFile>
- 
 
 3863 
   </soapenv:Body>
- 
 
 3864 
</soapenv:Envelope>
- 
 
 3865 
]]></screen>
- 
 
 3866 
	Sample response:
- 
 
 3867 
	<programlisting language="xml"><![CDATA[
- 
 
 3868 
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
- 
 
 3869 
   <soap:Body>
- 
 
 3870 
      <ns2:encodeFileResponse xmlns:ns2="http://ws.xservices.brutex.net">
- 
 
 3871 
         <return>
- 
 
 3872 
            <content>ADQBNA[... snipp ...]wAApzcAAAAA</content>
- 
 
 3873 
            <filename>test.docx</filename>
- 
 
 3874 
         </return>
- 
 
 3875 
      </ns2:encodeFileResponse>
- 
 
 3876 
   </soap:Body>
- 
 
 3877 
</soap:Envelope>]]></programlisting>
- 
 
 3878 
</para>
- 
 
 3879 
<para>DEPRECATED: Encoding files as base64 is very memory consuming!</para>
- 
 
 3880 
</section>
3792 
</section>
 3881 
</section>
- 
 
 3882 
		<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">
- 
 
 3883 
	<title>JobServices</title>
- 
 
 3884 
	<para>The JobService bundles re-occuring or scheduled operations. Its WSDL is located at
- 
 
 3885 
		http://server:port/XServices/JobService?wsdl</para>
- 
 
 3886 
		<!--
- 
 
 3887 
		<xi:include href="MiscServices/generateUUID.xml" />
- 
 
 3888 
		<xi:include href="MiscServices/getHostinfo.xml" />
- 
 
 3889 
		<xi:include href="MiscServices/sleep.xml" />
- 
 
 3890 
		-->
- 
 
 3891 
</section>
3793 
		<section id="mailservices" version="5.0" xml:base="MailServices.xml" xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude">
 3892 
		<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">
3794 
	<title>MailServices</title>
 3893 
	<title>MailServices</title>
3795 
	<para>The MailService contains mail send and receive operations. Its WSDL is located at
 3894 
	<para>The MailService contains mail send and receive operations. Its WSDL is located at
3796 
		http://server:port/XServices/MailService?wsdl</para>
 3895 
		http://server:port/XServices/MailService?wsdl</para>
3797 
		<section version="5.0" xml:base="MailServices/sendMailSimple.xml" xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude">
 3896 
		<section version="5.0" xml:base="MailServices/sendMailSimple.xml" xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude">
3798 
	<title>sendMailSimple</title>
 3897 
	<title>sendMailSimple</title>
3799 
	<para>Send email.</para>
 3898 
	<para>Send email.</para>
3800 
</section>
 3899 
</section>
3801 
</section>
 3900 
</section>
3802 
		<section id="miscservices" version="5.0" xml:base="MiscServices.xml" xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude">
 3901 
		<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">
3803 
	<title>MiscServices</title>
 3902 
	<title>MiscServices</title>
3804 
	<para>The MiscService bundles various operations. Its WSDL is located at
 3903 
	<para>The MiscService bundles various operations. Its WSDL is located at
3805 
		http://server:port/XServices/MiscService?wsdl</para>
 3904 
		http://server:port/XServices/MiscService?wsdl</para>
3806 
		<section version="5.0" xml:base="MiscServices/generateUUID.xml" xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude">
 3905 
		<section version="5.0" xml:base="MiscServices/generateUUID.xml" xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude">
3807 
	<title>generateUUID</title>
 3906 
	<title>generateUUID</title>
Line 3877... Line 3976...
3877 
		Tomcat or your client that prevents this web service to respond
 3976 
		Tomcat or your client that prevents this web service to respond
3878 
		correctly.
 3977 
		correctly.
3879 
</para>
 3978 
</para>
3880 
</section>
 3979 
</section>
3881 
</section>
 3980 
</section>
- 
 
 3981 
		<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">
- 
 
 3982 
	<title>StorageServices</title>
- 
 
 3983 
	<para>The StorageService will provide get/ push operations to store and retrieve data from various backends.
- 
 
 3984 
	This is currently under development and not yet released.
- 
 
 3985 
	    Its WSDL is located at
- 
 
 3986 
		http://server:port/XServices/StorageService?wsdl</para>
- 
 
 3987 
		<section version="5.0" xml:base="StorageServices/operationName.xml" xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude">
- 
 
 3988 
	<title> ...
- 
 
 3989 
	</title>
- 
 
 3990 
	<para>Description here</para>
- 
 
 3991 
	<section>
- 
 
 3992 
		<title>Input parameters
- 
 
 3993 
		</title>
- 
 
 3994 
		<para/>
- 
 
 3995 
		<table frame="all">
- 
 
 3996 
			<title>Input parameters
- 
 
 3997 
			</title>
- 
 
 3998 
			<tgroup cols="4">
- 
 
 3999 
				<colspec colname="parameter" colnum="1"/>
- 
 
 4000 
				<colspec colname="type" colnum="2"/>
- 
 
 4001 
				<colspec colname="required" colnum="3"/>
- 
 
 4002 
				<colspec colname="description" colnum="4"/>
- 
 
 4003 
				<thead>
- 
 
 4004 
					<row>
- 
 
 4005 
						<entry>parameter</entry>
- 
 
 4006 
						<entry>type</entry>
- 
 
 4007 
						<entry>required</entry>
- 
 
 4008 
						<entry>description</entry>
- 
 
 4009 
					</row>
- 
 
 4010 
				</thead>
- 
 
 4011 
				<tbody>
- 
 
 4012 
					<row>
- 
 
 4013 
						<entry>host</entry>
- 
 
 4014 
						<entry>HostConnection</entry>
- 
 
 4015 
						<entry>Yes</entry>
- 
 
 4016 
						<entry>
- 
 
 4017 
							Host where to execute the command. See
- 
 
 4018 
							<link linkend="hostconnection">HostConnection</link>
- 
 
 4019 
							.
- 
 
 4020 
						</entry>
- 
 
 4021 
					</row>
- 
 
 4022 
					<row>
- 
 
 4023 
						<entry>command</entry>
- 
 
 4024 
						<entry>String</entry>
- 
 
 4025 
						<entry>No</entry>
- 
 
 4026 
						<entry>Any command including arguments</entry>
- 
 
 4027 
					</row>
- 
 
 4028 
          <row xml:base="file:/C:/Users/brosenberger/workspace-XS/XServices/doc/entities.ent">
- 
 
 4029 
            <entry>timeout</entry>
- 
 
 4030 
            <entry>Long</entry>
- 
 
 4031 
            <entry>Yes</entry>
- 
 
 4032 
            <entry>Timeout in milliseconds. The command is forcefully terminated when timeout is reached.</entry>
- 
 
 4033 
          </row>
- 
 
 4034 
				</tbody>
- 
 
 4035 
			</tgroup>
- 
 
 4036 
		</table>
- 
 
 4037 
		<para/>
- 
 
 4038 
	</section>
- 
 
 4039 
	<section>
- 
 
 4040 
		<title>Output parameters
- 
 
 4041 
		</title>
- 
 
 4042 
		<section version="5.0" xml:base="./../types/ReturnCode.xml" xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude">
- 
 
 4043 
	<title>ReturnCode type</title>
- 
 
 4044 
	<para>
- 
 
 4045 
		The ReturnCode type is used as the generic answer type for most of the
- 
 
 4046 
		<application class="software">BruteXservices</application>
- 
 
 4047 
		operations.
- 
 
 4048 
	</para>
- 
 
 4049 
	<para>
- 
 
 4050 
		The defining Java class is
- 
 
 4051 
		<ulink url="javadoc/net/brutex/xservices/types/ReturnCode.html">
- 
 
 4052 
			<classname>net.brutex.xservices.types.ReturnCode</classname>
- 
 
 4053 
		</ulink>
- 
 
 4054 
		.
- 
 
 4055 
	</para>
- 
 
 4056 
	<bridgehead renderas="sect3">Schema definition</bridgehead>
- 
 
 4057 
	<programlisting language="xml"><![CDATA[
- 
 
 4058 
<xs:complexType name="ReturnCodeType">
- 
 
 4059 
    <xs:sequence>
- 
 
 4060 
        <xs:element name="returnCode" type="xs:int"/>
- 
 
 4061 
        <xs:element minOccurs="0" name="stdOut" type="xs:string"/>
- 
 
 4062 
        <xs:element minOccurs="0" name="stdErr" type="xs:string"/>
- 
 
 4063 
        <xs:element maxOccurs="unbounded" minOccurs="0" name="propertyList" nillable="true" type="]]><link linkend="antproperty">tns:antProperty</link><![CDATA["/>
- 
 
 4064 
    </xs:sequence>
- 
 
 4065 
</xs:complexType>]]>
- 
 
 4066 
	</programlisting>
- 
 
 4067 
 
- 
 
 4068 
	<bridgehead renderas="sect3">Example XML</bridgehead>
- 
 
 4069 
	<programlisting language="xml">
- 
 
 4070 
		&lt;ReturnCode
- 
 
 4071 
		xmlns:ns2="http://ws.xservices.brutex.net"&gt;
- 
 
 4072 
		&lt;returnCode&gt;0&lt;/returnCode&gt;
- 
 
 4073 
		&lt;stdOut/&gt;
- 
 
 4074 
		&lt;stdErr/&gt;
- 
 
 4075 
		&lt;propertyList&gt;
- 
 
 4076 
		<lineannotation>
- 
 
 4077 
			See
- 
 
 4078 
			<link linkend="antproperty">tns:antProperty</link>
- 
 
 4079 
			for details about the &lt;propertyList&gt; elements.
- 
 
 4080 
		</lineannotation>
- 
 
 4081 
		&lt;name&gt;key1&lt;/name&gt;
- 
 
 4082 
		&lt;value&gt;value1&lt;/value&gt;
- 
 
 4083 
		&lt;/propertyList&gt;
- 
 
 4084 
		&lt;propertyList&gt;
- 
 
 4085 
		&lt;name&gt;key2&lt;/name&gt;
- 
 
 4086 
		&lt;value&gt;value2&lt;/value&gt;
- 
 
 4087 
		&lt;/propertyList&gt;
- 
 
 4088 
		&lt;/ReturnCode&gt;
- 
 
 4089 
	</programlisting>
- 
 
 4090 
 
- 
 
 4091 
</section>
- 
 
 4092 
	</section>
- 
 
 4093 
</section>
- 
 
 4094
- 
 
 4095 
</section>
- 
 
 4096 
		<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">
- 
 
 4097 
	<title>StringServices</title>
- 
 
 4098 
	<para>The StringService provides String manipulation capabilities.
- 
 
 4099 
	    Its WSDL is located at
- 
 
 4100 
		http://server:port/XServices/StringService?wsdl</para>
- 
 
 4101 
		<section version="5.0" xml:base="StringServices/replaceRegEx.xml" xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude">
- 
 
 4102 
	<title>replaceRegEx</title>
- 
 
 4103 
	<para>Search and Replace using regular expression.
- 
 
 4104 
	Sample request:
- 
 
 4105 
<screen><![CDATA[
- 
 
 4106 
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
- 
 
 4107 
xmlns:ws="http://ws.xservices.brutex.net">
- 
 
 4108 
   <soapenv:Header/>
- 
 
 4109 
   <soapenv:Body>
- 
 
 4110 
      <ws:replaceRegEx>
- 
 
 4111 
         <string>Hallo Welt</string>
- 
 
 4112 
         <search>W.*</search>
- 
 
 4113 
         <replace>Brian</replace>
- 
 
 4114 
         <regexflags>ig</regexflags>
- 
 
 4115 
      </ws:replaceRegEx>
- 
 
 4116 
   </soapenv:Body>
- 
 
 4117 
</soapenv:Envelope>
- 
 
 4118 
]]></screen>
- 
 
 4119 
	Sample response:
- 
 
 4120 
	<programlisting language="xml"><![CDATA[
- 
 
 4121 
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
- 
 
 4122 
   <soap:Body>
- 
 
 4123 
      <ns2:replaceRegExResponse xmlns:ns2="http://ws.xservices.brutex.net">
- 
 
 4124 
         <return>
- 
 
 4125 
            <string>Hallo Brian</string>
- 
 
 4126 
            <count>1</count>
- 
 
 4127 
         </return>
- 
 
 4128 
      </ns2:replaceRegExResponse>
- 
 
 4129 
   </soap:Body>
- 
 
 4130 
</soap:Envelope>]]></programlisting>
- 
 
 4131 
</para>
- 
 
 4132 
<para>Allowed regexflags are case-insensitive (i) and global search (g).</para>
- 
 
 4133 
</section>
- 
 
 4134
- 
 
 4135 
</section>
- 
 
 4136 
		<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">
- 
 
 4137 
	<title>XmlServices</title>
- 
 
 4138 
	<para>The XmlService provides operations to manipulate XML structures.
- 
 
 4139 
	    Its WSDL is located at
- 
 
 4140 
		http://server:port/XServices/XmlService?wsdl</para>
- 
 
 4141 
		<section version="5.0" xml:base="XmlServices/insertNodes.xml" xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude">
- 
 
 4142 
	<title>insertNodes</title>
- 
 
 4143 
	<para>Insert an xml fragment into other elements specified by an XPath expression.
- 
 
 4144 
	This operation is namespace aware.
- 
 
 4145
- 
 
 4146 
	Sample request:
- 
 
 4147 
<programlisting language="xml"><![CDATA[
- 
 
 4148 
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ws="http://ws.xservices.brutex.net">
- 
 
 4149 
   <soapenv:Header/>
- 
 
 4150 
   <soapenv:Body>
- 
 
 4151 
      <ws:insertNodes>
- 
 
 4152 
         <sourcexml><![CDATA[
- 
 
 4153 
         <books>
- 
 
 4154 
			<author>
- 
 
 4155 
				<name>Mensiok</name>
- 
 
 4156 
				<surname>Bello</surname>
- 
 
 4157 
			</author>
- 
 
 4158 
			<author>
- 
 
 4159 
				<name>Schwab</name>
- 
 
 4160 
				<surname>Rumsau</surname>
- 
 
 4161 
			</author>
- 
 
 4162 
			<author>
- 
 
 4163 
				<name>Dollibert</name>
- 
 
 4164 
				<surname>Rach</surname>
- 
 
 4165 
			</author>
- 
 
 4166 
         </books>
- 
 
 4167 
         ]]]]><![CDATA[></sourcexml>
- 
 
 4168 
         <encoding>utf-8</encoding>
- 
 
 4169 
         <namespaceList>
- 
 
 4170 
            <!--Zero or more repetitions:-->
- 
 
 4171 
            <namespace>
- 
 
 4172 
               <prefix></prefix>
- 
 
 4173 
               <uri></uri>
- 
 
 4174 
            </namespace>
- 
 
 4175 
         </namespaceList>
- 
 
 4176 
         <xpath>/books/author</xpath>
- 
 
 4177 
         <!--Optional:-->
- 
 
 4178 
         <xmldata><![CDATA[<age namespace="http://btx"/>]]]]><![CDATA[></xmldata>
- 
 
 4179 
      </ws:insertNodes>
- 
 
 4180 
   </soapenv:Body>
- 
 
 4181 
</soapenv:Envelope>
- 
 
 4182 
]]></programlisting>
- 
 
 4183 
	Sample response:
- 
 
 4184 
	<programlisting language="xml"><![CDATA[
- 
 
 4185 
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
- 
 
 4186 
   <soap:Body>
- 
 
 4187 
      <ns2:insertNodesResponse xmlns:ns2="http://ws.xservices.brutex.net">
- 
 
 4188 
         <return><![CDATA[<?xml version='1.0' encoding='UTF-8'?>
- 
 
 4189 
         <books>
- 
 
 4190 
			<author>
- 
 
 4191 
				<name>Mensiok</name>
- 
 
 4192 
				<surname>Bello</surname>
- 
 
 4193 
			<age namespace="http://btx"/></author>
- 
 
 4194 
			<author>
- 
 
 4195 
				<name>Schwab</name>
- 
 
 4196 
				<surname>Rumsau</surname>
- 
 
 4197 
			<age namespace="http://btx"/></author>
- 
 
 4198 
			<author>
- 
 
 4199 
				<name>Dollibert</name>
- 
 
 4200 
				<surname>Rach</surname>
- 
 
 4201 
			<age namespace="http://btx"/></author>
- 
 
 4202 
         </books>]]]]><![CDATA[></!></return>
- 
 
 4203 
      </ns2:insertNodesResponse>
- 
 
 4204 
   </soap:Body>
- 
 
 4205 
</soap:Envelope>
- 
 
 4206 
]]></programlisting>
- 
 
 4207 
</para>
- 
 
 4208 
</section>
- 
 
 4209 
		<section version="5.0" xml:base="XmlServices/replaceNodes.xml" xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude">
- 
 
 4210 
	<title>replaceNodes</title>
- 
 
 4211 
	<para>Replace an xml fragment with another xml fragment. This operation is namespace aware.
- 
 
 4212
- 
 
 4213 
	Sample request:
- 
 
 4214 
<programlisting language="xml"><![CDATA[
- 
 
 4215 
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
- 
 
 4216 
xmlns:ws="http://ws.xservices.brutex.net">
- 
 
 4217 
   <soapenv:Header/>
- 
 
 4218 
   <soapenv:Body>
- 
 
 4219 
      <ws:replaceNodes>
- 
 
 4220 
         <sourcexml><![CDATA[
- 
 
 4221 
         <books>
- 
 
 4222 
			<author>
- 
 
 4223 
				<name>Mensiok</name>
- 
 
 4224 
				<surname>Bello</surname>
- 
 
 4225 
			</author>
- 
 
 4226 
			<author>
- 
 
 4227 
				<name>Schwab</name>
- 
 
 4228 
				<surname>Rumsau</surname>
- 
 
 4229 
			</author>
- 
 
 4230 
			<author>
- 
 
 4231 
				<name>Dollibert</name>
- 
 
 4232 
				<surname>Rach</surname>
- 
 
 4233 
			</author>
- 
 
 4234 
         </books>
- 
 
 4235 
         ]]]]><![CDATA[>
- 
 
 4236 
         </sourcexml>
- 
 
 4237 
         <encoding>utf-8</encoding>
- 
 
 4238 
         <namespaceList>
- 
 
 4239 
            <!--Zero or more repetitions:-->
- 
 
 4240 
            <namespace>
- 
 
 4241 
               <prefix></prefix>
- 
 
 4242 
               <uri></uri>
- 
 
 4243 
            </namespace>
- 
 
 4244 
         </namespaceList>
- 
 
 4245 
         <xpath>*/name[text()='Schwab']</xpath>
- 
 
 4246 
         <!--Optional:-->
- 
 
 4247 
         <xmldata><![CDATA[<name>Meyer</name><age>45</age><!--edited here-->]]]]><![CDATA[></xmldata>
- 
 
 4248 
      </ws:replaceNodes>
- 
 
 4249 
   </soapenv:Body>
- 
 
 4250 
</soapenv:Envelope>
- 
 
 4251 
]]></programlisting>
- 
 
 4252 
	Sample response:
- 
 
 4253 
	<programlisting language="xml"><![CDATA[
- 
 
 4254 
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
- 
 
 4255 
   <soap:Body>
- 
 
 4256 
      <ns2:replaceNodesResponse xmlns:ns2="http://ws.xservices.brutex.net">
- 
 
 4257 
         <return><![CDATA[<?xml version='1.0' encoding='UTF-8'?>
- 
 
 4258 
         <books>
- 
 
 4259 
			<author>
- 
 
 4260 
				<name>Mensiok</name>
- 
 
 4261 
				<surname>Bello</surname>
- 
 
 4262 
			</author>
- 
 
 4263 
			<author>
- 
 
 4264 
				<name>Meyer</name><age>45</age><!--edited here-->
- 
 
 4265 
				<surname>Rumsau</surname>
- 
 
 4266 
			</author>
- 
 
 4267 
			<author>
- 
 
 4268 
				<name>Dollibert</name>
- 
 
 4269 
				<surname>Rach</surname>
- 
 
 4270 
			</author>
- 
 
 4271 
         </books>]]]]><![CDATA[></return>
- 
 
 4272 
      </ns2:replaceNodesResponse>
- 
 
 4273 
   </soap:Body>
- 
 
 4274 
</soap:Envelope>]]></programlisting>
- 
 
 4275 
</para>
- 
 
 4276 
</section>
- 
 
 4277 
		<section version="5.0" xml:base="XmlServices/wrapInCDATA.xml" xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude">
- 
 
 4278 
	<title>wrapInCDATA</title>
- 
 
 4279 
	<para>Simply wraps any data fragment into &lt;![CDATA[ ... ]]&gt; section. This can be useful if you
- 
 
 4280 
	want to preserve indentation or line breaks.
- 
 
 4281 
	</para>
- 
 
 4282 
	<para>
- 
 
 4283 
	Sample request:
- 
 
 4284 
<programlisting language="xml"><![CDATA[
- 
 
 4285 
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
- 
 
 4286 
xmlns:ws="http://ws.xservices.brutex.net">
- 
 
 4287 
   <soapenv:Header/>
- 
 
 4288 
   <soapenv:Body>
- 
 
 4289 
      <ws:wrapInCDATA>
- 
 
 4290 
         <data>Hello World, here is some &lt;xml&gt; data</data>
- 
 
 4291 
      </ws:wrapInCDATA>
- 
 
 4292 
   </soapenv:Body>
- 
 
 4293 
</soapenv:Envelope>
- 
 
 4294 
]]></programlisting>
- 
 
 4295 
	Sample response:
- 
 
 4296 
	<programlisting language="xml"><![CDATA[
- 
 
 4297 
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
- 
 
 4298 
   <soap:Body>
- 
 
 4299 
      <ns2:wrapInCDATAResponse xmlns:ns2="http://ws.xservices.brutex.net">
- 
 
 4300 
         <return>&lt;![CDATA[Hello World, here is some &lt;xml> data]]&gt;</return>
- 
 
 4301 
      </ns2:wrapInCDATAResponse>
- 
 
 4302 
   </soap:Body>
- 
 
 4303 
</soap:Envelope>
- 
 
 4304 
]]></programlisting>
- 
 
 4305 
</para>
- 
 
 4306 
</section>
- 
 
 4307
- 
 
 4308 
</section>
3882 
	</chapter>
 4309 
	</chapter>
Line 3883... Line 4310...
3883 
 
 4310 
 
3884 
	<chapter id="xmltypes">
 4311 
	<chapter id="xmltypes">
3885 
		<beginpage/>
 4312 
		<beginpage/>
3886 
		<title>XML Types</title>
 4313 
		<title>XML Types</title>
3887 
		<para>This chapter bundles the documentation for common XML types used
 4314 
		<para>This chapter bundles the documentation for common XML types used
3888 
			by XServices web service.</para>
 4315 
			by XServices web service.</para>
3889 
		<section version="5.0" xml:base="Types.xml" xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude">
 4316 
		<section version="5.0" xml:base="types/Types.xml" xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude">
3890 
	<!-- Sort alphabetically -->
 4317 
	<!-- Sort alphabetically -->
3891 
	<section id="antproperty" xml:base="types/AntProperty.xml">
 4318 
	<section id="antproperty" xml:base="types/AntProperty.xml">
3892 
<title>AntProperty type</title>
 4319 
<title>AntProperty type</title>
3893 
			<para>The AntProperty type defines a list of key/value pairs.</para>
 4320 
			<para>The AntProperty type defines a list of key/value pairs.</para>