diff --git a/doc/ArchiveServices.xml b/doc/ArchiveServices.xml
index 8b52bbd..db45d6f 100644
--- a/doc/ArchiveServices.xml
+++ b/doc/ArchiveServices.xml
@@ -1,5 +1,9 @@
-
- ArchiveServices
- The ArchiveService bundles file packing operations. Its WSDL is located at
-http://server:port/XServices/ArchiveService?wsdl
-
\ No newline at end of file
+
+
+ ArchiveServices
+ The ArchiveService bundles file packing operations. Its
+ WSDL is
+ located at
+ http://server:port/XServices/ArchiveService?wsdl
+
\ No newline at end of file
diff --git a/doc/BruteXServices_User_Guide.dbk b/doc/BruteXServices_User_Guide.dbk
new file mode 100644
index 0000000..17fb2d2
--- /dev/null
+++ b/doc/BruteXServices_User_Guide.dbk
@@ -0,0 +1,887 @@
+
+ Brutex XServices Documentation
+
+ February, 16th 2010
+
+ Brian
+ Rosenberger
+ bru@brutex.de
+
+ Brutex Network
+
+ 2011
+
+
+
+ The copyright holders make no representation about the suitability
+ of this document for any purpose. It is provided
+ as is
+ without expressed or implied warranty.
+
+
+
+ Apache Tomcat and Apache Ant are trademarks of the Apache
+ Software Foundation.
+
+
+ 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.
+
+
+
+
+ Getting started
+ This chapter describes the installation.
+
+
+
+ Installation
+ tbd.
+ Sun Java SE 1.6.0
+ Apache Tomcat 7
+ tbd.
+ In short: Deploy .WAR file to Apache Tomcat
+
+ Securing with Basic Authentication
+ There is a quick guide explaining Basic Authentication for Tomcat here:
+ http://oreilly.com/pub/a/java/archive/tomcat-tips.html?page=1
+
+
+
+
+
+
+ Limit access to
+ 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.
+ 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.
+ <Context
+ path="/XService/ArchiveService"
+ ...> <Valve
+ className="org.apache.catalina.valves.RemoteAddrValve"
+ allow="127.0.0.1" deny=""/> </Context>
+
+ 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.
+
+ The <context> element must be placed into the
+ server.xml
+ file (into <engine><host>).
+
+
+
+
+
+
+ Available Services
+ List of available web services and their operations.
+
+ ArchiveServices
+ The ArchiveService bundles file packing operations. Its
+ WSDL is
+ located at
+ http://server:port/XServices/ArchiveService?wsdl
+
+
+ ExecuteServices
+ The ExecuteService bundles local and remote command
+ execution operations. Its WSDL is located at
+ http://server:port/XServices/ExecuteService?wsdl
+
+ rExec
+
+ provides remote execution facilities with authentication based on
+ user names and passwords.
+
+ Input parameters
+
+
+
+ rExec
+ input parameters
+
+
+
+
+
+
+
+
+ parameter
+ type
+ required
+ description
+
+
+
+
+ host
+ HostConnection
+ Yes
+
+ Host where to execute the command. See
+ HostConnection
+ .
+
+
+
+ command
+ String
+ No
+ Any command including arguments
+
+
+ timeout
+ Long
+ Yes
+ Timeout in milliseconds. The command is forcefully terminated when timeout is reached.
+
+
+
+
+
+
+
+ Output parameters
+
+
+ ReturnCode type
+
+ The ReturnCode type is used as the generic answer type for most of the
+ BruteXservices
+ operations.
+
+
+ The defining Java class is
+
+ net.brutex.xservices.types.ReturnCode
+
+ .
+
+ Schema definition
+
+
+
+
+
+ tns:antProperty
+
+]]>
+
+
+ Example XML
+
+ <ReturnCode
+ xmlns:ns2="http://ws.xservices.brutex.net">
+ <returnCode>0</returnCode>
+ <stdOut/>
+ <stdErr/>
+ <propertyList>
+
+ See
+ tns:antProperty
+ for details about the <propertyList> elements.
+
+ <name>key1</name>
+ <value>value1</value>
+ </propertyList>
+ <propertyList>
+ <name>key2</name>
+ <value>value2</value>
+ </propertyList>
+ </ReturnCode>
+
+
+
+
+
+
+ runCommand
+ 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.
+
+ Input parameters
+
+
+
+ runCommand input parameters
+
+
+
+
+
+
+
+ parameter
+ type
+ required
+ description
+
+
+
+
+ executable
+ String
+ Yes
+ Command to be run. The command may be specified with full
+ path using forward slash "/" as path separator.
+
+
+ argline
+ String
+ No
+ Any command line arguments
+
+
+ timeout
+ Long
+ Yes
+ Timeout in milliseconds. The command is forcefully terminated when timeout is reached.
+
+
+
+
+
+
+
+ Output parameters
+
+
+ ReturnCode type
+
+ The ReturnCode type is used as the generic answer type for most of the
+ BruteXservices
+ operations.
+
+
+ The defining Java class is
+
+ net.brutex.xservices.types.ReturnCode
+
+ .
+
+ Schema definition
+
+
+
+
+
+ tns:antProperty
+
+]]>
+
+
+ Example XML
+
+ <ReturnCode
+ xmlns:ns2="http://ws.xservices.brutex.net">
+ <returnCode>0</returnCode>
+ <stdOut/>
+ <stdErr/>
+ <propertyList>
+
+ See
+ tns:antProperty
+ for details about the <propertyList> elements.
+
+ <name>key1</name>
+ <value>value1</value>
+ </propertyList>
+ <propertyList>
+ <name>key2</name>
+ <value>value2</value>
+ </propertyList>
+ </ReturnCode>
+
+
+
+
+
+
+ runCommandWithSSH
+ Executes a command through a SSH session.
+
+ Input parameters
+
+
+
+ runCommandWithSSH input parameters
+
+
+
+
+
+
+
+ parameter
+ type
+ required
+ description
+
+
+
+
+ host
+ HostConnection
+ Yes
+
+ Host to connect to (see:
+ tns:HostConnection
+ )
+
+
+
+ command
+ String
+ No
+ The command to execute.
+
+
+ timeout
+ Long
+ Yes
+ Timeout in milliseconds. The command is forcefully terminated when timeout is reached.
+
+
+
+
+
+
+
+ Output parameters
+
+
+ ReturnCode type
+
+ The ReturnCode type is used as the generic answer type for most of the
+ BruteXservices
+ operations.
+
+
+ The defining Java class is
+
+ net.brutex.xservices.types.ReturnCode
+
+ .
+
+ Schema definition
+
+
+
+
+
+ tns:antProperty
+
+]]>
+
+
+ Example XML
+
+ <ReturnCode
+ xmlns:ns2="http://ws.xservices.brutex.net">
+ <returnCode>0</returnCode>
+ <stdOut/>
+ <stdErr/>
+ <propertyList>
+
+ See
+ tns:antProperty
+ for details about the <propertyList> elements.
+
+ <name>key1</name>
+ <value>value1</value>
+ </propertyList>
+ <propertyList>
+ <name>key2</name>
+ <value>value2</value>
+ </propertyList>
+ </ReturnCode>
+
+
+
+
+
+ Sample Request:
+
+
+
+ ssh.brutex.net
+ 22
+ roger
+ xxx
+
+ ls /etc/
+ 30000
+
+ ]]>
+
+
+
+ telnet
+ Runs a telnet session with an "expect shell" like behaviour.
+
+ Input parameters
+
+
+
+ telnet input parameters
+
+
+
+
+
+
+
+ parameter
+ type
+ required
+ description
+
+
+
+
+ host
+ HostConnection
+ Yes
+ Host to connect to (see: tns:HostConnection)
+
+
+ prompt
+ String
+ No
+ The prompt string to expect after login. This is used to recognize when
+ the session is open.
+
+
+ command
+ String
+ No
+ The command to execute.
+
+
+ expect
+ String
+ No
+ The prompt to expect after the command has been executed successfully.
+
+
+ timeout
+ Long
+ Yes
+ Timeout in milliseconds. The command is forcefully terminated when timeout is reached.
+
+
+
+
+
+
+
+ Output parameters
+
+ ReturnCode type
+
+ The ReturnCode type is used as the generic answer type for most of the
+ BruteXservices
+ operations.
+
+
+ The defining Java class is
+
+ net.brutex.xservices.types.ReturnCode
+
+ .
+
+ Schema definition
+
+
+
+
+
+ tns:antProperty
+
+]]>
+
+
+ Example XML
+
+ <ReturnCode
+ xmlns:ns2="http://ws.xservices.brutex.net">
+ <returnCode>0</returnCode>
+ <stdOut/>
+ <stdErr/>
+ <propertyList>
+
+ See
+ tns:antProperty
+ for details about the <propertyList> elements.
+
+ <name>key1</name>
+ <value>value1</value>
+ </propertyList>
+ <propertyList>
+ <name>key2</name>
+ <value>value2</value>
+ </propertyList>
+ </ReturnCode>
+
+
+
+
+
+ Sample Request:
+
+
+
+ localhost
+ 23
+ brosenberger
+
+
+ C:\Users\brosenberger>
+ dir c:\temp
+ enberger>
+ 60000
+
+ ]]>
+
+
+
+
+ FileServices
+ The FileServces bundles various file operations. Its WSDL is located at
+ http://server:port/XServices/FileService?wsdl
+
+
+ MiscServices
+ The MiscService bundles various operations. Its WSDL is located at
+ http://server:port/XServices/MiscService?wsdl
+
+
+
+
+
+
+ XML Types
+ This chapter bundles the documentation for common XML types used
+ by XServices web service.
+
+
+
+AntProperty type
+ The AntProperty type defines a list of key/value pairs.
+
+ The defining Java class is
+
+ net.brutex.xservices.types.AntProperty
+
+ .
+
+
+
+
+
+
+
+]]>
+
+
+
+ key2
+ value2
+]]>
+
+
+
+FileResource type
+ The FileResource type defines an URI to a file with optional on-the-fly decompression.
+
+ The defining Java class is
+
+ net.brutex.xservices.types.FileResource
+
+ .
+
+
+
+
+
+
+
+]]>
+
+ Available types:
+ FILE: URI points to a local file resource. Examples: c:\temp\something.txt, c:/dir/another.file, /home/brian/file
+ URL: File from URL (http, https, ftp, ...). Example: http://brutex.net/file.pdf
+ GZIP and BZIP2: File from a local file system with on-the-fly decompression.
+
+ FILE
+ c:\temp\xservices.war
+]]>
+
+
+
+ HostConnection type
+ The HostConnection type identifies a server resource and login
+ credentials.
+
+ The defining Java class is
+
+ net.brutex.xservices.types.HostConnection
+
+ .
+
+ Schema definition
+
+
+
+
+
+
+
+
+]]>
+
+ Example XML
+
+ server.brutex.net
+ 512
+ brian
+
+ somepass
+
+]]>
+
+
+
+ PatternElement type
+ The PatternElement type defines single string pattern for file/
+ directory matching.
+
+ The defining Java class is
+
+ net.brutex.xservices.types.PatternElement
+
+ .
+
+
+ These patterns look exactly like those used in Apache Ant
+ Patterns.
+ 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.
+
+ Some example patterns:
+
+ **/mydir/**
+
+ 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.
+
+ /mydir/
+
+ The
+ parser will automatically append an '**' symbol, thus the
+ resulting pattern is
+ /mydir/**.
+ All files below the "/mydir/" directory (including its
+ sub-directories will be chosen.
+
+
+ The pattern is OS independent. You should always use
+ "/" as path separator, even on windows based systems.
+
+
+ Schema definition
+
+
+]]>
+
+ Example XML
+ **/*]]>
+
+
+
+ PatternSetType type
+ The PatternSetType exposes various filters/ selectors for the
+ selection of resources (files).
+
+ The defining Java class is
+
+ net.brutex.xservices.types.PatternSetType
+
+ .
+
+ Schema definition
+
+
+ tns:patternElement
+ tns:patternElement
+ tns:selectorType
+
+]]>
+
+ Example XML
+
+
+
+
+ ReturnCode type
+
+ The ReturnCode type is used as the generic answer type for most of the
+ BruteXservices
+ operations.
+
+
+ The defining Java class is
+
+ net.brutex.xservices.types.ReturnCode
+
+ .
+
+ Schema definition
+
+
+
+
+
+ tns:antProperty
+
+]]>
+
+
+ Example XML
+
+ <ReturnCode
+ xmlns:ns2="http://ws.xservices.brutex.net">
+ <returnCode>0</returnCode>
+ <stdOut/>
+ <stdErr/>
+ <propertyList>
+
+ See
+ tns:antProperty
+ for details about the <propertyList> elements.
+
+ <name>key1</name>
+ <value>value1</value>
+ </propertyList>
+ <propertyList>
+ <name>key2</name>
+ <value>value2</value>
+ </propertyList>
+ </ReturnCode>
+
+
+
+
+ SelectorType type
+ The SelectorType exposes various selectors for the selection of resources (files).
+ The defining Java class is
+
+ net.brutex.xservices.types.SelectorType.
+Schema definition
+
+
+
+
+ ]]>
+
+Example XML
+
+
+
+
+
+
\ No newline at end of file
diff --git a/doc/BruteXServices_User_Guide.xml b/doc/BruteXServices_User_Guide.xml
index 555516d..e192fb3 100644
--- a/doc/BruteXServices_User_Guide.xml
+++ b/doc/BruteXServices_User_Guide.xml
@@ -1,178 +1,57 @@
-
-
- User Guide
-
- February, 16th 2010
-
- Brian
- Rosenberger
- bru@brutex.de
-
- Brutex Network
- 1997
- 2010
-
- The copyright holders make no representation about the
- suitability of this document for any purpose. It is provided
- as is without expressed or implied warranty.
-
-
- Apache Tomcat and Apache Ant are trademarks of the Apache
- Software Foundation.
-
-
- 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.
-
-
-
-
- Getting started
- This chapter describes the installation.
-
- Prerequisites
- tbd.
- Sun Java SE 1.6.0
- Apache Tomcat 6
-
-
- Installation
- tbd.
- In short: Deploy .WAR file to Apache Tomcat
-
- Securing with Basic Authentication
- There is a quick guide explaining Basic Authentication
- for Tomcat here:
-
-
-
-
- Limit access to
- 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.
- 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.
- <Context path="/XService/ArchiveService" ...>
- <Valve className="org.apache.catalina.valves.RemoteAddrValve"
- allow="127.0.0.1" deny=""/>
- </Context>
- 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.
- The <context> element must be placed into the
- server.xml file (into <engine><host>).
-
-
-
-
-
-
- ArchiveServices
- The ArchiveService bundles file packing operations. Its
- WSDL is located at
- http://server:port/XServices/ArchiveService?wsdl
-
-
- ExecuteServices
- The ExecuteService bundles local and remote command
- execution operations. Its WSDL is located at
- http://server:port/XServices/ExecuteService?wsdl
-
- runCommand
- 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.
-
-
-
-
- runCommand input parameters
-
-
-
-
-
-
-
- parameter
- type
- required
- description
-
-
-
-
- executable
- String
- Yes
- Command to be run. The command may be
- specified with full path using forward slash
- "/" as path separator.
-
-
- argline
- String
- No
- Any command line arguments
-
-
-
-
-
-
-
-
-
-
- XML Types
- This chapter bundles the documentation for common xml types
- used by XServices web service.
-
+
+%myent;
+]>
+
+ Brutex XServices Documentation
+
+ February, 16th 2010
+
+ Brian
+ Rosenberger
+ bru@brutex.de
+
+ Brutex Network
+
+ 2011
+
+
+
+ The copyright holders make no representation about the suitability
+ of this document for any purpose. It is provided
+ as is
+ without expressed or implied warranty.
+
+
+
+ Apache Tomcat and Apache Ant are trademarks of the Apache
+ Software Foundation.
+
+
+
+
+
+ Getting started
+ This chapter describes the installation.
+
+
+
+
+ Available Services
+ List of available web services and their operations.
+
+
+
+
+
+
+
+
+ XML Types
+ This chapter bundles the documentation for common XML types used
+ by XServices web service.
+
+
diff --git a/doc/ExecuteServices.xml b/doc/ExecuteServices.xml
index 9e6a82d..03d4a74 100644
--- a/doc/ExecuteServices.xml
+++ b/doc/ExecuteServices.xml
@@ -1,5 +1,13 @@
-
- ExecuteServices
- The ExecuteService bundles local and remote command execution operations. Its WSDL is located at
-http://server:port/XServices/ExecuteService?wsdl
-&runCommand;
\ No newline at end of file
+
+
+ ExecuteServices
+ The ExecuteService bundles local and remote command
+ execution operations. Its WSDL is located at
+ http://server:port/XServices/ExecuteService?wsdl
+
+
+
+
+
\ No newline at end of file
diff --git a/doc/ExecuteServices/rExec.xml b/doc/ExecuteServices/rExec.xml
new file mode 100644
index 0000000..91e137d
--- /dev/null
+++ b/doc/ExecuteServices/rExec.xml
@@ -0,0 +1,62 @@
+
+
+
+%myent;
+]>
+
+ &rExec;
+
+ provides remote execution facilities with authentication based on
+ user names and passwords.
+
+ &inp;
+
+
+
+ &rExec;
+ input parameters
+
+
+
+
+
+
+
+
+ parameter
+ type
+ required
+ description
+
+
+
+
+ host
+ HostConnection
+ Yes
+
+ Host where to execute the command. See
+ HostConnection
+ .
+
+
+
+ command
+ String
+ No
+ Any command including arguments
+
+ ¶m-timeout;
+
+
+
+
+
+
+ &outp;
+
+
+
+
\ No newline at end of file
diff --git a/doc/ExecuteServices/runCommand.xml b/doc/ExecuteServices/runCommand.xml
index 11b8a91..92703b3 100644
--- a/doc/ExecuteServices/runCommand.xml
+++ b/doc/ExecuteServices/runCommand.xml
@@ -1,42 +1,56 @@
-
- runCommand
- 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.
-
- &inp;
-
-
- runCommand input parameters
-
-
-
-
-
-
-
- parameter
- type
- required
- description
-
-
-
-
- executable
- String
- Yes
- Command to be run. The command may be specified with full path using forward slash "/" as path separator.
-
-
- argline
- String
- No
- Any command line arguments
-
+
+
+%myent;
+]>
+
+ runCommand
+ 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.
+
+ &inp;
+
+
+
+ runCommand input parameters
+
+
+
+
+
+
+
+ parameter
+ type
+ required
+ description
+
+
+
+
+ executable
+ String
+ Yes
+ Command to be run. The command may be specified with full
+ path using forward slash "/" as path separator.
+
+
+ argline
+ String
+ No
+ Any command line arguments
+
¶m-timeout;
-
-
-
-
-&returncode;
-
+
+
+
+
+
+
+ &outp;
+
+
+
\ No newline at end of file
diff --git a/doc/ExecuteServices/runCommandWithSSH.xml b/doc/ExecuteServices/runCommandWithSSH.xml
new file mode 100644
index 0000000..d638389
--- /dev/null
+++ b/doc/ExecuteServices/runCommandWithSSH.xml
@@ -0,0 +1,73 @@
+
+
+%myent;
+]>
+
+ runCommandWithSSH
+ Executes a command through a SSH session.
+
+ &inp;
+
+
+
+ runCommandWithSSH input parameters
+
+
+
+
+
+
+
+ parameter
+ type
+ required
+ description
+
+
+
+
+ host
+ HostConnection
+ Yes
+
+ Host to connect to (see:
+ tns:HostConnection
+ )
+
+
+
+ command
+ String
+ No
+ The command to execute.
+
+ ¶m-timeout;
+
+
+
+
+
+
+ &outp;
+
+
+
+
+ Sample Request:
+
+
+
+ ssh.brutex.net
+ 22
+ roger
+ xxx
+
+ ls /etc/
+ 30000
+
+ ]]>
+
+
\ No newline at end of file
diff --git a/doc/ExecuteServices/telnet.xml b/doc/ExecuteServices/telnet.xml
new file mode 100644
index 0000000..4d3197f
--- /dev/null
+++ b/doc/ExecuteServices/telnet.xml
@@ -0,0 +1,83 @@
+
+
+%myent;
+]>
+
+ telnet
+ Runs a telnet session with an "expect shell" like behaviour.
+
+ &inp;
+
+
+
+ telnet input parameters
+
+
+
+
+
+
+
+ parameter
+ type
+ required
+ description
+
+
+
+
+ host
+ HostConnection
+ Yes
+ Host to connect to (see: tns:HostConnection)
+
+
+ prompt
+ String
+ No
+ The prompt string to expect after login. This is used to recognize when
+ the session is open.
+
+
+ command
+ String
+ No
+ The command to execute.
+
+
+ expect
+ String
+ No
+ The prompt to expect after the command has been executed successfully.
+
+ ¶m-timeout;
+
+
+
+
+
+
+ &outp;
+
+
+
+ Sample Request:
+
+
+
+ localhost
+ 23
+ brosenberger
+
+
+ C:\Users\brosenberger>
+ dir c:\temp
+ enberger>
+ 60000
+
+ ]]>
+
+
\ No newline at end of file
diff --git a/doc/FileServices.xml b/doc/FileServices.xml
new file mode 100644
index 0000000..7f99c82
--- /dev/null
+++ b/doc/FileServices.xml
@@ -0,0 +1,8 @@
+
+
+ FileServices
+ The FileServces bundles various file operations. Its WSDL is located at
+ http://server:port/XServices/FileService?wsdl
+
\ No newline at end of file
diff --git a/doc/MiscServices.xml b/doc/MiscServices.xml
new file mode 100644
index 0000000..ef92133
--- /dev/null
+++ b/doc/MiscServices.xml
@@ -0,0 +1,9 @@
+
+
+ MiscServices
+ The MiscService bundles various operations. Its WSDL is located at
+ http://server:port/XServices/MiscService?wsdl
+
+
\ No newline at end of file
diff --git a/doc/Types.xml b/doc/Types.xml
index 2874d56..92a2c39 100644
--- a/doc/Types.xml
+++ b/doc/Types.xml
@@ -1,4 +1,12 @@
-
- XML Types
- This chapter bundles the documentation for common xml types used by XServices web service.
-&returncode;&patternsettype;&selectortype;&antproperty;&patternelement;
\ No newline at end of file
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/doc/XServices.xml b/doc/XServices.xml
deleted file mode 100644
index 94681fa..0000000
--- a/doc/XServices.xml
+++ /dev/null
@@ -1,3 +0,0 @@
-
- &brs;
-&ArchiveServices;&ExecuteServices;
\ No newline at end of file
diff --git a/doc/XServices_V1.0-User_Guide.odt b/doc/XServices_V1.0-User_Guide.odt
deleted file mode 100644
index 48f5e17..0000000
Binary files a/doc/XServices_V1.0-User_Guide.odt and /dev/null differ
diff --git a/doc/abstract.xml b/doc/abstract.xml
deleted file mode 100644
index b09a9df..0000000
--- a/doc/abstract.xml
+++ /dev/null
@@ -1,20 +0,0 @@
-
-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).
-&brs; 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.
-&brs; 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 &brs; add
- Web Services (SOAP) wrapper around Apache Ant tasks (since XBridgeNG 2.0)
-
-
-
-The current focus is on file-based operations. &brs; do not contain an integration server or a process execution engine.
diff --git a/doc/common/abstract.xml b/doc/common/abstract.xml
new file mode 100644
index 0000000..3015c24
--- /dev/null
+++ b/doc/common/abstract.xml
@@ -0,0 +1,59 @@
+
+
+ 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.
+
+
diff --git a/doc/common/installation.xml b/doc/common/installation.xml
new file mode 100644
index 0000000..d5ad632
--- /dev/null
+++ b/doc/common/installation.xml
@@ -0,0 +1,61 @@
+
+
+
+
+ Installation
+ tbd.
+ Sun Java SE 1.6.0
+ Apache Tomcat 7
+ tbd.
+ In short: Deploy .WAR file to Apache Tomcat
+
+ Securing with Basic Authentication
+ There is a quick guide explaining Basic Authentication for Tomcat here:
+ http://oreilly.com/pub/a/java/archive/tomcat-tips.html?page=1
+
+
+
+
+
+
+ Limit access to
+ 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.
+ 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.
+ <Context
+ path="/XService/ArchiveService"
+ ...> <Valve
+ className="org.apache.catalina.valves.RemoteAddrValve"
+ allow="127.0.0.1" deny=""/> </Context>
+
+ 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.
+
+ The <context> element must be placed into the
+ server.xml
+ file (into <engine><host>).
+
+
+
\ No newline at end of file
diff --git a/doc/entities.ent b/doc/entities.ent
index 15bf21a..2c15441 100644
--- a/doc/entities.ent
+++ b/doc/entities.ent
@@ -1,6 +1,6 @@
-BruteXservices">
+
timeoutLong
@@ -12,9 +12,4 @@
Schema definition">
-
-
-
-
-
diff --git a/doc/getting-started.xml b/doc/getting-started.xml
deleted file mode 100644
index 20aaabe..0000000
--- a/doc/getting-started.xml
+++ /dev/null
@@ -1,32 +0,0 @@
-
-
- Getting started
- This chapter describes the installation.
-
- Prerequisites
- tbd.
- Sun Java SE 1.6.0
- Apache Tomcat 6
-
-
- Installation
- tbd.
- In short: Deploy .WAR file to Apache Tomcat
-
- Securing &brs; with Basic Authentication
- There is a quick guide explaining Basic Authentication for Tomcat here:
-
-
-
- Limit access to &brs;
- Sometimes you'll only want to restrict access to &brs; to only specified host names or IP addresses. This way, only clients at those specified addresses can use the &brs; web services. Tomcat provides two configuration values for that: RemoteHostValve and RemoteAddrValve.
- 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.
- <Context path="/XService/ArchiveService" ...>
- <Valve className="org.apache.catalina.valves.RemoteAddrValve"
- allow="127.0.0.1" deny=""/>
- </Context>
- 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.
- The <context> element must be placed into the server.xml file (into <engine><host>).
-
-
-
\ No newline at end of file
diff --git a/doc/types/AntProperty.xml b/doc/types/AntProperty.xml
index c10576e..529e496 100644
--- a/doc/types/AntProperty.xml
+++ b/doc/types/AntProperty.xml
@@ -1,24 +1,31 @@
-
- AntProperty type
- The AntProperty type defines a list of key/value pairs.
- The defining Java class is
-
- net.brutex.xservices.types.AntProperty.
-&schemadefinition;
-
-
-
-
-
-]]>
-
-&examplexml;
-
- key2
- value2
-]]>
-
-
-
\ No newline at end of file
+
+
+AntProperty type
+ The AntProperty type defines a list of key/value pairs.
+
+ The defining Java class is
+
+ net.brutex.xservices.types.AntProperty
+
+ .
+
+
+
+
+
+
+
+]]>
+
+
+
+ key2
+ value2
+]]>
+
+
\ No newline at end of file
diff --git a/doc/types/FileResource.xml b/doc/types/FileResource.xml
new file mode 100644
index 0000000..6ab8582
--- /dev/null
+++ b/doc/types/FileResource.xml
@@ -0,0 +1,34 @@
+
+
+FileResource type
+ The FileResource type defines an URI to a file with optional on-the-fly decompression.
+
+ The defining Java class is
+
+ net.brutex.xservices.types.FileResource
+
+ .
+
+
+
+
+
+
+
+]]>
+
+ Available types:
+ FILE: URI points to a local file resource. Examples: c:\temp\something.txt, c:/dir/another.file, /home/brian/file
+ URL: File from URL (http, https, ftp, ...). Example: http://brutex.net/file.pdf
+ GZIP and BZIP2: File from a local file system with on-the-fly decompression.
+
+ FILE
+ c:\temp\xservices.war
+]]>
+
+
\ No newline at end of file
diff --git a/doc/types/HostConnection.xml b/doc/types/HostConnection.xml
new file mode 100644
index 0000000..37a0350
--- /dev/null
+++ b/doc/types/HostConnection.xml
@@ -0,0 +1,37 @@
+
+
+ HostConnection type
+ The HostConnection type identifies a server resource and login
+ credentials.
+
+ The defining Java class is
+
+ net.brutex.xservices.types.HostConnection
+
+ .
+
+ Schema definition
+
+
+
+
+
+
+
+
+]]>
+
+ Example XML
+
+ server.brutex.net
+ 512
+ brian
+
+ somepass
+
+]]>
+
+
diff --git a/doc/types/PatternElement.xml b/doc/types/PatternElement.xml
index 1c26425..ea30aac 100644
--- a/doc/types/PatternElement.xml
+++ b/doc/types/PatternElement.xml
@@ -1,31 +1,52 @@
-
- PatternElement type
- The PatternElement type defines single string pattern for file/ directory matching.
- The defining Java class is
-
- net.brutex.xservices.types.PatternElement
- .
-
- These patterns look exactly like those used in Apache Ant
- Patterns.
- 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.
-
- Some example patterns:
- **/mydir/**
- 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.
- /mydir/
- The parser will automatically append an '**' symbol, thus the resulting pattern is /mydir/**. All files below the "/mydir/" directory (including its sub-directories will be chosen.
-
- The pattern is OS independent. You should always use "/" as path separator, even on windows based systems.
-
- &schemadefinition;
-
+
+
+ PatternElement type
+ The PatternElement type defines single string pattern for file/
+ directory matching.
+
+ The defining Java class is
+
+ net.brutex.xservices.types.PatternElement
+
+ .
+
+
+ These patterns look exactly like those used in Apache Ant
+ Patterns.
+ 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.
+
+ Some example patterns:
+
+ **/mydir/**
+
+ 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.
+
+ /mydir/
+
+ The
+ parser will automatically append an '**' symbol, thus the
+ resulting pattern is
+ /mydir/**.
+ All files below the "/mydir/" directory (including its
+ sub-directories will be chosen.
+
+
+ The pattern is OS independent. You should always use
+ "/" as path separator, even on windows based systems.
+
+
+ Schema definition
+
]]>
-&examplexml;
- **/*]]>
+ Example XML
+ **/*]]>
\ No newline at end of file
diff --git a/doc/types/PatternSetType.xml b/doc/types/PatternSetType.xml
index 59bbabb..be41642 100644
--- a/doc/types/PatternSetType.xml
+++ b/doc/types/PatternSetType.xml
@@ -1,23 +1,32 @@
-
- PatternSetType type
- The PatternSetType exposes various filters/ selectors for the selection of resources (files).
- The defining Java class is
-
- net.brutex.xservices.types.PatternSetType.
- &schemadefinition;
-
+ PatternSetType type
+ The PatternSetType exposes various filters/ selectors for the
+ selection of resources (files).
+
+ The defining Java class is
+
+ net.brutex.xservices.types.PatternSetType
+
+ .
+
+ Schema definition
+
- tns:patternElement
- tns:patternElement
- tns:selectorType
+ tns:patternElement
+ tns:patternElement
+ tns:selectorType
]]>
-
-&examplexml;
-
+ Example XML
+
-
+
diff --git a/doc/types/ReturnCode.xml b/doc/types/ReturnCode.xml
index 94560f2..c87ee60 100644
--- a/doc/types/ReturnCode.xml
+++ b/doc/types/ReturnCode.xml
@@ -1,34 +1,53 @@
-
- ReturnCode type
- The ReturnCode type is used as the generic answer type for most of the &brs; operations.
- The defining Java class is
-
- net.brutex.xservices.types.ReturnCode.
-&schemadefinition;
-
+
+ ReturnCode type
+
+ The ReturnCode type is used as the generic answer type for most of the
+ BruteXservices
+ operations.
+
+
+ The defining Java class is
+
+ net.brutex.xservices.types.ReturnCode
+
+ .
+
+ Schema definition
+
- tns:antProperty
+ tns:antProperty
]]>
-
+
-&examplexml;
- <ReturnCode xmlns:ns2="http://ws.xservices.brutex.net">
- <returnCode>0</returnCode>
- <stdOut/>
- <stdErr/>
- <propertyList> See tns:antProperty for details about the <propertyList> elements.
- <name>key1</name>
- <value>value1</value>
- </propertyList>
- <propertyList>
- <name>key2</name>
- <value>value2</value>
- </propertyList>
- </ReturnCode>
+ Example XML
+
+ <ReturnCode
+ xmlns:ns2="http://ws.xservices.brutex.net">
+ <returnCode>0</returnCode>
+ <stdOut/>
+ <stdErr/>
+ <propertyList>
+
+ See
+ tns:antProperty
+ for details about the <propertyList> elements.
+
+ <name>key1</name>
+ <value>value1</value>
+ </propertyList>
+ <propertyList>
+ <name>key2</name>
+ <value>value2</value>
+ </propertyList>
+ </ReturnCode>
+
\ No newline at end of file
diff --git a/doc/types/SelectorType.xml b/doc/types/SelectorType.xml
index 20d9b52..27173c2 100644
--- a/doc/types/SelectorType.xml
+++ b/doc/types/SelectorType.xml
@@ -1,11 +1,13 @@
-
+SelectorType typeThe SelectorType exposes various selectors for the selection of resources (files).The defining Java class is
net.brutex.xservices.types.SelectorType.
-&schemadefinition;
+Schema definition
@@ -13,7 +15,7 @@
]]>
-&examplexml;
+Example XML