[659] | 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 | <meta name="viewport" content="width=device-width, initial-scale=1.0"> |
---|
| 9 | |
---|
| 10 | <title>Configuration and ZOO-Kernel use — ZOO-Project 1.4a0 documentation</title> |
---|
| 11 | |
---|
| 12 | <link href="http://fonts.googleapis.com/css?family=Days+One" rel="stylesheet" type="text/css"> |
---|
| 13 | |
---|
| 14 | |
---|
| 15 | |
---|
| 16 | |
---|
| 17 | |
---|
| 18 | |
---|
| 19 | |
---|
| 20 | |
---|
| 21 | <link rel="search" type="application/opensearchdescription+xml" title="Search within ZOO-Project 1.4a0 documentation" href="../../_static/opensearch.xml"/> |
---|
| 22 | |
---|
| 23 | |
---|
| 24 | |
---|
| 25 | |
---|
| 26 | |
---|
| 27 | |
---|
| 28 | <link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" /> |
---|
| 29 | |
---|
| 30 | |
---|
| 31 | |
---|
| 32 | |
---|
| 33 | |
---|
| 34 | <link rel="top" title="ZOO-Project 1.4a0 documentation" href="../../index.html"/> |
---|
| 35 | |
---|
| 36 | |
---|
| 37 | <script src="_static/js/modernizr.min.js"></script> |
---|
| 38 | |
---|
| 39 | </head> |
---|
| 40 | |
---|
| 41 | <body class="wy-body-for-nav" role="document"> |
---|
| 42 | |
---|
| 43 | <div class="wy-grid-for-nav"> |
---|
| 44 | |
---|
| 45 | |
---|
| 46 | <nav data-toggle="wy-nav-shift" class="wy-nav-side"> |
---|
| 47 | <div class="wy-side-nav-search"> |
---|
| 48 | |
---|
| 49 | |
---|
| 50 | |
---|
| 51 | <a class="shrink" href="../../contents.html"><img src="http://zoo-project.org/img/zoo-sun-logo.png" class="img-responsive sun" style="display: inline;"> ZOO</a> |
---|
| 52 | |
---|
| 53 | |
---|
| 54 | |
---|
| 55 | </a> |
---|
| 56 | |
---|
| 57 | |
---|
| 58 | <div role="search"> |
---|
| 59 | <form id="rtd-search-form" class="wy-form" action="../../search.html" method="get"> |
---|
| 60 | <input type="text" name="q" placeholder="Search docs" /> |
---|
| 61 | <input type="hidden" name="check_keywords" value="yes" /> |
---|
| 62 | <input type="hidden" name="area" value="default" /> |
---|
| 63 | </form> |
---|
| 64 | </div> |
---|
| 65 | |
---|
| 66 | |
---|
| 67 | </div> |
---|
| 68 | |
---|
| 69 | <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation"> |
---|
| 70 | |
---|
| 71 | |
---|
| 72 | |
---|
| 73 | <ul> |
---|
| 74 | <li class="toctree-l1"><a class="reference internal" href="../../intro.html">Introduction</a><ul> |
---|
| 75 | <li class="toctree-l2"><a class="reference internal" href="../../intro.html#what-is-zoo-project">What is ZOO-Project ?</a></li> |
---|
| 76 | <li class="toctree-l2"><a class="reference internal" href="../../intro.html#zoo-project-components">ZOO-Project components</a></li> |
---|
| 77 | <li class="toctree-l2"><a class="reference internal" href="../../intro.html#open-source">Open Source</a></li> |
---|
| 78 | </ul> |
---|
| 79 | </li> |
---|
| 80 | <li class="toctree-l1"><a class="reference internal" href="../../install/index.html">ZOO-Project installation</a><ul> |
---|
| 81 | <li class="toctree-l2"><a class="reference internal" href="../../install/install-prerequisites.html">Prerequisites</a></li> |
---|
| 82 | <li class="toctree-l2"><a class="reference internal" href="../../install/install-download.html">Download</a></li> |
---|
| 83 | <li class="toctree-l2"><a class="reference internal" href="../../install/install-confoptions.html">Configuration options</a></li> |
---|
| 84 | <li class="toctree-l2"><a class="reference internal" href="../../install/install-installation.html">Installation on Unix/Linux</a></li> |
---|
| 85 | <li class="toctree-l2"><a class="reference internal" href="../../install/install-installation.html#installation-on-mac-osx">Installation on Mac OSX</a></li> |
---|
| 86 | <li class="toctree-l2"><a class="reference internal" href="../../install/install-installation.html#installation-on-windows">Installation on Windows</a></li> |
---|
| 87 | </ul> |
---|
| 88 | </li> |
---|
| 89 | <li class="toctree-l1"><a class="reference internal" href="../../kernel/index.html">ZOO-Kernel</a><ul> |
---|
| 90 | <li class="toctree-l2"><a class="reference internal" href="../../kernel/what.html">What is ZOO-Kernel ?</a></li> |
---|
| 91 | <li class="toctree-l2"><a class="reference internal" href="../../kernel/configuration.html">ZOO-Kernel configuration</a></li> |
---|
| 92 | <li class="toctree-l2"><a class="reference internal" href="../../kernel/mapserver.html">Optional MapServer support</a></li> |
---|
| 93 | <li class="toctree-l2"><a class="reference internal" href="../../kernel/orfeotoolbox.html">Optional Orfeo Toolbox support</a></li> |
---|
| 94 | </ul> |
---|
| 95 | </li> |
---|
| 96 | <li class="toctree-l1"><a class="reference internal" href="../../services/index.html">ZOO-Services</a><ul> |
---|
| 97 | <li class="toctree-l2"><a class="reference internal" href="../../services/introduction.html">What are ZOO-Services ?</a></li> |
---|
| 98 | <li class="toctree-l2"><a class="reference internal" href="../../services/zcfg-reference.html">ZOO-Service configuration file</a></li> |
---|
| 99 | <li class="toctree-l2"><a class="reference internal" href="../../services/process-profiles.html">Process profiles registry</a></li> |
---|
| 100 | <li class="toctree-l2"><a class="reference internal" href="../../services/howtos.html">Create your own ZOO-Services</a></li> |
---|
| 101 | <li class="toctree-l2"><a class="reference internal" href="../../services/status.html">ZOO Status Service</a></li> |
---|
| 102 | <li class="toctree-l2"><a class="reference internal" href="../../services/debug.html">How To Debug ZOO Services</a></li> |
---|
| 103 | <li class="toctree-l2"><a class="reference internal" href="../../services/zoo-services.html">Available ZOO-Services</a></li> |
---|
| 104 | </ul> |
---|
| 105 | </li> |
---|
| 106 | <li class="toctree-l1"><a class="reference internal" href="../../api/index.html">ZOO-API</a><ul> |
---|
| 107 | <li class="toctree-l2"><a class="reference internal" href="../../api/what.html">What is ZOO-API ?</a></li> |
---|
| 108 | <li class="toctree-l2"><a class="reference internal" href="../../api/howto.html">Using ZOO-API</a></li> |
---|
| 109 | <li class="toctree-l2"><a class="reference internal" href="../../api/classes.html">ZOO-API Classes</a></li> |
---|
| 110 | <li class="toctree-l2"><a class="reference internal" href="../../api/examples.html">Examples</a></li> |
---|
| 111 | </ul> |
---|
| 112 | </li> |
---|
| 113 | <li class="toctree-l1"><a class="reference internal" href="../../client/index.html">ZOO-Client</a><ul> |
---|
| 114 | <li class="toctree-l2"><a class="reference internal" href="../../client/what.html">What is ZOO-Client ?</a></li> |
---|
| 115 | <li class="toctree-l2"><a class="reference internal" href="../../client/howto.html">Using ZOO-Client</a></li> |
---|
| 116 | <li class="toctree-l2"><a class="reference internal" href="../../client/example.html">Example application</a></li> |
---|
| 117 | </ul> |
---|
| 118 | </li> |
---|
| 119 | </ul> |
---|
| 120 | |
---|
| 121 | |
---|
| 122 | |
---|
| 123 | </div> |
---|
| 124 | |
---|
| 125 | </nav> |
---|
| 126 | |
---|
| 127 | <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> |
---|
| 128 | |
---|
| 129 | |
---|
| 130 | <nav class="wy-nav-top" role="navigation" aria-label="top navigation"> |
---|
| 131 | <i data-toggle="wy-nav-top" class="fa fa-bars"></i> |
---|
| 132 | <a href="../../contents.html">ZOO-Project</a> |
---|
| 133 | </nav> |
---|
| 134 | |
---|
| 135 | |
---|
| 136 | |
---|
| 137 | <div class="wy-nav-content"> |
---|
| 138 | <div class="rst-content"> |
---|
| 139 | <div role="navigation" aria-label="breadcrumbs navigation"> |
---|
| 140 | <ul class="wy-breadcrumbs"> |
---|
| 141 | |
---|
| 142 | <li><a href="../../contents.html"> Docs</a> ∕  </li> |
---|
| 143 | |
---|
| 144 | <li>Configuration and ZOO-Kernel use</li> |
---|
| 145 | <li class="wy-breadcrumbs-aside"> |
---|
| 146 | |
---|
| 147 | <a href="../../_sources/workshop/2014/using_zoo_from_osgeolivevm.txt" rel="nofollow"> View page source</a> |
---|
| 148 | |
---|
| 149 | </li> |
---|
| 150 | </ul> |
---|
| 151 | <hr/> |
---|
| 152 | </div> |
---|
| 153 | <div role="main" class="document"> |
---|
| 154 | |
---|
| 155 | <div class="section" id="configuration-and-zoo-kernel-use"> |
---|
| 156 | <span id="using-zoo-from-osgeolivevm"></span><h1><a class="toc-backref" href="#table-of-contents">Configuration and ZOO-Kernel use</a><a class="headerlink" href="#configuration-and-zoo-kernel-use" title="Permalink to this headline">¶</a></h1> |
---|
| 157 | <div class="contents topic" id="table-of-contents"> |
---|
| 158 | <p class="topic-title first">Table of Contents</p> |
---|
| 159 | <ul class="simple"> |
---|
| 160 | <li><a class="reference internal" href="#configuration-and-zoo-kernel-use" id="id7">Configuration and ZOO-Kernel use</a><ul> |
---|
| 161 | <li><a class="reference internal" href="#zoo-kernel-configuration" id="id8">ZOO-Kernel Configuration</a></li> |
---|
| 162 | <li><a class="reference internal" href="#testing-the-zoo-installation-with-getcapabilities" id="id9">Testing the ZOO installation with GetCapabilities</a></li> |
---|
| 163 | </ul> |
---|
| 164 | </li> |
---|
| 165 | </ul> |
---|
| 166 | </div> |
---|
| 167 | <div class="section" id="zoo-kernel-configuration"> |
---|
| 168 | <h2><a class="toc-backref" href="#table-of-contents">ZOO-Kernel Configuration</a><a class="headerlink" href="#zoo-kernel-configuration" title="Permalink to this headline">¶</a></h2> |
---|
| 169 | <p>As already said in introduction, an OSGeoLive Virtual Machine has been booted on your computer, allowing you to use ZOO-Kernel in a development environment directly.</p> |
---|
| 170 | <div class="admonition note"> |
---|
| 171 | <p class="first admonition-title">Note</p> |
---|
| 172 | <p class="last">we will use ZOO-Kernel or <code class="docutils literal"><span class="pre">zoo_loader.cgi</span></code> script without any distinction |
---|
| 173 | in this document.</p> |
---|
| 174 | </div> |
---|
| 175 | <p>General ZOO-Kernel settings are set in the <code class="docutils literal"><span class="pre">main.cfg</span></code> file located in the same directory as the ZOO-Kernel, so in <code class="docutils literal"><span class="pre">/usr/lib/cgi-bin/</span></code>. This informations will be accessible from each services at runtime, so when you wil use Execute requests. You can see a typical <code class="docutils literal"><span class="pre">main.cfg</span></code> content in the following:</p> |
---|
| 176 | <div class="highlight-guess"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre> 1 |
---|
| 177 | 2 |
---|
| 178 | 3 |
---|
| 179 | 4 |
---|
| 180 | 5 |
---|
| 181 | 6 |
---|
| 182 | 7 |
---|
| 183 | 8 |
---|
| 184 | 9 |
---|
| 185 | 10 |
---|
| 186 | 11 |
---|
| 187 | 12 |
---|
| 188 | 13 |
---|
| 189 | 14 |
---|
| 190 | 15 |
---|
| 191 | 16 |
---|
| 192 | 17 |
---|
| 193 | 18 |
---|
| 194 | 19 |
---|
| 195 | 20 |
---|
| 196 | 21 |
---|
| 197 | 22 |
---|
| 198 | 23 |
---|
| 199 | 24 |
---|
| 200 | 25 |
---|
| 201 | 26 |
---|
| 202 | 27 |
---|
| 203 | 28 |
---|
| 204 | 29 |
---|
| 205 | 30 |
---|
| 206 | 31 |
---|
| 207 | 32 |
---|
| 208 | 33 |
---|
| 209 | 34 |
---|
| 210 | 35 |
---|
| 211 | 36 |
---|
| 212 | 37 |
---|
| 213 | 38</pre></div></td><td class="code"><div class="highlight"><pre><span class="k">[headers]</span> |
---|
| 214 | <span class="na">X-Powered-By</span><span class="o">=</span><span class="s">ZOO-Project@MapMint</span> |
---|
| 215 | |
---|
| 216 | <span class="k">[main]</span> |
---|
| 217 | <span class="na">encoding</span><span class="o">=</span><span class="s">utf-8</span> |
---|
| 218 | <span class="na">dataPath</span><span class="o">=</span><span class="s">/var/data</span> |
---|
| 219 | <span class="na">tmpPath</span><span class="o">=</span><span class="s">/var/www/temp</span> |
---|
| 220 | <span class="na">cacheDir</span><span class="o">=</span><span class="s">/var/www/cache</span> |
---|
| 221 | <span class="na">version</span><span class="o">=</span><span class="s">1.0.0</span> |
---|
| 222 | <span class="na">sessPath</span><span class="o">=</span><span class="s">/tmp</span> |
---|
| 223 | <span class="na">msOgcVersion</span><span class="o">=</span><span class="s">1.0.0</span> |
---|
| 224 | <span class="na">serverAddress</span><span class="o">=</span><span class="s">http://localhost/cgi-bin/mm/zoo_loader.cgi</span> |
---|
| 225 | <span class="na">lang</span><span class="o">=</span><span class="s">fr-FR,ja-JP</span> |
---|
| 226 | <span class="na">language</span><span class="o">=</span><span class="s">en-US</span> |
---|
| 227 | <span class="na">mapserverAddress</span><span class="o">=</span><span class="s">http://localhost/cgi-bin/mapserv.cgi</span> |
---|
| 228 | <span class="na">tmpUrl</span><span class="o">=</span><span class="s">http://127.0.0.1/temp/</span> |
---|
| 229 | |
---|
| 230 | <span class="k">[identification]</span> |
---|
| 231 | <span class="na">keywords</span><span class="o">=</span><span class="s">WPS,GIS,buffer,MapMint,ZOO-Project</span> |
---|
| 232 | <span class="na">title</span><span class="o">=</span><span class="s">ZOO-Project Workshop - FOSS4G 2014</span> |
---|
| 233 | <span class="na">abstract</span><span class="o">=</span> <span class="s">Deploying Web Processing Services using ZOO-Project – Examples of Python based WPS using PgRouting</span> |
---|
| 234 | <span class="na">accessConstraints</span><span class="o">=</span><span class="s">none</span> |
---|
| 235 | <span class="na">fees</span><span class="o">=</span><span class="s">None</span> |
---|
| 236 | |
---|
| 237 | <span class="k">[provider]</span> |
---|
| 238 | <span class="na">positionName</span><span class="o">=</span><span class="s">Developer</span> |
---|
| 239 | <span class="na">providerName</span><span class="o">=</span><span class="s">GeoLabs SARL</span> |
---|
| 240 | <span class="na">addressAdministrativeArea</span><span class="o">=</span><span class="s">False</span> |
---|
| 241 | <span class="na">addressDeliveryPoint</span><span class="o">=</span><span class="s">1280, avenue des Platanes</span> |
---|
| 242 | <span class="na">addressCountry</span><span class="o">=</span><span class="s">fr</span> |
---|
| 243 | <span class="na">phoneVoice</span><span class="o">=</span><span class="s">+33467430995</span> |
---|
| 244 | <span class="na">addressPostalCode</span><span class="o">=</span><span class="s">34970</span> |
---|
| 245 | <span class="na">role</span><span class="o">=</span><span class="s">Dev</span> |
---|
| 246 | <span class="na">providerSite</span><span class="o">=</span><span class="s">http://www.geolabs.fr</span> |
---|
| 247 | <span class="na">phoneFacsimile</span><span class="o">=</span><span class="s">False</span> |
---|
| 248 | <span class="na">addressElectronicMailAddress</span><span class="o">=</span><span class="s">gerald@geolabs.fr</span> |
---|
| 249 | <span class="na">addressCity</span><span class="o">=</span><span class="s">Lattes</span> |
---|
| 250 | <span class="na">individualName</span><span class="o">=</span><span class="s">Gérald FENOY</span> |
---|
| 251 | </pre></div> |
---|
| 252 | </td></tr></table></div> |
---|
| 253 | <p>The <code class="docutils literal"><span class="pre">main.cfg</span></code> file contains metadata informations about the identification and provider but also some important settings. The file is composed of various sections, namely <code class="docutils literal"><span class="pre">[main]</span></code>, <code class="docutils literal"><span class="pre">[identification]</span></code> and <code class="docutils literal"><span class="pre">[provider]</span></code> per default.</p> |
---|
| 254 | <dl class="docutils"> |
---|
| 255 | <dt>From the <code class="docutils literal"><span class="pre">[main]</span></code> section settings are as follow:</dt> |
---|
| 256 | <dd><ul class="first last simple"> |
---|
| 257 | <li><code class="docutils literal"><span class="pre">lang</span></code>: the supported languages separated by a coma (the first is the default one),</li> |
---|
| 258 | <li><code class="docutils literal"><span class="pre">version</span></code>: the supported WPS version,</li> |
---|
| 259 | <li><code class="docutils literal"><span class="pre">encoding</span></code>: the default encoding of WPS Responses,</li> |
---|
| 260 | <li><code class="docutils literal"><span class="pre">serverAddress</span></code>: the url to access your ZOO-Kernel instance,</li> |
---|
| 261 | <li><code class="docutils literal"><span class="pre">dataPath</span></code>: the path to store data files (when MapServer support was activated, |
---|
| 262 | this directory is used to store mapfiles and data).</li> |
---|
| 263 | <li><code class="docutils literal"><span class="pre">tmpPath</span></code>: the path to store temporary files (such as ExecuteResponse when |
---|
| 264 | storeExecuteResponse was set to true),</li> |
---|
| 265 | <li><code class="docutils literal"><span class="pre">tmpUrl</span></code>: a url relative to <code class="docutils literal"><span class="pre">serverAddress</span></code> to access the temporary file,</li> |
---|
| 266 | <li><code class="docutils literal"><span class="pre">cacheDir</span></code>: the path to store cached request files <a class="footnote-reference" href="#f1" id="id1">[1]</a> (optional),</li> |
---|
| 267 | <li><code class="docutils literal"><span class="pre">mapservAddress</span></code>: your local MapServer address (optional),</li> |
---|
| 268 | <li><code class="docutils literal"><span class="pre">msOgcVersion</span></code>: the version for all supported OGC Web Services output <a class="footnote-reference" href="#f2" id="id2">[2]</a> |
---|
| 269 | (optional).</li> |
---|
| 270 | </ul> |
---|
| 271 | </dd> |
---|
| 272 | </dl> |
---|
| 273 | <p>The <code class="docutils literal"><span class="pre">[identification]</span></code> and <code class="docutils literal"><span class="pre">[provider]</span></code> section are specific to OGC metadata and |
---|
| 274 | should be set <a class="footnote-reference" href="#f3" id="id3">[3]</a>.</p> |
---|
| 275 | <p>Obviously, you are free to add new sections to this file if you need |
---|
| 276 | more <a class="footnote-reference" href="#f8" id="id4">[4]</a>. Nevertheless, you have to know |
---|
| 277 | that there is some specific names you should use only for specific |
---|
| 278 | purposes: <code class="docutils literal"><span class="pre">[headers]</span></code>, <code class="docutils literal"><span class="pre">[mapserver]</span></code>, <code class="docutils literal"><span class="pre">[env]</span></code>, <code class="docutils literal"><span class="pre">[lenv]</span></code> and <code class="docutils literal"><span class="pre">[senv]</span></code>.</p> |
---|
| 279 | <div class="admonition warning"> |
---|
| 280 | <p class="first admonition-title">Warning</p> |
---|
| 281 | <p class="last"><code class="docutils literal"><span class="pre">[senv]</span></code> and <code class="docutils literal"><span class="pre">[lenv]</span></code> are used / produced on runtime internaly by the ZOO-Kernel and should be defined only from the Service code.</p> |
---|
| 282 | </div> |
---|
| 283 | <p>The <code class="docutils literal"><span class="pre">headers</span></code> section is used to define your own HTTP Response |
---|
| 284 | headers. You may take a look at headers returned by web site such as |
---|
| 285 | <a class="reference external" href="http://www.zoo-project.org">http://www.zoo-project.org</a> by using curl command line tool for |
---|
| 286 | instance and notice the specific heder <code class="docutils literal"><span class="pre">X-Powered-By:</span> <span class="pre">Zoo-Project@Trac</span></code>.</p> |
---|
| 287 | <div class="admonition warning"> |
---|
| 288 | <p class="first admonition-title">Warning</p> |
---|
| 289 | <p class="last">There is no reason to define basic headers such as |
---|
| 290 | <code class="docutils literal"><span class="pre">Content-Type</span></code> or <code class="docutils literal"><span class="pre">encoding</span></code> as they will be overwritten at runtime by the |
---|
| 291 | ZOO-Kernel.</p> |
---|
| 292 | </div> |
---|
| 293 | <p>The <code class="docutils literal"><span class="pre">mapserver</span></code> section is used to store specific mapserver configuration |
---|
| 294 | parameters such as <cite>PROJ_LIB</cite> and <cite>GDAL_DATA</cite> or any other you want to be set to |
---|
| 295 | make your MapServer working.</p> |
---|
| 296 | <div class="admonition note"> |
---|
| 297 | <p class="first admonition-title">Note</p> |
---|
| 298 | <p class="last">the <code class="docutils literal"><span class="pre">mapserver</span></code> section is mainly used on WIN32 platform</p> |
---|
| 299 | </div> |
---|
| 300 | <p>The <code class="docutils literal"><span class="pre">env</span></code> section is used to store specific environment variables you want to be set |
---|
| 301 | prior to load your Services Provider and run your Service. A typical example, is when your |
---|
| 302 | Service requires to access to a X server running on framebuffer, then you will have to |
---|
| 303 | set the <code class="docutils literal"><span class="pre">DISPLAY</span></code> environnement variable, in this case you would add |
---|
| 304 | <code class="docutils literal"><span class="pre">DISPLAY=:1</span></code> line in your <code class="docutils literal"><span class="pre">[env]</span></code> section.</p> |
---|
| 305 | <p>The <code class="docutils literal"><span class="pre">lenv</span></code> is used to store runtime informations automatically set by the |
---|
| 306 | ZOO-Kernel before running your service and can be accesses / updated from it:</p> |
---|
| 307 | <blockquote> |
---|
| 308 | <div><ul class="simple"> |
---|
| 309 | <li><code class="docutils literal"><span class="pre">sid</span></code> (r): the service unique identifier,</li> |
---|
| 310 | <li><code class="docutils literal"><span class="pre">status</span></code> (rw): the current progress value (value between 0 and 100, percent),</li> |
---|
| 311 | <li><code class="docutils literal"><span class="pre">cwd</span></code> (r): the current working directory of the ZOO-Kernel,</li> |
---|
| 312 | <li><code class="docutils literal"><span class="pre">message</span></code> (rw): an error message when returning <code class="docutils literal"><span class="pre">SERVICE_FAILED</span></code> (optional),</li> |
---|
| 313 | <li><code class="docutils literal"><span class="pre">cookie</span></code> (rw): the cookie your service want to return to the client (for authentication |
---|
| 314 | purpose or tracking).</li> |
---|
| 315 | </ul> |
---|
| 316 | </div></blockquote> |
---|
| 317 | <p>The <code class="docutils literal"><span class="pre">senv</span></code> is used to store session informations on the server |
---|
| 318 | side. You can then access them automatically from service if the |
---|
| 319 | server is requested using a valid cookie (as defined in <code class="docutils literal"><span class="pre">lenv</span> <span class="pre">></span> |
---|
| 320 | <span class="pre">cookie</span></code>). The ZOO-Kernel will store on disk the values set in the |
---|
| 321 | <code class="docutils literal"><span class="pre">senv</span></code> maps, then load it and dynamically add its content to the one |
---|
| 322 | available in the <code class="docutils literal"><span class="pre">main.cfg</span></code>. The <code class="docutils literal"><span class="pre">senv</span></code> section should contain at |
---|
| 323 | least:</p> |
---|
| 324 | <blockquote> |
---|
| 325 | <div><ul> |
---|
| 326 | <li><dl class="first docutils"> |
---|
| 327 | <dt><code class="docutils literal"><span class="pre">XXX</span></code>: the session unique identifier where <code class="docutils literal"><span class="pre">XXX</span></code> is the name included in the</dt> |
---|
| 328 | <dd><p class="first last">returned cookie.</p> |
---|
| 329 | </dd> |
---|
| 330 | </dl> |
---|
| 331 | </li> |
---|
| 332 | </ul> |
---|
| 333 | </div></blockquote> |
---|
| 334 | <p id="cookie-example">For instance, if you get the following in your Service source code <a class="footnote-reference" href="#f4" id="id5">[5]</a> :</p> |
---|
| 335 | <div class="highlight-python"><div class="highlight"><pre><span class="n">conf</span><span class="p">[</span><span class="s">"lenv"</span><span class="p">][</span><span class="s">"cookie"</span><span class="p">]</span><span class="o">=</span><span class="s">"XXX=XXX1000000; path=/"</span> |
---|
| 336 | <span class="n">conf</span><span class="p">[</span><span class="s">"senv"</span><span class="p">]</span><span class="o">=</span><span class="p">{</span><span class="s">"XXX"</span><span class="p">:</span> <span class="s">"XXX1000000"</span><span class="p">,</span><span class="s">"login"</span><span class="p">:</span> <span class="s">"demoUser"</span><span class="p">}</span> |
---|
| 337 | </pre></div> |
---|
| 338 | </div> |
---|
| 339 | <p>That means that the ZOO-Kernel will create a file <code class="docutils literal"><span class="pre">sess_XXX1000000.cfg</span></code> in the |
---|
| 340 | <code class="docutils literal"><span class="pre">cacheDir</span></code> and return the specified cookie to the client. Each time the client will |
---|
| 341 | request the ZOO-Kernel using the Cookie, it will automatically load the value stored |
---|
| 342 | before running your service. You can then easilly access this informations from your |
---|
| 343 | service source code. This functionality won’t be used in the following presentation.</p> |
---|
| 344 | </div> |
---|
| 345 | <div class="section" id="testing-the-zoo-installation-with-getcapabilities"> |
---|
| 346 | <h2><a class="toc-backref" href="#table-of-contents">Testing the ZOO installation with GetCapabilities</a><a class="headerlink" href="#testing-the-zoo-installation-with-getcapabilities" title="Permalink to this headline">¶</a></h2> |
---|
| 347 | <p>Once you have a main.cfg file available in the same directory as your |
---|
| 348 | ZOO-Kernel, then you can use <cite>GetCapablities</cite>. Indeed, to answer such |
---|
| 349 | kind of requests, the ZOO-Kernel will simply parse the <cite>main.cfg</cite> file |
---|
| 350 | (to gather global informations), then parse individually each zcfg |
---|
| 351 | files (if any) contained in the same directory or in sub-directories |
---|
| 352 | <a class="footnote-reference" href="#f9" id="id6">[6]</a>, then return a well formed <cite>Capabilities</cite> document.</p> |
---|
| 353 | <p>You can request ZOO-Kernel using the following link from your Internet browser:</p> |
---|
| 354 | <p><a class="reference external" href="http://localhost/cgi-bin/zoo_loader.cgi?Request=GetCapabilities&Service=WPS">http://localhost/cgi-bin/zoo_loader.cgi?Request=GetCapabilities&Service=WPS</a></p> |
---|
| 355 | <p>You should get a valid Capabilities XML document, looking like the following :</p> |
---|
| 356 | <a class="reference internal image-reference" href="../../_images/GC.png"><img alt="../../_images/GC.png" class="align-center" src="../../_images/GC.png" style="width: 650px;" /></a> |
---|
| 357 | <p>Please note that some Process nodes are returned in the |
---|
| 358 | ProcessOfferings section, as somes are available already on OSGeoLive |
---|
| 359 | DVD. You can also run a GetCapabilities request from the command line, |
---|
| 360 | using the following command:</p> |
---|
| 361 | <div class="highlight-bash"><div class="highlight"><pre><span class="nb">cd</span> /usr/lib/cgi-bin |
---|
| 362 | ./zoo_loader.cgi “request<span class="o">=</span>GetCapabilities<span class="p">&</span><span class="nv">service</span><span class="o">=</span>WPS” <span class="p">|</span> less |
---|
| 363 | </pre></div> |
---|
| 364 | </div> |
---|
| 365 | <p>The same result as in your browser will be returned, as shown in the following screenshot:</p> |
---|
| 366 | <a class="reference internal image-reference" href="../../_images/GC_CL.png"><img alt="../../_images/GC_CL.png" class="align-center" src="../../_images/GC_CL.png" style="width: 450px;" /></a> |
---|
| 367 | <p>Invoking ZOO Kernel from the command line can be helpful during |
---|
| 368 | development process of new Services for debugging purpose. If you |
---|
| 369 | need to simulate POST request from the command line, then you can use |
---|
| 370 | the following:</p> |
---|
| 371 | <div class="highlight-bash"><div class="highlight"><pre><span class="nb">cd</span> /usr/lib/cgi-bin |
---|
| 372 | <span class="c"># Download the sample GetCapabilities request</span> |
---|
| 373 | curl -o /tmp/10_wpsGetCapabilities_request.xml http://schemas.opengis.net/wps/1.0.0/examples/10_wpsGetCapabilities_request.xml |
---|
| 374 | <span class="c"># Define required environment settings</span> |
---|
| 375 | <span class="nb">export </span><span class="nv">REQUEST_METHOD</span><span class="o">=</span>POST |
---|
| 376 | <span class="nb">export </span><span class="nv">CONTENT_TYPE</span><span class="o">=</span>text/xml |
---|
| 377 | <span class="c"># Run the request downloaded</span> |
---|
| 378 | ./zoo_loader.cgi < /tmp/10_wpsGetCapabilities_request.xml <span class="p">|</span> less |
---|
| 379 | </pre></div> |
---|
| 380 | </div> |
---|
| 381 | <p>You should have the same result as presented before.</p> |
---|
| 382 | <p class="rubric">Footnotes</p> |
---|
| 383 | <table class="docutils footnote" frame="void" id="f1" rules="none"> |
---|
| 384 | <colgroup><col class="label" /><col /></colgroup> |
---|
| 385 | <tbody valign="top"> |
---|
| 386 | <tr><td class="label"><a class="fn-backref" href="#id1">[1]</a></td><td>when you use GET requests passed through <code class="docutils literal"><span class="pre">xlink:href</span></code> the ZOO-Kernel will |
---|
| 387 | execute the request only once, the first time you will ask for this ressource and it will |
---|
| 388 | store on disk the result. The next time you will need the same feature, the cached file |
---|
| 389 | will be used which make your process running faster. If <code class="docutils literal"><span class="pre">cachedir</span></code> was not |
---|
| 390 | specified in the <code class="docutils literal"><span class="pre">main.cfg</span></code> then <code class="docutils literal"><span class="pre">tmpPath</span></code> value will be used.</td></tr> |
---|
| 391 | </tbody> |
---|
| 392 | </table> |
---|
| 393 | <table class="docutils footnote" frame="void" id="f2" rules="none"> |
---|
| 394 | <colgroup><col class="label" /><col /></colgroup> |
---|
| 395 | <tbody valign="top"> |
---|
| 396 | <tr><td class="label"><a class="fn-backref" href="#id2">[2]</a></td><td>since version 1.3.0, when MapServer is activated, your service can automatically |
---|
| 397 | return a WMS, WFS or WCS request to expose your data. Your can set here the specific |
---|
| 398 | version number you want to use to request your local MapServer setup. It depends |
---|
| 399 | mostly on the client capability to deal with specific OGC Web Services version.</td></tr> |
---|
| 400 | </tbody> |
---|
| 401 | </table> |
---|
| 402 | <table class="docutils footnote" frame="void" id="f3" rules="none"> |
---|
| 403 | <colgroup><col class="label" /><col /></colgroup> |
---|
| 404 | <tbody valign="top"> |
---|
| 405 | <tr><td class="label"><a class="fn-backref" href="#id3">[3]</a></td><td>since version 1.3.0, when MapServer is activated, the same metadata will be used |
---|
| 406 | for setting metadata for OGC Web Services.</td></tr> |
---|
| 407 | </tbody> |
---|
| 408 | </table> |
---|
| 409 | <table class="docutils footnote" frame="void" id="f8" rules="none"> |
---|
| 410 | <colgroup><col class="label" /><col /></colgroup> |
---|
| 411 | <tbody valign="top"> |
---|
| 412 | <tr><td class="label"><a class="fn-backref" href="#id4">[4]</a></td><td>you can take a quick look into the mapmint <code class="docutils literal"><span class="pre">main.cfg</span></code> file |
---|
| 413 | which is available in <cite>/usr/lib/cgi-bin/mm/</cite> directory to have |
---|
| 414 | example of sections use.</td></tr> |
---|
| 415 | </tbody> |
---|
| 416 | </table> |
---|
| 417 | <table class="docutils footnote" frame="void" id="f4" rules="none"> |
---|
| 418 | <colgroup><col class="label" /><col /></colgroup> |
---|
| 419 | <tbody valign="top"> |
---|
| 420 | <tr><td class="label"><a class="fn-backref" href="#id5">[5]</a></td><td>If you’re not familiar with ZOO-Project, you can <a class="reference external" href="using_zoo_from_osgeolivevm#testing-the-zoo-installation-with-getcapabilities">pass</a> this part and come to it after the next section.</td></tr> |
---|
| 421 | </tbody> |
---|
| 422 | </table> |
---|
| 423 | <table class="docutils footnote" frame="void" id="f9" rules="none"> |
---|
| 424 | <colgroup><col class="label" /><col /></colgroup> |
---|
| 425 | <tbody valign="top"> |
---|
| 426 | <tr><td class="label"><a class="fn-backref" href="#id6">[6]</a></td><td>sub-directories listing is available from <a class="reference external" href="http://zoo-project.org/trac/changeset/469">revision 469</a>.</td></tr> |
---|
| 427 | </tbody> |
---|
| 428 | </table> |
---|
| 429 | </div> |
---|
| 430 | </div> |
---|
| 431 | |
---|
| 432 | |
---|
| 433 | </div> |
---|
| 434 | <footer> |
---|
| 435 | |
---|
| 436 | |
---|
| 437 | <hr/> |
---|
| 438 | <div class="pfoot"> |
---|
| 439 | <div role="contentinfo"> |
---|
| 440 | <p> |
---|
| 441 | © Copyright 2009-2015, ZOO-Project team. |
---|
| 442 | </p> |
---|
| 443 | </div> |
---|
| 444 | Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> inspired by <a href="https://readthedocs.org">Read the Docs</a>. |
---|
| 445 | </div> |
---|
| 446 | </footer> |
---|
| 447 | |
---|
| 448 | </div> |
---|
| 449 | </div> |
---|
| 450 | |
---|
| 451 | </section> |
---|
| 452 | |
---|
| 453 | </div> |
---|
| 454 | |
---|
| 455 | |
---|
| 456 | |
---|
| 457 | |
---|
| 458 | |
---|
| 459 | <script type="text/javascript"> |
---|
| 460 | var DOCUMENTATION_OPTIONS = { |
---|
| 461 | URL_ROOT:'../../', |
---|
| 462 | VERSION:'1.4a0', |
---|
| 463 | COLLAPSE_INDEX:false, |
---|
| 464 | FILE_SUFFIX:'.html', |
---|
| 465 | HAS_SOURCE: true |
---|
| 466 | }; |
---|
| 467 | </script> |
---|
| 468 | <script type="text/javascript" src="../../_static/jquery.js"></script> |
---|
| 469 | <script type="text/javascript" src="../../_static/underscore.js"></script> |
---|
| 470 | <script type="text/javascript" src="../../_static/doctools.js"></script> |
---|
| 471 | |
---|
| 472 | |
---|
| 473 | |
---|
| 474 | |
---|
| 475 | |
---|
| 476 | <script type="text/javascript" src="../../_static/js/theme.js"></script> |
---|
| 477 | |
---|
| 478 | |
---|
| 479 | |
---|
| 480 | |
---|
| 481 | <script type="text/javascript"> |
---|
| 482 | jQuery(function () { |
---|
| 483 | SphinxRtdTheme.StickyNav.enable(); |
---|
| 484 | }); |
---|
| 485 | </script> |
---|
| 486 | |
---|
| 487 | |
---|
| 488 | </body> |
---|
| 489 | </html> |
---|