Installation

This guide illustrates the installation procedure for the GPIR Service.

Required Software Prerequisites

The following software packages are prerequisites to using the GPIR Service:

  • Java 1.4.2_xx. Please download and install the latest version of the Java 1.4.2 SDK.
  • Maven 1.0.2. Please download and install Maven version 1.0.2.

    Note: The GridPort Demo Portal has not been tested with more recent versions of Maven.
  • Tomcat 5.0.xx or 5.5.x. Please download and install the latest version of Tomcat 5.0.xx or 5.5.x.

    Note: If you are using Tomcat 5.5.x, you will need to also download and install the compatability patch (labeled jakarta-tomcat-5.5.x-compat) to allow Tomcat 5.5.x to work with Java 1.4.2_xx.

We recommend setting up a dedicated system account to run the GPIR service software. To install the service, you will need write permissions in your Tomcat, and GPIR service directories. Thus, you should install these as your dedicated service user. The other required software may be installed as any user.

Environment

In order to use the software required to support the GPIR Service, you must first set up your environment. You will need to set the JAVA_HOME and MAVEN_HOME environment variables and ensure that the respective binaries are in your PATH. Additionally, you will need to set the CATALINA_HOME environment variable appropriately. The following is an example environment script. 


### for sh-based shells

### DEV SOFTWARE
export JAVA_HOME=/opt/java/j2sdk1.4.2_07;
export MAVEN_HOME=/opt/maven/maven-1.0.2;
export PATH=${JAVA_HOME}/bin:${MAVEN_HOME}/bin:${PATH};

### SERVICE ENVIRONMENT
export CATALINA_HOME=/opt/tomcat/jakarta-tomcat-5.5.7;

Installation

After installing the prerequisite software and setting up your environment, please download the GPIR source distribution and unpack it. To install the service, use Maven to attain the install goal and start Tomcat. 


    > tar xvfz gpir-version.tar.gz
    > cd gpir-version
    > maven install -Dinitdb=true
    > $CATALINA_HOME/bin/startup.sh
The '-Dinitdb=true' argument will initialize the database to its default state. If you need to re-deploy the service without re-initializing the database you should omit this argument.

The web service URL of the GPIR service is http://localhost:8080/gpir/webservices. You may point your browser to this URL to see a list of the service methods available. You may also view the service's WSDL from this URL by clicking on the 'wsdl' hyperlink next to the service of interest.

The administrative client is located at http://localhost:8080/gpir. For more information please visit the Administrative client documentation.