GeoServer : Adding a Configuration Option-GS2
This page last changed on Mar 17, 2009 by aaime.
This page describes extending GeoServer's configuration in the new Catalog API, in use as of GeoServer 2.0.x. The Catalog API is described in more detail here.
In the Catalog API, most configuration objects include a metadata map which provides easy storage of arbitrarily named configuration options. For example, if you simply want to add a new configuration option to a StoreInfo, just add it to the metadata map for the layer. This is all you need to do:
To help avoid naming conflicts, please prefix your custom options with a string identifying the module that uses it. For example, the name of the option that controls whether the GeoSearch extension will index a layer is called "geosearch.enable" rather than just "enable".
The GeoServer Catalog API provides several types of configuration object. The following table summarizes the object types and what they should be used for.
The metadata map can contain any Serializable Java Object, so it should be sufficient for most needs. However, if you are implementing a feature that simply does not map to any of the existing configuration objects, you will probably need to extend and implement one of the existing interfaces to provide the appropriate place. For example, when implementing a new service you may need to provide a new type of ResourceInfo to control the data used by the service.
|Document generated by Confluence on May 14, 2014 23:00|