GFAC

From Ogce

Contents

Download

Date Download Link
June 6th, 2008 GFac Release TG 08

Introduction

The Generic Service Toolkit (GST) (a.k.a Generic Factory a.k.a GFac) can "wrap" any command-line application as an application service. An application service is a web service interface to a command-line application. When an application service is invoked with a given set of input parameters, it runs the application with those input parameters (possibly on a cluster of resources), monitors the application and returns the results to the user. This toolkit can be used by application providers (a.k.a application service providers or service providers) to wrap any command-line application as an application service without writing any program code or modifying their applications in any way.

The GST is part of the Workflow Suite in OGCE. We describe below how to install the Workflow Suite in OGCE.

Installing the Workflow Suite in OGCE

The OGCE workflow suite consists of two web services viz. XRegistry and GFac and two portlets viz. GFac portlet and XBaya Workflow Composer portlet. The XBaya Workflow Composer Portlet is part of the OGCE portal distribution and so does not have to be installed separately. The following instructions are for installing and running the XRegistry, GFac portlet and the GFac service.

Pre-Requisites

Before you install any component in the OGCE Workflow Suite, make sure you install the following:

  1. MyProxy credentials generated and stored in a MyProxy server
  2. MySQL (version 5 or later). Make sure you create an empty database under your MySQL account, with the name xregistry_ogce and make sure MySQL server is running
  3. JDK 1.5 on every Service Host i.e every host (resource) on which you may run an application service
  4. The maven2 build system

Install and Run XRegistry

  1. Download XRegistry from the OGCE SVN
  2. Edit the pom.xml file and set databaseUrl, databaseUser, and databasePass properties
    NOTE: 3306 represents the default port that MySQL runs on, please check with your own installation.
  3. Run mvn -Dmaven.test.skip=true install, to build and install the system in target/dist-bin.
  4. cd target/dist-bin and then run the command ./xregistry.sh xregistry.properties
  5. To check if the service has started correctly, open the file xregistry.log in any editor, and make sure there aren't any errors in it. It should have a line that looks like the following "Server started on https://yourhost:6666"

Install GFac Portlet and Run GFac Service

  1. Install GFac Portlet

    1. GFac from the OGCE SVN
    2. Edit the pom.xml file to set the properties below. The pom.xml provides example values.
      • set portal.catalina.home to the tomcat installed by your OGCE portal installation
      • set xregistry.location to the URL of WSDL file of the XRegistry that you started above
      • set factory.location to the URL of WSDL of GFac
    3. Run mvn -Dmaven.test.skip=true install, to build and install the GFac portlet into your OGCE portal installation
    4. in target/dist.dir

  2. Run GFac Service

  3. After compiling GFac with mvn -Dmaven.test.skip=true install in the above step

    1. cd target/dist.dir
    2. Run the command ./factory.sh factory.properties to start the GFac service

Further Reading

  1. To Learn more about the format of GFac deployment descriptors and how to edit them, see Guide to GFac Deployment Descriptors
  2. To Invoke a Web Service from the command-line or a Java client, see Invoking a GFac Web Service.
  3. To start a stand-alone application service without using the GFac service, see Starting a Standalone Service
  4. To learn about the various options supported by GFac, see Reference Manual
  5. Schema files for Deployment Descriptors can be found here


Web site tools