Installation Guide - GShell

Introduction

The Grimoires Shell (GShell) is a simple client that supports some of the functionality of the Grimoires service in interactive mode or batch mode. Full Grimoires functionality may be accessed either by the Java Programming Client Side API or by the SOAP message submission facility. GShell provides a group of utilities for users to publish/inquire business/service/wsdl/metadata.

How to compile and run

In the Grimoires release, GShell is under the "GShell/" directory. Having run Grimoires ant target "build-client", GShell will be copied to the  "dist/client/" directory.

Use "GShell/" or "dist/client/" as the current directory.

To compile, type on the command line:

ant

If you wish to use GShell to run against a secure Grimoires deployment, then type

ant secure

Also, read the next section on running GShell as secure client before proceeding.

To run on Windows, type on the command line:

run GRIMOIRES_LOCATION

To run on Unix/Linux, type on the command line:

chmod +x run.sh
./run.sh GRIMOIRES_LOCATION

If you have deployed the registry on, e.g., http://hostname:8080/grimoires, you need to start the GShell by

run http://hostname:8080/grimoires/services

Running GShell as a secure client

If Grimoires is deployed securely, then GShell must be run as a secure client, i.e. the outgoing SOAP messages from GShell to Grimoires must be signed appropriately. This requires the use of the keystore and certificate found in the OMII client, which needs to be downloaded and installed first. The parameters in the crypto.properties file in gshell/config then needs to be updated:

org.apache.ws.security.crypto.merlin.file=/home/bob/OMIICLIENT/omii.ks
org.apache.ws.security.crypto.merlin.keystore.password=tmpstore
org.apache.ws.security.crypto.merlin.keystore.alias=omii_server
org.apache.ws.security.crypto.merlin.alias.password=tmpstore
org.apache.ws.security.crypto.provider=org.apache.ws.security.components.crypto.Merlin
org.apache.ws.security.crypto.merlin.keystore.type=JKS
org.apache.ws.security.crypto.merlin.crldir=/home/bob/OMIICLIENT/grid/CRLs

If the OMII client is installed at /home/bob/OMIICLIENT, then the value for org.apache.ws.security.crypto.merlin.file is /home/bob/OMIICLIENT/omii.ks. Same comments apply to org.apache.ws.security.crypto.merlin.crldir.