Subversion Repositories XServices

Rev

Go to most recent revision | Details | Last modification | View Log | RSS feed

Rev Author Line No. Line
43 brianR 1
<?xml version='1.0'?>
2
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">
3
<book>
4
  <title>User Guide</title>
5
  <bookinfo>
6
    <date>February, 16th 2010</date>
7
    <author>
8
      <firstname>Brian</firstname>
9
      <surname>Rosenberger</surname>
10
      <email>bru@brutex.de</email>
11
    </author>
12
    <corpname>Brutex Network</corpname>
13
    <pubdate>1997</pubdate>
14
    <copyright><year>2010</year></copyright>
15
    <legalnotice>
16
      <para>The copyright holders make no representation about the
17
      suitability of this document for any purpose. It is provided
18
      <quote>as is</quote> without expressed or implied warranty.</para>
19
    </legalnotice>
20
    <legalnotice>
21
      <para>Apache Tomcat and Apache Ant are trademarks of the Apache
22
      Software Foundation.</para>
23
    </legalnotice>
24
    <abstract>
25
      <title>Abstract</title>
26
      <para>In complex IT environments it is necessary to integrate
27
      different information systems with each other, exchange data
28
      between tools and automate actions and function calls depending
29
      on events arising from user interaction. To meet the requirements
30
      of integration building usually means to implement APIs and to
31
      create tool-to-tool bridges. Web Services can help to clean up
32
      bridges into interfaces as well as to abstract functions from
33
      their underlying platform and implementation.</para>
34
      <para>These are the major goals of the loosely coupled
35
      integration strategy which is in turn one essential idea of a
36
      service-oriented architecture (SOA).</para>
37
      <para>provide a low level set of functions and web services.
38
      These can be orchestrated into services and used in business
39
      processes which make up the execution part of a SOA
40
      environment.</para>
41
      <para>is an add-on to XBridgeNG 2.0. It runs standalone or in
42
      combination with XBridgeNG. Pure XBridgeNG has two
43
      components:</para>
44
      <para>
45
        <itemizedlist>
46
          <listitem>
47
            <para>XML Schema for item based data types (e.g. tickets
48
            from a bug tracker system or a database record)</para>
49
          </listitem>
50
          <listitem>
51
            <para>Set of Apache Ant tasks to function as a bridge
52
            between the XBridgeNG XML format at legacy 3rd party
53
            software (e.g. HP Quality Center, Serena TeamTrack,
54
            ...)</para>
55
          </listitem>
56
          <listitem>
57
            <para>The add Web Services (SOAP) wrapper around Apache Ant
58
            tasks (since XBridgeNG 2.0)</para>
59
          </listitem>
60
        </itemizedlist>
61
      </para>
62
      <para>The current focus is on file-based operations. do not
63
      contain an integration server or a process execution
64
      engine.</para>
65
    </abstract>
66
  </bookinfo>
67
  <chapter>
68
    <beginpage />
69
    <title>Getting started</title>
70
    <para>This chapter describes the installation.</para>
71
    <sect1>
72
      <title>Prerequisites</title>
73
      <para>tbd.</para>
74
      <para>Sun Java SE 1.6.0</para>
75
      <para>Apache Tomcat 6</para>
76
    </sect1>
77
    <sect1>
78
      <title>Installation</title>
79
      <para>tbd.</para>
80
      <para>In short: Deploy .WAR file to Apache Tomcat</para>
81
      <sect2>
82
        <title>Securing with Basic Authentication</title>
83
        <para>There is a quick guide explaining Basic Authentication
84
        for Tomcat here:</para>
85
        <para>
86
        <ulink url="http://oreilly.com/pub/a/java/archive/tomcat-tips.html?page=1"/></para>
87
      </sect2>
88
      <sect2>
89
        <title>Limit access to</title>
90
        <para>Sometimes you&apos;ll only want to restrict access to to
91
        only specified host names or IP addresses. This way, only
92
        clients at those specified addresses can use the web services.
93
        Tomcat provides two configuration values for that:
94
        RemoteHostValve and RemoteAddrValve.</para>
95
        <para>These Valves allow you to filter requests by host name or
96
        by IP address, and to allow or deny hosts that match. The
97
        example below restricts access to the ArchiveService from any
98
        machine that is not the local host.</para>
99
        <programlisting language="xml">&lt;Context path=&quot;/XService/ArchiveService&quot; ...&gt;
100
                &lt;Valve className=&quot;org.apache.catalina.valves.RemoteAddrValve&quot;
101
                allow=&quot;127.0.0.1&quot; deny=&quot;&quot;/&gt;
102
            &lt;/Context&gt;</programlisting>
103
        <para>If no allow pattern is given, then patterns that match
104
        the deny attribute patterns will be rejected, and all others
105
        will be allowed. Similarly, if no deny pattern is given,
106
        patterns that match the allow attribute will be allowed, and
107
        all others will be denied.</para>
108
        <para>The &lt;context&gt; element must be placed into the
109
        server.xml file (into &lt;engine&gt;&lt;host&gt;).</para>
110
      </sect2>
111
    </sect1>
112
  </chapter>
113
  <chapter>
114
    <title />
115
    <section>
116
      <title>ArchiveServices</title>
117
      <para>The ArchiveService bundles file packing operations. Its
118
      WSDL is located at
119
      http://server:port/XServices/ArchiveService?wsdl</para>
120
    </section>
121
    <section>
122
      <title>ExecuteServices</title>
123
      <para>The ExecuteService bundles local and remote command
124
      execution operations. Its WSDL is located at
125
      http://server:port/XServices/ExecuteService?wsdl</para>
126
      <section>
127
        <title>runCommand</title>
128
        <para>Run an executable with arguments on the server providing
129
        the web service. The command is run within the environment and
130
        under the user privileges of the user who is running the Tomcat
131
        Server.</para>
132
        <section>
133
          <title />
134
          <para />
135
          <table frame="all">
136
            <title>runCommand input parameters</title>
137
            <tgroup cols="4">
138
              <colspec colname="parameter" colnum="1"/>
139
              <colspec colname="type" colnum="2"/>
140
              <colspec colname="required" colnum="3"/>
141
              <colspec colname="description" colnum="4"/>
142
              <thead>
143
                <row>
144
                  <entry>parameter</entry>
145
                  <entry>type</entry>
146
                  <entry>required</entry>
147
                  <entry>description</entry>
148
                </row>
149
              </thead>
150
              <tbody>
151
                <row>
152
                  <entry>executable</entry>
153
                  <entry>String</entry>
154
                  <entry>Yes</entry>
155
                  <entry>Command to be run. The command may be
156
                  specified with full path using forward slash
157
                  &quot;/&quot; as path separator.</entry>
158
                </row>
159
                <row>
160
                  <entry>argline</entry>
161
                  <entry>String</entry>
162
                  <entry>No</entry>
163
                  <entry>Any command line arguments</entry>
164
                </row>
165
              </tbody>
166
            </tgroup>
167
          </table>
168
          <para />
169
        </section>
170
      </section>
171
    </section>
172
  </chapter>
173
  <chapter>
174
    <title>XML Types</title>
175
    <para>This chapter bundles the documentation for common xml types
176
    used by XServices web service.</para>
177
  </chapter>
178
</book>