| 59 |
brianR |
1 |
<?xml version='1.0' encoding='utf-8'?>
|
|
|
2 |
<!DOCTYPE section [
|
|
|
3 |
<!ENTITY % myent SYSTEM "../entities.ent">
|
|
|
4 |
%myent;
|
|
|
5 |
]>
|
|
|
6 |
<section xmlns="http://docbook.org/ns/docbook" version="5.0"
|
|
|
7 |
xmlns:xi="http://www.w3.org/2001/XInclude">
|
|
|
8 |
<title>runCommand</title>
|
|
|
9 |
<para>Run an executable with arguments on the server providing the web
|
|
|
10 |
service. The command is run within the environment and under the user
|
|
|
11 |
privileges of the user who is running the Tomcat Server.</para>
|
|
|
12 |
<section>
|
|
|
13 |
<title>&inp;
|
|
|
14 |
</title>
|
|
|
15 |
<para />
|
|
|
16 |
<table frame="all">
|
|
|
17 |
<title>runCommand input parameters</title>
|
|
|
18 |
<tgroup cols="4">
|
|
|
19 |
<colspec colnum="1" colname="parameter" />
|
|
|
20 |
<colspec colnum="2" colname="type" />
|
|
|
21 |
<colspec colnum="3" colname="required" />
|
|
|
22 |
<colspec colnum="4" colname="description" />
|
|
|
23 |
<thead>
|
|
|
24 |
<row>
|
|
|
25 |
<entry>parameter</entry>
|
|
|
26 |
<entry>type</entry>
|
|
|
27 |
<entry>required</entry>
|
|
|
28 |
<entry>description</entry>
|
|
|
29 |
</row>
|
|
|
30 |
</thead>
|
|
|
31 |
<tbody>
|
|
|
32 |
<row>
|
|
|
33 |
<entry>executable</entry>
|
|
|
34 |
<entry>String</entry>
|
|
|
35 |
<entry>Yes</entry>
|
|
|
36 |
<entry>Command to be run. The command may be specified with full
|
|
|
37 |
path using forward slash "/" as path separator.</entry>
|
|
|
38 |
</row>
|
|
|
39 |
<row>
|
|
|
40 |
<entry>argline</entry>
|
|
|
41 |
<entry>String</entry>
|
|
|
42 |
<entry>No</entry>
|
|
|
43 |
<entry>Any command line arguments</entry>
|
|
|
44 |
</row>
|
| 24 |
brianR |
45 |
¶m-timeout;
|
| 59 |
brianR |
46 |
</tbody>
|
|
|
47 |
</tgroup>
|
|
|
48 |
</table>
|
|
|
49 |
<para />
|
|
|
50 |
</section>
|
|
|
51 |
<section>
|
|
|
52 |
<title>&outp;
|
|
|
53 |
</title>
|
|
|
54 |
<xi:include href="../types/ReturnCode.xml" />
|
|
|
55 |
</section>
|
| 163 |
brianR |
56 |
<section>
|
|
|
57 |
<para>
|
|
|
58 |
Sample request: Start Windows Command Interpreter and print "Hello World" to STDOUT.
|
|
|
59 |
<programlisting language="xml">
|
|
|
60 |
<![CDATA[<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ws="http://ws.xservices.brutex.net">
|
|
|
61 |
<soapenv:Header/>
|
|
|
62 |
<soapenv:Body>
|
|
|
63 |
<ws:runCommand>
|
|
|
64 |
<executable>c:/windows/system32/cmd.exe</executable>
|
|
|
65 |
<argline>/C "echo Hallo Welt!"</argline>
|
|
|
66 |
<timeout>3000</timeout>
|
|
|
67 |
</ws:runCommand>
|
|
|
68 |
</soapenv:Body>
|
|
|
69 |
</soapenv:Envelope>]]>
|
|
|
70 |
</programlisting>
|
|
|
71 |
|
|
|
72 |
Sample response:
|
|
|
73 |
<programlisting language="xml">
|
|
|
74 |
<![CDATA[<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
|
|
|
75 |
<soap:Body>
|
|
|
76 |
<ns2:runCommandResponse xmlns:ns2="http://ws.xservices.brutex.net">
|
|
|
77 |
<return>
|
|
|
78 |
<returnCode>0</returnCode>
|
|
|
79 |
<stdOut/>
|
|
|
80 |
<stdErr/>
|
|
|
81 |
<propertyList>
|
|
|
82 |
<name>ExecuteService.result</name>
|
|
|
83 |
<value>0</value>
|
|
|
84 |
</propertyList>
|
|
|
85 |
<propertyList>
|
|
|
86 |
<name>ExecuteService.stdout</name>
|
|
|
87 |
<value>Hallo Welt!</value>
|
|
|
88 |
</propertyList>
|
|
|
89 |
<propertyList>
|
|
|
90 |
<name>ExecuteService.stderr</name>
|
|
|
91 |
<value/>
|
|
|
92 |
</propertyList>
|
|
|
93 |
</return>
|
|
|
94 |
</ns2:runCommandResponse>
|
|
|
95 |
</soap:Body>
|
|
|
96 |
</soap:Envelope>]]></programlisting></para></section>
|
|
|
97 |
<section>
|
|
|
98 |
<para>
|
|
|
99 |
Sample request: Start notepad.exe and close it after 15 seconds.
|
|
|
100 |
<programlisting language="xml">
|
|
|
101 |
<![CDATA[<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ws="http://ws.xservices.brutex.net">
|
|
|
102 |
<soapenv:Header/>
|
|
|
103 |
<soapenv:Body>
|
|
|
104 |
<ws:runCommand>
|
|
|
105 |
<executable>c:/windows/system32/notepad.exe</executable>
|
|
|
106 |
<argline></argline>
|
|
|
107 |
<timeout>15000</timeout>
|
|
|
108 |
</ws:runCommand>
|
|
|
109 |
</soapenv:Body>
|
|
|
110 |
</soapenv:Envelope>]]></programlisting></para></section>
|
| 24 |
brianR |
111 |
</section>
|