Code Monkey home page Code Monkey logo

geoserver-documentor's Introduction

Introduction

Geoserver extension to provide a REST interface (XML)for extracting info for documentation generation. This extension is currently tested with Geoserver 2.4.8 and 2.6.5. Contributions to make this extension compatible with more recent versions of Geoserver are very welcome.

Installation

Building the extension

Run

make build

The generated JARs will be in the target/ directory.

Installing into Geoserver

To install this extension, follow these steps:

  • Drop all JARs of the target directory to geoservers WEB-INF/lib/ directory. The target directory will also contain the dependencies which are not already bundled with geoserver.
  • Restart geoserver.
  • Congratulations, you're done.

Usage

Examples

Complete route

curl -u admin:geoserver http://hostname:8080/geoserver/rest/documentor/complete.xml

Specific workspace with one shapefile datasource and one layer published.

curl -u admin:geoserver http://hostname:8080/geoserver/rest/documentor/workspaces/it.geosolutions.xml

Output would be something like this:

<de.geops.geoserver.documentor.info.WorkspaceFullDoc>
  <name>it.geosolutions</name>
  <layers>
    <de.geops.geoserver.documentor.info.LayerDoc>
      <workspaceName>it.geosolutions</workspaceName>
      <name>states</name>
      <title defined-in="de.geops.geoserver.documentor.info.LayerBaseDoc">states</title>
      <nativeName>states</nativeName>
      <type>vector</type>
      <featureType>
        <properties>
          <de.geops.geoserver.documentor.info.PropertyDoc>
            <name>the_geom</name>
            <type>MultiPolygon</type>
          </de.geops.geoserver.documentor.info.PropertyDoc>
          <de.geops.geoserver.documentor.info.PropertyDoc>
            <name>STATE_NAME</name>
            <type>String</type>
          </de.geops.geoserver.documentor.info.PropertyDoc>
          <de.geops.geoserver.documentor.info.PropertyDoc>
            <name>STATE_FIPS</name>
            <type>String</type>
          </de.geops.geoserver.documentor.info.PropertyDoc>
          <de.geops.geoserver.documentor.info.PropertyDoc>
            <name>SUB_REGION</name>
            <type>String</type>
          </de.geops.geoserver.documentor.info.PropertyDoc>
          <de.geops.geoserver.documentor.info.PropertyDoc>
            <name>STATE_ABBR</name>
            <type>String</type>
          </de.geops.geoserver.documentor.info.PropertyDoc>
          <de.geops.geoserver.documentor.info.PropertyDoc>
            <name>LAND_KM</name>
            <type>Double</type>
          </de.geops.geoserver.documentor.info.PropertyDoc>
          <de.geops.geoserver.documentor.info.PropertyDoc>
            <name>WATER_KM</name>
            <type>Double</type>
          </de.geops.geoserver.documentor.info.PropertyDoc>
          <de.geops.geoserver.documentor.info.PropertyDoc>
            <name>PERSONS</name>
            <type>Double</type>
          </de.geops.geoserver.documentor.info.PropertyDoc>
          <de.geops.geoserver.documentor.info.PropertyDoc>
            <name>FAMILIES</name>
            <type>Double</type>
          </de.geops.geoserver.documentor.info.PropertyDoc>
          <de.geops.geoserver.documentor.info.PropertyDoc>
            <name>HOUSHOLD</name>
            <type>Double</type>
          </de.geops.geoserver.documentor.info.PropertyDoc>
          <de.geops.geoserver.documentor.info.PropertyDoc>
            <name>MALE</name>
            <type>Double</type>
          </de.geops.geoserver.documentor.info.PropertyDoc>
          <de.geops.geoserver.documentor.info.PropertyDoc>
            <name>FEMALE</name>
            <type>Double</type>
          </de.geops.geoserver.documentor.info.PropertyDoc>
          <de.geops.geoserver.documentor.info.PropertyDoc>
            <name>WORKERS</name>
            <type>Double</type>
          </de.geops.geoserver.documentor.info.PropertyDoc>
          <de.geops.geoserver.documentor.info.PropertyDoc>
            <name>DRVALONE</name>
            <type>Double</type>
          </de.geops.geoserver.documentor.info.PropertyDoc>
          <de.geops.geoserver.documentor.info.PropertyDoc>
            <name>CARPOOL</name>
            <type>Double</type>
          </de.geops.geoserver.documentor.info.PropertyDoc>
          <de.geops.geoserver.documentor.info.PropertyDoc>
            <name>PUBTRANS</name>
            <type>Double</type>
          </de.geops.geoserver.documentor.info.PropertyDoc>
          <de.geops.geoserver.documentor.info.PropertyDoc>
            <name>EMPLOYED</name>
            <type>Double</type>
          </de.geops.geoserver.documentor.info.PropertyDoc>
          <de.geops.geoserver.documentor.info.PropertyDoc>
            <name>UNEMPLOY</name>
            <type>Double</type>
          </de.geops.geoserver.documentor.info.PropertyDoc>
          <de.geops.geoserver.documentor.info.PropertyDoc>
            <name>SERVICE</name>
            <type>Double</type>
          </de.geops.geoserver.documentor.info.PropertyDoc>
          <de.geops.geoserver.documentor.info.PropertyDoc>
            <name>MANUAL</name>
            <type>Double</type>
          </de.geops.geoserver.documentor.info.PropertyDoc>
          <de.geops.geoserver.documentor.info.PropertyDoc>
            <name>P_MALE</name>
            <type>Double</type>
          </de.geops.geoserver.documentor.info.PropertyDoc>
          <de.geops.geoserver.documentor.info.PropertyDoc>
            <name>P_FEMALE</name>
            <type>Double</type>
          </de.geops.geoserver.documentor.info.PropertyDoc>
          <de.geops.geoserver.documentor.info.PropertyDoc>
            <name>SAMP_POP</name>
            <type>Double</type>
          </de.geops.geoserver.documentor.info.PropertyDoc>
        </properties>
      </featureType>
      <store>
        <workspaceName>it.geosolutions</workspaceName>
        <name>states_test</name>
        <type>Shapefile</type>
      </store>
      <isAdvertized>true</isAdvertized>
      <isEnabled>true</isEnabled>
      <defaultStyle>
        <name>polygon</name>
      </defaultStyle>
      <keywords>
        <string>features</string>
        <string>states</string>
      </keywords>
    </de.geops.geoserver.documentor.info.LayerDoc>
  </layers>
</de.geops.geoserver.documentor.info.WorkspaceFullDoc>

The documentor respects the permissions of the credentials that are supplied via the request. It is advised to create a seperate account for the documentor and grant only the permission to ressources you want to be able to query.

Documenting Postgresql relations

Documentor documents the relations used by a layer by default. This also includes for example all tables referenced by a view when geoserver uses a view as its datasource.

Syntax:

  Directives:
  
    * ignore
      ignore the current entity
    
    * include-ref [reference]
      Also load the documentation for the referenced entity
      
    * ignore-ref [reference]
      Ignore the reference to the specified entity
 
      
  References:
  
  The syntax to reference tables is
  
      table:[table schema].[table name]
 
  Quoted identifiers are allowed.

These directives so far are supported in comments on Postgresql tables and views.

Known issues

Fetching the Webservice in JSON-Format fails

2014-11-05 11:48:05,091 ERROR [geoserver.rest] - Exception intercepted
java.util.EmptyStackException
    at org.codehaus.jettison.util.FastStack.peek(FastStack.java:39)
    at org.codehaus.jettison.mapped.MappedXMLStreamWriter.setNewValue(MappedXMLStreamWriter.ja
    at org.codehaus.jettison.mapped.MappedXMLStreamWriter.writeCharacters(MappedXMLStreamWrite
    at com.thoughtworks.xstream.io.xml.StaxWriter.setValue(StaxWriter.java:158)
    at com.thoughtworks.xstream.converters.SingleValueConverterWrapper.marshal(SingleValueConv
    at com.thoughtworks.xstream.core.TreeMarshaller.convert(TreeMarshaller.java:70)
    at com.thoughtworks.xstream.core.TreeMarshaller.convertAnother(TreeMarshaller.java:58)
    at com.thoughtworks.xstream.converters.reflection.AbstractReflectionConverter.marshallFiel
    at com.thoughtworks.xstream.converters.reflection.AbstractReflectionConverter$2.writeField
    at com.thoughtworks.xstream.converters.reflection.AbstractReflectionConverter$2.<init>(Abs
    at com.thoughtworks.xstream.converters.reflection.AbstractReflectionConverter.doMarshal(Ab
    at com.thoughtworks.xstream.converters.reflection.AbstractReflectionConverter.marshal(Abst
    at com.thoughtworks.xstream.core.TreeMarshaller.convert(TreeMarshaller.java:70)
    at com.thoughtworks.xstream.core.TreeMarshaller.convertAnother(TreeMarshaller.java:58)
    at com.thoughtworks.xstream.core.TreeMarshaller.convertAnother(TreeMarshaller.java:43)
    at com.thoughtworks.xstream.converters.collections.AbstractCollectionConverter.writeItem(A
    at org.geoserver.config.util.XStreamPersister$ProxyCollectionConverter.writeItem(XStreamPe
    at com.thoughtworks.xstream.converters.collections.CollectionConverter.marshal(CollectionC
    [...]

This is an issue with jettison 1.0.x. An Upgrade of the jettision jar to 1.3.x fixes this issue, but jettison changed its object and array nesting in JSON format slightly between these versions. This will affect all of geoservers REST services. The better solution would be to just use the XML format.

See http://stackoverflow.com/questions/13804878/spring-batch-spring-batch-admin-project and https://jira.codehaus.org/browse/JETTISON-70

geoserver-documentor's People

Contributors

lb1c avatar

Watchers

avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.