Subversion Repositories XServices

Compare Revisions

Regard whitespace Rev 24 → Rev 26

/xservices/trunk/doc/buch.html
File deleted
/xservices/trunk/doc/buch.xml
File deleted
/xservices/trunk/doc/abstract.xml
1,16 → 1,15
<?xml version='1.0' encoding='UTF-8'?><chapter>
<?xml version='1.0' encoding='UTF-8'?>
<title>Abstract</title>
<para>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.</para>
<para>These are the major goals of the loosely coupled integration strategy which is in turn one essential idea of a service-oriented architecture (SOA).</para>
<para>&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.</para>
<para>&brs; is an add-on to XBridgeNG 2.0. It runs standalone or in combination with XBridgeNG. Pure XBridgeNG has two components:</para>
<itemizedlist>
<para><itemizedlist>
<listitem>
<para>XML Schema for item based data types (e.g. tickets from a bug tracker system or a database record)</para>
</listitem>
<listitem>
<para>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, …)
</para>
<para>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, ...)</para>
</listitem>
<listitem>
<para>The &brs; add
17,5 → 16,5
Web Services (SOAP) wrapper around Apache Ant tasks (since XBridgeNG 2.0)</para>
</listitem>
</itemizedlist>
</para>
<para>The current focus is on file-based operations. &brs; do not contain an integration server or a process execution engine.</para>
</chapter>
/xservices/trunk/doc/Types.xml
1,4 → 1,4
<?xml version='1.0' encoding='UTF-8'?><chapter>
<title>XML Types</title>
<para>This chapter bundles the documentation for common xml types used by XServices web service.</para>
&returncode;&antproperty;&patternelement;</chapter>
&returncode;&patternsettype;&selectortype;&antproperty;&patternelement;</chapter>
/xservices/trunk/doc/getting-started.xml
1,6 → 1,6
<?xml version='1.0' encoding='UTF-8'?><chapter>
<beginpage/>
<title>Getting startet</title>
<title>Getting started</title>
<para>This chapter describes the installation.</para>
<sect1>
<title>Prerequisites</title>
/xservices/trunk/doc/types/SelectorType.xml
0,0 → 1,20
<?xml version="1.0" encoding="UTF-8"?>
<section id="selectortype">
<title>SelectorType type</title>
<para>The SelectorType exposes various selectors for the selection of resources (files).</para>
<para>The defining Java class is
<ulink url="javadoc/net/brutex/xservices/types/SelectorType.html">
<classname>net.brutex.xservices.types.SelectorType</classname></ulink>.</para>
&schemadefinition;
<programlisting language="xml"><![CDATA[
<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>]]>
</programlisting>
&examplexml;
<programlisting language="xml"><![CDATA[
tbd.]]>
</programlisting>
</section>
/xservices/trunk/doc/types/AntProperty.xml
4,8 → 4,7
<para>The defining Java class is
<ulink url="javadoc/net/brutex/xservices/types/AntProperty.html">
<classname>net.brutex.xservices.types.AntProperty</classname></ulink>.</para>
<section>
<title>Schema description</title>
&schemadefinition;
<programlisting language="xml"><![CDATA[
<xs:complexType name="antProperty">
<xs:sequence>
14,9 → 13,7
</xs:sequence>
</xs:complexType>]]>
</programlisting>
</section>
<section>
<title>Example XML </title>
&examplexml;
<programlisting language="xml"><![CDATA[
<AntProperty>
<name>key2</name>
23,5 → 20,5
<value>value2</value>
</AntProperty>]]>
</programlisting>
</section>
 
</section>
/xservices/trunk/doc/types/PatternElement.xml
1,21 → 1,31
<?xml version='1.0' encoding='UTF-8'?><section id="patternelement">
<title>PatternElement type</title>
<para>The PatternElement type defines single string pattern.</para>
<para>The PatternElement type defines single string pattern for file/ directory matching.</para>
<para>The defining Java class is
<ulink url="javadoc/net/brutex/xservices/types/PatternElement.html">
<classname>net.brutex.xservices.types.PatternElement</classname></ulink>.</para>
<section>
<title>Schema description</title>
<programlisting language="xml"><![CDATA[
<xs:simpleType name="patternElement">
<classname>net.brutex.xservices.types.PatternElement</classname>
</ulink>.
</para>
<para>These patterns look exactly like those used in Apache Ant
<ulink url="http://ant.apache.org/manual/dirtasks.html#patterns">Patterns</ulink>.
The &apos;*&apos; matches zero or more characters and the &apos;?&apos; will match a single character.
Both symbols can be combined in one pattern. The &apos;**&apos;
symbol can be used to match any directory deepth.
</para>
<para>Some example patterns:</para>
<para><parameter>**/mydir/**</parameter></para>
<para>Match all file that are located in any directory that has &quot;mydir&quot; string in its pathname. Also applies to files with &quot;mydir&quot; in their name.</para>
<para><parameter>/mydir/</parameter></para>
<para>The parser will automatically append an &apos;**&apos; symbol, thus the resulting pattern is <parameter>/mydir/**</parameter>. All files below the &quot;/mydir/&quot; directory (including its sub-directories will be chosen.</para>
<note>
<para>The pattern is OS independent. You should always use &quot;/&quot; as path separator, even on windows based systems.</para>
</note>
&schemadefinition;
<programlisting language="xml"><![CDATA[<xs:simpleType name="patternElement">
<xs:restriction base="xs:string"/>
</xs:simpleType>]]>
</programlisting>
</section>
<section>
<title>Example XML</title>
<programlisting language="xml"><![CDATA[
<PatternElement>**/*</PatternElement>]]>
</programlisting>
</section>
</xs:simpleType>]]></programlisting>
 
&examplexml;
<programlisting language="xml"><![CDATA[<PatternElement>**/*</PatternElement>]]></programlisting>
 
</section>
/xservices/trunk/doc/types/ReturnCode.xml
2,10 → 2,9
<title>ReturnCode type</title>
<para>The ReturnCode type is used as the generic answer type for most of the &brs; operations.</para>
<para>The defining Java class is
<ulink url="javadoc/net/brutex/xservices/types/ReturnCode.html">
<ulink url="&javadoc-base;javadoc/net/brutex/xservices/types/ReturnCode.html">
<classname>net.brutex.xservices.types.ReturnCode</classname></ulink>.</para>
<section>
<title>Schema description</title>
&schemadefinition;
<programlisting language="xml"><![CDATA[
<xs:complexType name="ReturnCodeType">
<xs:sequence>
16,9 → 15,8
</xs:sequence>
</xs:complexType>]]>
</programlisting>
</section>
<section>
<title>Example XML </title>
 
&examplexml;
<programlisting language="xml">&lt;ReturnCode xmlns:ns2=&quot;http://ws.xservices.brutex.net&quot;&gt;
&lt;returnCode&gt;0&lt;/returnCode&gt;
&lt;stdOut/&gt;
32,5 → 30,5
&lt;value&gt;value2&lt;/value&gt;
&lt;/propertyList&gt;
&lt;/ReturnCode&gt;</programlisting>
</section>
 
</section>
/xservices/trunk/doc/types/PatternSetType.xml
0,0 → 1,23
<?xml version="1.0" encoding="UTF-8"?>
<section id="patternsettype">
<title>PatternSetType type</title>
<para>The PatternSetType exposes various filters/ selectors for the selection of resources (files).</para>
<para>The defining Java class is
<ulink url="javadoc/net/brutex/xservices/types/PatternSetType.html">
<classname>net.brutex.xservices.types.PatternSetType</classname></ulink>.</para>
&schemadefinition;
<programlisting language="xml"><![CDATA[
<xs:complexType name="patternSetType">
<xs:sequence>
<xs:element default="**/*" maxOccurs="unbounded" minOccurs="0" name="include" type="]]><link linkend="patternelement">tns:patternElement</link><![CDATA["/>
<xs:element maxOccurs="unbounded" minOccurs="0" name="exclude" type="]]><link linkend="patternelement">tns:patternElement</link><![CDATA["/>
<xs:element minOccurs="0" name="selector" nillable="true" type="]]><link linkend="selectortype">tns:selectorType</link><![CDATA["/>
</xs:sequence>
</xs:complexType>]]>
</programlisting>
&examplexml;
<programlisting language="xml"><![CDATA[
tbd.]]>
</programlisting>
</section>
 
/xservices/trunk/doc/ExecuteServices/runCommand.xml
24,7 → 24,7
<entry>executable</entry>
<entry>String</entry>
<entry>Yes</entry>
<entry>Command to be run. The command may be specified with full path using forward slash “/” as path separator.</entry>
<entry>Command to be run. The command may be specified with full path using forward slash &quot;/&quot; as path separator.</entry>
</row>
<row>
<entry>argline</entry>
/xservices/trunk/doc/BruteXServices_User_Guide.xml
0,0 → 1,40
<?xml version='1.0' encoding='UTF-8'?>
<!-- This document was created with Syntext Serna Free. --><!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "docbookV4.5/docbookx.dtd" [
<!ENTITY types SYSTEM "Types.xml">
<!ENTITY runCommand SYSTEM "ExecuteServices/runCommand.xml">
<!ENTITY ArchiveServices SYSTEM "ArchiveServices.xml">
<!ENTITY ExecuteServices SYSTEM "ExecuteServices.xml">
<!ENTITY xservices SYSTEM "XServices.xml">
<!ENTITY abstract SYSTEM "abstract.xml">
<!ENTITY getting-started SYSTEM "getting-started.xml">
<!ENTITY % myent SYSTEM "entities.ent">
%myent;
]>
<book>
<title>&brs; User Guide</title>
<bookinfo>
<date>February, 16th 2010</date>
<author>
<firstname>Brian</firstname>
<surname>Rosenberger</surname>
<email>bru@brutex.de</email>
</author>
<corpname>Brutex Network</corpname>
<pubdate>1997</pubdate>
<copyright>
<year>2010</year>
</copyright>
<legalnotice>
<para>The copyright holders make no representation about the suitability of
this document for any purpose. It is provided <quote>as is</quote> without expressed
or implied warranty.</para>
</legalnotice>
<legalnotice>
<para>
Apache Tomcat and Apache Ant are trademarks of the Apache Software Foundation.
</para>
</legalnotice>
<abstract>
&abstract; </abstract>
</bookinfo>
&getting-started;&xservices;&types;</book>
/xservices/trunk/doc/entities.ent
7,7 → 7,14
<entry>Yes</entry>
<entry>Timeout in milliseconds. The command is forcefully terminated when timeout is reached.</entry>
</row>">
<!ENTITY javadoc-base "file:///home/brian/NetBeansProjects/XServices/dist/">
<!ENTITY examplexml "<bridgehead renderas='sect3'>Example XML</bridgehead>">
<!ENTITY schemadefinition "<bridgehead renderas='sect3'>Schema definition</bridgehead>">
 
 
<!ENTITY returncode SYSTEM "types/ReturnCode.xml">
<!ENTITY antproperty SYSTEM "types/AntProperty.xml">
<!ENTITY patternelement SYSTEM "types/PatternElement.xml">
<!ENTITY patternsettype SYSTEM "types/PatternSetType.xml">
<!ENTITY selectortype SYSTEM "types/SelectorType.xml">