| /xservices/trunk/doc/html/miscservices.html |
|---|
| 0,0 → 1,2 |
| <html><head><META http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>MiscServices</title><link href="corpstyle.css" type="text/css" rel="stylesheet"><meta content="DocBook XSL-NS Stylesheets V1.76.1" name="generator"><link rel="home" href="index.html" title="Brutex XServices Documentation"><link rel="up" href="services.html" title="Chapter 2. Available Services"><link rel="prev" href="fileservices.html" title="FileServices"><link rel="next" href="xmltypes.html" title="Chapter 3. XML Types"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table summary="Navigation header" width="100%"><tr><th align="center" colspan="3">MiscServices</th></tr><tr><td align="left" width="20%"><a accesskey="p" href="fileservices.html">Prev</a> </td><th align="center" width="60%">Chapter 2. Available Services</th><td align="right" width="20%"> <a accesskey="n" href="xmltypes.html">Next</a></td></tr></table><hr></div><div class="breadcrumbs"><span class="breadcrumb-link"><a href="index.html">Brutex XServices Documentation</a></span> > <span class="breadcrumb-link"><a href="services.html">Available Services</a></span> > <span class="breadcrumb-node">MiscServices</span></div><div class="section" title="MiscServices"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="miscservices"></a>MiscServices</h2></div></div></div><p>The MiscService bundles various operations. Its WSDL is located at |
| http://server:port/XServices/MiscService?wsdl</p></div><div class="navfooter"><hr><table summary="Navigation footer" width="100%"><tr><td align="left" width="40%"><a accesskey="p" href="fileservices.html">Prev</a> </td><td align="center" width="20%"><a accesskey="u" href="services.html">Up</a></td><td align="right" width="40%"> <a accesskey="n" href="xmltypes.html">Next</a></td></tr><tr><td valign="top" align="left" width="40%">FileServices </td><td align="center" width="20%"><a accesskey="h" href="index.html">Home</a></td><td valign="top" align="right" width="40%"> Chapter 3. XML Types</td></tr></table></div></body></html> |
| Property changes: |
| Added: svn:mime-type |
| +text/plain |
| \ No newline at end of property |
| /xservices/trunk/doc/html/installation.html |
|---|
| 0,0 → 1,34 |
| <html><head><META http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>Chapter 1. Getting started</title><link href="corpstyle.css" type="text/css" rel="stylesheet"><meta content="DocBook XSL-NS Stylesheets V1.76.1" name="generator"><link rel="home" href="index.html" title="Brutex XServices Documentation"><link rel="up" href="index.html" title="Brutex XServices Documentation"><link rel="prev" href="index.html" title="Brutex XServices Documentation"><link rel="next" href="services.html" title="Chapter 2. Available Services"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table summary="Navigation header" width="100%"><tr><th align="center" colspan="3">Chapter 1. Getting started</th></tr><tr><td align="left" width="20%"><a accesskey="p" href="index.html">Prev</a> </td><th align="center" width="60%"> </th><td align="right" width="20%"> <a accesskey="n" href="services.html">Next</a></td></tr></table><hr></div><div class="breadcrumbs"><span class="breadcrumb-link"><a href="index.html">Brutex XServices Documentation</a></span> > <span class="breadcrumb-node">Getting started</span></div><div class="chapter" title="Chapter 1. Getting started"><div class="titlepage"><div><div><h2 class="title"><a name="installation"></a>Chapter 1. Getting started</h2></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="section"><a href="installation.html#N10042"></a></span></dt><dd><dl><dt><span class="section"><a href="installation.html#N10048">Installation</a></span></dt></dl></dd></dl></div><p>This chapter describes the installation.</p><div class="section"><div class="titlepage"></div><div class="section" title="Installation"><div class="titlepage"><div><div><h3 class="title"><a name="N10048"></a>Installation</h3></div></div></div><p>tbd.</p><p>Sun Java SE 1.6.0</p><p>Apache Tomcat 7</p><p>tbd.</p><p>In short: Deploy .WAR file to Apache Tomcat</p><div class="section" title="Securing with Basic Authentication"><div class="titlepage"><div><div><h4 class="title"><a name="N10055"></a>Securing with Basic Authentication</h4></div></div></div><p>There is a quick guide explaining Basic Authentication for Tomcat here: <a class="link" href="http://oreilly.com/pub/a/java/archive/tomcat-tips.html?page=1" target="_top"> |
| http://oreilly.com/pub/a/java/archive/tomcat-tips.html?page=1</a> |
| </p><p> |
| </p></div><div class="section" title="Limit access to"><div class="titlepage"><div><div><h4 class="title"><a name="N10060"></a>Limit access to</h4></div></div></div><p>Sometimes you'll only want to restrict access to to |
| only |
| specified host names or IP addresses. This way, only |
| clients at |
| those specified addresses can use the web services. |
| Tomcat provides |
| two configuration values for that: |
| RemoteHostValve and |
| RemoteAddrValve.</p><p>These Valves allow you to filter requests by host name or |
| by IP |
| address, and to allow or deny hosts that match. The |
| example below |
| restricts access to the ArchiveService from any |
| machine that is not |
| the local host.</p><pre class="programlisting"><Context |
| path="/XService/ArchiveService" |
| ...> <Valve |
| className="org.apache.catalina.valves.RemoteAddrValve" |
| allow="127.0.0.1" deny=""/> </Context> |
| </pre><p>If no allow pattern is given, then patterns that match |
| the deny |
| attribute patterns will be rejected, and all others |
| will be allowed. |
| Similarly, if no deny pattern is given, |
| patterns that match the |
| allow attribute will be allowed, and |
| all others will be denied. |
| </p><p>The <context> element must be placed into the |
| server.xml |
| file (into <engine><host>).</p></div></div></div></div><div class="navfooter"><hr><table summary="Navigation footer" width="100%"><tr><td align="left" width="40%"><a accesskey="p" href="index.html">Prev</a> </td><td align="center" width="20%"> </td><td align="right" width="40%"> <a accesskey="n" href="services.html">Next</a></td></tr><tr><td valign="top" align="left" width="40%">Brutex XServices Documentation </td><td align="center" width="20%"><a accesskey="h" href="index.html">Home</a></td><td valign="top" align="right" width="40%"> Chapter 2. Available Services</td></tr></table></div></body></html> |
| Property changes: |
| Added: svn:mime-type |
| +text/plain |
| \ No newline at end of property |
| /xservices/trunk/doc/html/fileservices.html |
|---|
| 0,0 → 1,2 |
| <html><head><META http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>FileServices</title><link href="corpstyle.css" type="text/css" rel="stylesheet"><meta content="DocBook XSL-NS Stylesheets V1.76.1" name="generator"><link rel="home" href="index.html" title="Brutex XServices Documentation"><link rel="up" href="services.html" title="Chapter 2. Available Services"><link rel="prev" href="executeservices.html" title="ExecuteServices"><link rel="next" href="miscservices.html" title="MiscServices"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table summary="Navigation header" width="100%"><tr><th align="center" colspan="3">FileServices</th></tr><tr><td align="left" width="20%"><a accesskey="p" href="executeservices.html">Prev</a> </td><th align="center" width="60%">Chapter 2. Available Services</th><td align="right" width="20%"> <a accesskey="n" href="miscservices.html">Next</a></td></tr></table><hr></div><div class="breadcrumbs"><span class="breadcrumb-link"><a href="index.html">Brutex XServices Documentation</a></span> > <span class="breadcrumb-link"><a href="services.html">Available Services</a></span> > <span class="breadcrumb-node">FileServices</span></div><div class="section" title="FileServices"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="fileservices"></a>FileServices</h2></div></div></div><p>The FileServces bundles various file operations. Its WSDL is located at |
| http://server:port/XServices/FileService?wsdl</p></div><div class="navfooter"><hr><table summary="Navigation footer" width="100%"><tr><td align="left" width="40%"><a accesskey="p" href="executeservices.html">Prev</a> </td><td align="center" width="20%"><a accesskey="u" href="services.html">Up</a></td><td align="right" width="40%"> <a accesskey="n" href="miscservices.html">Next</a></td></tr><tr><td valign="top" align="left" width="40%">ExecuteServices </td><td align="center" width="20%"><a accesskey="h" href="index.html">Home</a></td><td valign="top" align="right" width="40%"> MiscServices</td></tr></table></div></body></html> |
| Property changes: |
| Added: svn:mime-type |
| +text/plain |
| \ No newline at end of property |
| /xservices/trunk/doc/html/services.html |
|---|
| 0,0 → 1,5 |
| <html><head><META http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>Chapter 2. Available Services</title><link href="corpstyle.css" type="text/css" rel="stylesheet"><meta content="DocBook XSL-NS Stylesheets V1.76.1" name="generator"><link rel="home" href="index.html" title="Brutex XServices Documentation"><link rel="up" href="index.html" title="Brutex XServices Documentation"><link rel="prev" href="installation.html" title="Chapter 1. Getting started"><link rel="next" href="executeservices.html" title="ExecuteServices"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table summary="Navigation header" width="100%"><tr><th align="center" colspan="3">Chapter 2. Available Services</th></tr><tr><td align="left" width="20%"><a accesskey="p" href="installation.html">Prev</a> </td><th align="center" width="60%"> </th><td align="right" width="20%"> <a accesskey="n" href="executeservices.html">Next</a></td></tr></table><hr></div><div class="breadcrumbs"><span class="breadcrumb-link"><a href="index.html">Brutex XServices Documentation</a></span> > <span class="breadcrumb-node">Available Services</span></div><div class="chapter" title="Chapter 2. Available Services"><div class="titlepage"><div><div><h2 class="title"><a name="services"></a>Chapter 2. Available Services</h2></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="section"><a href="services.html#archiveservices">ArchiveServices</a></span></dt><dt><span class="section"><a href="executeservices.html">ExecuteServices</a></span></dt><dd><dl><dt><span class="section"><a href="executeservices.html#N10089">rExec |
| </a></span></dt><dt><span class="section"><a href="executeservices.html#N10104">runCommand</a></span></dt><dt><span class="section"><a href="executeservices.html#N1017B">runCommandWithSSH</a></span></dt><dt><span class="section"><a href="executeservices.html#N101FC">telnet</a></span></dt></dl></dd><dt><span class="section"><a href="fileservices.html">FileServices</a></span></dt><dt><span class="section"><a href="miscservices.html">MiscServices</a></span></dt></dl></div><p>List of available web services and their operations.</p><div class="section" title="ArchiveServices"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="archiveservices"></a>ArchiveServices</h2></div></div></div><p>The ArchiveService bundles file packing operations. Its |
| WSDL is |
| located at |
| http://server:port/XServices/ArchiveService?wsdl</p></div></div><div class="navfooter"><hr><table summary="Navigation footer" width="100%"><tr><td align="left" width="40%"><a accesskey="p" href="installation.html">Prev</a> </td><td align="center" width="20%"> </td><td align="right" width="40%"> <a accesskey="n" href="executeservices.html">Next</a></td></tr><tr><td valign="top" align="left" width="40%">Chapter 1. Getting started </td><td align="center" width="20%"><a accesskey="h" href="index.html">Home</a></td><td valign="top" align="right" width="40%"> ExecuteServices</td></tr></table></div></body></html> |
| Property changes: |
| Added: svn:mime-type |
| +text/plain |
| \ No newline at end of property |
| /xservices/trunk/doc/html/xmltypes.html |
|---|
| 0,0 → 1,160 |
| <html><head><META http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>Chapter 3. XML Types</title><link href="corpstyle.css" type="text/css" rel="stylesheet"><meta content="DocBook XSL-NS Stylesheets V1.76.1" name="generator"><link rel="home" href="index.html" title="Brutex XServices Documentation"><link rel="up" href="index.html" title="Brutex XServices Documentation"><link rel="prev" href="miscservices.html" title="MiscServices"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table summary="Navigation header" width="100%"><tr><th align="center" colspan="3">Chapter 3. XML Types</th></tr><tr><td align="left" width="20%"><a accesskey="p" href="miscservices.html">Prev</a> </td><th align="center" width="60%"> </th><td align="right" width="20%"> </td></tr></table><hr></div><div class="breadcrumbs"><span class="breadcrumb-link"><a href="index.html">Brutex XServices Documentation</a></span> > <span class="breadcrumb-node">XML Types</span></div><div class="chapter" title="Chapter 3. XML Types"><div class="titlepage"><div><div><h2 class="title"><a name="xmltypes"></a>Chapter 3. XML Types</h2></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="section"><a href="xmltypes.html#N102AA"></a></span></dt><dd><dl><dt><span class="section"><a href="xmltypes.html#N102B0">AntProperty type</a></span></dt><dt><span class="section"><a href="xmltypes.html#N102C5">FileResource type</a></span></dt><dt><span class="section"><a href="xmltypes.html#hostconnection">HostConnection type</a></span></dt><dt><span class="section"><a href="xmltypes.html#patternelement">PatternElement type</a></span></dt><dt><span class="section"><a href="xmltypes.html#patternsettype">PatternSetType type</a></span></dt><dt><span class="section"><a href="xmltypes.html#N10367">ReturnCode type</a></span></dt><dt><span class="section"><a href="xmltypes.html#selectortype">SelectorType type</a></span></dt></dl></dd></dl></div><p>This chapter bundles the documentation for common XML types used |
| by XServices web service.</p><div class="section"><div class="titlepage"></div><div class="section" title="AntProperty type"><div class="titlepage"><div><div><h3 class="title"><a name="N102B0"></a>AntProperty type</h3></div></div></div><p>The AntProperty type defines a list of key/value pairs.</p><p> |
| The defining Java class is |
| <a class="ulink" href="javadoc/net/brutex/xservices/types/AntProperty.html" target="_top"> |
| <code class="classname">net.brutex.xservices.types.AntProperty</code> |
| </a> |
| . |
| </p><pre class="programlisting"> |
| <xs:complexType name="antProperty"> |
| <xs:sequence> |
| <xs:element name="name" type="xs:string"/> |
| <xs:element name="value" type="xs:string"/> |
| </xs:sequence> |
| </xs:complexType> |
| </pre><pre class="programlisting"> |
| <AntProperty> |
| <name>key2</name> |
| <value>value2</value> |
| </AntProperty> |
| </pre></div><div class="section" title="FileResource type"><div class="titlepage"><div><div><h3 class="title"><a name="N102C5"></a>FileResource type</h3></div></div></div><p>The FileResource type defines an URI to a file with optional on-the-fly decompression.</p><p> |
| The defining Java class is |
| <a class="ulink" href="javadoc/net/brutex/xservices/types/FileResource.html" target="_top"> |
| <code class="classname">net.brutex.xservices.types.FileResource</code> |
| </a> |
| . |
| </p><pre class="programlisting"> |
| <xs:complexType name="FileResourceType"> |
| <xs:sequence> |
| <xs:element default="FILE" name="type" type="tns:type"/> |
| <xs:element name="uri" type="xs:string"/> |
| </xs:sequence> |
| </xs:complexType> |
| </pre><p>Available types:</p><p>FILE: URI points to a local file resource. Examples: c:\temp\something.txt, c:/dir/another.file, /home/brian/file</p><p>URL: File from URL (http, https, ftp, ...). Example: http://brutex.net/file.pdf</p><p>GZIP and BZIP2: File from a local file system with on-the-fly decompression.</p><pre class="programlisting"> |
| <resource> |
| <type>FILE</type> |
| <uri>c:\temp\xservices.war</uri> |
| </resource> |
| </pre></div><div class="section" title="HostConnection type"><div class="titlepage"><div><div><h3 class="title"><a name="hostconnection"></a>HostConnection type</h3></div></div></div><p>The HostConnection type identifies a server resource and login |
| credentials.</p><p> |
| The defining Java class is |
| <a class="ulink" href="javadoc/net/brutex/xservices/types/HostConnection.html" target="_top"> |
| <code class="classname">net.brutex.xservices.types.HostConnection</code> |
| </a> |
| . |
| </p><h4><a name="N102F5"></a>Schema definition</h4><pre class="programlisting"> |
| <xs:complexType name="connection"> |
| <xs:sequence> |
| <xs:element name="hostname" type="xs:string"/> |
| <xs:element name="port" type="xs:int"/> |
| <xs:element minOccurs="0" name="user" type="xs:string"/> |
| <xs:element minOccurs="0" name="password" type="xs:string"/> |
| </xs:sequence> |
| </xs:complexType> |
| </pre><h4><a name="N102FB"></a>Example XML</h4><pre class="programlisting"> |
| <host> |
| <hostname>server.brutex.net</hostname> |
| <port>512</port> <!-- default rExec port --> |
| <user>brian</user> |
| <!--Optional:--> |
| <password>somepass</password> |
| </host> |
| </pre></div><div class="section" title="PatternElement type"><div class="titlepage"><div><div><h3 class="title"><a name="patternelement"></a>PatternElement type</h3></div></div></div><p>The PatternElement type defines single string pattern for file/ |
| directory matching.</p><p> |
| The defining Java class is |
| <a class="ulink" href="javadoc/net/brutex/xservices/types/PatternElement.html" target="_top"> |
| <code class="classname">net.brutex.xservices.types.PatternElement</code> |
| </a> |
| . |
| </p><p> |
| These patterns look exactly like those used in Apache Ant |
| <a class="ulink" href="http://ant.apache.org/manual/dirtasks.html#patterns" target="_top">Patterns</a>. |
| The '*' matches zero or more characters and the |
| '?' will match a single character. |
| Both symbols can be combined in one pattern. The '**' |
| symbol can be used to match any directory deepth. |
| </p><p>Some example patterns:</p><p> |
| <em class="parameter"><code>**/mydir/**</code></em> |
| </p><p>Match all file that are located in any directory that has |
| "mydir" string in its pathname. Also applies to files with |
| "mydir" in their name.</p><p> |
| <em class="parameter"><code>/mydir/</code></em> |
| </p><p>The |
| parser will automatically append an '**' symbol, thus the |
| resulting pattern is |
| <em class="parameter"><code>/mydir/**</code></em>. |
| All files below the "/mydir/" directory (including its |
| sub-directories will be chosen. |
| </p><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><table border="0" summary="Note"><tr><td valign="top" align="center" rowspan="2" width="25"><img alt="[Note]" src="images/note.png"></td><th align="left">Note</th></tr><tr><td valign="top" align="left"><p>The pattern is OS independent. You should always use |
| "/" as path separator, even on windows based systems. |
| </p></td></tr></table></div><h4><a name="N10330"></a>Schema definition</h4><pre class="programlisting"><xs:simpleType name="patternElement"> |
| <xs:restriction base="xs:string"/> |
| </xs:simpleType></pre><h4><a name="N10336"></a>Example XML</h4><pre class="programlisting"><PatternElement>**/*</PatternElement></pre></div><div class="section" title="PatternSetType type"><div class="titlepage"><div><div><h3 class="title"><a name="patternsettype"></a>PatternSetType type</h3></div></div></div><p>The PatternSetType exposes various filters/ selectors for the |
| selection of resources (files).</p><p> |
| The defining Java class is |
| <a class="ulink" href="javadoc/net/brutex/xservices/types/PatternSetType.html" target="_top"> |
| <code class="classname">net.brutex.xservices.types.PatternSetType</code> |
| </a> |
| . |
| </p><h4><a name="N1034F"></a>Schema definition</h4><pre class="programlisting"> |
| <xs:complexType name="patternSetType"> |
| <xs:sequence> |
| <xs:element default="**/*" maxOccurs="unbounded" minOccurs="0" name="include" type="<a class="link" href="xmltypes.html#patternelement" title="PatternElement type">tns:patternElement</a>"/> |
| <xs:element maxOccurs="unbounded" minOccurs="0" name="exclude" type="<a class="link" href="xmltypes.html#patternelement" title="PatternElement type">tns:patternElement</a>"/> |
| <xs:element minOccurs="0" name="selector" nillable="true" type="<a class="link" href="xmltypes.html#selectortype" title="SelectorType type">tns:selectorType</a>"/> |
| </xs:sequence> |
| </xs:complexType> |
| </pre><h4><a name="N10361"></a>Example XML</h4><pre class="programlisting"> |
| tbd. |
| </pre></div><div class="section" title="ReturnCode type"><div class="titlepage"><div><div><h3 class="title"><a name="N10367"></a>ReturnCode type</h3></div></div></div><p> |
| The ReturnCode type is used as the generic answer type for most of the |
| <span class="application">BruteXservices</span> |
| operations. |
| </p><p> |
| The defining Java class is |
| <a class="ulink" href="javadoc/net/brutex/xservices/types/ReturnCode.html" target="_top"> |
| <code class="classname">net.brutex.xservices.types.ReturnCode</code> |
| </a> |
| . |
| </p><h4><a name="N1037D"></a>Schema definition</h4><pre class="programlisting"> |
| <xs:complexType name="ReturnCodeType"> |
| <xs:sequence> |
| <xs:element name="returnCode" type="xs:int"/> |
| <xs:element minOccurs="0" name="stdOut" type="xs:string"/> |
| <xs:element minOccurs="0" name="stdErr" type="xs:string"/> |
| <xs:element maxOccurs="unbounded" minOccurs="0" name="propertyList" nillable="true" type="<a class="link" href="">tns:antProperty</a>"/> |
| </xs:sequence> |
| </xs:complexType> |
| </pre><h4><a name="N10387"></a>Example XML</h4><pre class="programlisting"> |
| <ReturnCode |
| xmlns:ns2="http://ws.xservices.brutex.net"> |
| <returnCode>0</returnCode> |
| <stdOut/> |
| <stdErr/> |
| <propertyList> |
| <em class="lineannotation"><span class="lineannotation"> |
| See |
| <a class="link" href="">tns:antProperty</a> |
| for details about the <propertyList> elements. |
| </span></em> |
| <name>key1</name> |
| <value>value1</value> |
| </propertyList> |
| <propertyList> |
| <name>key2</name> |
| <value>value2</value> |
| </propertyList> |
| </ReturnCode> |
| </pre></div><div class="section" title="SelectorType type"><div class="titlepage"><div><div><h3 class="title"><a name="selectortype"></a>SelectorType type</h3></div></div></div><p>The SelectorType exposes various selectors for the selection of resources (files).</p><p>The defining Java class is |
| <a class="ulink" href="javadoc/net/brutex/xservices/types/SelectorType.html" target="_top"> |
| <code class="classname">net.brutex.xservices.types.SelectorType</code></a>.</p><h4><a name="N103A6"></a>Schema definition</h4><pre class="programlisting"> |
| <xs:complexType abstract="true" name="selectorType"> |
| <xs:sequence> |
| <xs:element maxOccurs="unbounded" minOccurs="0" name="contains" nillable="true" type="tns:containsSelectorType"/> |
| </xs:sequence> |
| </xs:complexType> |
| </pre><h4><a name="N103AC"></a>Example XML</h4><pre class="programlisting"> |
| tbd. |
| </pre></div></div></div><div class="navfooter"><hr><table summary="Navigation footer" width="100%"><tr><td align="left" width="40%"><a accesskey="p" href="miscservices.html">Prev</a> </td><td align="center" width="20%"> </td><td align="right" width="40%"> </td></tr><tr><td valign="top" align="left" width="40%">MiscServices </td><td align="center" width="20%"><a accesskey="h" href="index.html">Home</a></td><td valign="top" align="right" width="40%"> </td></tr></table></div></body></html> |
| Property changes: |
| Added: svn:mime-type |
| +text/plain |
| \ No newline at end of property |
| /xservices/trunk/doc/html/executeservices.html |
|---|
| 0,0 → 1,210 |
| <html><head><META http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>ExecuteServices</title><link href="corpstyle.css" type="text/css" rel="stylesheet"><meta content="DocBook XSL-NS Stylesheets V1.76.1" name="generator"><link rel="home" href="index.html" title="Brutex XServices Documentation"><link rel="up" href="services.html" title="Chapter 2. Available Services"><link rel="prev" href="services.html" title="Chapter 2. Available Services"><link rel="next" href="fileservices.html" title="FileServices"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table summary="Navigation header" width="100%"><tr><th align="center" colspan="3">ExecuteServices</th></tr><tr><td align="left" width="20%"><a accesskey="p" href="services.html">Prev</a> </td><th align="center" width="60%">Chapter 2. Available Services</th><td align="right" width="20%"> <a accesskey="n" href="fileservices.html">Next</a></td></tr></table><hr></div><div class="breadcrumbs"><span class="breadcrumb-link"><a href="index.html">Brutex XServices Documentation</a></span> > <span class="breadcrumb-link"><a href="services.html">Available Services</a></span> > <span class="breadcrumb-node">ExecuteServices</span></div><div class="section" title="ExecuteServices"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="executeservices"></a>ExecuteServices</h2></div></div></div><p>The ExecuteService bundles local and remote command |
| execution operations. Its WSDL is located at |
| http://server:port/XServices/ExecuteService?wsdl</p><div class="section" title="rExec"><div class="titlepage"><div><div><h3 class="title"><a name="N10089"></a>rExec |
| </h3></div></div></div><p>provides remote execution facilities with authentication based on |
| user names and passwords.</p><div class="section" title="Input parameters"><div class="titlepage"><div><div><h4 class="title"><a name="N10092"></a>Input parameters |
| </h4></div></div></div><p></p><div class="table"><a name="N10096"></a><p class="title"><b>Table 2.1. rExec |
| input parameters |
| </b></p><div class="table-contents"><table summary="rExec |
| input parameters |
| " border="1"><colgroup><col class="parameter"><col class="type"><col class="required"><col class="description"></colgroup><thead><tr><th>parameter</th><th>type</th><th>required</th><th>description</th></tr></thead><tbody><tr><td>host</td><td>HostConnection</td><td>Yes</td><td> |
| Host where to execute the command. See |
| <a class="link" href="xmltypes.html#hostconnection" title="HostConnection type">HostConnection</a> |
| . |
| </td></tr><tr><td>command</td><td>String</td><td>No</td><td>Any command including arguments</td></tr><tr><td>timeout</td><td>Long</td><td>Yes</td><td>Timeout in milliseconds. The command is forcefully terminated when timeout is reached.</td></tr></tbody></table></div></div><br class="table-break"><p></p></div><div class="section" title="Output parameters"><div class="titlepage"><div><div><h4 class="title"><a name="N100D4"></a>Output parameters |
| </h4></div></div></div><div class="section" title="ReturnCode type"><div class="titlepage"><div><div><h5 class="title"><a name="N100D7"></a>ReturnCode type</h5></div></div></div><p> |
| The ReturnCode type is used as the generic answer type for most of the |
| <span class="application">BruteXservices</span> |
| operations. |
| </p><p> |
| The defining Java class is |
| <a class="ulink" href="javadoc/net/brutex/xservices/types/ReturnCode.html" target="_top"> |
| <code class="classname">net.brutex.xservices.types.ReturnCode</code> |
| </a> |
| . |
| </p><h4><a name="N100ED"></a>Schema definition</h4><pre class="programlisting"> |
| <xs:complexType name="ReturnCodeType"> |
| <xs:sequence> |
| <xs:element name="returnCode" type="xs:int"/> |
| <xs:element minOccurs="0" name="stdOut" type="xs:string"/> |
| <xs:element minOccurs="0" name="stdErr" type="xs:string"/> |
| <xs:element maxOccurs="unbounded" minOccurs="0" name="propertyList" nillable="true" type="<a class="link" href="">tns:antProperty</a>"/> |
| </xs:sequence> |
| </xs:complexType> |
| </pre><h4><a name="N100F7"></a>Example XML</h4><pre class="programlisting"> |
| <ReturnCode |
| xmlns:ns2="http://ws.xservices.brutex.net"> |
| <returnCode>0</returnCode> |
| <stdOut/> |
| <stdErr/> |
| <propertyList> |
| <em class="lineannotation"><span class="lineannotation"> |
| See |
| <a class="link" href="">tns:antProperty</a> |
| for details about the <propertyList> elements. |
| </span></em> |
| <name>key1</name> |
| <value>value1</value> |
| </propertyList> |
| <propertyList> |
| <name>key2</name> |
| <value>value2</value> |
| </propertyList> |
| </ReturnCode> |
| </pre></div></div></div><div class="section" title="runCommand"><div class="titlepage"><div><div><h3 class="title"><a name="N10104"></a>runCommand</h3></div></div></div><p>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.</p><div class="section" title="Input parameters"><div class="titlepage"><div><div><h4 class="title"><a name="N1010D"></a>Input parameters |
| </h4></div></div></div><p></p><div class="table"><a name="N10111"></a><p class="title"><b>Table 2.2. runCommand input parameters</b></p><div class="table-contents"><table summary="runCommand input parameters" border="1"><colgroup><col class="parameter"><col class="type"><col class="required"><col class="description"></colgroup><thead><tr><th>parameter</th><th>type</th><th>required</th><th>description</th></tr></thead><tbody><tr><td>executable</td><td>String</td><td>Yes</td><td>Command to be run. The command may be specified with full |
| path using forward slash "/" as path separator.</td></tr><tr><td>argline</td><td>String</td><td>No</td><td>Any command line arguments</td></tr><tr><td>timeout</td><td>Long</td><td>Yes</td><td>Timeout in milliseconds. The command is forcefully terminated when timeout is reached.</td></tr></tbody></table></div></div><br class="table-break"><p></p></div><div class="section" title="Output parameters"><div class="titlepage"><div><div><h4 class="title"><a name="N1014B"></a>Output parameters |
| </h4></div></div></div><div class="section" title="ReturnCode type"><div class="titlepage"><div><div><h5 class="title"><a name="N1014E"></a>ReturnCode type</h5></div></div></div><p> |
| The ReturnCode type is used as the generic answer type for most of the |
| <span class="application">BruteXservices</span> |
| operations. |
| </p><p> |
| The defining Java class is |
| <a class="ulink" href="javadoc/net/brutex/xservices/types/ReturnCode.html" target="_top"> |
| <code class="classname">net.brutex.xservices.types.ReturnCode</code> |
| </a> |
| . |
| </p><h4><a name="N10164"></a>Schema definition</h4><pre class="programlisting"> |
| <xs:complexType name="ReturnCodeType"> |
| <xs:sequence> |
| <xs:element name="returnCode" type="xs:int"/> |
| <xs:element minOccurs="0" name="stdOut" type="xs:string"/> |
| <xs:element minOccurs="0" name="stdErr" type="xs:string"/> |
| <xs:element maxOccurs="unbounded" minOccurs="0" name="propertyList" nillable="true" type="<a class="link" href="">tns:antProperty</a>"/> |
| </xs:sequence> |
| </xs:complexType> |
| </pre><h4><a name="N1016E"></a>Example XML</h4><pre class="programlisting"> |
| <ReturnCode |
| xmlns:ns2="http://ws.xservices.brutex.net"> |
| <returnCode>0</returnCode> |
| <stdOut/> |
| <stdErr/> |
| <propertyList> |
| <em class="lineannotation"><span class="lineannotation"> |
| See |
| <a class="link" href="">tns:antProperty</a> |
| for details about the <propertyList> elements. |
| </span></em> |
| <name>key1</name> |
| <value>value1</value> |
| </propertyList> |
| <propertyList> |
| <name>key2</name> |
| <value>value2</value> |
| </propertyList> |
| </ReturnCode> |
| </pre></div></div></div><div class="section" title="runCommandWithSSH"><div class="titlepage"><div><div><h3 class="title"><a name="N1017B"></a>runCommandWithSSH</h3></div></div></div><p>Executes a command through a SSH session.</p><div class="section" title="Input parameters"><div class="titlepage"><div><div><h4 class="title"><a name="N10184"></a>Input parameters |
| </h4></div></div></div><p></p><div class="table"><a name="N10188"></a><p class="title"><b>Table 2.3. runCommandWithSSH input parameters</b></p><div class="table-contents"><table summary="runCommandWithSSH input parameters" border="1"><colgroup><col class="parameter"><col class="type"><col class="required"><col class="description"></colgroup><thead><tr><th>parameter</th><th>type</th><th>required</th><th>description</th></tr></thead><tbody><tr><td>host</td><td>HostConnection</td><td>Yes</td><td> |
| Host to connect to (see: |
| <a class="link" href="xmltypes.html#hostconnection" title="HostConnection type">tns:HostConnection</a> |
| ) |
| </td></tr><tr><td>command</td><td>String</td><td>No</td><td>The command to execute.</td></tr><tr><td>timeout</td><td>Long</td><td>Yes</td><td>Timeout in milliseconds. The command is forcefully terminated when timeout is reached.</td></tr></tbody></table></div></div><br class="table-break"><p></p></div><div class="section" title="Output parameters"><div class="titlepage"><div><div><h4 class="title"><a name="N101C6"></a>Output parameters |
| </h4></div></div></div><div class="section" title="ReturnCode type"><div class="titlepage"><div><div><h5 class="title"><a name="N101C9"></a>ReturnCode type</h5></div></div></div><p> |
| The ReturnCode type is used as the generic answer type for most of the |
| <span class="application">BruteXservices</span> |
| operations. |
| </p><p> |
| The defining Java class is |
| <a class="ulink" href="javadoc/net/brutex/xservices/types/ReturnCode.html" target="_top"> |
| <code class="classname">net.brutex.xservices.types.ReturnCode</code> |
| </a> |
| . |
| </p><h4><a name="N101DF"></a>Schema definition</h4><pre class="programlisting"> |
| <xs:complexType name="ReturnCodeType"> |
| <xs:sequence> |
| <xs:element name="returnCode" type="xs:int"/> |
| <xs:element minOccurs="0" name="stdOut" type="xs:string"/> |
| <xs:element minOccurs="0" name="stdErr" type="xs:string"/> |
| <xs:element maxOccurs="unbounded" minOccurs="0" name="propertyList" nillable="true" type="<a class="link" href="">tns:antProperty</a>"/> |
| </xs:sequence> |
| </xs:complexType> |
| </pre><h4><a name="N101E9"></a>Example XML</h4><pre class="programlisting"> |
| <ReturnCode |
| xmlns:ns2="http://ws.xservices.brutex.net"> |
| <returnCode>0</returnCode> |
| <stdOut/> |
| <stdErr/> |
| <propertyList> |
| <em class="lineannotation"><span class="lineannotation"> |
| See |
| <a class="link" href="">tns:antProperty</a> |
| for details about the <propertyList> elements. |
| </span></em> |
| <name>key1</name> |
| <value>value1</value> |
| </propertyList> |
| <propertyList> |
| <name>key2</name> |
| <value>value2</value> |
| </propertyList> |
| </ReturnCode> |
| </pre></div></div><div class="section" title="Sample Request:"><div class="titlepage"><div><div><h4 class="title"><a name="N101F6"></a>Sample Request:</h4></div></div></div><pre class="programlisting"> |
| <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> |
| </pre></div></div><div class="section" title="telnet"><div class="titlepage"><div><div><h3 class="title"><a name="N101FC"></a>telnet</h3></div></div></div><p>Runs a telnet session with an "expect shell" like behaviour.</p><div class="section" title="Input parameters"><div class="titlepage"><div><div><h4 class="title"><a name="N10205"></a>Input parameters |
| </h4></div></div></div><p></p><div class="table"><a name="N10209"></a><p class="title"><b>Table 2.4. telnet input parameters</b></p><div class="table-contents"><table summary="telnet input parameters" border="1"><colgroup><col class="parameter"><col class="type"><col class="required"><col class="description"></colgroup><thead><tr><th>parameter</th><th>type</th><th>required</th><th>description</th></tr></thead><tbody><tr><td>host</td><td>HostConnection</td><td>Yes</td><td>Host to connect to (see: <a class="link" href="xmltypes.html#hostconnection" title="HostConnection type">tns:HostConnection</a>)</td></tr><tr><td>prompt</td><td>String</td><td>No</td><td>The prompt string to expect after login. This is used to recognize when |
| the session is open.</td></tr><tr><td>command</td><td>String</td><td>No</td><td>The command to execute.</td></tr><tr><td>expect</td><td>String</td><td>No</td><td>The prompt to expect after the command has been executed successfully.</td></tr><tr><td>timeout</td><td>Long</td><td>Yes</td><td>Timeout in milliseconds. The command is forcefully terminated when timeout is reached.</td></tr></tbody></table></div></div><br class="table-break"><p></p></div><div class="section" title="Output parameters"><div class="titlepage"><div><div><h4 class="title"><a name="N10259"></a>Output parameters</h4></div></div></div><div class="section" title="ReturnCode type"><div class="titlepage"><div><div><h5 class="title"><a name="N1025C"></a>ReturnCode type</h5></div></div></div><p> |
| The ReturnCode type is used as the generic answer type for most of the |
| <span class="application">BruteXservices</span> |
| operations. |
| </p><p> |
| The defining Java class is |
| <a class="ulink" href="javadoc/net/brutex/xservices/types/ReturnCode.html" target="_top"> |
| <code class="classname">net.brutex.xservices.types.ReturnCode</code> |
| </a> |
| . |
| </p><h4><a name="N10272"></a>Schema definition</h4><pre class="programlisting"> |
| <xs:complexType name="ReturnCodeType"> |
| <xs:sequence> |
| <xs:element name="returnCode" type="xs:int"/> |
| <xs:element minOccurs="0" name="stdOut" type="xs:string"/> |
| <xs:element minOccurs="0" name="stdErr" type="xs:string"/> |
| <xs:element maxOccurs="unbounded" minOccurs="0" name="propertyList" nillable="true" type="<a class="link" href="">tns:antProperty</a>"/> |
| </xs:sequence> |
| </xs:complexType> |
| </pre><h4><a name="N1027C"></a>Example XML</h4><pre class="programlisting"> |
| <ReturnCode |
| xmlns:ns2="http://ws.xservices.brutex.net"> |
| <returnCode>0</returnCode> |
| <stdOut/> |
| <stdErr/> |
| <propertyList> |
| <em class="lineannotation"><span class="lineannotation"> |
| See |
| <a class="link" href="">tns:antProperty</a> |
| for details about the <propertyList> elements. |
| </span></em> |
| <name>key1</name> |
| <value>value1</value> |
| </propertyList> |
| <propertyList> |
| <name>key2</name> |
| <value>value2</value> |
| </propertyList> |
| </ReturnCode> |
| </pre></div></div><div class="section" title="Sample Request:"><div class="titlepage"><div><div><h4 class="title"><a name="N10289"></a>Sample Request:</h4></div></div></div><pre class="programlisting"> |
| <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> |
| </pre></div></div></div><div class="navfooter"><hr><table summary="Navigation footer" width="100%"><tr><td align="left" width="40%"><a accesskey="p" href="services.html">Prev</a> </td><td align="center" width="20%"><a accesskey="u" href="services.html">Up</a></td><td align="right" width="40%"> <a accesskey="n" href="fileservices.html">Next</a></td></tr><tr><td valign="top" align="left" width="40%">Chapter 2. Available Services </td><td align="center" width="20%"><a accesskey="h" href="index.html">Home</a></td><td valign="top" align="right" width="40%"> FileServices</td></tr></table></div></body></html> |
| Property changes: |
| Added: svn:mime-type |
| +text/plain |
| \ No newline at end of property |
| /xservices/trunk/doc/html/index.html |
|---|
| 0,0 → 1,48 |
| <html><head><META http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>Brutex XServices Documentation</title><link href="corpstyle.css" type="text/css" rel="stylesheet"><meta content="DocBook XSL-NS Stylesheets V1.76.1" name="generator"><meta name="description" content="Abstract In complex IT environments it is necessary to integrate different information systems with each other, exchange data between tools and automate actions and function calls depending on events arising from user interaction. To meet the requirements of integration building usually means to implement APIs and to create tool-to-tool bridges. Web Services can help to clean up bridges into interfaces as well as to abstract functions from their underlying platform and implementation. These are the major goals of the loosely coupled integration strategy which is in turn one essential idea of a service-oriented architecture (SOA). provide a low level set of functions and web services. These can be orchestrated into services and used in business processes which make up the execution part of a SOA environment. is an add-on to XBridgeNG 2.0. It runs standalone or in combination with XBridgeNG. Pure XBridgeNG has two components: XML Schema for item based data types (e.g. tickets from a bug tracker system or a database record)Set of Apache Ant tasks to function as a bridge between the XBridgeNG XML format at legacy 3rd party software (e.g. HP Quality Center, Serena TeamTrack, ...)The add Web Services (SOAP) wrapper around Apache Ant tasks (since XBridgeNG 2.0) The current focus is on file-based operations. do not contain an integration server or a process execution engine."><link rel="home" href="index.html" title="Brutex XServices Documentation"><link rel="next" href="installation.html" title="Chapter 1. Getting started"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table summary="Navigation header" width="100%"><tr><th align="center" colspan="3">Brutex XServices Documentation</th></tr><tr><td align="left" width="20%"> </td><th align="center" width="60%"> </th><td align="right" width="20%"> <a accesskey="n" href="installation.html">Next</a></td></tr></table><hr></div><div class="breadcrumbs"><span class="breadcrumb-node">Brutex XServices Documentation</span></div><div class="book" title="Brutex XServices Documentation"><div class="titlepage"><div><div><h1 class="title"><a name="N10001"></a>Brutex XServices Documentation</h1></div><div><div class="author"><h3 class="author"><span class="firstname">Brian</span> <span class="surname">Rosenberger</span></h3><code class="email"><<a class="email" href="mailto:bru@brutex.de">bru@brutex.de</a>></code></div></div><div><p class="copyright">Copyright © 2011 </p></div><div><div class="legalnotice" title="Legal Notice"><a name="N10017"></a><p> |
| The copyright holders make no representation about the suitability |
| of this document for any purpose. It is provided |
| <span class="quote">“<span class="quote">as is</span>”</span> |
| without expressed or implied warranty. |
| </p></div></div><div><div class="legalnotice" title="Legal Notice"><a name="N1001D"></a><p>Apache Tomcat and Apache Ant are trademarks of the Apache |
| Software Foundation.</p></div></div><div><div class="abstract" title="Abstract"><p class="title"><b>Abstract</b></p><p>In complex IT environments it is necessary to integrate |
| different information systems with each other, exchange data |
| between |
| tools and automate actions and function calls depending |
| on events |
| arising from user interaction. To meet the requirements |
| of |
| integration building usually means to implement APIs and to |
| create |
| tool-to-tool bridges. Web Services can help to clean up |
| bridges into |
| interfaces as well as to abstract functions from |
| their underlying |
| platform and implementation.</p><p>These are the major goals of the loosely coupled |
| integration |
| strategy which is in turn one essential idea of a |
| service-oriented |
| architecture (SOA).</p><p>provide a low level set of functions and web services. |
| These can |
| be orchestrated into services and used in business |
| processes which |
| make up the execution part of a SOA |
| environment.</p><p>is an add-on to XBridgeNG 2.0. It runs standalone or in |
| combination with XBridgeNG. Pure XBridgeNG has two |
| components:</p><p> |
| </p><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem"><p>XML Schema for item based data types (e.g. tickets |
| from a bug |
| tracker system or a database record)</p></li><li class="listitem"><p>Set of Apache Ant tasks to function as a bridge |
| between the |
| XBridgeNG XML format at legacy 3rd party |
| software (e.g. HP Quality |
| Center, Serena TeamTrack, |
| ...)</p></li><li class="listitem"><p>The add Web Services (SOAP) wrapper around Apache Ant |
| tasks |
| (since XBridgeNG 2.0)</p></li></ul></div><p> |
| </p><p>The current focus is on file-based operations. do not |
| contain an |
| integration server or a process execution |
| engine.</p></div></div></div><hr></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="chapter"><a href="installation.html">1. Getting started</a></span></dt><dd><dl><dt><span class="section"><a href="installation.html#N10042"></a></span></dt><dd><dl><dt><span class="section"><a href="installation.html#N10048">Installation</a></span></dt></dl></dd></dl></dd><dt><span class="chapter"><a href="services.html">2. Available Services</a></span></dt><dd><dl><dt><span class="section"><a href="services.html#archiveservices">ArchiveServices</a></span></dt><dt><span class="section"><a href="executeservices.html">ExecuteServices</a></span></dt><dd><dl><dt><span class="section"><a href="executeservices.html#N10089">rExec |
| </a></span></dt><dt><span class="section"><a href="executeservices.html#N10104">runCommand</a></span></dt><dt><span class="section"><a href="executeservices.html#N1017B">runCommandWithSSH</a></span></dt><dt><span class="section"><a href="executeservices.html#N101FC">telnet</a></span></dt></dl></dd><dt><span class="section"><a href="fileservices.html">FileServices</a></span></dt><dt><span class="section"><a href="miscservices.html">MiscServices</a></span></dt></dl></dd><dt><span class="chapter"><a href="xmltypes.html">3. XML Types</a></span></dt><dd><dl><dt><span class="section"><a href="xmltypes.html#N102AA"></a></span></dt><dd><dl><dt><span class="section"><a href="xmltypes.html#N102B0">AntProperty type</a></span></dt><dt><span class="section"><a href="xmltypes.html#N102C5">FileResource type</a></span></dt><dt><span class="section"><a href="xmltypes.html#hostconnection">HostConnection type</a></span></dt><dt><span class="section"><a href="xmltypes.html#patternelement">PatternElement type</a></span></dt><dt><span class="section"><a href="xmltypes.html#patternsettype">PatternSetType type</a></span></dt><dt><span class="section"><a href="xmltypes.html#N10367">ReturnCode type</a></span></dt><dt><span class="section"><a href="xmltypes.html#selectortype">SelectorType type</a></span></dt></dl></dd></dl></dd></dl></div><div class="list-of-tables"><p><b>List of Tables</b></p><dl><dt>2.1. <a href="executeservices.html#N10096">rExec |
| input parameters |
| </a></dt><dt>2.2. <a href="executeservices.html#N10111">runCommand input parameters</a></dt><dt>2.3. <a href="executeservices.html#N10188">runCommandWithSSH input parameters</a></dt><dt>2.4. <a href="executeservices.html#N10209">telnet input parameters</a></dt></dl></div></div><div class="navfooter"><hr><table summary="Navigation footer" width="100%"><tr><td align="left" width="40%"> </td><td align="center" width="20%"> </td><td align="right" width="40%"> <a accesskey="n" href="installation.html">Next</a></td></tr><tr><td valign="top" align="left" width="40%"> </td><td align="center" width="20%"> </td><td valign="top" align="right" width="40%"> Chapter 1. Getting started</td></tr></table></div></body></html> |
| Property changes: |
| Added: svn:mime-type |
| +text/plain |
| \ No newline at end of property |
| /xservices/trunk/doc/. |
|---|
| Property changes: |
| Modified: svn:ignore |
| .~lock.XServices_V1.0-User_Guide.odt# |
| + |
| +api |