Subversion Repositories XServices

Rev

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

Rev 83 Rev 85
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>February, 16th 2010</date>
 4 
		<date>Januar 2012</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>2011</year>
 12 
			<year>2012</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
18 
				<emphasis>as is</emphasis>
 18 
				<emphasis>as is</emphasis>
19 
				without expressed or implied warranty.
 19 
				without expressed or implied warranty.
20 
			</para>
 20 
			</para>
21 
		</legalnotice>
 21 
		</legalnotice>
22 
		<legalnotice>
 22 
		<legalnotice>
- 
 
 23 
			<para>
- 
 
 24 
			<literallayout>
- 
 
 25 
			Licensed under the Apache License, Version 2.0 (the "License");
- 
 
 26 
			you may not use this file except in compliance with the License.
- 
 
 27 
			You may obtain a copy of the License at
- 
 
 28
- 
 
 29 
			http://www.apache.org/licenses/LICENSE-2.0
- 
 
 30
- 
 
 31 
			Unless required by applicable law or agreed to in writing, software
- 
 
 32 
			distributed under the License is distributed on an "AS IS" BASIS,
- 
 
 33 
			WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- 
 
 34 
			See the License for the specific language governing permissions and
- 
 
 35 
			limitations under the License.
- 
 
 36 
			</literallayout></para>
23 
			<para>Apache Tomcat and Apache Ant are trademarks of the Apache
 37 
			<para>Apache Tomcat and Apache Ant are trademarks of the Apache
24 
				Software Foundation.</para>
 38 
				Software Foundation.</para>
25 
		</legalnotice>
 39 
		</legalnotice>
26 
		<abstract xml:base="common/abstract.xml">
 40 
		<abstract xml:base="common/abstract.xml">
27 
			<title>Abstract</title>
 41 
	<title>Abstract</title>
28 
			<para>In complex IT environments it is necessary to integrate
 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>
29 
				different information systems with each other, exchange data
 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>
30 
				between
 - 
 
31 
				tools and automate actions and function calls depending
 - 
 
32 
				on events
 - 
 
33 
				arising from user interaction. To meet the requirements
 - 
 
34 
				of
 - 
 
35 
				integration building usually means to implement APIs and to
 - 
 
36 
				create
 - 
 
37 
				tool-to-tool bridges. Web Services can help to clean up
 - 
 
38 
				bridges into
 - 
 
39 
				interfaces as well as to abstract functions from
 - 
 
40 
				their underlying
 - 
 
41 
				platform and implementation.</para>
 - 
 
42 
			<para>These are the major goals of the loosely coupled
 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>
43 
				integration
 - 
 
44 
				strategy which is in turn one essential idea of a
 - 
 
45 
				service-oriented
 - 
 
46 
				architecture (SOA).</para>
 - 
 
47 
			<para>provide a low level set of functions and web services.
 - 
 
48 
				These can
 - 
 
49 
				be orchestrated into services and used in business
 - 
 
50 
				processes which
 - 
 
51 
				make up the execution part of a SOA
 - 
 
52 
				environment.</para>
 - 
 
53 
			<para>is an add-on to XBridgeNG 2.0. It runs standalone or in
 - 
 
54 
				combination with XBridgeNG. Pure XBridgeNG has two
 - 
 
55 
				components:</para>
 - 
 
56 
			<para>
 - 
 
57 
				<itemizedlist>
 - 
 
58 
					<listitem>
 - 
 
59 
						<para>XML Schema for item based data types (e.g. tickets
 - 
 
60 
							from a bug
 - 
 
61 
							tracker system or a database record)</para>
 - 
 
62 
					</listitem>
 - 
 
63 
					<listitem>
 - 
 
64 
						<para>Set of Apache Ant tasks to function as a bridge
 - 
 
65 
							between the
 - 
 
66 
							XBridgeNG XML format at legacy 3rd party
 - 
 
67 
							software (e.g. HP Quality
 - 
 
68 
							Center, Serena TeamTrack,
 - 
 
69 
							...)</para>
 - 
 
70 
					</listitem>
 - 
 
71 
					<listitem>
 - 
 
72 
						<para>The add Web Services (SOAP) wrapper around Apache Ant
 - 
 
73 
							tasks
 - 
 
74 
							(since XBridgeNG 2.0)</para>
 - 
 
75 
					</listitem>
 - 
 
76 
				</itemizedlist>
 - 
 
77 
			</para>
 - 
 
78 
			<para>The current focus is on file-based operations. do not
 - 
 
79 
				contain an
 - 
 
80 
				integration server or a process execution
 - 
 
81 
				engine.</para>
 - 
 
82 
		</abstract>
 45 
</abstract>
83 
	</bookinfo>
 46 
	</bookinfo>
84 
	<chapter id="installation">
 47 
	<chapter id="installation">
85 
		<beginpage/>
 48 
		<beginpage/>
86 
		<title>Getting started</title>
 49 
		<title>Getting started</title>
87 
		<para>This chapter describes the installation process.</para>
 50 
		<para>This chapter describes the installation process.</para>
Line 3348... Line 3311...
3348 
   </soap:Body>
 3311 
   </soap:Body>
3349 
</soap:Envelope>
 3312 
</soap:Envelope>
3350 
]]></programlisting>
 3313 
]]></programlisting>
3351 
</para>
 3314 
</para>
3352 
</section>
 3315 
</section>
3353 
</section>
3316 
</section>
3354 
		<section id="executeservices" version="5.0" xml:base="ExecuteServices.xml" xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude">
 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">
3355 
	<title>ExecuteServices</title>
 3318 
	<title>ExecuteServices</title>
3356 
	<para>The ExecuteService bundles local and remote command
 3319 
	<para>The ExecuteService bundles local and remote command
3357 
		execution operations. Its WSDL is located at
 3320 
		execution operations. Its WSDL is located at
3358 
		http://server:port/XServices/ExecuteService?wsdl</para>
 3321 
		http://server:port/XServices/ExecuteService?wsdl</para>
Line 3825... Line 3788...
3825 
		<section id="fileservices" version="5.0" xml:base="FileServices.xml" xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude">
 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">
3826 
	<title>FileServices</title>
 3789 
	<title>FileServices</title>
3827 
	<para>The FileServces bundles various file operations. Its WSDL is located at
 3790 
	<para>The FileServces bundles various file operations. Its WSDL is located at
3828 
		http://server:port/XServices/FileService?wsdl</para>
 3791 
		http://server:port/XServices/FileService?wsdl</para>
3829 
</section>
 3792 
</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">
- 
 
 3794 
	<title>MailServices</title>
- 
 
 3795 
	<para>The MailService contains mail send and receive operations. Its WSDL is located at
- 
 
 3796 
		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">
- 
 
 3798 
	<title>sendMailSimple</title>
- 
 
 3799 
	<para>Send email.</para>
- 
 
 3800 
</section>
- 
 
 3801 
</section>
3830 
		<section id="miscservices" version="5.0" xml:base="MiscServices.xml" xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude">
 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">
3831 
	<title>MiscServices</title>
 3803 
	<title>MiscServices</title>
3832 
	<para>The MiscService bundles various operations. Its WSDL is located at
 3804 
	<para>The MiscService bundles various operations. Its WSDL is located at
3833 
		http://server:port/XServices/MiscService?wsdl</para>
 3805 
		http://server:port/XServices/MiscService?wsdl</para>
3834 
		<section version="5.0" xml:base="MiscServices/generateUUID.xml" xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude">
 3806 
		<section version="5.0" xml:base="MiscServices/generateUUID.xml" xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude">
Line 3895... Line 3867...
3895 
   	</soap:Body>
 3867 
   	</soap:Body>
3896 
</soap:Envelope>
 3868 
</soap:Envelope>
3897 
]]></screen>
 3869 
]]></screen>
3898 
</para>
 3870 
</para>
3899 
</section>
 3871 
</section>
- 
 
 3872 
		<section version="5.0" xml:base="MiscServices/sleep.xml" xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude">
- 
 
 3873 
	<title>sleep</title>
- 
 
 3874 
	<para>Delays the response by the given minutes/ seconds. Please note,
- 
 
 3875 
		that it may take more time to perform the server roundtrip (network
- 
 
 3876 
		delays, parsing, etc.). Also you may have a network timeout set up in
- 
 
 3877 
		Tomcat or your client that prevents this web service to respond
- 
 
 3878 
		correctly.
- 
 
 3879 
</para>
3900 
</section>
3880 
</section>
- 
 
 3881 
</section>
3901 
	</chapter>
 3882 
	</chapter>
Line 3902... Line 3883...
3902 
 
 3883 
 
3903 
	<chapter id="xmltypes">
 3884 
	<chapter id="xmltypes">
3904 
		<beginpage/>
 3885 
		<beginpage/>