SimpleMapServer 'web application' configuration
The class which implements the WMS service is the simpleMapServer.MapProducer class.
In a typical web server installation, the simpleMapServer.server.MapServlet
class is used.
(Since release 0.712, all the servlets classes have moved from the package 'simpleMapServer'
into the package 'simpleMapServer.server')
A) The MapServlet need the following parameters:
Parameter name |
Required |
Meaning |
Example of value |
Comment |
| propertiesFilePath | YES |
The absolute path where the MapProducer property file is | /home/user/tomcat/webapps/simpleMapServer/WEB-INF/mapServer.props |
Example of MapServlet declaration in a web.xml file:
<servlet>
<servlet-name>mapServer</servlet-name>
<servlet-class>simpleMapServer.server.MapServlet</servlet-class>
<init-param>
<param-name>debug</param-name>
<param-value>2</param-value>
</init-param>
<init-param>
<param-name>propertiesFilePath</param-name>
<param-value>C:\tomcat413\webapps\simpleMapServer\WEB-INF\mapServer.props</param-value>
</init-param>
<!-- Load this servlet at server startup time -->
<load-on-startup>5</load-on-startup>
</servlet>
...
...
<!-- Define the mapServlet Servlet Mapping -->
<servlet-mapping>
<servlet-name>mapServer</servlet-name>
<url-pattern>/mapServer</url-pattern>
</servlet-mapping>
B) The MapProducer class need the following parameters (passed inside a PropertiesFile, which encapsulate a java Property):
Parameter name |
Required |
Meaning |
Example of value |
Comment |
| map_producer_data_path | YES |
The path of the folder[s] which contains the GIS layers | /home/user/gis; /home/user/gis2 | if multiple: ; separated |
| map_producer_url | YES |
The server base url which will be put in the capabilities | http://my_server:port/ | just http:// + hostname + port |
| resource_url | YES |
The online ressource url which will be put in the capabilities | http://my_server:port/explanation.html | |
| keywords | NO |
the list of keywords put in the capabilities | Satellite images, Envisat, Meris, Asar | , separated |
| maxMapWidth | NO |
the maximum width size allowed for the map image | 800 | default is 2048 |
| maxMapHeight | NO |
the maximum height size allowed for the map image | 600 | default is 2048 |
| cacheEnabled | NO |
the request cache: if the url is EXACTLY the same, the cached image is sent | true/false | default is false |
| cacheLimit | NO |
the cache maximum memory limit | 20 | in Mbs |
| cacheTimeout | NO |
the cache item timeout | 720000 | in seconds |
| cacheReclaim | NO |
the cache reclaim ratio: fraction (max 1.0) of memory reclaimed when cache is full | 0.33 | fraction of 1 |
| imageStamp | YES |
A message written on the map image | Hello world! | default message is: |
| imageStampColor | YES |
And thr color used to write it | #ff0000 | #RRGGBB |
| quantizeGif | NO |
do a quantization of the GIF colormap | true/false | default is false. Is quite time consuming |
| showTileBBox | NO |
show the data tiles outline on the map image | true/false | default is false |
| showTileOutline | NO |
show the data tiles bounding box | true/false | default is false |
| imageDebugDumpPath | NO |
disk location where the map image is written, for debugging purpose | /tmp | default is false |
| showErrorStack | NO |
if true: show the full error track | true/false | default is false |
Table 1: MapServlet parameters
RED: required settings
GREEN: settings for debugging
glavaux <at> serco <dot> it