Subversion Repositories XServices

Compare Revisions

No changes between revisions

Ignore whitespace Rev 166 → Rev 180

/xservices/branches/xservices-jre7/doc/ExecuteServices/ExecuteServices.xml
0,0 → 1,18
<?xml version='1.0' encoding="utf-8"?>
<section xmlns="http://docbook.org/ns/docbook" version="5.0"
xmlns:xi="http://www.w3.org/2001/XInclude"
id="executeservices">
<title>ExecuteServices</title>
<para>The ExecuteService bundles local and remote command
execution operations. Its WSDL is located at
http://server:port/XServices/ExecuteService?wsdl</para>
<xi:include href="./rExec.xml" />
<xi:include href="./runCommand.xml" />
<xi:include href="./runCommandAsync.xml" />
<xi:include href="./runCommandAsyncWithArgs.xml" />
<xi:include href="./runCommandWithArgs.xml" />
<xi:include href="./runCommandWithSSH.xml" />
<xi:include href="./runCommandWithSSHKeyAuth.xml" />
<xi:include href="./runJavaScript.xml" />
<xi:include href="./telnet.xml" />
</section>
/xservices/branches/xservices-jre7/doc/ExecuteServices/runCommandWithSSHKeyAuth.xml
0,0 → 1,11
<?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>runCommandWithSSHKeyAuth</title>
<para>Executes a command through a SSH session.</para>
</section>
Property changes:
Added: svn:mime-type
+text/plain
\ No newline at end of property
/xservices/branches/xservices-jre7/doc/ExecuteServices/runCommandAsyncWithArgs.xml
0,0 → 1,13
<?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>runCommandAsyncWithArgs</title>
<para>Run an executable with arguments on the server providing the web
service and don't wait for the executable to finish.
The command is run within the environment and under the user
privileges of the user who is running the Tomcat Server.</para>
</section>
Property changes:
Added: svn:mime-type
+text/plain
\ No newline at end of property
/xservices/branches/xservices-jre7/doc/ExecuteServices/runJavaScript.xml
0,0 → 1,10
<?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>runJavaScript</title>
<para>Execute a JavaScript and or Java program using Mozilla Rhino JIT-Compiler.</para>
</section>
Property changes:
Added: svn:mime-type
+text/plain
\ No newline at end of property
/xservices/branches/xservices-jre7/doc/ExecuteServices/runCommandWithArgs.xml
0,0 → 1,12
<?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>runCommandWithArgs</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>
Property changes:
Added: svn:mime-type
+text/plain
\ No newline at end of property
/xservices/branches/xservices-jre7/doc/ExecuteServices/runCommandAsync.xml
0,0 → 1,13
<?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>runCommandAsync</title>
<para>Run an executable with arguments on the server providing the web
service and don't wait for the executable to finish.
The command is run within the environment and under the user
privileges of the user who is running the Tomcat Server.</para>
</section>
Property changes:
Added: svn:mime-type
+text/plain
\ No newline at end of property
/xservices/branches/xservices-jre7/doc/ExecuteServices/runCommand.xml
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 &quot;/&quot; as path separator.</entry>
</row>
<row>
<entry>argline</entry>
<entry>String</entry>
<entry>No</entry>
<entry>Any command line arguments</entry>
</row>
&param-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>
/xservices/branches/xservices-jre7/doc/ExecuteServices/rExec.xml
0,0 → 1,62
<?xml version='1.0' encoding='utf-8'?>
<!DOCTYPE section [
<!ENTITY % myent SYSTEM "../entities.ent">
<!ENTITY rExec "rExec">
%myent;
]>
<section xmlns="http://docbook.org/ns/docbook" version="5.0"
xmlns:xi="http://www.w3.org/2001/XInclude">
<title>&rExec;
</title>
<para>provides remote execution facilities with authentication based on
user names and passwords.</para>
<section>
<title>&inp;
</title>
<para />
<table frame="all">
<title>&rExec;
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>host</entry>
<entry>HostConnection</entry>
<entry>Yes</entry>
<entry>
Host where to execute the command. See
<link linkend='hostconnection'>HostConnection</link>
.
</entry>
</row>
<row>
<entry>command</entry>
<entry>String</entry>
<entry>No</entry>
<entry>Any command including arguments</entry>
</row>
&param-timeout;
</tbody>
</tgroup>
</table>
<para />
</section>
<section>
<title>&outp;
</title>
<xi:include href="../types/ReturnCode.xml" />
</section>
</section>
Property changes:
Added: svn:mime-type
+text/plain
\ No newline at end of property
/xservices/branches/xservices-jre7/doc/ExecuteServices/telnet.xml
0,0 → 1,83
<?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>telnet</title>
<para>Runs a telnet session with an "expect shell" like behaviour.</para>
<section>
<title>&inp;
</title>
<para />
<table frame="all">
<title>telnet 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>host</entry>
<entry>HostConnection</entry>
<entry>Yes</entry>
<entry>Host to connect to (see: <link linkend="hostconnection">tns:HostConnection</link>)</entry>
</row>
<row>
<entry>prompt</entry>
<entry>String</entry>
<entry>No</entry>
<entry>The prompt string to expect after login. This is used to recognize when
the session is open.</entry>
</row>
<row>
<entry>command</entry>
<entry>String</entry>
<entry>No</entry>
<entry>The command to execute.</entry>
</row>
<row>
<entry>expect</entry>
<entry>String</entry>
<entry>No</entry>
<entry>The prompt to expect after the command has been executed successfully.</entry>
</row>
&param-timeout;
</tbody>
</tgroup>
</table>
<para />
</section>
<section>
<title>&outp;</title>
<xi:include href="../types/ReturnCode.xml" />
</section>
<section>
<title>Sample Request:</title>
<programlisting language="xml">
<![CDATA[
<ws:telnet>
<host>
<hostname>localhost</hostname>
<port>23</port>
<user>brosenberger</user>
<password></password>
</host>
<prompt>C:\Users\brosenberger&gt;</prompt>
<command>dir c:\temp</command>
<expect>enberger&gt;</expect>
<timeout>60000</timeout>
</ws:telnet>
]]></programlisting>
</section>
</section>
Property changes:
Added: svn:mime-type
+text/plain
\ No newline at end of property
/xservices/branches/xservices-jre7/doc/ExecuteServices/runCommandWithSSH.xml
0,0 → 1,73
<?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>runCommandWithSSH</title>
<para>Executes a command through a SSH session.</para>
<section>
<title>&inp;
</title>
<para />
<table frame="all">
<title>runCommandWithSSH 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>host</entry>
<entry>HostConnection</entry>
<entry>Yes</entry>
<entry>
Host to connect to (see:
<link linkend="hostconnection">tns:HostConnection</link>
)
</entry>
</row>
<row>
<entry>command</entry>
<entry>String</entry>
<entry>No</entry>
<entry>The command to execute.</entry>
</row>
&param-timeout;
</tbody>
</tgroup>
</table>
<para />
</section>
<section>
<title>&outp;
</title>
<xi:include href="../types/ReturnCode.xml" />
</section>
<section>
<title>Sample Request:</title>
<programlisting language="xml">
<![CDATA[
<ws:runCommandWithSSH>
<host>
<hostname>ssh.brutex.net</hostname>
<port>22</port>
<user>roger</user>
<password>xxx</password>
</host>
<command>ls /etc/</command>
<timeout>30000</timeout>
</ws:runCommandWithSSH>
]]></programlisting>
</section>
</section>
Property changes:
Added: svn:mime-type
+text/plain
\ No newline at end of property