From 84243b901deef0dce6d02461ab7c9f3ece16bf0a Mon Sep 17 00:00:00 2001 From: Brian Rosenberger Date: Mon, 15 Feb 2010 20:06:47 +0000 Subject: [PATCH] Moving to docbook style documentation git-svn-id: https://brutex.net/svn/xservices/trunk@24 e7e49efb-446e-492e-b9ec-fcafc1997a86 --- doc/ArchiveServices.xml | 5 + doc/ExecuteServices.xml | 5 + doc/ExecuteServices/runCommand.xml | 42 ++++ doc/Types.xml | 4 + doc/XServices.xml | 3 + doc/abstract.xml | 21 ++ doc/buch.html | 361 +++++++++++++++++++++++++++++ doc/buch.xml | 26 +++ doc/entities.ent | 13 ++ doc/getting-started.xml | 32 +++ doc/types/AntProperty.xml | 27 +++ doc/types/PatternElement.xml | 21 ++ doc/types/ReturnCode.xml | 36 +++ 13 files changed, 596 insertions(+) create mode 100644 doc/ArchiveServices.xml create mode 100644 doc/ExecuteServices.xml create mode 100644 doc/ExecuteServices/runCommand.xml create mode 100644 doc/Types.xml create mode 100644 doc/XServices.xml create mode 100644 doc/abstract.xml create mode 100644 doc/buch.html create mode 100644 doc/buch.xml create mode 100644 doc/entities.ent create mode 100644 doc/getting-started.xml create mode 100644 doc/types/AntProperty.xml create mode 100644 doc/types/PatternElement.xml create mode 100644 doc/types/ReturnCode.xml diff --git a/doc/ArchiveServices.xml b/doc/ArchiveServices.xml new file mode 100644 index 0000000..8b52bbd --- /dev/null +++ b/doc/ArchiveServices.xml @@ -0,0 +1,5 @@ +
+ 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/ExecuteServices.xml b/doc/ExecuteServices.xml new file mode 100644 index 0000000..9e6a82d --- /dev/null +++ b/doc/ExecuteServices.xml @@ -0,0 +1,5 @@ +
+ 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 diff --git a/doc/ExecuteServices/runCommand.xml b/doc/ExecuteServices/runCommand.xml new file mode 100644 index 0000000..a9a4b85 --- /dev/null +++ b/doc/ExecuteServices/runCommand.xml @@ -0,0 +1,42 @@ +
+ 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; +
+
\ No newline at end of file diff --git a/doc/Types.xml b/doc/Types.xml new file mode 100644 index 0000000..9a9f1b7 --- /dev/null +++ b/doc/Types.xml @@ -0,0 +1,4 @@ + + XML Types + This chapter bundles the documentation for common xml types used by XServices web service. +&returncode;&antproperty;&patternelement; \ No newline at end of file diff --git a/doc/XServices.xml b/doc/XServices.xml new file mode 100644 index 0000000..94681fa --- /dev/null +++ b/doc/XServices.xml @@ -0,0 +1,3 @@ + + &brs; +&ArchiveServices;&ExecuteServices; \ No newline at end of file diff --git a/doc/abstract.xml b/doc/abstract.xml new file mode 100644 index 0000000..0985d03 --- /dev/null +++ b/doc/abstract.xml @@ -0,0 +1,21 @@ + + 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. + \ No newline at end of file diff --git a/doc/buch.html b/doc/buch.html new file mode 100644 index 0000000..cd6a1bd --- /dev/null +++ b/doc/buch.html @@ -0,0 +1,361 @@ + + + +BruteXservices User Guide + + +
+
+
+

+BruteXservices User Guide

+
+

+Brian Rosenberger +

+ +
+

Copyright 2010

+
+
+
+
+

Table of Contents

+
+
1. Abstract
+
2. Getting startet
+
+
Prerequisites
+
Installation
+
+
Securing BruteXservices with Basic Authentication
+
Limit access to BruteXservices
+
+
+
3. BruteXservices
+
+
ArchiveServices
+
ExecuteServices
+
runCommand
+
+
4. XML Types
+
+
ReturnCode type
+
+
Schema description
+
Example XML
+
+
AntProperty type
+
+
Schema description
+
Example XML
+
+
PatternElement type
+
+
Schema description
+
Example XML
+
+
+
+
+
+

List of Tables

+
3.1. runCommand input parameters +
+
+
+

+Chapter1.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).

+

BruteXservices 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.

+

BruteXservices 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 BruteXservices add + Web Services (SOAP) wrapper around Apache Ant tasks (since XBridgeNG 2.0)

    • +
+

The current focus is on file-based operations. BruteXservices do not contain an integration server or a process execution engine.

+
+
+

+Chapter2.Getting startet

+
+

Table of Contents

+
+
Prerequisites
+
Installation
+
+
Securing BruteXservices with Basic Authentication
+
Limit access to BruteXservices
+
+
+
+

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 BruteXservices 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 BruteXservices +

+

Sometimes you'll only want to restrict access to BruteXservices to only specified host names or IP addresses. This way, only clients at those specified addresses can use the BruteXservices 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>).

+
+
+
+
+

+Chapter3.BruteXservices +

+
+

Table of Contents

+
+
ArchiveServices
+
ExecuteServices
+
runCommand
+
+
+
+

+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.

+
+

+Input parameters

+

+
+

Table3.1.runCommand input parameters

+ ++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + +
parametertyperequireddescription
executableStringYesCommand to be run. The command may be specified with full path using forward slash “/” as path separator.
arglineStringNoAny command line arguments
timeoutLongYesTimeout in milliseconds. The command is forcefully terminated when timeout is reached.
+
+

+
+
+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 description
+
+<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="tns:antProperty"/>
+    </xs:sequence>
+            </xs:complexType>
+
+
+
+
+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>
+
+
+
+
+
+
+
+

+Chapter4.XML Types

+
+

Table of Contents

+
+
ReturnCode type
+
+
Schema description
+
Example XML
+
+
AntProperty type
+
+
Schema description
+
Example XML
+
+
PatternElement type
+
+
Schema description
+
Example XML
+
+
+
+

This chapter bundles the documentation for common xml types used by XServices web service.

+
+

+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 description

+
+<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="tns:antProperty"/>
+    </xs:sequence>
+            </xs:complexType>
+
+
+
+

+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>
+
+
+
+

+AntProperty type

+

The AntProperty type defines a list of key/value pairs.

+

The defining Java class is + + net.brutex.xservices.types.AntProperty.

+
+

+Schema description

+
+<xs:complexType name="antProperty">
+   <xs:sequence>
+      <xs:element name="name" type="xs:string"/>
+      <xs:element name="value" type="xs:string"/>
+   </xs:sequence>
+</xs:complexType>
+
+
+
+

+Example XML

+
+<AntProperty>
+    <name>key2</name>
+    <value>value2</value>
+</AntProperty>
+
+
+
+
+

+PatternElement type

+

The PatternElement type defines single string pattern.

+

The defining Java class is + + net.brutex.xservices.types.PatternElement.

+
+

+Schema description

+
+<xs:simpleType name="patternElement">
+    <xs:restriction base="xs:string"/>
+</xs:simpleType>
+
+
+
+

+Example XML

+
+<PatternElement>**/*</PatternElement>
+
+
+
+
+
+ diff --git a/doc/buch.xml b/doc/buch.xml new file mode 100644 index 0000000..c6582fb --- /dev/null +++ b/doc/buch.xml @@ -0,0 +1,26 @@ + + + + + + + + + +%myent; +]> + + &brs; User Guide + + + Brian + Rosenberger + bru@brutex.de + + Brutex Network + + 2010 + + +&abstract;&getting-started;&xservices;&types; diff --git a/doc/entities.ent b/doc/entities.ent new file mode 100644 index 0000000..0f02a9c --- /dev/null +++ b/doc/entities.ent @@ -0,0 +1,13 @@ + + +BruteXservices"> + + timeout + Long + Yes + Timeout in milliseconds. The command is forcefully terminated when timeout is reached. + "> + + + + diff --git a/doc/getting-started.xml b/doc/getting-started.xml new file mode 100644 index 0000000..fbf0648 --- /dev/null +++ b/doc/getting-started.xml @@ -0,0 +1,32 @@ + + + Getting startet + 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 new file mode 100644 index 0000000..5fc320c --- /dev/null +++ b/doc/types/AntProperty.xml @@ -0,0 +1,27 @@ +
+ AntProperty type + The AntProperty type defines a list of key/value pairs. + The defining Java class is + + net.brutex.xservices.types.AntProperty. +
+ Schema description + + + + + +]]> + +
+
+ Example XML + + key2 + value2 +]]> + +
+
\ No newline at end of file diff --git a/doc/types/PatternElement.xml b/doc/types/PatternElement.xml new file mode 100644 index 0000000..f66ead6 --- /dev/null +++ b/doc/types/PatternElement.xml @@ -0,0 +1,21 @@ +
+ PatternElement type + The PatternElement type defines single string pattern. + The defining Java class is + + net.brutex.xservices.types.PatternElement. +
+ Schema description + + +]]> + +
+
+ Example XML + **/*]]> + +
+
\ No newline at end of file diff --git a/doc/types/ReturnCode.xml b/doc/types/ReturnCode.xml new file mode 100644 index 0000000..555bc52 --- /dev/null +++ b/doc/types/ReturnCode.xml @@ -0,0 +1,36 @@ +
+ 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. +
+ Schema description + + + + + + 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> +
+
\ No newline at end of file