Developers Guide

0 Overview

Welcome to the GeoServer development community

• 1 Developer Introduction
• 2 Developer Tutorials

1 Setup

Download and installation instructions for GeoServer development. There are also nightly builds available for testing.

• 1 Java — Install a Java SDK
  • JDK Install Instructions
• 2 Subversion — Install a Subversion Command Line Client
• 3 Código Fuente — Verifique las fuentes de GeoServer
• 4 Maven — Download and Install Maven
• 5 Eclipse — Download and Install an Eclipse SDK

2 Maven Quickstart

Building and Running GeoServer with Maven.

• GeoServer 2 Maven Quickstart

3 Eclipse Quickstart

Building and Debugging GeoServer with Eclipse

• GeoServer and Eclipse with Tomcat
  • GeoServer as Eclipse Dynamic Web Project for Tomcat
• Integrating GeoServer JIRA with Eclipse's Mylyn (Mylar)

4 Programmers Guide

Guide to using GeoServer as a framework for additional applications

• 0 Introduction — Welcome, overview and terminology
• 1 GeoServer Architecture — Overview of the GeoServer architecture
• 2 GeoServer Platform — Short introduction to Spring, and its role in GeoServer
• 3 A Simple PlugIn — How to Create a Simple GeoServer Plugin
• 4 Developer Tutorials — Tutorials to get going with GeoServer as a framework
  • Adding new configuration options
  • Create your own Output Format
  • Creating a WFS Output Format
  • Working With The Catalog — Create a simple service which queries the catalog
• 5 Hints and Tricks — Advice and howtos for navigating the GeoServer codebase
  • Alternative for reloading the Geoserver catalog
  • Debugging Hints
  • Defining a custom projection
  • GeoTools Advice
  • Logging
  • Maven Build Reference
• Online Help
  • Developer Documentation Writing Guidelines
  • User Documentation Writing Guidelines

5 Reference

Information like javadocs, specifics on code, diagrams, configuration files and the like

• 0 Extension Points — Objects in GeoServer built for extension
  • MapProducerFactory
  • Operation
• 1 Javadocs — Where to access the javadocs for releases and trunk
• 2 Code Explanations — These explain in detail how different parts of the codebase work.
  • 1 How a GetFeature Request Works
  • 2 Request Response
  • 3 STRUTS Info
  • 5 GeoTools
  • 9 Validation Module
  • Developing Open Web Services
  • Global
  • TransactionResponse
• 3 Diagrams — This section contains various diagrams and pictures
  • 1 Overview
  • UML-WFS
  • UML-WMS
• 4 Design Notes — Notes on the designs of various sub-systems of GeoServer
  • 3 Output Strategies
  • Servlets
  • STRUTS
• 5 VWFS documentation — Documentation from the vwfs project of 2003/4
  • 1 Geoserver Configuration Design
  • 2 GeoServer Web Based Configuration Implementation Report
• 6 Configuration Files
  • 1 Structure
  • 2 Files

6 FAQ

7 Policies and Procedures

• 1 Code Conventions — This section provides a few general conventions for GeoServer developers, about formatting code, testing, directory structures, refactoring, and logging.
  • 1 Formatting — Information on how to format your code to match the rest of the codebase
  • 2 Subversion conventions — Recommendations for using GeoServer's SVN
  • 3 Logging — Most GeoServer logging conventions are directly inherited from GeoTools
  • 4 Refractoring — Recommendations for performing refactors of code in GeoServer
  • 5 Bug Fixing
• 2 Documentation Guidelines — run geoserver and open the config ui
• 3 Project Roles
  • 0 Project Steering Committee
  • 1 Getting Commit Status
• 4 Testing
  • 1 Unit and functional tests — Testing performed during the GeoServer build is the first safety net against bugs and regressions
  • 3 CITE tests — The CITE Conformance Tests of the Open Geospatial Consortium are the best functional tests we have of GeoServer
  • 4 Hand Testing — Between the forms of testing mentioned above is testing GeoServer by hand, issuing a number of requests to ensure that nothing major was broken.
• 5 Change Conventions — This section contains procedures for small fixes up to major improvements
  • 1 Reporting Issues — How to report issues in GeoServer
  • 2 GeoServer Improvement Proposal — A GSIP - GeoServer Improvement Proposal is the formal mechanism used to perform any sort of major change in the GeoServer project
  • 3 Merge Procedure — Guidelines on performing merges in the codebase
• 6 Communication — The various avenues for communication within the GeoServer Project
  • 1 Mailing lists — Links for archives and subscription management
  • 2 Issue Tracker — Our JIRA issue tracker is one of the primary modes of communication
  • 3 IRC
  • 4 GeoServer Improvement Proposals — How the project communicates about large changes - a persistent mechanism that all stakeholders can comment on
• 7 Releasing — h1. Create a GeoServer Release
  • Deploying — Deploy GeoServer jars to the Maven Repository
  • Pre-Release Testing Walkthrough
• 8 Licensing
  • Contributor Agreement
  • Do I need a proprietary license FAQ

Building GeoServer from source code

Format Options

GetLegendGraphic Improvements

Contributing to Documentation

The table of contents to the left are automatically generated based on child pages. Please keep this in mind as you add additional content, we have no wish to make this more difficult then it needs to be.

Writing guidelines are available:

Please read and follow these guidelines, they allow us to use your work in a proper GeoServer release.

If you make Development changes that result in a different user experience we will need to set up a Users Guide for
you to update as well.