Skip to content
An implementation in Java of the Geonorge Download API (https://nedlasting.geonorge.no/Help)
Java HTML
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github/ISSUE_TEMPLATE
src
.gitignore
CODE_OF_CONDUCT.md
CONTRIBUTING.md
LICENSE
README.md
pom.xml
testdata.sql

README.md

What is Geonorge Nedlasting-api

It's an implementation in Java of the Geonorge Download API Geonorge Download API enables seemless integration of distributes downloadable geographic datasets from data owners (mostly governmental agencies, municipalities etc) into the geonorge portal.

The official API documentation available at https://nedlasting.geonorge.no/Help

With this download api you can integrate download and query a dataset for

Install and run

This API-implementation is developed using Java, Maven and JUnit.

From Source

Checkout the source code from Github and build from source using Maven:

sh
$ mvn package 
$ java -jar target/geonorge-nedlastingapi-<version>.jar
$ 

From releases

Download a release and run using Java

sh
$ 
$ java -jar geonorge-nedlastingapi-<version>.jar
$ 

This will start an embedded webserver running Jetty from a jar file. You can also change packaging in pom.xml from jar to war, and deploy war-file to Tomcat,JBoss etc.

The webserver (CORS-enabled) is running at no.geonorge.download.httpd.DownloadWebServer The REST-api is autoconfigured with Jersey annotations at no.geonorge.rest.DownloadService

Example usage

When running the embedded webserver (Jetty), the API will expose itself on your computer default port 10000: The main endpoint would then be http://yourserver:10000/api and consequtive endpoints are generated after adding datasets using one or both of the following

Set up dev environment

Since this API is developed using Java and Maven, you have a range of possibilities. The code is follows the convensions of Maven and is ignorant to specific Integrated Development Environments. All you need to start develop is a a recent version of Java Develope Kit and Maven.

Development using Eclipse, IntelliJ IDEA etc

Maven comes with support for multiple IDEs. You can tell Maven to generate project files and setup classpaths:

  • Eclipse:
cd {/Path/to/your/git/clone}
mvn eclipse:eclipse
  • IntelliJ IDEA:
cd {/Path/to/your/git/clone}
mvn idea:idea

Configuration

Configuration can be done using environment variables, java VM arguments or a properties file. This API supports multiple RDBMS using JDBC. It has been tested with PostgreSQL, Apache Derby and Oracle and it should also work with SQLServer from Microsoft.

Oracle RDBMS

The license agreement for Oracle JDBC has such restrictions that we cannot ship this project or the releases with the ojdbc jar-file. You can add in ojdbc by multiple methods.

  1. Add ojdbc-version.jar to your classpath when starting geonorge-nedlastingapi.jar
  2. Install ojdbc into your local Maven archive as described below
mvn install:install-file -Dfile={Path/to/your/ojdbc7.jar}
      -DgroupId=com.oracle -DartifactId=ojdbc7 -Dversion=12.1.0 -Dpackaging=jar

And then add the following to pom.xml:

<!-- ojdbc7.jar example -->
        <dependency>
            <groupId>com.oracle</groupId>
            <artifactId>ojdbc7</artifactId>
            <version>12.1.0</version>
        </dependency>

Here are example parameters as java VM arguments.

-Ddatabase.url=jdbc:postgresql://127.0.0.1/db -Ddatabase.driver=org.postgresql.Driver \
-Ddatabase.username=user -Ddatabase.password=pass

Here is an example properties file. It should be located in ./geonorge.properties or /etc/geonorge.properties.

database.url=jdbc:postgresql://127.0.0.1/db
database.driver=org.postgresql.Driver
database.username=user
database.password=pass
cors=*

Another note on postgresql. PostgreSQL will use public as currentSchema unless overridden. So - if you want to use a custom db schema you can configure it in the jdbc url:

-Ddatabase.url=jdbc:postgresql://127.0.0.1/nedlastingtest?currentSchema=myschema

API Documentation

After starting the API server, it has a built in API Documentation available at /api/docs. The latest one from GitHUB is also available here.

User management

The API server has a simple internal user database for users that need to update the API server content via HTTP(S). To add a user, use one of the following two ways.

-- echo -n SuperPassord | shasum5.18 -a 512
insert into api_user (username, password_sha512) values ('user1', 'bbb5e8484f4cfbb67ab1b6ec026ebe433091436fe6135955e5e9796f2f6c6f5fad16f528aa20edf0e3dadf217480a94c4fc571cd5c5695cf2393eea714384026');
-- or use pgcrypto
CREATE EXTENSION pgcrypto;
insert into api_user (username, password_sha512) values ('user2', encode(digest('mittpassord','sha512'),'hex'));

Contributions accepted

We welcome contributions, as code preferrable as pull request here on Github.

  1. Fork our codebase
  2. Make a branch for your contribution
  3. Commit changes and push your changes to your branch
  4. Make a pull request for your change.

Example contributions:

  • Extend and add support for more backends
  • File bugs or feature requests using Issue Tracker
  • Improve on API documentation and/or suite of unit tests.

License and credit

License of this code is MIT - meaning you can do pretty much what you want with it. Full license-clause found in file LICENSE This API is developed at the Geological survey of Norway

Contact: Bjorn.Ove.Grotan AT ngu.no

Talks

This software have been or is going to be presented at

  • FME World Tour Oslo 2018
  • #FOSS4G Tanzania 2018

Thanks

  • @MalteStr - from the Norwegian Institute of Bioeconomy Research
  • @halset from Electronic Chart Centre.
  • Dag-Olav at Arkitektum for help during development.
  • Kartverket (Norwegian Mapping Authority)
You can’t perform that action at this time.