Eclipse Guide

A reference for developing GeoServer with Eclipse.

Importing modules

See the Eclipse section of the Maven Guide.

Running and debugging

Run or debug the class org.geoserver.web.Start in the web-app module. The steps to do so are detailed in the Quickstart.

Running GeoServer with Extensions

By default, GeoServer will run without any extensions enabled. In order to run GeoServer with extensions, the web-app module declares a number of profiles used to enable specific extensions when running Start. To enable an extension, re-generate the root eclipse profile with the appropriate maven profile(s) enabled:

% mvn eclipse:eclipse -P wps

The full list of supported profiles can be found in src/web/app/pom.xml.

Setting the data directory

If unset, GeoServer will default to the minimal directory inside of the web-app module for its data directory. To change this:

  1. Open Debug Configurations... from the Eclipse menu

    ../_images/dd1.jpg
  2. Select the Start configuration, select the Arguments panel and specify the -DGEOSERVER_DATA_DIR parameter, setting it to the absolute path of the data directory

    ../_images/dd2.jpg

Changing the default port for Jetty

If unset, Jetty will default to port 8080. To change this:

  1. Open the Arguments panel of the Start configuration as described in the above section

  2. Specify the -Djetty.port parameter, setting it to the desired port

    ../_images/port.jpg

Configuring JNDI resources in Jetty

JNDI resources such as data sources can be configured by supplying a Jetty server configuration file named in the system property jetty.config.file, specified as a line in VM arguments in the Arguments panel of the launch configuration for Start (separate lines are joined when the JVM is launched). The path to the configuration file is relative to the root of the web-app module, in which the launch configuration runs. Naming factory system properties must also be configured for Jetty. For example, VM arguments could include:

-Djetty.config.file=../../../../../settings/jetty.xml
-Djava.naming.factory.url.pkgs=org.mortbay.naming
-Djava.naming.factory.initial=org.mortbay.naming.InitialContextFactory

The following Jetty server configuration file configures a JNDI data source java:comp/env/jdbc/demo that is a connection pool for an Oracle database:

<?xml version="1.0"?>
<!DOCTYPE Configure PUBLIC "-//Mort Bay Consulting//DTD Configure//EN" "http://jetty.mortbay.org/configure.dtd">
<Configure class="org.mortbay.jetty.Server">
    <New class="org.mortbay.jetty.plus.naming.Resource">
        <Arg>java:comp/env/jdbc/demo</Arg>
        <Arg>
            <New class="org.apache.commons.dbcp.BasicDataSource">
                <Set name="driverClassName">oracle.jdbc.driver.OracleDriver</Set>
                <Set name="url">jdbc:oracle:thin:@oracle.example.com:1521:demodb</Set>
                <Set name="username">claudius</Set>
                <Set name="password">s3cr3t</Set>
                <Set name="maxActive">20</Set>
                <Set name="maxIdle">10</Set>
                <Set name="minIdle">0</Set>
                <Set name="maxWait">10000</Set>
                <Set name="minEvictableIdleTimeMillis">300000</Set>
                <Set name="timeBetweenEvictionRunsMillis">300000</Set>
                <Set name="numTestsPerEvictionRun">20</Set>
                <Set name="poolPreparedStatements">true</Set>
                <Set name="maxOpenPreparedStatements">100</Set>
                <Set name="testOnBorrow">true</Set>
                <Set name="validationQuery">SELECT SYSDATE FROM DUAL</Set>
            </New>
        </Arg>
    </New>
</Configure>

Jetty does not mandate a reference-ref in GeoServer WEB-INF/web.xml, so there is no need to modify that file. No Jetty-specific information is required inside the GeoServer web-app module or data directory, so JNDI resources can be tested under Jetty for later deployment under Tomcat. See also the tutorial Setting up a JNDI connection pool with Tomcat in the GeoServer User Manual.

Starting Jetty with an open SSL port

The SSL port used 8843.

  1. Open the Arguments panel of the Start configuration.

  2. Specify the -Dssl.hostname parameter, setting it to the full qualified host name of the box running Jetty.

    ../_images/ssl.jpeg

On first time startup, a key store is created in <home directory>/.geoserver/keystore.jks. The password is changeit and the key store contains a self signed certificate for the host name passed in the ssl.hostname parameter.

Test the SSL connection by opening a browser and entering https://ux-desktop03.mc-home.local:8843/geoserver. The browser should complain about the self singed certificate which does not hurt for test and development setups.

Eclipse preferences

Code formatting

  1. Download https://github.com/geotools/geotools/blob/master/build/eclipse/formatter.xml

  2. Navigate to Java, Code Style, Formatter and click Import...

    ../_images/code_formatting1.jpg
  3. Select the formatter.xml file downloaded in step 1

  4. Click Apply

    ../_images/code_formatting2.jpg
  5. We follow “Sun Coding Conventions and a little bit more”:

For more information see GeoTools Coding Style page.

Code templates

  1. Download https://github.com/geotools/geotools/blob/master/build/eclipse/codetemplates.xml

  2. Navigate to Java, Code Style, Code Templates and click Import...

    ../_images/code_templates.jpg
  3. Select the codetemplates.xml file downloaded in step 1

  4. Update the file header:

    /* (c) ${year} Open Source Geospatial Foundation - all rights reserved
     * This code is licensed under the GPL 2.0 license, available at the root
     * application directory.
     */
  5. Click Apply

Text editors

  1. Navigate to General, Editors, Text Editors

  2. Check Insert spaces for tabs

  3. Check Show print margin and set Print margin column to “100”

  4. Check Show line numbers

  5. Check Show whitespace characters (optional)

    Note

    Showing whitespace characters can help insure that unecessary whitespace is not unintentionaly comitted.

    ../_images/text_editors.jpg
  6. Click Apply

Compiler

  1. Navigate to Java, Compiler, Building

  2. Expand Output folder and add ”.svn/” to the list of Filtered resources

    ../_images/compiler.jpg
  3. Click Apply

Previous: Maven Guide