Data Services 1.4 Administrators Guide

Prerequisites

The caGrid Data Services infrastructure does not require any software or special system configuration beyond the standard caGrid stack. Specific query processor implementations may have additional requirements.

Obtaining the Service Infrastructure

Information on obtaining the caGrid Data Services infrastructure may be found on the Downloads Page

Configuration

The data services infrastructure itself does not require any specific configuration, however caGrid services generated using the data service infrastructure will have some common features which are configurable.

For example, any Introduce-generated caGrid service will have a service.properties file, which controls several runtime parameters of the grid services. Data services add some specific properties to this file which control the way the data service infrastructure behaves:

• dataService_domainModelValidatorClass
  • The class name of the validator implementation which can be used by the data service to validate incoming CQL queries for correctness against the service's exposed data model.
• dataService_validateDomainModelFlag
  • A flag which indicates to the data service framework whether or not to validate incoming CQL and CQL 2 queries for correctness against the service's exposed data model.
• dataService_classMappingsFilename
  • An XML document containing mappings from Java class name to XML Qname. This file is automatically generated and the value automatically set by the data service code-generation utilities, and shouldn't have to be adjusted.
• dataService_cqlValidatorClass
  • The class name of the validator implementation which can be used by the data service to validate incoming CQL queries for syntactic correctness.
• dataService_cql2ValidatorClasses
  • A comma separated list of class names which implement gov.nih.nci.cagrid.data.cql2.validation.walker.BaseCustomCql2WalkerHandler to validate CQL 2 queries coming in to the data service's query operations.
• dataService_validateCqlFlag
  • A flag which indicates to the data service framework whether or not to validate incoming CQL and CQL 2 queries for syntactic correctness.
• queryProcessorClass
  • The class name of the CQL Query Processor implementation to be used for handling CQL queries submitted to this data service.
• cql2QueryProcessorClass
  • The class name of the CQL 2 Query Processor implementation to be used for handling CQL 2 queries submitted to this data service.

Installation

The caGrid Data Services infrastructure is not a stand-alone service so much as a set of tools and interfaces which work together to build a consistent type of grid service. It can be installed into the Introduce toolkit as an extension by executing the command "ant installIntroduceExtensions" from either the top level of a source distribution, or from the dataExtensions project, found in projects/dataExtensions under the top level of a source distribution.

If a data service which makes use of caGrid Transfer is to be deployed, the Transfer service must be deployed to the container first to function correctly.

Validation

The data service framework can be verified to be installed correctly by building, deploying, and executing a caGrid data service. See the Developer's Guide.