Installation

This section describes how to install the Registry User Interface software contained in the registry-ui package. The following topics can be found in this section:

• System Requirements
• Unpacking the Package
• Configuring Service Endpoint
• Deploying the Application

System Requirements

The Registry User Interface was developed using Java and Google Web Toolkit and will run under a standard Java Application Server. The tool was specifically developed under Sun Java version 1.6, so the tool will execute correctly under 1.6 and future versions.

Since the tool was developed using Sun's Java, the target Java Application Server should support Sun's Java Runtime Environment (JRE). The application was tested using Apache's Tomcat version 5.5.X, which is the preferred Java Application Server for deployment. The software can be obtained from the Apache Tomcat web site. Other Java Application Servers should be compatible.

Unpacking the Package

Download the registry-ui package from the yet to be developed PDS 2010 web page. The binary distribution is available in identical zip or tar/gzip packages. Unpack the selected binary distribution file with one of the following commands:

% unzip registry-ui-0.2.0-bin.zip
or
% tar -xzvf registry-ui-0.2.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 registry-ui-0.2.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.

• registry-ui-0.2.0.war
  

  This is the Web ARchive (WAR) file containing the Registry User Interface software including all dependent JAR files.

• doc/
  

  This document directory contains a local web site with the Registry User Interface Guide, javadoc, unit test results and other configuration management related information. Just point your favorite browser to the index.html file in this directory.

Configuring Service Endpoint

The Registry User Interface software is configured at build time to access a specific Registry Service endpoint. If this configuration requires modification, the WAR file will need to be unpacked and the ./WEB-INF/classes/application.properties file modified. The file contents are as follows:

service.endpoint=http\://{host}\:{port}/registry-service/
      

Modify the values contained in the {} according to the desired Registry Service endpoint, save the file and repack the WAR file.

Deploying the Application

The Registry User Interface web application is packaged as a WAR file and is intended for installation under a standard Java Application Server. Prior to installation the WAR file should be renamed from registry-ui-0.2.0.war to registry-ui.war. A WAR file is normally copied directly to the webapps directory or installed via the Manager interface. Once this step is complete, the application is ready for operation.