This document describes how to install the Catalog Tool contained in the catalog package. The following topics can be found in this document:
This section details the system requirements for installing and operating the Catalog Tool.
The Catalog Tool was developed using Java and will run on any platform with a supported Java Runtime Environment (JRE). The software was specifically compiled for and tested in Java version 1.8. The following commands test the local Java installation in a UNIX-based environment:
% which java
/usr/bin/java
% java -version
java version "1.8.0_101"
Java(TM) SE Runtime Environment (build 1.8.0_101-b13)
Java HotSpot(TM) 64-Bit Server VM (build 25.101-b13, 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.8, 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 suggested software package is the Java Standard Edition (SE) 8, 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.
Release 1r64 or later of the Planetary Science Data Dictionary (PSDD) is required for the tool to function properly. Release 1r66 of the PSDD supports the validation of explicit FILE objects. The latest version of the PDS data dictionary can be retrieved from the PDS Data Dictionary web page.
Download the catalog 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 catalog-1.16.0-bin.zip
or
% tar -xzvf catalog-1.16.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 catalog-1.16.0 directory with the following directory structure:
A README file directing the user to the available documentation for the project.
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.
This directory contains batch and shell scripts for executing the tool.
This directory contains a local web site with the Catalog Tool documentation, javadoc, unit test results and other configuration management related information. Just point your favorite browser to the index.html file in this directory.
This directory contains the dependent jar files for the tool along with the executable jar file (catalog-1.16.0.jar) containing the Catalog Tool software.
This directory contains the keystore file needed for Catalog to support product registration to a secured instance of the Registry Service.
By default, the Catalog Tool comes configured to access the Registry Service at the specific end point http://localhost:8080/registry. This should be modified to represent the end point of the Registry Service target installation. To change the end point, the catalog script should be modified as follows:
${JAVA_HOME}/bin/java -Dpds.registry="http://localhost:8080/registry" \
-Dpds.security.keystore="${KEYSTORE}" -jar ${CATALOG_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 ${CATALOG_JAR} "$@"
To change the end point for Windows, the catalog.bat script should be modified as follows:
"%JAVA_HOME%"\bin\java -Dpds.registry="http://localhost:8080/registry" \
-Dpds.security.keystore="%KEYSTORE%" -jar "%CATALOG_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 "%CATALOG_JAR%" %*
The examples above have been broken into multiple lines for readability. The commands should be reassembled into a single line.
By default, the Registry Service installation is not a secured instance. If specific steps have been taken to secure the local installation, then the following procedure should be completed in order to allow the Catalog Tool to access the Registry Service.
In order for the Catalog Tool to access a secured instance of the Registry Service, a keystore file must first be generated. Follow the instructions in the PDS Security Service Installation Guide on how to generate this keystore file. Once this is generated, copy the keystore file to the keystore/ directory of the Catalog package and rename the file to tomcat_self_sign_keystore as this is what the Catalog shell script and batch file look for by default.
In order to execute the Catalog Tool, the local environment must first be configured appropriately. This section describes how to setup the user environment on UNIX-based and Windows machines.
This section details the environment setup for UNIX-based machines. The binary distribution includes a couple shell scripts that must be executed from the command-line. Setting the PATH environment variable to the location of the scripts, enables the shell scripts to be executed from any location on the local machine.
The following command demonstrates how to set the PATH environment variable (in Bourne shell), by appending to its current setting:
% export PATH=${PATH}:/usr/local/catalog-1.16.0/bin
In addition, the shell scripts require that the JAVA_HOME environment variable be set to the appropriate location of the Java installation on the local machine. The following command demonstrates how to set the JAVA_HOME environment variable:
% export JAVA_HOME=/path/to/java/home
The system administrator for the local machine may need to be consulted for this location. The path specified should have a bin sub-directory that contains the java executable. This variable may also be defined within the scripts. Edit the scripts (files without the .bat extension) and change the line in the example above to represent the local Java installation.
This section details the environment setup for Windows machines. The binary distribution includes a couple batch scripts that must be executed from the command-line. Setting the PATH environment variable to the location of the files, enables the batch scripts to be executed from any location on the local machine.
The following command demonstrates how to set the PATH environment variable, by appending to its current setting:
C:\> set PATH = %PATH%;C:\Program Files\catalog-1.16.0\bin
In addition, the batch scripts require that the JAVA_HOME environment variable be set to the appropriate location of the Java installation on the local machine. The following command demonstrates how to set the JAVA_HOME environment variable:
C:\> set JAVA_HOME = C:\path\to\java\home
The system administrator for the local machine may need to be consulted for this location. The path specified should have a bin sub-directory that contains the java executable. This variable may also be defined within the scripts. Edit the scripts (files with the .bat extension) and change the line in the example above to represent the local Java installation. Additional methods for setting Windows environment variables can be found in the Windows System Properties document.
Both the shell and batch scripts for this software utilize system commands for determining the installation home directory that may or may not be available on all platforms. If these commands are not available in the current environment, their use can be replaced in the scripts by setting the PARENT_DIR variable with the actual installation path. Modify the UNIX-based shell scripts as follows (the actual installation path may be different in the current environment):
SCRIPT_DIR=`dirname $0`
PARENT_DIR=`cd ${SCRIPT_DIR}/.. && pwd`
should be replaced with:
PARENT_DIR=/usr/local/catalog-1.16.0
Modify the Windows-based batch scripts as follows (the actual installation path may be different in the current environment):
set SCRIPT_DIR=%~dps0
set PARENT_DIR=%SCRIPT_DIR%..
should be replaced with:
set PARENT_DIR=C:\Program Files\catalog-1.16.0