Installation

This document describes how to install the Harvest Tool contained in the harvest package. The following topics can be found in this document:

• System Requirements
• Unpacking the Package
• Configuring the Tool
• Configuring the Environment

System Requirements

The Harvest Tool was developed using Java and will run on any platform with a supported Java Runtime Environment (JRE). The software was specifically developed under Java version 1.6 and has only been tested with this version. The following commands test the local Java installation in a UNIX-based environment:

% which java
/usr/bin/java

% java -version
java version "1.6.0_26"
Java(TM) SE Runtime Environment (build 1.6.0_26-b03-384-10M3425)
Java HotSpot(TM) 64-Bit Server VM (build 20.1-b02-384, mixed mode)
      

The first command above checks whether the java executable is in the environment's path and the second command reports the version. If Java is not installed or the version is not at least 1.6, Java will need to be downloaded and installed in the current environment. Consult the local system administrator for installation of this software. For the do-it-yourself crowd, the Java software can be downloaded from the Oracle Java Download page. The software package of choice is the Java Standard Edition (SE) 6, either the JDK or the JRE package. The JDK package is not necessary to run the software but could be useful if development and compilation of Java software will also occur in the current environment.

Unpacking the Package

Download the harvest package from the PDS FTP site. The binary distribution is available in identical zip or tar/gzip packages. The installation directory may vary from environment to environment but in UNIX-based environments it is typical to install software packages in the /usr/local directory and in Windows-based environments it is typical to install software packages in the C:\Program Files directory. Unpack the selected binary distribution file with one of the following commands:

% unzip harvest-1.3.0-bin.zip
or
% tar -xzvf harvest-1.3.0-bin.tar.gz
      

Note: Depending on the platform, the native version of tar may produce an error when attempting to unpack the distribution file because many of the file paths are greater than 100 characters. If available, the GNU version of tar will resolve this problem. If that is not available or cannot be installed, the zipped package will work just fine in a UNIX environment.

The commands above result in the creation of the harvest-1.3.0 directory with the following directory structure:

• README.txt
  

  A README file directing the user to the available documentation for the project.

• LICENSE.txt
  

  The copyright notice from the California Institute of Technology detailing the restrictions regarding the use and distribution of this software. Although the license is strictly worded, the software has been classified as Technology and Software Publicly Available (TSPA) and is available for anyone to download and use.

• bin/
  

  This directory contains batch and shell scripts for executing the tool.

• doc/
  

  This directory contains a local web site with the Harvest Tool documentation, javadoc, unit test results and other configuration management related information. Just point the desired web browser to the index.html file in this directory.

• examples/
  

  This directory contains examples of the policy file used for specifying how the Harvest Tool discovers products and extracts metadata for registration.

• lib/
  

  This directory contains the dependent jar files for the tool along with the executable jar file (harvest-1.3.0.jar) containing the Harvest Tool software.

• keystore/
  

  This directory contains the keystore file needed for Harvest to support product registration to a secured instance of the PDS Registry.

Configuring the Tool

By default, the Harvest Tool comes configured to access the Registry Service at the specific URL location http://localhost:8080/registry. This should be modified to represent the URL location of the Registry Service target installation. To change the URL location, the harvest script should be modified as follows:

${JAVA_HOME}/bin/java -Dpds.registry="http://localhost:8080/registry" \
-Dpds.security.keystore="${KEYSTORE}" -jar ${HARVEST_JAR} "$@"

  should be changed to (if hosted at node.nasa.gov on port 80):

${JAVA_HOME}/bin/java -Dpds.registry="http://node.nasa.gov/registry" \
-Dpds.security.keystore="${KEYSTORE}" -jar ${HARVEST_JAR} "$@"
      

To change the endpoint for Windows, the harvest.bat script should be modified as follows:

"%JAVA_HOME%"\bin\java -Dpds.registry="http://localhost:8080/registry" \
-Dpds.security.keystore="%KEYSTORE%" -jar "%HARVEST_JAR%" %*

  should be changed to (if hosted at node.nasa.gov on port 80):

"%JAVA_HOME%"\bin\java -Dpds.registry="http://node.nasa.gov/registry" \
-Dpds.security.keystore="%KEYSTORE%" -jar "%HARVEST_JAR%" %*
      

The examples above have been broken into multiple lines for readability. The commands should be reassembled into a single line.

Configuring the Environment

In order to execute the Harvest Tool, the local environment must first be configured appropriately. This section describes how to setup the user environment on UNIX-based and Windows machines.

% export PATH=${PATH}:/usr/local/harvest-1.3.0/bin
        

% export JAVA_HOME=/path/to/java/home
        

C:\> set PATH = %PATH%;C:\Program Files\harvest-1.3.0\bin
        

C:\> set JAVA_HOME = C:\path\to\java\home
        

SCRIPT_DIR=`dirname $0`
PARENT_DIR=`cd ${SCRIPT_DIR}/.. && pwd`

  should be replaced with:

PARENT_DIR=/usr/local/harvest-1.3.0
        

set SCRIPT_DIR=%~dps0
set PARENT_DIR=%SCRIPT_DIR%..

  should be replaced with:

set PARENT_DIR=C:\Program Files\harvest-1.3.0