diff --git a/doc/BruteXServices_User_Guide.xml b/doc/BruteXServices_User_Guide.xml index e6019c9..555516d 100644 --- a/doc/BruteXServices_User_Guide.xml +++ b/doc/BruteXServices_User_Guide.xml @@ -1,40 +1,178 @@ - - - - - - - - - -%myent; -]> - - &brs; 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; - -&getting-started;&xservices;&types; + + + + 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>). + + + + + + <section> + <title>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. +
+ + <para /> + <table frame="all"> + <title>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. + +