Registry Service User's Guide

Contents

• Introduction
• Requirements
• Installation
• Using the registry tool
• API
• Examples

Introduction

The GEMSS Registry Service comprises support for publishing/removing GEMSS applications services as well as querying the registry from clients in order to find appropriate services. Each service that is published in the registry contains information about itself at least the service endpoint URI. Further it is possible to store a set of arbitrary attributes (name/value pairs) but concrete names of these attributes are not defined yet. A common example would be to store the category of the service within an extra attribute (e.g. name/value="serviceCategory"/"SPECT").

This release contains the actual registry service as common Apache Axis Web Service, this brief user guide and a command line tool in order to publish and remove services in the registry.

Requirements

The GEMSS Registry requires a Tomcat hosting environment(version >= 4.1.27).

Installation & Starting

First you have to unpack the ISS_Registry_Service.zip into a new directory.

This release has the following directory structure:

dist - war file (actual registry web service)
docs - this documentation and Registry Service API
lib - jar files needed for properly work of Registry Service
tool - registry-tool.jar with the according jar files

In order to install the GEMSS Registry Service you have to perform the following steps:

1. Configure your GEMSS Registry by editing the build.properties file:
   
   registry-context-name - the name of the registry service
   registry-tomcat-url - where the registry service will be deployed
   registry-manager-user - tomcat manager name
   registry-manager-pwd - tomcat manager password
   
   For example:
   registry-context-name=registry
   registry-tomcat-url=http://localhost:9075
   registry-manager-user=user
   registry-manager-pwd=pwd


2. Optional Configuration of a separate logfile for the GEMSS Registry Service:
   
   The GEMSS Registry Service uses the standard java logging mechanism (java.util.logging). To configure an extra log file for the GEMSS Registry Service the loggig.properties file should contain the following lines:

   logging.registry.level = INFO
   logging.registry.pattern = ../logs/registry.log
   logging.registry.limit = 50000
   logging.registry.count = 1

3. Starting Tomcat
4. Execute ant or ant help in the root directory of your GEMSS Registry Service in order to display all provided targets of the ant build script (build.xml)
5. To deploy the GEMSS Registry Service execute: ant deploy-registry
6. The following output should be displayed:

   deploy-registry:

   [echo] Deploys the registry.war...
   [tomcat-install] OK - Installed application at context path /registry

Using the registry tool

In order to use registry tool at first you have to install and start the GEMSS Registry Service, then the using of registry tool has the following view

Publishing: In order to publish a service you have to write the following command

java -jar tool/registry-tool.jar -d uri2REGISTRYwsdl -r uri2SERVICEwsdl [-attrfile someAttributeFile]

where,

uri2REGISTRYwsdl is a URI of the running GEMSS Registry Service

uri2SERVICEwsdl is a URI of the running GEMSS Application Service, which will be published

someAttributeFile is an optional element. It is a properties file, which specifies the attributes of the service in a form of "name/value" pair, e.g:

serviceCategory=SPECT provider=ISS

In the main directory of the GEMSS Registry Service there is an example of such attribute file - example.attributes.

Removing: In order to remove a service you have to write the following command

java -jar tool/registry-tool.jar -d uri2REGISTRYwsdl -u uri2SERVICEwsdl

Listing: In order to print a list of all published services you have to write the following command

java -jar tool/registry-tool.jar -d uri2REGISTRYwsdl -l