Motuclient Java Project

@author smarty@cls.fr: Scrum master, Software architect, Quality assurance, Continuous Integration manager

How to read this file? Use a markdown reader: plugins chrome exists (Once installed in Chrome, open URL chrome://extensions/, and check "Markdown Preview"/Authorise access to file URL.), or for firefox (anchor tags do not work) and also plugin for notepadd++.

Be careful: Markdown format has issue while rendering underscore "_" character which can lead to bad variable name or path.

Summary

• Overview
• Build
• Installation
  • Prerequisites
  • Using Maven
• Integration examples
  • Out of a Java spring projects
  • In a Java spring projects
• API
  • Using Spring API
    • Download
    • GetSize
    • DescribeProduct
• Licence

Overview

Motu client "motuclient-java" is a Java API used to connect to Motu HTTP server in order to:

• extract the data of a dataset, with geospatial, temporal and variable criterias (default option)
• get the size of an extraction with geospatial, temporal and variable criterias
• get information about a dataset

This program can be integrated into a processing chain in order to automate the downloading of products via the Motu.

Build

From the "motuclient-java-parent" folder runs the command:

mvn clean install -Dmaven.test.skip=true
[...]
[INFO] BUILD SUCCESS
[...]

This creates Jar archives in the target folder:

• motuclient-java-tools/target/motuclient-java-tools-X.Y.Z.jar: Archive containing the API

Installation

Prerequisites

You must use Java version 1.8 or later.

Using Maven

Add in your pom.xml the following maven dependency:

<dependency>  
  <groupId>cls.atoll.motu.client</groupId>  
  <artifactId>motuclient-java-tools</artifactId>  
  <version>${project.version}</version>  
</dependency>  

Integration examples

Note that in all the examples, the Motu connection settings (server url, username and password) are defined as environment variables as declared in the file
/motuclient-java-tools/src/main/resources/motuClientConnection.properties.
You can set them using these environement variables (MOTU_USERNAME, MOTU_PASSWORD, MOTU_URL) or use the MotuClientConnectionProperties class to set them.

Out of a Java spring projects

See source code:

• /motuclient-java-non-spring/src/main/java/cls/motu/MotuClientNonSpringApplication.java
• /motuclient-java-non-spring/src/main/resources/spring-context.xml

In a Java spring project

See source code:

• /motuclient-java/src/main/java/cls/motu/MotuClientApplication.java

API

Using Spring API

See source code:

• /motuclient-java/src/main/java/cls/motu/MotuClientApplication.java

API examples

Download

See source code:

• /motuclient-java/src/main/java/cls/motu/MotuClientApplication.java

GetSize

See source code:

• /motuclient-java/src/main/java/cls/motu/MotuClientApplication.java

DescribeProduct

See source code:

• /motuclient-java/src/main/java/cls/motu/MotuClientApplication.java

Licence

This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 2.1 of the License, or (at your option) any later version.

This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public License along with this library; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307, USA.