website/docs/war.html

   1
   2
   3 <!DOCTYPE html>
   4 <!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
   5 <!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
   6 <head>
   7   <meta charset="utf-8">
   8
   9   <meta name="viewport" content="width=device-width, initial-scale=1.0">
  10
  11   <title>Web Application Archive (WAR) &mdash; JABAWS 2.2 documentation</title>
  12
  13
  14
  15
  16
  17
  18
  19
  20
  21
  22
  23
  24
  25
  26
  27
  28
  29     <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
  30
  31
  32
  33
  34
  35         <link rel="index" title="Index"
  36               href="genindex.html"/>
  37         <link rel="search" title="Search" href="search.html"/>
  38     <link rel="top" title="JABAWS 2.2 documentation" href="index.html"/>
  39         <link rel="next" title="Virtual Appliance (VA)" href="va.html"/>
  40         <link rel="prev" title="Command Line Client (CLI)" href="client.html"/>
  41
  42
  43   <script src="_static/js/modernizr.min.js"></script>
  44
  45 </head>
  46
  47 <body class="wy-body-for-nav" role="document">
  48
  49
  50   <div class="wy-grid-for-nav">
  51
  52
  53     <nav data-toggle="wy-nav-shift" class="wy-nav-side">
  54       <div class="wy-side-scroll">
  55         <div class="wy-side-nav-search">
  56
  57
  58
  59             <a href="index.html" class="icon icon-home"> JABAWS
  60
  61
  62
  63           </a>
  64
  65
  66
  67
  68               <div class="version">
  69                 2.2
  70               </div>
  71
  72
  73
  74
  75 <div role="search">
  76   <form id="rtd-search-form" class="wy-form" action="search.html" method="get">
  77     <input type="text" name="q" placeholder="Search docs" />
  78     <input type="hidden" name="check_keywords" value="yes" />
  79     <input type="hidden" name="area" value="default" />
  80   </form>
  81 </div>
  82
  83
  84         </div>
  85
  86         <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
  87
  88
  89
  90
  91
  92
  93               <p class="caption"><span class="caption-text">Contents:</span></p>
  94 <ul class="current">
  95 <li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting Started</a></li>
  96 <li class="toctree-l1"><a class="reference internal" href="included_tools.html">Included Tools</a></li>
  97 <li class="toctree-l1"><a class="reference internal" href="client.html">Command Line Client (CLI)</a></li>
  98 <li class="toctree-l1 current"><a class="current reference internal" href="#">Web Application Archive (WAR)</a><ul>
  99 <li class="toctree-l2"><a class="reference internal" href="#installing">Installing</a></li>
 100 <li class="toctree-l2"><a class="reference internal" href="#usage">Usage</a></li>
 101 <li class="toctree-l2"><a class="reference internal" href="#troubleshooting">Troubleshooting</a></li>
 102 </ul>
 103 </li>
 104 <li class="toctree-l1"><a class="reference internal" href="va.html">Virtual Appliance (VA)</a></li>
 105 <li class="toctree-l1"><a class="reference internal" href="docker.html">Docker Container</a></li>
 106 <li class="toctree-l1"><a class="reference internal" href="advanced.html">Advanced Usage</a></li>
 107 <li class="toctree-l1"><a class="reference internal" href="develop.html">For Developers</a></li>
 108 <li class="toctree-l1"><a class="reference internal" href="stats.html">Usage Statistics</a></li>
 109 <li class="toctree-l1"><a class="reference internal" href="citations.html">Citations</a></li>
 110 <li class="toctree-l1"><a class="reference internal" href="changelog.html">Changelog</a></li>
 111 </ul>
 112
 113
 114
 115         </div>
 116       </div>
 117     </nav>
 118
 119     <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
 120
 121
 122       <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
 123
 124           <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
 125           <a href="index.html">JABAWS</a>
 126
 127       </nav>
 128
 129
 130
 131       <div class="wy-nav-content">
 132         <div class="rst-content">
 133
 134
 135
 136
 137
 138
 139
 140
 141
 142
 143
 144
 145
 146
 147
 148
 149 <div role="navigation" aria-label="breadcrumbs navigation">
 150
 151   <ul class="wy-breadcrumbs">
 152
 153       <li><a href="index.html">Docs</a> &raquo;</li>
 154
 155       <li>Web Application Archive (WAR)</li>
 156
 157
 158       <li class="wy-breadcrumbs-aside">
 159
 160
 161             <!-- <a href="_sources/war.rst.txt" rel="nofollow"> View page source</a> -->
 162             <a href="../">Return to the JABAWS homepage</a>
 163
 164
 165       </li>
 166
 167   </ul>
 168
 169
 170   <hr/>
 171 </div>
 172           <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
 173            <div itemprop="articleBody">
 174
 175   <div class="section" id="web-application-archive-war">
 176 <h1>Web Application Archive (WAR)<a class="headerlink" href="#web-application-archive-war" title="Permalink to this headline">¶</a></h1>
 177 <p>JABAWS Web Application aRchive can run on any host operating system that supports <a class="reference external" href="http://www.oracle.com/technetwork/java/javase/downloads/jre7-downloads-1880261.html">Java</a> and <a class="reference external" href="http://tomcat.apache.org/download-80.cgi">Apache-Tomcat</a>. JABAWS requires a Java web application server compliant with version 2.4 of the Java Servlet specification, and a <a class="reference external" href="http://www.oracle.com/technetwork/java/javase/downloads/jre7-downloads-1880261.html">Java</a> 7 runtime environment. We recommend using an official Oracle Java 7 runtime environment, and <a class="reference external" href="http://tomcat.apache.org/download-80.cgi">Apache-Tomcat</a> web application server version 8.5, but older Tomcat versions above 5.5 will work too.</p>
 178 <div class="admonition danger">
 179 <p class="first admonition-title">Danger</p>
 180 <p class="last">The JABAWS WAR is not generally compatible with older Mac systems based on the PowerPC architecture, since Java 1.7 is not available to run JABAWS.</p>
 181 </div>
 182 <p>However JABAWS depends on a number of third party programs which are not available for all operating systems. In particular, not all web services are currently available for MS Windows platform. JABAWS comes with pre-compiled MS Windows and Linux x86 binaries, as well as the source code and build scripts necessary to recompile them.</p>
 183 <p>To run JABAWS on the cluster you must have shared disk space accessible from all cluster nodes.</p>
 184 <hr class="docutils" />
 185 <div class="section" id="installing">
 186 <span id="war-installing"></span><h2>Installing<a class="headerlink" href="#installing" title="Permalink to this headline">¶</a></h2>
 187 <div class="admonition tip">
 188 <p class="first admonition-title">Tip</p>
 189 <p class="last">Check if you are running the recommended versions of Java and Apache-Tomcat.</p>
 190 </div>
 191 <p>JABAWS is distributed as a web application archive (WAR). To deploy JABAWS in <a class="reference external" href="http://tomcat.apache.org/download-80.cgi">Apache-Tomcat</a> - simply drop the war file into the webapps directory of a running Tomcat, and it will do the rest. If you used this deployment procedure, do not remove the Jabaws WAR file, otherwise Tomcat will undeploy your application! The context path for your deployed application will be the same as the name of the war file. For example, assuming the Tomcat server is running on the <code class="docutils literal"><span class="pre">localhost:8080</span></code> and <em>jaba.war</em> file is put into the <code class="docutils literal"><span class="pre">&lt;tomcat</span> <span class="pre">server</span> <span class="pre">root&gt;/webapps</span></code> directory, the deployed application from the jabaws.war file then can be accessed by this URL <code class="docutils literal"><span class="pre">http://localhost:8080/jabaws</span></code>.</p>
 192 <p>For any other web application server, please follow your server&#8217;s specific deployment procedure for &#8216;WAR&#8217; files. If you install JABAWS on a MS Windows machine, then at this point your JABAWS installation will already be up and running, and you can try its services out as described here in the <a class="reference external" href="advanced.html#testing-the-jabaws-server">documentation</a>. If you install JABAWS on Linux you will need to compile the binaries for your system and set an executable flag for binaries (<a class="reference external" href="advanced.html#pre-compiled-binaries">more details here</a> and <a class="reference external" href="advanced.html#recompiling-binaries-for-your-system">here</a>).</p>
 193 <hr class="docutils" />
 194 </div>
 195 <div class="section" id="usage">
 196 <span id="war-usage"></span><h2>Usage<a class="headerlink" href="#usage" title="Permalink to this headline">¶</a></h2>
 197 <p><strong>Running many JABAWS instances on the same server</strong></p>
 198 <p>JABAWS is supplied as a Web Application aRchive which can be dealt with as any other web applications. So it is perfectly possible to run two JABAWS instances from the same server. Just make two different contexts on your application server and unpack JABAWS in both of them. For example if your server name is <a class="reference external" href="http://www.align.ac.uk">http://www.align.ac.uk</a>, and the context names are public and private. Than one group of users could be given a URL <a class="reference external" href="http://www.align.ac.uk/public">http://www.align.ac.uk/public</a> and another <a class="reference external" href="http://www.align.ac.uk/private">http://www.align.ac.uk/private</a>. These contexts will be served by two independent JABAWS instances, and could be configured differently. If you keep local engine enabled, make sure you reduce the number of threads local engine is allowed to use to avoid overloading the server. Alternatively two completely separate web application server instances (e.g. Apache-Tomcat) could be used. This will give you a better resilience and more flexibility in memory settings.</p>
 199 <p><strong>JABAWS on a single server</strong></p>
 200 <p>You can run JABAWS on a single server. Obviously the capacity will be limited, but it may be sufficient for a small lab. Installed on a single server, JABAWS executes tasks in parallel, so the more cores the server has the more requests it will be able to handle.</p>
 201 <p><strong>JABAWS supported cluster batch management systems</strong></p>
 202 <p>JABAWS uses <a class="reference external" href="http://www.drmaa.org/">DRMAA</a> v1.0 library to send and manage jobs on the cluster. DRMAA supports many different cluster job management systems. Namely Sun Grid Engine, Condor, PBS, GridWay, Globus 2/4, PBSPro, LSF. For up to date information please consult DRMAA web site. We found that DRMAA implementation differ from platform to platform and were trying to use only the basic functions. We have only tested JABAWS on Sun Grid Engine v 6.2. Please let use know if you have any experience of running JABAWS on other platforms.</p>
 203 <hr class="docutils" />
 204 </div>
 205 <div class="section" id="troubleshooting">
 206 <span id="war-troubleshooting"></span><h2>Troubleshooting<a class="headerlink" href="#troubleshooting" title="Permalink to this headline">¶</a></h2>
 207 <p><strong>If Apache-Tomcat fails to deploy jabaws.war file:</strong></p>
 208 <ul class="simple">
 209 <li>Make sure Tomcat has sufficient access rights to read your war file.</li>
 210 <li>Restart the Tomcat, sometimes it will not restart after the new war file is added without restart</li>
 211 <li>If Tomcat still refuses to unpack the war file, unpack it manually into web application folder (the war file is just a zip archive). Restart the Tomcat.</li>
 212 </ul>
 213 <p><strong>If Tomcat undeployes your application:</strong></p>
 214 <p>If the war file is automatically removed by Tomcat use an explicit application descriptor. Add a context descriptor file into <code class="docutils literal"><span class="pre">&lt;tomcatRoot&gt;conf/Catalina/localhost</span></code> directory. Name your context file the same as your application folder e.g. if your JABAWS resides in <code class="docutils literal"><span class="pre">webapps/jabaws</span></code> folder, then call the context file jabaws.xml. Below is an example of content this file might have.</p>
 215 <div class="highlight-xml"><div class="highlight"><pre><span></span><span class="cp">&lt;?xml version=&quot;1.0&quot; encoding=&quot;UTF-8&quot;?&gt;</span>
 216 <span class="nt">&lt;Context</span> <span class="na">antiResourceLocking=</span><span class="s">&quot;false&quot;</span> <span class="na">privileged=</span><span class="s">&quot;true&quot;</span> <span class="nt">/&gt;</span>
 217 </pre></div>
 218 </div>
 219 <p>This should be sufficient to prevent Tomcat from removing your JABAWS from WEBAPPS. For more information about the Tomcat deployer read this documentation on the Apache-Tomcat web site.</p>
 220 </div>
 221 </div>
 222
 223
 224            </div>
 225            <div class="articleComments">
 226
 227            </div>
 228           </div>
 229           <footer>
 230
 231     <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
 232
 233         <a href="va.html" class="btn btn-neutral float-right" title="Virtual Appliance (VA)" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
 234
 235
 236         <a href="client.html" class="btn btn-neutral" title="Command Line Client (CLI)" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
 237
 238     </div>
 239
 240
 241   <hr/>
 242
 243   <div role="contentinfo">
 244     <p><a href="../">JABAWS 2.2</a>
 245         &copy; Copyright 2017, Peter Troshin, Alexander Sherstnev, Jim Procter, Daniel Barton, Fábio Madeira, Alexey Drozdetskiy, Suzanne Duce and Geoff Barton.
 246
 247     </p>
 248   </div>
 249   Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
 250
 251 </footer>
 252         </div>
 253       </div>
 254
 255     </section>
 256
 257   </div>
 258
 259
 260
 261
 262
 263     <script type="text/javascript">
 264         var DOCUMENTATION_OPTIONS = {
 265             URL_ROOT:'./',
 266             VERSION:'2.2',
 267             LANGUAGE:'None',
 268             COLLAPSE_INDEX:false,
 269             FILE_SUFFIX:'.html',
 270             HAS_SOURCE:  true,
 271             SOURCELINK_SUFFIX: '.txt'
 272         };
 273     </script>
 274       <script type="text/javascript" src="_static/jquery.js"></script>
 275       <script type="text/javascript" src="_static/underscore.js"></script>
 276       <script type="text/javascript" src="_static/doctools.js"></script>
 277
 278
 279
 280
 281
 282     <script type="text/javascript" src="_static/js/theme.js"></script>
 283
 284
 285
 286
 287   <script type="text/javascript">
 288       jQuery(function () {
 289           SphinxRtdTheme.StickyNav.enable();
 290       });
 291   </script>
 292
 293
 294 </body>
 295 </html>