| 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>February, 16th 2010</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>2011</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 |
<quote>as is</quote>
|
18 |
<quote>as is</quote>
|
| 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>Apache Tomcat and Apache Ant are trademarks of the Apache
|
23 |
<para>Apache Tomcat and Apache Ant are trademarks of the Apache
|
| 24 |
Software Foundation.</para>
|
24 |
Software Foundation.</para>
|
| 25 |
</legalnotice>
|
25 |
</legalnotice>
|
| 26 |
<abstract xml:base="common/abstract.xml">
|
26 |
<abstract xml:base="common/abstract.xml">
|
| 27 |
<title>Abstract</title>
|
27 |
<title>Abstract</title>
|
| 28 |
<para>In complex IT environments it is necessary to integrate
|
28 |
<para>In complex IT environments it is necessary to integrate
|
| 29 |
different information systems with each other, exchange data
|
29 |
different information systems with each other, exchange data
|
| 30 |
between
|
30 |
between
|
| 31 |
tools and automate actions and function calls depending
|
31 |
tools and automate actions and function calls depending
|
| 32 |
on events
|
32 |
on events
|
| 33 |
arising from user interaction. To meet the requirements
|
33 |
arising from user interaction. To meet the requirements
|
| 34 |
of
|
34 |
of
|
| 35 |
integration building usually means to implement APIs and to
|
35 |
integration building usually means to implement APIs and to
|
| 36 |
create
|
36 |
create
|
| 37 |
tool-to-tool bridges. Web Services can help to clean up
|
37 |
tool-to-tool bridges. Web Services can help to clean up
|
| 38 |
bridges into
|
38 |
bridges into
|
| 39 |
interfaces as well as to abstract functions from
|
39 |
interfaces as well as to abstract functions from
|
| 40 |
their underlying
|
40 |
their underlying
|
| 41 |
platform and implementation.</para>
|
41 |
platform and implementation.</para>
|
| 42 |
<para>These are the major goals of the loosely coupled
|
42 |
<para>These are the major goals of the loosely coupled
|
| 43 |
integration
|
43 |
integration
|
| 44 |
strategy which is in turn one essential idea of a
|
44 |
strategy which is in turn one essential idea of a
|
| 45 |
service-oriented
|
45 |
service-oriented
|
| 46 |
architecture (SOA).</para>
|
46 |
architecture (SOA).</para>
|
| 47 |
<para>provide a low level set of functions and web services.
|
47 |
<para>provide a low level set of functions and web services.
|
| 48 |
These can
|
48 |
These can
|
| 49 |
be orchestrated into services and used in business
|
49 |
be orchestrated into services and used in business
|
| 50 |
processes which
|
50 |
processes which
|
| 51 |
make up the execution part of a SOA
|
51 |
make up the execution part of a SOA
|
| 52 |
environment.</para>
|
52 |
environment.</para>
|
| 53 |
<para>is an add-on to XBridgeNG 2.0. It runs standalone or in
|
53 |
<para>is an add-on to XBridgeNG 2.0. It runs standalone or in
|
| 54 |
combination with XBridgeNG. Pure XBridgeNG has two
|
54 |
combination with XBridgeNG. Pure XBridgeNG has two
|
| 55 |
components:</para>
|
55 |
components:</para>
|
| 56 |
<para>
|
56 |
<para>
|
| 57 |
<itemizedlist>
|
57 |
<itemizedlist>
|
| 58 |
<listitem>
|
58 |
<listitem>
|
| 59 |
<para>XML Schema for item based data types (e.g. tickets
|
59 |
<para>XML Schema for item based data types (e.g. tickets
|
| 60 |
from a bug
|
60 |
from a bug
|
| 61 |
tracker system or a database record)</para>
|
61 |
tracker system or a database record)</para>
|
| 62 |
</listitem>
|
62 |
</listitem>
|
| 63 |
<listitem>
|
63 |
<listitem>
|
| 64 |
<para>Set of Apache Ant tasks to function as a bridge
|
64 |
<para>Set of Apache Ant tasks to function as a bridge
|
| 65 |
between the
|
65 |
between the
|
| 66 |
XBridgeNG XML format at legacy 3rd party
|
66 |
XBridgeNG XML format at legacy 3rd party
|
| 67 |
software (e.g. HP Quality
|
67 |
software (e.g. HP Quality
|
| 68 |
Center, Serena TeamTrack,
|
68 |
Center, Serena TeamTrack,
|
| 69 |
...)</para>
|
69 |
...)</para>
|
| 70 |
</listitem>
|
70 |
</listitem>
|
| 71 |
<listitem>
|
71 |
<listitem>
|
| 72 |
<para>The add Web Services (SOAP) wrapper around Apache Ant
|
72 |
<para>The add Web Services (SOAP) wrapper around Apache Ant
|
| 73 |
tasks
|
73 |
tasks
|
| 74 |
(since XBridgeNG 2.0)</para>
|
74 |
(since XBridgeNG 2.0)</para>
|
| 75 |
</listitem>
|
75 |
</listitem>
|
| 76 |
</itemizedlist>
|
76 |
</itemizedlist>
|
| 77 |
</para>
|
77 |
</para>
|
| 78 |
<para>The current focus is on file-based operations. do not
|
78 |
<para>The current focus is on file-based operations. do not
|
| 79 |
contain an
|
79 |
contain an
|
| 80 |
integration server or a process execution
|
80 |
integration server or a process execution
|
| 81 |
engine.</para>
|
81 |
engine.</para>
|
| 82 |
</abstract>
|
82 |
</abstract>
|
| 83 |
</bookinfo>
|
83 |
</bookinfo>
|
| 84 |
<chapter id="installation">
|
84 |
<chapter id="installation">
|
| 85 |
<beginpage/>
|
85 |
<beginpage/>
|
| 86 |
<title>Getting started</title>
|
86 |
<title>Getting started</title>
|
| 87 |
<para>This chapter describes the installation.</para>
|
87 |
<para>This chapter describes the installation.</para>
|
| 88 |
<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">
|
88 |
<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">
|
| 89 |
|
89 |
|
| 90 |
<section>
|
90 |
<section>
|
| 91 |
<title>Installation</title>
|
91 |
<title>Installation</title>
|
| 92 |
<para>tbd.</para>
|
92 |
<para>tbd.</para>
|
| 93 |
<para>Sun Java SE 1.6.0</para>
|
93 |
<para>Sun Java SE 1.6.0</para>
|
| 94 |
<para>Apache Tomcat 7</para>
|
94 |
<para>Apache Tomcat 7</para>
|
| 95 |
<para>tbd.</para>
|
95 |
<para>tbd.</para>
|
| 96 |
<para>In short: Deploy .WAR file to Apache Tomcat</para>
|
96 |
<para>In short: Deploy .WAR file to Apache Tomcat</para>
|
| 97 |
<section>
|
97 |
<section>
|
| 98 |
<title>Securing with Basic Authentication</title>
|
98 |
<title>Securing with Basic Authentication</title>
|
| 99 |
<para>There is a quick guide explaining Basic Authentication for Tomcat here: <link xlink:href="http://oreilly.com/pub/a/java/archive/tomcat-tips.html?page=1">
|
99 |
<para>There is a quick guide explaining Basic Authentication for Tomcat here: <link xlink:href="http://oreilly.com/pub/a/java/archive/tomcat-tips.html?page=1">
|
| 100 |
http://oreilly.com/pub/a/java/archive/tomcat-tips.html?page=1</link>
|
100 |
http://oreilly.com/pub/a/java/archive/tomcat-tips.html?page=1</link>
|
| 101 |
</para>
|
101 |
</para>
|
| 102 |
<para>
|
102 |
<para>
|
| 103 |
|
103 |
|
| 104 |
</para>
|
104 |
</para>
|
| 105 |
</section>
|
105 |
</section>
|
| 106 |
<section>
|
106 |
<section>
|
| 107 |
<title>Limit access to</title>
|
107 |
<title>Limit access to</title>
|
| 108 |
<para>Sometimes you'll only want to restrict access to to
|
108 |
<para>Sometimes you'll only want to restrict access to to
|
| 109 |
only
|
109 |
only
|
| 110 |
specified host names or IP addresses. This way, only
|
110 |
specified host names or IP addresses. This way, only
|
| 111 |
clients at
|
111 |
clients at
|
| 112 |
those specified addresses can use the web services.
|
112 |
those specified addresses can use the web services.
|
| 113 |
Tomcat provides
|
113 |
Tomcat provides
|
| 114 |
two configuration values for that:
|
114 |
two configuration values for that:
|
| 115 |
RemoteHostValve and
|
115 |
RemoteHostValve and
|
| 116 |
RemoteAddrValve.</para>
|
116 |
RemoteAddrValve.</para>
|
| 117 |
<para>These Valves allow you to filter requests by host name or
|
117 |
<para>These Valves allow you to filter requests by host name or
|
| 118 |
by IP
|
118 |
by IP
|
| 119 |
address, and to allow or deny hosts that match. The
|
119 |
address, and to allow or deny hosts that match. The
|
| 120 |
example below
|
120 |
example below
|
| 121 |
restricts access to the ArchiveService from any
|
121 |
restricts access to the ArchiveService from any
|
| 122 |
machine that is not
|
122 |
machine that is not
|
| 123 |
the local host.</para>
|
123 |
the local host.</para>
|
| 124 |
<programlisting language="xml"><Context
|
124 |
<programlisting language="xml"><Context
|
| 125 |
path="/XService/ArchiveService"
|
125 |
path="/XService/ArchiveService"
|
| 126 |
...> <Valve
|
126 |
...> <Valve
|
| 127 |
className="org.apache.catalina.valves.RemoteAddrValve"
|
127 |
className="org.apache.catalina.valves.RemoteAddrValve"
|
| 128 |
allow="127.0.0.1" deny=""/> </Context>
|
128 |
allow="127.0.0.1" deny=""/> </Context>
|
| 129 |
</programlisting>
|
129 |
</programlisting>
|
| 130 |
<para>If no allow pattern is given, then patterns that match
|
130 |
<para>If no allow pattern is given, then patterns that match
|
| 131 |
the deny
|
131 |
the deny
|
| 132 |
attribute patterns will be rejected, and all others
|
132 |
attribute patterns will be rejected, and all others
|
| 133 |
will be allowed.
|
133 |
will be allowed.
|
| 134 |
Similarly, if no deny pattern is given,
|
134 |
Similarly, if no deny pattern is given,
|
| 135 |
patterns that match the
|
135 |
patterns that match the
|
| 136 |
allow attribute will be allowed, and
|
136 |
allow attribute will be allowed, and
|
| 137 |
all others will be denied.
|
137 |
all others will be denied.
|
| 138 |
</para>
|
138 |
</para>
|
| 139 |
<para>The <context> element must be placed into the
|
139 |
<para>The <context> element must be placed into the
|
| 140 |
server.xml
|
140 |
server.xml
|
| 141 |
file (into <engine><host>).</para>
|
141 |
file (into <engine><host>).</para>
|
| 142 |
</section>
|
142 |
</section>
|
| 143 |
</section>
|
143 |
</section>
|
| 144 |
</section>
|
144 |
</section>
|
| 145 |
</chapter>
|
145 |
</chapter>
|
| 146 |
<chapter id="services">
|
146 |
<chapter id="services">
|
| 147 |
<beginpage/>
|
147 |
<beginpage/>
|
| 148 |
<title>Available Services</title>
|
148 |
<title>Available Services</title>
|
| 149 |
<para>List of available web services and their operations.</para>
|
149 |
<para>List of available web services and their operations.</para>
|
| 150 |
<section id="archiveservices" version="5.0" xml:base="ArchiveServices.xml" xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude">
|
150 |
<section id="archiveservices" version="5.0" xml:base="ArchiveServices.xml" xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude">
|
| 151 |
<title>ArchiveServices</title>
|
151 |
<title>ArchiveServices</title>
|
| 152 |
<para>The ArchiveService bundles file packing operations. Its
|
152 |
<para>The ArchiveService bundles file packing operations. Its
|
| 153 |
WSDL is
|
153 |
WSDL is
|
| 154 |
located at
|
154 |
located at
|
| 155 |
http://server:port/XServices/ArchiveService?wsdl</para>
|
155 |
http://server:port/XServices/ArchiveService?wsdl</para>
|
| 156 |
</section>
|
156 |
</section>
|
| 157 |
<section id="dateservices" version="5.0" xml:base="DateServices.xml" xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude">
|
157 |
<section id="dateservices" version="5.0" xml:base="DateServices.xml" xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude">
|
| 158 |
<title>DateServices</title>
|
158 |
<title>DateServices</title>
|
| 159 |
<para>The DateService bundles various date and time related operations. Its WSDL is located at
|
159 |
<para>The DateService bundles various date and time related operations. Its WSDL is located at
|
| 160 |
http://server:port/XServices/DateService?wsdl</para>
|
160 |
http://server:port/XServices/DateService?wsdl</para>
|
| 161 |
|
161 |
|
| 162 |
</section>
|
162 |
</section>
|
| 163 |
<section id="executeservices" version="5.0" xml:base="ExecuteServices.xml" xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude">
|
163 |
<section id="executeservices" version="5.0" xml:base="ExecuteServices.xml" xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude">
|
| 164 |
<title>ExecuteServices</title>
|
164 |
<title>ExecuteServices</title>
|
| 165 |
<para>The ExecuteService bundles local and remote command
|
165 |
<para>The ExecuteService bundles local and remote command
|
| 166 |
execution operations. Its WSDL is located at
|
166 |
execution operations. Its WSDL is located at
|
| 167 |
http://server:port/XServices/ExecuteService?wsdl</para>
|
167 |
http://server:port/XServices/ExecuteService?wsdl</para>
|
| 168 |
<section version="5.0" xml:base="ExecuteServices/rExec.xml" xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude">
|
168 |
<section version="5.0" xml:base="ExecuteServices/rExec.xml" xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude">
|
| 169 |
<title>rExec
|
169 |
<title>rExec
|
| 170 |
</title>
|
170 |
</title>
|
| 171 |
<para>provides remote execution facilities with authentication based on
|
171 |
<para>provides remote execution facilities with authentication based on
|
| 172 |
user names and passwords.</para>
|
172 |
user names and passwords.</para>
|
| 173 |
<section>
|
173 |
<section>
|
| 174 |
<title>Input parameters
|
174 |
<title>Input parameters
|
| 175 |
</title>
|
175 |
</title>
|
| 176 |
<para/>
|
176 |
<para/>
|
| 177 |
<table frame="all">
|
177 |
<table frame="all">
|
| 178 |
<title>rExec
|
178 |
<title>rExec
|
| 179 |
input parameters
|
179 |
input parameters
|
| 180 |
</title>
|
180 |
</title>
|
| 181 |
<tgroup cols="4">
|
181 |
<tgroup cols="4">
|
| 182 |
<colspec colname="parameter" colnum="1"/>
|
182 |
<colspec colname="parameter" colnum="1"/>
|
| 183 |
<colspec colname="type" colnum="2"/>
|
183 |
<colspec colname="type" colnum="2"/>
|
| 184 |
<colspec colname="required" colnum="3"/>
|
184 |
<colspec colname="required" colnum="3"/>
|
| 185 |
<colspec colname="description" colnum="4"/>
|
185 |
<colspec colname="description" colnum="4"/>
|
| 186 |
<thead>
|
186 |
<thead>
|
| 187 |
<row>
|
187 |
<row>
|
| 188 |
<entry>parameter</entry>
|
188 |
<entry>parameter</entry>
|
| 189 |
<entry>type</entry>
|
189 |
<entry>type</entry>
|
| 190 |
<entry>required</entry>
|
190 |
<entry>required</entry>
|
| 191 |
<entry>description</entry>
|
191 |
<entry>description</entry>
|
| 192 |
</row>
|
192 |
</row>
|
| 193 |
</thead>
|
193 |
</thead>
|
| 194 |
<tbody>
|
194 |
<tbody>
|
| 195 |
<row>
|
195 |
<row>
|
| 196 |
<entry>host</entry>
|
196 |
<entry>host</entry>
|
| 197 |
<entry>HostConnection</entry>
|
197 |
<entry>HostConnection</entry>
|
| 198 |
<entry>Yes</entry>
|
198 |
<entry>Yes</entry>
|
| 199 |
<entry>
|
199 |
<entry>
|
| 200 |
Host where to execute the command. See
|
200 |
Host where to execute the command. See
|
| 201 |
<link linkend="hostconnection">HostConnection</link>
|
201 |
<link linkend="hostconnection">HostConnection</link>
|
| 202 |
.
|
202 |
.
|
| 203 |
</entry>
|
203 |
</entry>
|
| 204 |
</row>
|
204 |
</row>
|
| 205 |
<row>
|
205 |
<row>
|
| 206 |
<entry>command</entry>
|
206 |
<entry>command</entry>
|
| 207 |
<entry>String</entry>
|
207 |
<entry>String</entry>
|
| 208 |
<entry>No</entry>
|
208 |
<entry>No</entry>
|
| 209 |
<entry>Any command including arguments</entry>
|
209 |
<entry>Any command including arguments</entry>
|
| 210 |
</row>
|
210 |
</row>
|
| 211 |
<row xml:base="file:/C:/Users/brosenberger/workspace/XServices/doc/entities.ent">
|
211 |
<row xml:base="file:/C:/Users/brosenberger/workspace/XServices/doc/entities.ent">
|
| 212 |
<entry>timeout</entry>
|
212 |
<entry>timeout</entry>
|
| 213 |
<entry>Long</entry>
|
213 |
<entry>Long</entry>
|
| 214 |
<entry>Yes</entry>
|
214 |
<entry>Yes</entry>
|
| 215 |
<entry>Timeout in milliseconds. The command is forcefully terminated when timeout is reached.</entry>
|
215 |
<entry>Timeout in milliseconds. The command is forcefully terminated when timeout is reached.</entry>
|
| 216 |
</row>
|
216 |
</row>
|
| 217 |
</tbody>
|
217 |
</tbody>
|
| 218 |
</tgroup>
|
218 |
</tgroup>
|
| 219 |
</table>
|
219 |
</table>
|
| 220 |
<para/>
|
220 |
<para/>
|
| 221 |
</section>
|
221 |
</section>
|
| 222 |
<section>
|
222 |
<section>
|
| 223 |
<title>Output parameters
|
223 |
<title>Output parameters
|
| 224 |
</title>
|
224 |
</title>
|
| 225 |
<section version="5.0" xml:base="ExecuteServices/../types/ReturnCode.xml" xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude">
|
225 |
<section version="5.0" xml:base="ExecuteServices/../types/ReturnCode.xml" xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude">
|
| 226 |
<title>ReturnCode type</title>
|
226 |
<title>ReturnCode type</title>
|
| 227 |
<para>
|
227 |
<para>
|
| 228 |
The ReturnCode type is used as the generic answer type for most of the
|
228 |
The ReturnCode type is used as the generic answer type for most of the
|
| 229 |
<application class="software">BruteXservices</application>
|
229 |
<application class="software">BruteXservices</application>
|
| 230 |
operations.
|
230 |
operations.
|
| 231 |
</para>
|
231 |
</para>
|
| 232 |
<para>
|
232 |
<para>
|
| 233 |
The defining Java class is
|
233 |
The defining Java class is
|
| 234 |
<ulink url="javadoc/net/brutex/xservices/types/ReturnCode.html">
|
234 |
<ulink url="javadoc/net/brutex/xservices/types/ReturnCode.html">
|
| 235 |
<classname>net.brutex.xservices.types.ReturnCode</classname>
|
235 |
<classname>net.brutex.xservices.types.ReturnCode</classname>
|
| 236 |
</ulink>
|
236 |
</ulink>
|
| 237 |
.
|
237 |
.
|
| 238 |
</para>
|
238 |
</para>
|
| 239 |
<bridgehead renderas="sect3">Schema definition</bridgehead>
|
239 |
<bridgehead renderas="sect3">Schema definition</bridgehead>
|
| 240 |
<programlisting language="xml"><![CDATA[
|
240 |
<programlisting language="xml"><![CDATA[
|
| 241 |
<xs:complexType name="ReturnCodeType">
|
241 |
<xs:complexType name="ReturnCodeType">
|
| 242 |
<xs:sequence>
|
242 |
<xs:sequence>
|
| 243 |
<xs:element name="returnCode" type="xs:int"/>
|
243 |
<xs:element name="returnCode" type="xs:int"/>
|
| 244 |
<xs:element minOccurs="0" name="stdOut" type="xs:string"/>
|
244 |
<xs:element minOccurs="0" name="stdOut" type="xs:string"/>
|
| 245 |
<xs:element minOccurs="0" name="stdErr" type="xs:string"/>
|
245 |
<xs:element minOccurs="0" name="stdErr" type="xs:string"/>
|
| 246 |
<xs:element maxOccurs="unbounded" minOccurs="0" name="propertyList" nillable="true" type="]]><link linkend="antproperty">tns:antProperty</link><![CDATA["/>
|
246 |
<xs:element maxOccurs="unbounded" minOccurs="0" name="propertyList" nillable="true" type="]]><link linkend="antproperty">tns:antProperty</link><![CDATA["/>
|
| 247 |
</xs:sequence>
|
247 |
</xs:sequence>
|
| 248 |
</xs:complexType>]]>
|
248 |
</xs:complexType>]]>
|
| 249 |
</programlisting>
|
249 |
</programlisting>
|
| 250 |
|
250 |
|
| 251 |
<bridgehead renderas="sect3">Example XML</bridgehead>
|
251 |
<bridgehead renderas="sect3">Example XML</bridgehead>
|
| 252 |
<programlisting language="xml">
|
252 |
<programlisting language="xml">
|
| 253 |
<ReturnCode
|
253 |
<ReturnCode
|
| 254 |
xmlns:ns2="http://ws.xservices.brutex.net">
|
254 |
xmlns:ns2="http://ws.xservices.brutex.net">
|
| 255 |
<returnCode>0</returnCode>
|
255 |
<returnCode>0</returnCode>
|
| 256 |
<stdOut/>
|
256 |
<stdOut/>
|
| 257 |
<stdErr/>
|
257 |
<stdErr/>
|
| 258 |
<propertyList>
|
258 |
<propertyList>
|
| 259 |
<lineannotation>
|
259 |
<lineannotation>
|
| 260 |
See
|
260 |
See
|
| 261 |
<link linkend="antproperty">tns:antProperty</link>
|
261 |
<link linkend="antproperty">tns:antProperty</link>
|
| 262 |
for details about the <propertyList> elements.
|
262 |
for details about the <propertyList> elements.
|
| 263 |
</lineannotation>
|
263 |
</lineannotation>
|
| 264 |
<name>key1</name>
|
264 |
<name>key1</name>
|
| 265 |
<value>value1</value>
|
265 |
<value>value1</value>
|
| 266 |
</propertyList>
|
266 |
</propertyList>
|
| 267 |
<propertyList>
|
267 |
<propertyList>
|
| 268 |
<name>key2</name>
|
268 |
<name>key2</name>
|
| 269 |
<value>value2</value>
|
269 |
<value>value2</value>
|
| 270 |
</propertyList>
|
270 |
</propertyList>
|
| 271 |
</ReturnCode>
|
271 |
</ReturnCode>
|
| 272 |
</programlisting>
|
272 |
</programlisting>
|
| 273 |
|
273 |
|
| 274 |
</section>
|
274 |
</section>
|
| 275 |
</section>
|
275 |
</section>
|
| 276 |
</section>
|
276 |
</section>
|
| 277 |
<section version="5.0" xml:base="ExecuteServices/runCommand.xml" xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude">
|
277 |
<section version="5.0" xml:base="ExecuteServices/runCommand.xml" xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude">
|
| 278 |
<title>runCommand</title>
|
278 |
<title>runCommand</title>
|
| 279 |
<para>Run an executable with arguments on the server providing the web
|
279 |
<para>Run an executable with arguments on the server providing the web
|
| 280 |
service. The command is run within the environment and under the user
|
280 |
service. The command is run within the environment and under the user
|
| 281 |
privileges of the user who is running the Tomcat Server.</para>
|
281 |
privileges of the user who is running the Tomcat Server.</para>
|
| 282 |
<section>
|
282 |
<section>
|
| 283 |
<title>Input parameters
|
283 |
<title>Input parameters
|
| 284 |
</title>
|
284 |
</title>
|
| 285 |
<para/>
|
285 |
<para/>
|
| 286 |
<table frame="all">
|
286 |
<table frame="all">
|
| 287 |
<title>runCommand input parameters</title>
|
287 |
<title>runCommand input parameters</title>
|
| 288 |
<tgroup cols="4">
|
288 |
<tgroup cols="4">
|
| 289 |
<colspec colname="parameter" colnum="1"/>
|
289 |
<colspec colname="parameter" colnum="1"/>
|
| 290 |
<colspec colname="type" colnum="2"/>
|
290 |
<colspec colname="type" colnum="2"/>
|
| 291 |
<colspec colname="required" colnum="3"/>
|
291 |
<colspec colname="required" colnum="3"/>
|
| 292 |
<colspec colname="description" colnum="4"/>
|
292 |
<colspec colname="description" colnum="4"/>
|
| 293 |
<thead>
|
293 |
<thead>
|
| 294 |
<row>
|
294 |
<row>
|
| 295 |
<entry>parameter</entry>
|
295 |
<entry>parameter</entry>
|
| 296 |
<entry>type</entry>
|
296 |
<entry>type</entry>
|
| 297 |
<entry>required</entry>
|
297 |
<entry>required</entry>
|
| 298 |
<entry>description</entry>
|
298 |
<entry>description</entry>
|
| 299 |
</row>
|
299 |
</row>
|
| 300 |
</thead>
|
300 |
</thead>
|
| 301 |
<tbody>
|
301 |
<tbody>
|
| 302 |
<row>
|
302 |
<row>
|
| 303 |
<entry>executable</entry>
|
303 |
<entry>executable</entry>
|
| 304 |
<entry>String</entry>
|
304 |
<entry>String</entry>
|
| 305 |
<entry>Yes</entry>
|
305 |
<entry>Yes</entry>
|
| 306 |
<entry>Command to be run. The command may be specified with full
|
306 |
<entry>Command to be run. The command may be specified with full
|
| 307 |
path using forward slash "/" as path separator.</entry>
|
307 |
path using forward slash "/" as path separator.</entry>
|
| 308 |
</row>
|
308 |
</row>
|
| 309 |
<row>
|
309 |
<row>
|
| 310 |
<entry>argline</entry>
|
310 |
<entry>argline</entry>
|
| 311 |
<entry>String</entry>
|
311 |
<entry>String</entry>
|
| 312 |
<entry>No</entry>
|
312 |
<entry>No</entry>
|
| 313 |
<entry>Any command line arguments</entry>
|
313 |
<entry>Any command line arguments</entry>
|
| 314 |
</row>
|
314 |
</row>
|
| 315 |
<row xml:base="file:/C:/Users/brosenberger/workspace/XServices/doc/entities.ent">
|
315 |
<row xml:base="file:/C:/Users/brosenberger/workspace/XServices/doc/entities.ent">
|
| 316 |
<entry>timeout</entry>
|
316 |
<entry>timeout</entry>
|
| 317 |
<entry>Long</entry>
|
317 |
<entry>Long</entry>
|
| 318 |
<entry>Yes</entry>
|
318 |
<entry>Yes</entry>
|
| 319 |
<entry>Timeout in milliseconds. The command is forcefully terminated when timeout is reached.</entry>
|
319 |
<entry>Timeout in milliseconds. The command is forcefully terminated when timeout is reached.</entry>
|
| 320 |
</row>
|
320 |
</row>
|
| 321 |
</tbody>
|
321 |
</tbody>
|
| 322 |
</tgroup>
|
322 |
</tgroup>
|
| 323 |
</table>
|
323 |
</table>
|
| 324 |
<para/>
|
324 |
<para/>
|
| 325 |
</section>
|
325 |
</section>
|
| 326 |
<section>
|
326 |
<section>
|
| 327 |
<title>Output parameters
|
327 |
<title>Output parameters
|
| 328 |
</title>
|
328 |
</title>
|
| 329 |
<section version="5.0" xml:base="ExecuteServices/../types/ReturnCode.xml" xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude">
|
329 |
<section version="5.0" xml:base="ExecuteServices/../types/ReturnCode.xml" xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude">
|
| 330 |
<title>ReturnCode type</title>
|
330 |
<title>ReturnCode type</title>
|
| 331 |
<para>
|
331 |
<para>
|
| 332 |
The ReturnCode type is used as the generic answer type for most of the
|
332 |
The ReturnCode type is used as the generic answer type for most of the
|
| 333 |
<application class="software">BruteXservices</application>
|
333 |
<application class="software">BruteXservices</application>
|
| 334 |
operations.
|
334 |
operations.
|
| 335 |
</para>
|
335 |
</para>
|
| 336 |
<para>
|
336 |
<para>
|
| 337 |
The defining Java class is
|
337 |
The defining Java class is
|
| 338 |
<ulink url="javadoc/net/brutex/xservices/types/ReturnCode.html">
|
338 |
<ulink url="javadoc/net/brutex/xservices/types/ReturnCode.html">
|
| 339 |
<classname>net.brutex.xservices.types.ReturnCode</classname>
|
339 |
<classname>net.brutex.xservices.types.ReturnCode</classname>
|
| 340 |
</ulink>
|
340 |
</ulink>
|
| 341 |
.
|
341 |
.
|
| 342 |
</para>
|
342 |
</para>
|
| 343 |
<bridgehead renderas="sect3">Schema definition</bridgehead>
|
343 |
<bridgehead renderas="sect3">Schema definition</bridgehead>
|
| 344 |
<programlisting language="xml"><![CDATA[
|
344 |
<programlisting language="xml"><![CDATA[
|
| 345 |
<xs:complexType name="ReturnCodeType">
|
345 |
<xs:complexType name="ReturnCodeType">
|
| 346 |
<xs:sequence>
|
346 |
<xs:sequence>
|
| 347 |
<xs:element name="returnCode" type="xs:int"/>
|
347 |
<xs:element name="returnCode" type="xs:int"/>
|
| 348 |
<xs:element minOccurs="0" name="stdOut" type="xs:string"/>
|
348 |
<xs:element minOccurs="0" name="stdOut" type="xs:string"/>
|
| 349 |
<xs:element minOccurs="0" name="stdErr" type="xs:string"/>
|
349 |
<xs:element minOccurs="0" name="stdErr" type="xs:string"/>
|
| 350 |
<xs:element maxOccurs="unbounded" minOccurs="0" name="propertyList" nillable="true" type="]]><link linkend="antproperty">tns:antProperty</link><![CDATA["/>
|
350 |
<xs:element maxOccurs="unbounded" minOccurs="0" name="propertyList" nillable="true" type="]]><link linkend="antproperty">tns:antProperty</link><![CDATA["/>
|
| 351 |
</xs:sequence>
|
351 |
</xs:sequence>
|
| 352 |
</xs:complexType>]]>
|
352 |
</xs:complexType>]]>
|
| 353 |
</programlisting>
|
353 |
</programlisting>
|
| 354 |
|
354 |
|
| 355 |
<bridgehead renderas="sect3">Example XML</bridgehead>
|
355 |
<bridgehead renderas="sect3">Example XML</bridgehead>
|
| 356 |
<programlisting language="xml">
|
356 |
<programlisting language="xml">
|
| 357 |
<ReturnCode
|
357 |
<ReturnCode
|
| 358 |
xmlns:ns2="http://ws.xservices.brutex.net">
|
358 |
xmlns:ns2="http://ws.xservices.brutex.net">
|
| 359 |
<returnCode>0</returnCode>
|
359 |
<returnCode>0</returnCode>
|
| 360 |
<stdOut/>
|
360 |
<stdOut/>
|
| 361 |
<stdErr/>
|
361 |
<stdErr/>
|
| 362 |
<propertyList>
|
362 |
<propertyList>
|
| 363 |
<lineannotation>
|
363 |
<lineannotation>
|
| 364 |
See
|
364 |
See
|
| 365 |
<link linkend="antproperty">tns:antProperty</link>
|
365 |
<link linkend="antproperty">tns:antProperty</link>
|
| 366 |
for details about the <propertyList> elements.
|
366 |
for details about the <propertyList> elements.
|
| 367 |
</lineannotation>
|
367 |
</lineannotation>
|
| 368 |
<name>key1</name>
|
368 |
<name>key1</name>
|
| 369 |
<value>value1</value>
|
369 |
<value>value1</value>
|
| 370 |
</propertyList>
|
370 |
</propertyList>
|
| 371 |
<propertyList>
|
371 |
<propertyList>
|
| 372 |
<name>key2</name>
|
372 |
<name>key2</name>
|
| 373 |
<value>value2</value>
|
373 |
<value>value2</value>
|
| 374 |
</propertyList>
|
374 |
</propertyList>
|
| 375 |
</ReturnCode>
|
375 |
</ReturnCode>
|
| 376 |
</programlisting>
|
376 |
</programlisting>
|
| 377 |
|
377 |
|
| 378 |
</section>
|
378 |
</section>
|
| 379 |
</section>
|
379 |
</section>
|
| 380 |
</section>
|
380 |
</section>
|
| 381 |
<section version="5.0" xml:base="ExecuteServices/runCommandWithSSH.xml" xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude">
|
381 |
<section version="5.0" xml:base="ExecuteServices/runCommandWithSSH.xml" xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude">
|
| 382 |
<title>runCommandWithSSH</title>
|
382 |
<title>runCommandWithSSH</title>
|
| 383 |
<para>Executes a command through a SSH session.</para>
|
383 |
<para>Executes a command through a SSH session.</para>
|
| 384 |
<section>
|
384 |
<section>
|
| 385 |
<title>Input parameters
|
385 |
<title>Input parameters
|
| 386 |
</title>
|
386 |
</title>
|
| 387 |
<para/>
|
387 |
<para/>
|
| 388 |
<table frame="all">
|
388 |
<table frame="all">
|
| 389 |
<title>runCommandWithSSH input parameters</title>
|
389 |
<title>runCommandWithSSH input parameters</title>
|
| 390 |
<tgroup cols="4">
|
390 |
<tgroup cols="4">
|
| 391 |
<colspec colname="parameter" colnum="1"/>
|
391 |
<colspec colname="parameter" colnum="1"/>
|
| 392 |
<colspec colname="type" colnum="2"/>
|
392 |
<colspec colname="type" colnum="2"/>
|
| 393 |
<colspec colname="required" colnum="3"/>
|
393 |
<colspec colname="required" colnum="3"/>
|
| 394 |
<colspec colname="description" colnum="4"/>
|
394 |
<colspec colname="description" colnum="4"/>
|
| 395 |
<thead>
|
395 |
<thead>
|
| 396 |
<row>
|
396 |
<row>
|
| 397 |
<entry>parameter</entry>
|
397 |
<entry>parameter</entry>
|
| 398 |
<entry>type</entry>
|
398 |
<entry>type</entry>
|
| 399 |
<entry>required</entry>
|
399 |
<entry>required</entry>
|
| 400 |
<entry>description</entry>
|
400 |
<entry>description</entry>
|
| 401 |
</row>
|
401 |
</row>
|
| 402 |
</thead>
|
402 |
</thead>
|
| 403 |
<tbody>
|
403 |
<tbody>
|
| 404 |
<row>
|
404 |
<row>
|
| 405 |
<entry>host</entry>
|
405 |
<entry>host</entry>
|
| 406 |
<entry>HostConnection</entry>
|
406 |
<entry>HostConnection</entry>
|
| 407 |
<entry>Yes</entry>
|
407 |
<entry>Yes</entry>
|
| 408 |
<entry>
|
408 |
<entry>
|
| 409 |
Host to connect to (see:
|
409 |
Host to connect to (see:
|
| 410 |
<link linkend="hostconnection">tns:HostConnection</link>
|
410 |
<link linkend="hostconnection">tns:HostConnection</link>
|
| 411 |
)
|
411 |
)
|
| 412 |
</entry>
|
412 |
</entry>
|
| 413 |
</row>
|
413 |
</row>
|
| 414 |
<row>
|
414 |
<row>
|
| 415 |
<entry>command</entry>
|
415 |
<entry>command</entry>
|
| 416 |
<entry>String</entry>
|
416 |
<entry>String</entry>
|
| 417 |
<entry>No</entry>
|
417 |
<entry>No</entry>
|
| 418 |
<entry>The command to execute.</entry>
|
418 |
<entry>The command to execute.</entry>
|
| 419 |
</row>
|
419 |
</row>
|
| 420 |
<row xml:base="file:/C:/Users/brosenberger/workspace/XServices/doc/entities.ent">
|
420 |
<row xml:base="file:/C:/Users/brosenberger/workspace/XServices/doc/entities.ent">
|
| 421 |
<entry>timeout</entry>
|
421 |
<entry>timeout</entry>
|
| 422 |
<entry>Long</entry>
|
422 |
<entry>Long</entry>
|
| 423 |
<entry>Yes</entry>
|
423 |
<entry>Yes</entry>
|
| 424 |
<entry>Timeout in milliseconds. The command is forcefully terminated when timeout is reached.</entry>
|
424 |
<entry>Timeout in milliseconds. The command is forcefully terminated when timeout is reached.</entry>
|
| 425 |
</row>
|
425 |
</row>
|
| 426 |
</tbody>
|
426 |
</tbody>
|
| 427 |
</tgroup>
|
427 |
</tgroup>
|
| 428 |
</table>
|
428 |
</table>
|
| 429 |
<para/>
|
429 |
<para/>
|
| 430 |
</section>
|
430 |
</section>
|
| 431 |
<section>
|
431 |
<section>
|
| 432 |
<title>Output parameters
|
432 |
<title>Output parameters
|
| 433 |
</title>
|
433 |
</title>
|
| 434 |
<section version="5.0" xml:base="ExecuteServices/../types/ReturnCode.xml" xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude">
|
434 |
<section version="5.0" xml:base="ExecuteServices/../types/ReturnCode.xml" xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude">
|
| 435 |
<title>ReturnCode type</title>
|
435 |
<title>ReturnCode type</title>
|
| 436 |
<para>
|
436 |
<para>
|
| 437 |
The ReturnCode type is used as the generic answer type for most of the
|
437 |
The ReturnCode type is used as the generic answer type for most of the
|
| 438 |
<application class="software">BruteXservices</application>
|
438 |
<application class="software">BruteXservices</application>
|
| 439 |
operations.
|
439 |
operations.
|
| 440 |
</para>
|
440 |
</para>
|
| 441 |
<para>
|
441 |
<para>
|
| 442 |
The defining Java class is
|
442 |
The defining Java class is
|
| 443 |
<ulink url="javadoc/net/brutex/xservices/types/ReturnCode.html">
|
443 |
<ulink url="javadoc/net/brutex/xservices/types/ReturnCode.html">
|
| 444 |
<classname>net.brutex.xservices.types.ReturnCode</classname>
|
444 |
<classname>net.brutex.xservices.types.ReturnCode</classname>
|
| 445 |
</ulink>
|
445 |
</ulink>
|
| 446 |
.
|
446 |
.
|
| 447 |
</para>
|
447 |
</para>
|
| 448 |
<bridgehead renderas="sect3">Schema definition</bridgehead>
|
448 |
<bridgehead renderas="sect3">Schema definition</bridgehead>
|
| 449 |
<programlisting language="xml"><![CDATA[
|
449 |
<programlisting language="xml"><![CDATA[
|
| 450 |
<xs:complexType name="ReturnCodeType">
|
450 |
<xs:complexType name="ReturnCodeType">
|
| 451 |
<xs:sequence>
|
451 |
<xs:sequence>
|
| 452 |
<xs:element name="returnCode" type="xs:int"/>
|
452 |
<xs:element name="returnCode" type="xs:int"/>
|
| 453 |
<xs:element minOccurs="0" name="stdOut" type="xs:string"/>
|
453 |
<xs:element minOccurs="0" name="stdOut" type="xs:string"/>
|
| 454 |
<xs:element minOccurs="0" name="stdErr" type="xs:string"/>
|
454 |
<xs:element minOccurs="0" name="stdErr" type="xs:string"/>
|
| 455 |
<xs:element maxOccurs="unbounded" minOccurs="0" name="propertyList" nillable="true" type="]]><link linkend="antproperty">tns:antProperty</link><![CDATA["/>
|
455 |
<xs:element maxOccurs="unbounded" minOccurs="0" name="propertyList" nillable="true" type="]]><link linkend="antproperty">tns:antProperty</link><![CDATA["/>
|
| 456 |
</xs:sequence>
|
456 |
</xs:sequence>
|
| 457 |
</xs:complexType>]]>
|
457 |
</xs:complexType>]]>
|
| 458 |
</programlisting>
|
458 |
</programlisting>
|
| 459 |
|
459 |
|
| 460 |
<bridgehead renderas="sect3">Example XML</bridgehead>
|
460 |
<bridgehead renderas="sect3">Example XML</bridgehead>
|
| 461 |
<programlisting language="xml">
|
461 |
<programlisting language="xml">
|
| 462 |
<ReturnCode
|
462 |
<ReturnCode
|
| 463 |
xmlns:ns2="http://ws.xservices.brutex.net">
|
463 |
xmlns:ns2="http://ws.xservices.brutex.net">
|
| 464 |
<returnCode>0</returnCode>
|
464 |
<returnCode>0</returnCode>
|
| 465 |
<stdOut/>
|
465 |
<stdOut/>
|
| 466 |
<stdErr/>
|
466 |
<stdErr/>
|
| 467 |
<propertyList>
|
467 |
<propertyList>
|
| 468 |
<lineannotation>
|
468 |
<lineannotation>
|
| 469 |
See
|
469 |
See
|
| 470 |
<link linkend="antproperty">tns:antProperty</link>
|
470 |
<link linkend="antproperty">tns:antProperty</link>
|
| 471 |
for details about the <propertyList> elements.
|
471 |
for details about the <propertyList> elements.
|
| 472 |
</lineannotation>
|
472 |
</lineannotation>
|
| 473 |
<name>key1</name>
|
473 |
<name>key1</name>
|
| 474 |
<value>value1</value>
|
474 |
<value>value1</value>
|
| 475 |
</propertyList>
|
475 |
</propertyList>
|
| 476 |
<propertyList>
|
476 |
<propertyList>
|
| 477 |
<name>key2</name>
|
477 |
<name>key2</name>
|
| 478 |
<value>value2</value>
|
478 |
<value>value2</value>
|
| 479 |
</propertyList>
|
479 |
</propertyList>
|
| 480 |
</ReturnCode>
|
480 |
</ReturnCode>
|
| 481 |
</programlisting>
|
481 |
</programlisting>
|
| 482 |
|
482 |
|
| 483 |
</section>
|
483 |
</section>
|
| 484 |
</section>
|
484 |
</section>
|
| 485 |
<section>
|
485 |
<section>
|
| 486 |
<title>Sample Request:</title>
|
486 |
<title>Sample Request:</title>
|
| 487 |
<programlisting language="xml">
|
487 |
<programlisting language="xml">
|
| 488 |
<![CDATA[
|
488 |
<![CDATA[
|
| 489 |
<ws:runCommandWithSSH>
|
489 |
<ws:runCommandWithSSH>
|
| 490 |
<host>
|
490 |
<host>
|
| 491 |
<hostname>ssh.brutex.net</hostname>
|
491 |
<hostname>ssh.brutex.net</hostname>
|
| 492 |
<port>22</port>
|
492 |
<port>22</port>
|
| 493 |
<user>roger</user>
|
493 |
<user>roger</user>
|
| 494 |
<password>xxx</password>
|
494 |
<password>xxx</password>
|
| 495 |
</host>
|
495 |
</host>
|
| 496 |
<command>ls /etc/</command>
|
496 |
<command>ls /etc/</command>
|
| 497 |
<timeout>30000</timeout>
|
497 |
<timeout>30000</timeout>
|
| 498 |
</ws:runCommandWithSSH>
|
498 |
</ws:runCommandWithSSH>
|
| 499 |
]]></programlisting>
|
499 |
]]></programlisting>
|
| 500 |
</section>
|
500 |
</section>
|
| 501 |
</section>
|
501 |
</section>
|
| 502 |
<section version="5.0" xml:base="ExecuteServices/telnet.xml" xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude">
|
502 |
<section version="5.0" xml:base="ExecuteServices/telnet.xml" xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude">
|
| 503 |
<title>telnet</title>
|
503 |
<title>telnet</title>
|
| 504 |
<para>Runs a telnet session with an "expect shell" like behaviour.</para>
|
504 |
<para>Runs a telnet session with an "expect shell" like behaviour.</para>
|
| 505 |
<section>
|
505 |
<section>
|
| 506 |
<title>Input parameters
|
506 |
<title>Input parameters
|
| 507 |
</title>
|
507 |
</title>
|
| 508 |
<para/>
|
508 |
<para/>
|
| 509 |
<table frame="all">
|
509 |
<table frame="all">
|
| 510 |
<title>telnet input parameters</title>
|
510 |
<title>telnet input parameters</title>
|
| 511 |
<tgroup cols="4">
|
511 |
<tgroup cols="4">
|
| 512 |
<colspec colname="parameter" colnum="1"/>
|
512 |
<colspec colname="parameter" colnum="1"/>
|
| 513 |
<colspec colname="type" colnum="2"/>
|
513 |
<colspec colname="type" colnum="2"/>
|
| 514 |
<colspec colname="required" colnum="3"/>
|
514 |
<colspec colname="required" colnum="3"/>
|
| 515 |
<colspec colname="description" colnum="4"/>
|
515 |
<colspec colname="description" colnum="4"/>
|
| 516 |
<thead>
|
516 |
<thead>
|
| 517 |
<row>
|
517 |
<row>
|
| 518 |
<entry>parameter</entry>
|
518 |
<entry>parameter</entry>
|
| 519 |
<entry>type</entry>
|
519 |
<entry>type</entry>
|
| 520 |
<entry>required</entry>
|
520 |
<entry>required</entry>
|
| 521 |
<entry>description</entry>
|
521 |
<entry>description</entry>
|
| 522 |
</row>
|
522 |
</row>
|
| 523 |
</thead>
|
523 |
</thead>
|
| 524 |
<tbody>
|
524 |
<tbody>
|
| 525 |
<row>
|
525 |
<row>
|
| 526 |
<entry>host</entry>
|
526 |
<entry>host</entry>
|
| 527 |
<entry>HostConnection</entry>
|
527 |
<entry>HostConnection</entry>
|
| 528 |
<entry>Yes</entry>
|
528 |
<entry>Yes</entry>
|
| 529 |
<entry>Host to connect to (see: <link linkend="hostconnection">tns:HostConnection</link>)</entry>
|
529 |
<entry>Host to connect to (see: <link linkend="hostconnection">tns:HostConnection</link>)</entry>
|
| 530 |
</row>
|
530 |
</row>
|
| 531 |
<row>
|
531 |
<row>
|
| 532 |
<entry>prompt</entry>
|
532 |
<entry>prompt</entry>
|
| 533 |
<entry>String</entry>
|
533 |
<entry>String</entry>
|
| 534 |
<entry>No</entry>
|
534 |
<entry>No</entry>
|
| 535 |
<entry>The prompt string to expect after login. This is used to recognize when
|
535 |
<entry>The prompt string to expect after login. This is used to recognize when
|
| 536 |
the session is open.</entry>
|
536 |
the session is open.</entry>
|
| 537 |
</row>
|
537 |
</row>
|
| 538 |
<row>
|
538 |
<row>
|
| 539 |
<entry>command</entry>
|
539 |
<entry>command</entry>
|
| 540 |
<entry>String</entry>
|
540 |
<entry>String</entry>
|
| 541 |
<entry>No</entry>
|
541 |
<entry>No</entry>
|
| 542 |
<entry>The command to execute.</entry>
|
542 |
<entry>The command to execute.</entry>
|
| 543 |
</row>
|
543 |
</row>
|
| 544 |
<row>
|
544 |
<row>
|
| 545 |
<entry>expect</entry>
|
545 |
<entry>expect</entry>
|
| 546 |
<entry>String</entry>
|
546 |
<entry>String</entry>
|
| 547 |
<entry>No</entry>
|
547 |
<entry>No</entry>
|
| 548 |
<entry>The prompt to expect after the command has been executed successfully.</entry>
|
548 |
<entry>The prompt to expect after the command has been executed successfully.</entry>
|
| 549 |
</row>
|
549 |
</row>
|
| 550 |
<row xml:base="file:/C:/Users/brosenberger/workspace/XServices/doc/entities.ent">
|
550 |
<row xml:base="file:/C:/Users/brosenberger/workspace/XServices/doc/entities.ent">
|
| 551 |
<entry>timeout</entry>
|
551 |
<entry>timeout</entry>
|
| 552 |
<entry>Long</entry>
|
552 |
<entry>Long</entry>
|
| 553 |
<entry>Yes</entry>
|
553 |
<entry>Yes</entry>
|
| 554 |
<entry>Timeout in milliseconds. The command is forcefully terminated when timeout is reached.</entry>
|
554 |
<entry>Timeout in milliseconds. The command is forcefully terminated when timeout is reached.</entry>
|
| 555 |
</row>
|
555 |
</row>
|
| 556 |
</tbody>
|
556 |
</tbody>
|
| 557 |
</tgroup>
|
557 |
</tgroup>
|
| 558 |
</table>
|
558 |
</table>
|
| 559 |
<para/>
|
559 |
<para/>
|
| 560 |
</section>
|
560 |
</section>
|
| 561 |
<section>
|
561 |
<section>
|
| 562 |
<title>Output parameters</title>
|
562 |
<title>Output parameters</title>
|
| 563 |
<section version="5.0" xml:base="ExecuteServices/../types/ReturnCode.xml" xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude">
|
563 |
<section version="5.0" xml:base="ExecuteServices/../types/ReturnCode.xml" xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude">
|
| 564 |
<title>ReturnCode type</title>
|
564 |
<title>ReturnCode type</title>
|
| 565 |
<para>
|
565 |
<para>
|
| 566 |
The ReturnCode type is used as the generic answer type for most of the
|
566 |
The ReturnCode type is used as the generic answer type for most of the
|
| 567 |
<application class="software">BruteXservices</application>
|
567 |
<application class="software">BruteXservices</application>
|
| 568 |
operations.
|
568 |
operations.
|
| 569 |
</para>
|
569 |
</para>
|
| 570 |
<para>
|
570 |
<para>
|
| 571 |
The defining Java class is
|
571 |
The defining Java class is
|
| 572 |
<ulink url="javadoc/net/brutex/xservices/types/ReturnCode.html">
|
572 |
<ulink url="javadoc/net/brutex/xservices/types/ReturnCode.html">
|
| 573 |
<classname>net.brutex.xservices.types.ReturnCode</classname>
|
573 |
<classname>net.brutex.xservices.types.ReturnCode</classname>
|
| 574 |
</ulink>
|
574 |
</ulink>
|
| 575 |
.
|
575 |
.
|
| 576 |
</para>
|
576 |
</para>
|
| 577 |
<bridgehead renderas="sect3">Schema definition</bridgehead>
|
577 |
<bridgehead renderas="sect3">Schema definition</bridgehead>
|
| 578 |
<programlisting language="xml"><![CDATA[
|
578 |
<programlisting language="xml"><![CDATA[
|
| 579 |
<xs:complexType name="ReturnCodeType">
|
579 |
<xs:complexType name="ReturnCodeType">
|
| 580 |
<xs:sequence>
|
580 |
<xs:sequence>
|
| 581 |
<xs:element name="returnCode" type="xs:int"/>
|
581 |
<xs:element name="returnCode" type="xs:int"/>
|
| 582 |
<xs:element minOccurs="0" name="stdOut" type="xs:string"/>
|
582 |
<xs:element minOccurs="0" name="stdOut" type="xs:string"/>
|
| 583 |
<xs:element minOccurs="0" name="stdErr" type="xs:string"/>
|
583 |
<xs:element minOccurs="0" name="stdErr" type="xs:string"/>
|
| 584 |
<xs:element maxOccurs="unbounded" minOccurs="0" name="propertyList" nillable="true" type="]]><link linkend="antproperty">tns:antProperty</link><![CDATA["/>
|
584 |
<xs:element maxOccurs="unbounded" minOccurs="0" name="propertyList" nillable="true" type="]]><link linkend="antproperty">tns:antProperty</link><![CDATA["/>
|
| 585 |
</xs:sequence>
|
585 |
</xs:sequence>
|
| 586 |
</xs:complexType>]]>
|
586 |
</xs:complexType>]]>
|
| 587 |
</programlisting>
|
587 |
</programlisting>
|
| 588 |
|
588 |
|
| 589 |
<bridgehead renderas="sect3">Example XML</bridgehead>
|
589 |
<bridgehead renderas="sect3">Example XML</bridgehead>
|
| 590 |
<programlisting language="xml">
|
590 |
<programlisting language="xml">
|
| 591 |
<ReturnCode
|
591 |
<ReturnCode
|
| 592 |
xmlns:ns2="http://ws.xservices.brutex.net">
|
592 |
xmlns:ns2="http://ws.xservices.brutex.net">
|
| 593 |
<returnCode>0</returnCode>
|
593 |
<returnCode>0</returnCode>
|
| 594 |
<stdOut/>
|
594 |
<stdOut/>
|
| 595 |
<stdErr/>
|
595 |
<stdErr/>
|
| 596 |
<propertyList>
|
596 |
<propertyList>
|
| 597 |
<lineannotation>
|
597 |
<lineannotation>
|
| 598 |
See
|
598 |
See
|
| 599 |
<link linkend="antproperty">tns:antProperty</link>
|
599 |
<link linkend="antproperty">tns:antProperty</link>
|
| 600 |
for details about the <propertyList> elements.
|
600 |
for details about the <propertyList> elements.
|
| 601 |
</lineannotation>
|
601 |
</lineannotation>
|
| 602 |
<name>key1</name>
|
602 |
<name>key1</name>
|
| 603 |
<value>value1</value>
|
603 |
<value>value1</value>
|
| 604 |
</propertyList>
|
604 |
</propertyList>
|
| 605 |
<propertyList>
|
605 |
<propertyList>
|
| 606 |
<name>key2</name>
|
606 |
<name>key2</name>
|
| 607 |
<value>value2</value>
|
607 |
<value>value2</value>
|
| 608 |
</propertyList>
|
608 |
</propertyList>
|
| 609 |
</ReturnCode>
|
609 |
</ReturnCode>
|
| 610 |
</programlisting>
|
610 |
</programlisting>
|
| 611 |
|
611 |
|
| 612 |
</section>
|
612 |
</section>
|
| 613 |
</section>
|
613 |
</section>
|
| 614 |
<section>
|
614 |
<section>
|
| 615 |
<title>Sample Request:</title>
|
615 |
<title>Sample Request:</title>
|
| 616 |
<programlisting language="xml">
|
616 |
<programlisting language="xml">
|
| 617 |
<![CDATA[
|
617 |
<![CDATA[
|
| 618 |
<ws:telnet>
|
618 |
<ws:telnet>
|
| 619 |
<host>
|
619 |
<host>
|
| 620 |
<hostname>localhost</hostname>
|
620 |
<hostname>localhost</hostname>
|
| 621 |
<port>23</port>
|
621 |
<port>23</port>
|
| 622 |
<user>brosenberger</user>
|
622 |
<user>brosenberger</user>
|
| 623 |
<password></password>
|
623 |
<password></password>
|
| 624 |
</host>
|
624 |
</host>
|
| 625 |
<prompt>C:\Users\brosenberger></prompt>
|
625 |
<prompt>C:\Users\brosenberger></prompt>
|
| 626 |
<command>dir c:\temp</command>
|
626 |
<command>dir c:\temp</command>
|
| 627 |
<expect>enberger></expect>
|
627 |
<expect>enberger></expect>
|
| 628 |
<timeout>60000</timeout>
|
628 |
<timeout>60000</timeout>
|
| 629 |
</ws:telnet>
|
629 |
</ws:telnet>
|
| 630 |
]]></programlisting>
|
630 |
]]></programlisting>
|
| 631 |
</section>
|
631 |
</section>
|
| 632 |
</section>
|
632 |
</section>
|
| 633 |
</section>
|
633 |
</section>
|
| 634 |
<section id="fileservices" version="5.0" xml:base="FileServices.xml" xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude">
|
634 |
<section id="fileservices" version="5.0" xml:base="FileServices.xml" xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude">
|
| 635 |
<title>FileServices</title>
|
635 |
<title>FileServices</title>
|
| 636 |
<para>The FileServces bundles various file operations. Its WSDL is located at
|
636 |
<para>The FileServces bundles various file operations. Its WSDL is located at
|
| 637 |
http://server:port/XServices/FileService?wsdl</para>
|
637 |
http://server:port/XServices/FileService?wsdl</para>
|
| 638 |
</section>
|
638 |
</section>
|
| 639 |
<section id="miscservices" version="5.0" xml:base="MiscServices.xml" xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude">
|
639 |
<section id="miscservices" version="5.0" xml:base="MiscServices.xml" xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude">
|
| 640 |
<title>MiscServices</title>
|
640 |
<title>MiscServices</title>
|
| 641 |
<para>The MiscService bundles various operations. Its WSDL is located at
|
641 |
<para>The MiscService bundles various operations. Its WSDL is located at
|
| 642 |
http://server:port/XServices/MiscService?wsdl</para>
|
642 |
http://server:port/XServices/MiscService?wsdl</para>
|
| - |
|
643 |
<section version="5.0" xml:base="MiscServices/generateUUID.xml" xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude">
|
| - |
|
644 |
<title>generateUUID</title>
|
| - |
|
645 |
<para>Generates a UUID that represents a 128-bit value. This operation does not require any
|
| - |
|
646 |
input parameters. The output has the format:
|
| - |
|
647 |
<screen>
|
| - |
|
648 |
0xFFFFFFFF00000000 time_low
|
| - |
|
649 |
0x00000000FFFF0000 time_mid
|
| - |
|
650 |
0x000000000000F000 version
|
| - |
|
651 |
0x0000000000000FFF time_hi
|
| - |
|
652 |
</screen>
|
| 643 |
|
653 |
|
| - |
|
654 |
The least significant long consists of the following unsigned fields:
|
| - |
|
655 |
<screen>
|
| - |
|
656 |
0xC000000000000000 variant
|
| - |
|
657 |
0x3FFF000000000000 clock_seq
|
| - |
|
658 |
0x0000FFFFFFFFFFFF node
|
| - |
|
659 |
</screen>
|
| - |
|
660 |
Sample response:
|
| - |
|
661 |
<screen><![CDATA[
|
| - |
|
662 |
<soap:Envelope
|
| - |
|
663 |
xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
|
| - |
|
664 |
<soap:Body>
|
| - |
|
665 |
<ns1:generateUUIDResponse
|
| - |
|
666 |
xmlns:ns1="http://ws.xservices.brutex.net">
|
| - |
|
667 |
<ns1:return>]]><emphasis>33b9e5c8-9102-423b-88af-bbee479ebea8</emphasis><![CDATA[</ns1:return>
|
| - |
|
668 |
</ns1:generateUUIDResponse>
|
| - |
|
669 |
</soap:Body>
|
| - |
|
670 |
</soap:Envelope>
|
| - |
|
671 |
]]></screen>
|
| - |
|
672 |
</para>
|
| - |
|
673 |
</section>
|
| - |
|
674 |
<section version="5.0" xml:base="MiscServices/getHostinfo.xml" xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude">
|
| - |
|
675 |
<title>getHostinfo</title>
|
| - |
|
676 |
<para>Collect information about a host address.
|
| - |
|
677 |
Sample request:
|
| - |
|
678 |
<screen><![CDATA[
|
| - |
|
679 |
<soapenv:Envelope
|
| - |
|
680 |
xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
|
| - |
|
681 |
xmlns:ws="http://ws.xservices.brutex.net">
|
| - |
|
682 |
<soapenv:Header/>
|
| - |
|
683 |
<soapenv:Body>
|
| - |
|
684 |
<ws:getHostinfo>
|
| - |
|
685 |
<ws:hostname>]]><emphasis>google.com</emphasis><![CDATA[</ws:hostname>
|
| - |
|
686 |
</ws:getHostinfo>
|
| - |
|
687 |
</soapenv:Body>
|
| - |
|
688 |
</soapenv:Envelope>
|
| - |
|
689 |
]]></screen>
|
| - |
|
690 |
Sample response:
|
| - |
|
691 |
<screen><![CDATA[
|
| - |
|
692 |
<soap:Envelope
|
| - |
|
693 |
xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
|
| - |
|
694 |
<soap:Body>
|
| - |
|
695 |
<ns1:getHostinfoResponse
|
| - |
|
696 |
xmlns:ns1="http://ws.xservices.brutex.net">
|
| - |
|
697 |
<ns1:return>
|
| - |
|
698 |
<ns1:domain>]]><emphasis>1e100.net</emphasis><![CDATA[</ns1:domain>
|
| - |
|
699 |
<ns1:ip4>]]><emphasis>173.194.66.105</emphasis><![CDATA[</ns1:ip4>
|
| - |
|
700 |
<ns1:ip6>]]><emphasis>::</emphasis><![CDATA[</ns1:ip6>
|
| - |
|
701 |
<ns1:name>]]><emphasis>we-in-f105</emphasis><![CDATA[</ns1:name>
|
| - |
|
702 |
</ns1:return>
|
| - |
|
703 |
</ns1:getHostinfoResponse>
|
| - |
|
704 |
</soap:Body>
|
| - |
|
705 |
</soap:Envelope>
|
| - |
|
706 |
]]></screen>
|
| - |
|
707 |
</para>
|
| - |
|
708 |
</section>
|
| 644 |
</section>
|
709 |
</section>
|
| 645 |
</chapter>
|
710 |
</chapter>
|
| 646 |
|
711 |
|
| 647 |
<chapter id="xmltypes">
|
712 |
<chapter id="xmltypes">
|
| 648 |
<beginpage/>
|
713 |
<beginpage/>
|
| 649 |
<title>XML Types</title>
|
714 |
<title>XML Types</title>
|
| 650 |
<para>This chapter bundles the documentation for common XML types used
|
715 |
<para>This chapter bundles the documentation for common XML types used
|
| 651 |
by XServices web service.</para>
|
716 |
by XServices web service.</para>
|
| 652 |
<section version="5.0" xml:base="Types.xml" xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude">
|
717 |
<section version="5.0" xml:base="Types.xml" xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude">
|
| 653 |
<!-- Sort alphabetically -->
|
718 |
<!-- Sort alphabetically -->
|
| 654 |
<section xml:base="types/AntProperty.xml">
|
719 |
<section xml:base="types/AntProperty.xml">
|
| 655 |
<title>AntProperty type</title>
|
720 |
<title>AntProperty type</title>
|
| 656 |
<para>The AntProperty type defines a list of key/value pairs.</para>
|
721 |
<para>The AntProperty type defines a list of key/value pairs.</para>
|
| 657 |
<para>
|
722 |
<para>
|
| 658 |
The defining Java class is
|
723 |
The defining Java class is
|
| 659 |
<ulink url="javadoc/net/brutex/xservices/types/AntProperty.html">
|
724 |
<ulink url="javadoc/net/brutex/xservices/types/AntProperty.html">
|
| 660 |
<classname>net.brutex.xservices.types.AntProperty</classname>
|
725 |
<classname>net.brutex.xservices.types.AntProperty</classname>
|
| 661 |
</ulink>
|
726 |
</ulink>
|
| 662 |
.
|
727 |
.
|
| 663 |
</para>
|
728 |
</para>
|
| 664 |
|
729 |
|
| 665 |
<programlisting language="xml"><![CDATA[
|
730 |
<programlisting language="xml"><![CDATA[
|
| 666 |
<xs:complexType name="antProperty">
|
731 |
<xs:complexType name="antProperty">
|
| 667 |
<xs:sequence>
|
732 |
<xs:sequence>
|
| 668 |
<xs:element name="name" type="xs:string"/>
|
733 |
<xs:element name="name" type="xs:string"/>
|
| 669 |
<xs:element name="value" type="xs:string"/>
|
734 |
<xs:element name="value" type="xs:string"/>
|
| 670 |
</xs:sequence>
|
735 |
</xs:sequence>
|
| 671 |
</xs:complexType>]]>
|
736 |
</xs:complexType>]]>
|
| 672 |
</programlisting>
|
737 |
</programlisting>
|
| 673 |
|
738 |
|
| 674 |
<programlisting language="xml"><![CDATA[
|
739 |
<programlisting language="xml"><![CDATA[
|
| 675 |
<AntProperty>
|
740 |
<AntProperty>
|
| 676 |
<name>key2</name>
|
741 |
<name>key2</name>
|
| 677 |
<value>value2</value>
|
742 |
<value>value2</value>
|
| 678 |
</AntProperty>]]>
|
743 |
</AntProperty>]]>
|
| 679 |
</programlisting>
|
744 |
</programlisting>
|
| 680 |
</section>
|
745 |
</section>
|
| 681 |
<section xml:base="types/FileResource.xml">
|
746 |
<section xml:base="types/FileResource.xml">
|
| 682 |
<title>FileResource type</title>
|
747 |
<title>FileResource type</title>
|
| 683 |
<para>The FileResource type defines an URI to a file with optional on-the-fly decompression.</para>
|
748 |
<para>The FileResource type defines an URI to a file with optional on-the-fly decompression.</para>
|
| 684 |
<para>
|
749 |
<para>
|
| 685 |
The defining Java class is
|
750 |
The defining Java class is
|
| 686 |
<ulink url="javadoc/net/brutex/xservices/types/FileResource.html">
|
751 |
<ulink url="javadoc/net/brutex/xservices/types/FileResource.html">
|
| 687 |
<classname>net.brutex.xservices.types.FileResource</classname>
|
752 |
<classname>net.brutex.xservices.types.FileResource</classname>
|
| 688 |
</ulink>
|
753 |
</ulink>
|
| 689 |
.
|
754 |
.
|
| 690 |
</para>
|
755 |
</para>
|
| 691 |
|
756 |
|
| 692 |
<programlisting language="xml"><![CDATA[
|
757 |
<programlisting language="xml"><![CDATA[
|
| 693 |
<xs:complexType name="FileResourceType">
|
758 |
<xs:complexType name="FileResourceType">
|
| 694 |
<xs:sequence>
|
759 |
<xs:sequence>
|
| 695 |
<xs:element default="FILE" name="type" type="tns:type"/>
|
760 |
<xs:element default="FILE" name="type" type="tns:type"/>
|
| 696 |
<xs:element name="uri" type="xs:string"/>
|
761 |
<xs:element name="uri" type="xs:string"/>
|
| 697 |
</xs:sequence>
|
762 |
</xs:sequence>
|
| 698 |
</xs:complexType>]]>
|
763 |
</xs:complexType>]]>
|
| 699 |
</programlisting>
|
764 |
</programlisting>
|
| 700 |
<para>Available types:</para>
|
765 |
<para>Available types:</para>
|
| 701 |
<para>FILE: URI points to a local file resource. Examples: c:\temp\something.txt, c:/dir/another.file, /home/brian/file</para>
|
766 |
<para>FILE: URI points to a local file resource. Examples: c:\temp\something.txt, c:/dir/another.file, /home/brian/file</para>
|
| 702 |
<para>URL: File from URL (http, https, ftp, ...). Example: http://brutex.net/file.pdf</para>
|
767 |
<para>URL: File from URL (http, https, ftp, ...). Example: http://brutex.net/file.pdf</para>
|
| 703 |
<para>GZIP and BZIP2: File from a local file system with on-the-fly decompression.</para>
|
768 |
<para>GZIP and BZIP2: File from a local file system with on-the-fly decompression.</para>
|
| 704 |
<programlisting language="xml"><![CDATA[
|
769 |
<programlisting language="xml"><![CDATA[
|
| 705 |
<resource>
|
770 |
<resource>
|
| 706 |
<type>FILE</type>
|
771 |
<type>FILE</type>
|
| 707 |
<uri>c:\temp\xservices.war</uri>
|
772 |
<uri>c:\temp\xservices.war</uri>
|
| 708 |
</resource>]]>
|
773 |
</resource>]]>
|
| 709 |
</programlisting>
|
774 |
</programlisting>
|
| 710 |
</section>
|
775 |
</section>
|
| 711 |
<section id="hostconnection" version="5.0" xml:base="types/HostConnection.xml" xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude">
|
776 |
<section id="hostconnection" version="5.0" xml:base="types/HostConnection.xml" xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude">
|
| 712 |
<title>HostConnection type</title>
|
777 |
<title>HostConnection type</title>
|
| 713 |
<para>The HostConnection type identifies a server resource and login
|
778 |
<para>The HostConnection type identifies a server resource and login
|
| 714 |
credentials.</para>
|
779 |
credentials.</para>
|
| 715 |
<para>
|
780 |
<para>
|
| 716 |
The defining Java class is
|
781 |
The defining Java class is
|
| 717 |
<ulink url="javadoc/net/brutex/xservices/types/HostConnection.html">
|
782 |
<ulink url="javadoc/net/brutex/xservices/types/HostConnection.html">
|
| 718 |
<classname>net.brutex.xservices.types.HostConnection</classname>
|
783 |
<classname>net.brutex.xservices.types.HostConnection</classname>
|
| 719 |
</ulink>
|
784 |
</ulink>
|
| 720 |
.
|
785 |
.
|
| 721 |
</para>
|
786 |
</para>
|
| 722 |
<bridgehead renderas="sect3">Schema definition</bridgehead>
|
787 |
<bridgehead renderas="sect3">Schema definition</bridgehead>
|
| 723 |
<programlisting language="xml"><![CDATA[
|
788 |
<programlisting language="xml"><![CDATA[
|
| 724 |
<xs:complexType name="connection">
|
789 |
<xs:complexType name="connection">
|
| 725 |
<xs:sequence>
|
790 |
<xs:sequence>
|
| 726 |
<xs:element name="hostname" type="xs:string"/>
|
791 |
<xs:element name="hostname" type="xs:string"/>
|
| 727 |
<xs:element name="port" type="xs:int"/>
|
792 |
<xs:element name="port" type="xs:int"/>
|
| 728 |
<xs:element minOccurs="0" name="user" type="xs:string"/>
|
793 |
<xs:element minOccurs="0" name="user" type="xs:string"/>
|
| 729 |
<xs:element minOccurs="0" name="password" type="xs:string"/>
|
794 |
<xs:element minOccurs="0" name="password" type="xs:string"/>
|
| 730 |
</xs:sequence>
|
795 |
</xs:sequence>
|
| 731 |
</xs:complexType>
|
796 |
</xs:complexType>
|
| 732 |
]]>
|
797 |
]]>
|
| 733 |
</programlisting>
|
798 |
</programlisting>
|
| 734 |
<bridgehead renderas="sect3">Example XML</bridgehead>
|
799 |
<bridgehead renderas="sect3">Example XML</bridgehead>
|
| 735 |
<programlisting language="xml"><![CDATA[
|
800 |
<programlisting language="xml"><![CDATA[
|
| 736 |
<host>
|
801 |
<host>
|
| 737 |
<hostname>server.brutex.net</hostname>
|
802 |
<hostname>server.brutex.net</hostname>
|
| 738 |
<port>512</port> <!-- default rExec port -->
|
803 |
<port>512</port> <!-- default rExec port -->
|
| 739 |
<user>brian</user>
|
804 |
<user>brian</user>
|
| 740 |
<!--Optional:-->
|
805 |
<!--Optional:-->
|
| 741 |
<password>somepass</password>
|
806 |
<password>somepass</password>
|
| 742 |
</host>
|
807 |
</host>
|
| 743 |
]]>
|
808 |
]]>
|
| 744 |
</programlisting>
|
809 |
</programlisting>
|
| 745 |
</section>
|
810 |
</section>
|
| 746 |
<section id="patternelement" version="5.0" xml:base="types/PatternElement.xml" xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude">
|
811 |
<section id="patternelement" version="5.0" xml:base="types/PatternElement.xml" xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude">
|
| 747 |
<title>PatternElement type</title>
|
812 |
<title>PatternElement type</title>
|
| 748 |
<para>The PatternElement type defines single string pattern for file/
|
813 |
<para>The PatternElement type defines single string pattern for file/
|
| 749 |
directory matching.</para>
|
814 |
directory matching.</para>
|
| 750 |
<para>
|
815 |
<para>
|
| 751 |
The defining Java class is
|
816 |
The defining Java class is
|
| 752 |
<ulink url="javadoc/net/brutex/xservices/types/PatternElement.html">
|
817 |
<ulink url="javadoc/net/brutex/xservices/types/PatternElement.html">
|
| 753 |
<classname>net.brutex.xservices.types.PatternElement</classname>
|
818 |
<classname>net.brutex.xservices.types.PatternElement</classname>
|
| 754 |
</ulink>
|
819 |
</ulink>
|
| 755 |
.
|
820 |
.
|
| 756 |
</para>
|
821 |
</para>
|
| 757 |
<para>
|
822 |
<para>
|
| 758 |
These patterns look exactly like those used in Apache Ant
|
823 |
These patterns look exactly like those used in Apache Ant
|
| 759 |
<ulink url="http://ant.apache.org/manual/dirtasks.html#patterns">Patterns</ulink>.
|
824 |
<ulink url="http://ant.apache.org/manual/dirtasks.html#patterns">Patterns</ulink>.
|
| 760 |
The '*' matches zero or more characters and the
|
825 |
The '*' matches zero or more characters and the
|
| 761 |
'?' will match a single character.
|
826 |
'?' will match a single character.
|
| 762 |
Both symbols can be combined in one pattern. The '**'
|
827 |
Both symbols can be combined in one pattern. The '**'
|
| 763 |
symbol can be used to match any directory deepth.
|
828 |
symbol can be used to match any directory deepth.
|
| 764 |
</para>
|
829 |
</para>
|
| 765 |
<para>Some example patterns:</para>
|
830 |
<para>Some example patterns:</para>
|
| 766 |
<para>
|
831 |
<para>
|
| 767 |
<parameter>**/mydir/**</parameter>
|
832 |
<parameter>**/mydir/**</parameter>
|
| 768 |
</para>
|
833 |
</para>
|
| 769 |
<para>Match all file that are located in any directory that has
|
834 |
<para>Match all file that are located in any directory that has
|
| 770 |
"mydir" string in its pathname. Also applies to files with
|
835 |
"mydir" string in its pathname. Also applies to files with
|
| 771 |
"mydir" in their name.</para>
|
836 |
"mydir" in their name.</para>
|
| 772 |
<para>
|
837 |
<para>
|
| 773 |
<parameter>/mydir/</parameter>
|
838 |
<parameter>/mydir/</parameter>
|
| 774 |
</para>
|
839 |
</para>
|
| 775 |
<para>The
|
840 |
<para>The
|
| 776 |
parser will automatically append an '**' symbol, thus the
|
841 |
parser will automatically append an '**' symbol, thus the
|
| 777 |
resulting pattern is
|
842 |
resulting pattern is
|
| 778 |
<parameter>/mydir/**</parameter>.
|
843 |
<parameter>/mydir/**</parameter>.
|
| 779 |
All files below the "/mydir/" directory (including its
|
844 |
All files below the "/mydir/" directory (including its
|
| 780 |
sub-directories will be chosen.
|
845 |
sub-directories will be chosen.
|
| 781 |
</para>
|
846 |
</para>
|
| 782 |
<note>
|
847 |
<note>
|
| 783 |
<para>The pattern is OS independent. You should always use
|
848 |
<para>The pattern is OS independent. You should always use
|
| 784 |
"/" as path separator, even on windows based systems.
|
849 |
"/" as path separator, even on windows based systems.
|
| 785 |
</para>
|
850 |
</para>
|
| 786 |
</note>
|
851 |
</note>
|
| 787 |
<bridgehead renderas="sect3">Schema definition</bridgehead>
|
852 |
<bridgehead renderas="sect3">Schema definition</bridgehead>
|
| 788 |
<programlisting language="xml"><![CDATA[<xs:simpleType name="patternElement">
|
853 |
<programlisting language="xml"><![CDATA[<xs:simpleType name="patternElement">
|
| 789 |
<xs:restriction base="xs:string"/>
|
854 |
<xs:restriction base="xs:string"/>
|
| 790 |
</xs:simpleType>]]></programlisting>
|
855 |
</xs:simpleType>]]></programlisting>
|
| 791 |
|
856 |
|
| 792 |
<bridgehead renderas="sect3">Example XML</bridgehead>
|
857 |
<bridgehead renderas="sect3">Example XML</bridgehead>
|
| 793 |
<programlisting language="xml"><![CDATA[<PatternElement>**/*</PatternElement>]]></programlisting>
|
858 |
<programlisting language="xml"><![CDATA[<PatternElement>**/*</PatternElement>]]></programlisting>
|
| 794 |
|
859 |
|
| 795 |
</section>
|
860 |
</section>
|
| 796 |
<section id="patternsettype" version="5.0" xml:base="types/PatternSetType.xml" xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude">
|
861 |
<section id="patternsettype" version="5.0" xml:base="types/PatternSetType.xml" xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude">
|
| 797 |
<title>PatternSetType type</title>
|
862 |
<title>PatternSetType type</title>
|
| 798 |
<para>The PatternSetType exposes various filters/ selectors for the
|
863 |
<para>The PatternSetType exposes various filters/ selectors for the
|
| 799 |
selection of resources (files).</para>
|
864 |
selection of resources (files).</para>
|
| 800 |
<para>
|
865 |
<para>
|
| 801 |
The defining Java class is
|
866 |
The defining Java class is
|
| 802 |
<ulink url="javadoc/net/brutex/xservices/types/PatternSetType.html">
|
867 |
<ulink url="javadoc/net/brutex/xservices/types/PatternSetType.html">
|
| 803 |
<classname>net.brutex.xservices.types.PatternSetType</classname>
|
868 |
<classname>net.brutex.xservices.types.PatternSetType</classname>
|
| 804 |
</ulink>
|
869 |
</ulink>
|
| 805 |
.
|
870 |
.
|
| 806 |
</para>
|
871 |
</para>
|
| 807 |
<bridgehead renderas="sect3">Schema definition</bridgehead>
|
872 |
<bridgehead renderas="sect3">Schema definition</bridgehead>
|
| 808 |
<programlisting language="xml"><![CDATA[
|
873 |
<programlisting language="xml"><![CDATA[
|
| 809 |
<xs:complexType name="patternSetType">
|
874 |
<xs:complexType name="patternSetType">
|
| 810 |
<xs:sequence>
|
875 |
<xs:sequence>
|
| 811 |
<xs:element default="**/*" maxOccurs="unbounded" minOccurs="0" name="include" type="]]><link linkend="patternelement">tns:patternElement</link><![CDATA["/>
|
876 |
<xs:element default="**/*" maxOccurs="unbounded" minOccurs="0" name="include" type="]]><link linkend="patternelement">tns:patternElement</link><![CDATA["/>
|
| 812 |
<xs:element maxOccurs="unbounded" minOccurs="0" name="exclude" type="]]><link linkend="patternelement">tns:patternElement</link><![CDATA["/>
|
877 |
<xs:element maxOccurs="unbounded" minOccurs="0" name="exclude" type="]]><link linkend="patternelement">tns:patternElement</link><![CDATA["/>
|
| 813 |
<xs:element minOccurs="0" name="selector" nillable="true" type="]]><link linkend="selectortype">tns:selectorType</link><![CDATA["/>
|
878 |
<xs:element minOccurs="0" name="selector" nillable="true" type="]]><link linkend="selectortype">tns:selectorType</link><![CDATA["/>
|
| 814 |
</xs:sequence>
|
879 |
</xs:sequence>
|
| 815 |
</xs:complexType>]]>
|
880 |
</xs:complexType>]]>
|
| 816 |
</programlisting>
|
881 |
</programlisting>
|
| 817 |
<bridgehead renderas="sect3">Example XML</bridgehead>
|
882 |
<bridgehead renderas="sect3">Example XML</bridgehead>
|
| 818 |
<programlisting language="xml"><![CDATA[
|
883 |
<programlisting language="xml"><![CDATA[
|
| 819 |
tbd.]]>
|
884 |
tbd.]]>
|
| 820 |
</programlisting>
|
885 |
</programlisting>
|
| 821 |
</section>
|
886 |
</section>
|
| 822 |
<section version="5.0" xml:base="types/ReturnCode.xml" xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude">
|
887 |
<section version="5.0" xml:base="types/ReturnCode.xml" xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude">
|
| 823 |
<title>ReturnCode type</title>
|
888 |
<title>ReturnCode type</title>
|
| 824 |
<para>
|
889 |
<para>
|
| 825 |
The ReturnCode type is used as the generic answer type for most of the
|
890 |
The ReturnCode type is used as the generic answer type for most of the
|
| 826 |
<application class="software">BruteXservices</application>
|
891 |
<application class="software">BruteXservices</application>
|
| 827 |
operations.
|
892 |
operations.
|
| 828 |
</para>
|
893 |
</para>
|
| 829 |
<para>
|
894 |
<para>
|
| 830 |
The defining Java class is
|
895 |
The defining Java class is
|
| 831 |
<ulink url="javadoc/net/brutex/xservices/types/ReturnCode.html">
|
896 |
<ulink url="javadoc/net/brutex/xservices/types/ReturnCode.html">
|
| 832 |
<classname>net.brutex.xservices.types.ReturnCode</classname>
|
897 |
<classname>net.brutex.xservices.types.ReturnCode</classname>
|
| 833 |
</ulink>
|
898 |
</ulink>
|
| 834 |
.
|
899 |
.
|
| 835 |
</para>
|
900 |
</para>
|
| 836 |
<bridgehead renderas="sect3">Schema definition</bridgehead>
|
901 |
<bridgehead renderas="sect3">Schema definition</bridgehead>
|
| 837 |
<programlisting language="xml"><![CDATA[
|
902 |
<programlisting language="xml"><![CDATA[
|
| 838 |
<xs:complexType name="ReturnCodeType">
|
903 |
<xs:complexType name="ReturnCodeType">
|
| 839 |
<xs:sequence>
|
904 |
<xs:sequence>
|
| 840 |
<xs:element name="returnCode" type="xs:int"/>
|
905 |
<xs:element name="returnCode" type="xs:int"/>
|
| 841 |
<xs:element minOccurs="0" name="stdOut" type="xs:string"/>
|
906 |
<xs:element minOccurs="0" name="stdOut" type="xs:string"/>
|
| 842 |
<xs:element minOccurs="0" name="stdErr" type="xs:string"/>
|
907 |
<xs:element minOccurs="0" name="stdErr" type="xs:string"/>
|
| 843 |
<xs:element maxOccurs="unbounded" minOccurs="0" name="propertyList" nillable="true" type="]]><link linkend="antproperty">tns:antProperty</link><![CDATA["/>
|
908 |
<xs:element maxOccurs="unbounded" minOccurs="0" name="propertyList" nillable="true" type="]]><link linkend="antproperty">tns:antProperty</link><![CDATA["/>
|
| 844 |
</xs:sequence>
|
909 |
</xs:sequence>
|
| 845 |
</xs:complexType>]]>
|
910 |
</xs:complexType>]]>
|
| 846 |
</programlisting>
|
911 |
</programlisting>
|
| 847 |
|
912 |
|
| 848 |
<bridgehead renderas="sect3">Example XML</bridgehead>
|
913 |
<bridgehead renderas="sect3">Example XML</bridgehead>
|
| 849 |
<programlisting language="xml">
|
914 |
<programlisting language="xml">
|
| 850 |
<ReturnCode
|
915 |
<ReturnCode
|
| 851 |
xmlns:ns2="http://ws.xservices.brutex.net">
|
916 |
xmlns:ns2="http://ws.xservices.brutex.net">
|
| 852 |
<returnCode>0</returnCode>
|
917 |
<returnCode>0</returnCode>
|
| 853 |
<stdOut/>
|
918 |
<stdOut/>
|
| 854 |
<stdErr/>
|
919 |
<stdErr/>
|
| 855 |
<propertyList>
|
920 |
<propertyList>
|
| 856 |
<lineannotation>
|
921 |
<lineannotation>
|
| 857 |
See
|
922 |
See
|
| 858 |
<link linkend="antproperty">tns:antProperty</link>
|
923 |
<link linkend="antproperty">tns:antProperty</link>
|
| 859 |
for details about the <propertyList> elements.
|
924 |
for details about the <propertyList> elements.
|
| 860 |
</lineannotation>
|
925 |
</lineannotation>
|
| 861 |
<name>key1</name>
|
926 |
<name>key1</name>
|
| 862 |
<value>value1</value>
|
927 |
<value>value1</value>
|
| 863 |
</propertyList>
|
928 |
</propertyList>
|
| 864 |
<propertyList>
|
929 |
<propertyList>
|
| 865 |
<name>key2</name>
|
930 |
<name>key2</name>
|
| 866 |
<value>value2</value>
|
931 |
<value>value2</value>
|
| 867 |
</propertyList>
|
932 |
</propertyList>
|
| 868 |
</ReturnCode>
|
933 |
</ReturnCode>
|
| 869 |
</programlisting>
|
934 |
</programlisting>
|
| 870 |
|
935 |
|
| 871 |
</section>
|
936 |
</section>
|
| 872 |
<section id="selectortype" version="5.0" xml:base="types/SelectorType.xml" xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude">
|
937 |
<section id="selectortype" version="5.0" xml:base="types/SelectorType.xml" xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude">
|
| 873 |
<title>SelectorType type</title>
|
938 |
<title>SelectorType type</title>
|
| 874 |
<para>The SelectorType exposes various selectors for the selection of resources (files).</para>
|
939 |
<para>The SelectorType exposes various selectors for the selection of resources (files).</para>
|
| 875 |
<para>The defining Java class is
|
940 |
<para>The defining Java class is
|
| 876 |
<ulink url="javadoc/net/brutex/xservices/types/SelectorType.html">
|
941 |
<ulink url="javadoc/net/brutex/xservices/types/SelectorType.html">
|
| 877 |
<classname>net.brutex.xservices.types.SelectorType</classname></ulink>.</para>
|
942 |
<classname>net.brutex.xservices.types.SelectorType</classname></ulink>.</para>
|
| 878 |
<bridgehead renderas="sect3">Schema definition</bridgehead>
|
943 |
<bridgehead renderas="sect3">Schema definition</bridgehead>
|
| 879 |
<programlisting language="xml"><![CDATA[
|
944 |
<programlisting language="xml"><![CDATA[
|
| 880 |
<xs:complexType abstract="true" name="selectorType">
|
945 |
<xs:complexType abstract="true" name="selectorType">
|
| 881 |
<xs:sequence>
|
946 |
<xs:sequence>
|
| 882 |
<xs:element maxOccurs="unbounded" minOccurs="0" name="contains" nillable="true" type="tns:containsSelectorType"/>
|
947 |
<xs:element maxOccurs="unbounded" minOccurs="0" name="contains" nillable="true" type="tns:containsSelectorType"/>
|
| 883 |
</xs:sequence>
|
948 |
</xs:sequence>
|
| 884 |
</xs:complexType>]]>
|
949 |
</xs:complexType>]]>
|
| 885 |
</programlisting>
|
950 |
</programlisting>
|
| 886 |
<bridgehead renderas="sect3">Example XML</bridgehead>
|
951 |
<bridgehead renderas="sect3">Example XML</bridgehead>
|
| 887 |
<programlisting language="xml"><![CDATA[
|
952 |
<programlisting language="xml"><![CDATA[
|
| 888 |
tbd.]]>
|
953 |
tbd.]]>
|
| 889 |
</programlisting>
|
954 |
</programlisting>
|
| 890 |
</section>
|
955 |
</section>
|
| 891 |
</section>
|
956 |
</section>
|
| 892 |
</chapter>
|
957 |
</chapter>
|
| 893 |
</book>
|
958 |
</book>
|
| 894 |
|
959 |
|
| 895 |
Generated by GNU Enscript 1.6.5.90.
|
960 |
Generated by GNU Enscript 1.6.5.90.
|
| 896 |
|
961 |
|
| 897 |
|
962 |
|