| 0,0 → 1,111 |
|---|
| <?xml version='1.0' encoding='utf-8'?> |
| <!DOCTYPE section [ |
| <!ENTITY % myent SYSTEM "../entities.ent"> |
| %myent; |
| ]> |
| <section xmlns="http://docbook.org/ns/docbook" version="5.0" |
| xmlns:xi="http://www.w3.org/2001/XInclude"> |
| <title>runCommand</title> |
| <para>Run an executable with arguments on the server providing the web |
| service. The command is run within the environment and under the user |
| privileges of the user who is running the Tomcat Server.</para> |
| <section> |
| <title>&inp; |
| </title> |
| <para /> |
| <table frame="all"> |
| <title>runCommand input parameters</title> |
| <tgroup cols="4"> |
| <colspec colnum="1" colname="parameter" /> |
| <colspec colnum="2" colname="type" /> |
| <colspec colnum="3" colname="required" /> |
| <colspec colnum="4" colname="description" /> |
| <thead> |
| <row> |
| <entry>parameter</entry> |
| <entry>type</entry> |
| <entry>required</entry> |
| <entry>description</entry> |
| </row> |
| </thead> |
| <tbody> |
| <row> |
| <entry>executable</entry> |
| <entry>String</entry> |
| <entry>Yes</entry> |
| <entry>Command to be run. The command may be specified with full |
| path using forward slash "/" as path separator.</entry> |
| </row> |
| <row> |
| <entry>argline</entry> |
| <entry>String</entry> |
| <entry>No</entry> |
| <entry>Any command line arguments</entry> |
| </row> |
| ¶m-timeout; |
| </tbody> |
| </tgroup> |
| </table> |
| <para /> |
| </section> |
| <section> |
| <title>&outp; |
| </title> |
| <xi:include href="../types/ReturnCode.xml" /> |
| </section> |
| <section> |
| <para> |
| Sample request: Start Windows Command Interpreter and print "Hello World" to STDOUT. |
| <programlisting language="xml"> |
| <![CDATA[<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ws="http://ws.xservices.brutex.net"> |
| <soapenv:Header/> |
| <soapenv:Body> |
| <ws:runCommand> |
| <executable>c:/windows/system32/cmd.exe</executable> |
| <argline>/C "echo Hallo Welt!"</argline> |
| <timeout>3000</timeout> |
| </ws:runCommand> |
| </soapenv:Body> |
| </soapenv:Envelope>]]> |
| </programlisting> |
| |
| Sample response: |
| <programlisting language="xml"> |
| <![CDATA[<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> |
| <soap:Body> |
| <ns2:runCommandResponse xmlns:ns2="http://ws.xservices.brutex.net"> |
| <return> |
| <returnCode>0</returnCode> |
| <stdOut/> |
| <stdErr/> |
| <propertyList> |
| <name>ExecuteService.result</name> |
| <value>0</value> |
| </propertyList> |
| <propertyList> |
| <name>ExecuteService.stdout</name> |
| <value>Hallo Welt!</value> |
| </propertyList> |
| <propertyList> |
| <name>ExecuteService.stderr</name> |
| <value/> |
| </propertyList> |
| </return> |
| </ns2:runCommandResponse> |
| </soap:Body> |
| </soap:Envelope>]]></programlisting></para></section> |
| <section> |
| <para> |
| Sample request: Start notepad.exe and close it after 15 seconds. |
| <programlisting language="xml"> |
| <![CDATA[<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ws="http://ws.xservices.brutex.net"> |
| <soapenv:Header/> |
| <soapenv:Body> |
| <ws:runCommand> |
| <executable>c:/windows/system32/notepad.exe</executable> |
| <argline></argline> |
| <timeout>15000</timeout> |
| </ws:runCommand> |
| </soapenv:Body> |
| </soapenv:Envelope>]]></programlisting></para></section> |
| </section> |