WS Information Services: System Administrator's Guide

Overview
Configuring the Index Service
Registering a Resource Service to and Index Service
Using Service Data Providers
Testing Service Data Aggregation
Index Service Configuration File
>Server Configuration File

Configuring server-config.wsdd for the Index Service

In relation to your WS installation and configuration, each persistent Index Service instance you create requires the following:

• One service descriptor entry in the server configuration file, server-config.wsdd.

• One Index Service configuration file, index-service-config.xml.

This page describes how to configure server-config.wsdd for the Index Service.

The server-config.wsdd file is also included in the GT3.2 installation and resides by default in <gt3-install-location>.  This file contains all of the deployment descriptors for every service in the hosting environment.  By default, there is a single descriptor for the Index Service.  If you want additional persistent Index Service instances, you just add more descriptors, but with different service names.

This page contains the following topics:

• Default Content
• General Parameters
• serviceConfig
• Xindice

Server Configuration File: Default Content

The default Index Service deployment descriptor in server-config.wsdd appears as follows:

<service name="base/index/IndexService" provider="Handler" style="wrapped">
 <parameter name="name" value="Index Service"/>
 <parameter name="schemaPath" value="schema/base/index/index_service.wsdl"/>
 <parameter name="className" value="org.globus.ogsa.base.index.IndexService"/>
 <parameter name="baseClassName" value="org.globus.ogsa.impl.base.index.IndexServiceImpl"/>
 <parameter name="instance-schemaPath" value="schema/ogsi/ogsi_service_group_entry_service.wsdl"/>
 <parameter name="instance-baseClassName" value="org.globus.ogsa.impl.ogsi.ServiceGroupEntryImpl"/>
 <parameter name="factoryCallback" value="org.globus.ogsa.impl.ogsi.DynamicFactoryCallbackImpl"/>
 <parameter name="operationProviders" value="org.globus.ogsa.impl.ogsi.NotificationSourceProvider org.globus.ogsa.impl.ogsi.ServiceGroupProvider org.globus.ogsa.impl.base.index.IndexingServiceGroupRegistrationProvider org.globus.ogsa.impl.base.providers.servicedata.ServiceDataProviderManager"/>
 <parameter name="handlerClass" value="org.globus.ogsa.handlers.RPCURIProvider"/>
 <parameter name="persistent" value="true"/>
 <parameter name="allowedMethods" value="*"/>
 <parameter name="promiscuousCache" value="true"/>
 <parameter name="sweepServiceData" value="false"/>
 <parameter name="entryInstanceCreation" value="true"/>
 <parameter name="disableFactoryRegistry" value="true"/>
 <parameter name="serviceConfig" value="etc/index-service-config.xml"/>
 <parameter name="aggregateServiceGroupEntryContent" value="true"/>
 <parameter name="aggregateServiceData" value="true"/>
 <parameter name="messageGateway" value="false"/>
 <parameter name="minNotificationInterval" value="5"/>
 <parameter name="xindiceEnabled" value="false"/>
 <parameter name="xindiceURI" value="xindice-embed:///db"/>
</service>

The parameter names above are described in more detail in the User's Guide Core Framework and the Java Programmer's Guide Core Framework.  The parameters of particular interest for the Index Service are as follows:

Server Configuration File: General Parameters

<parameter name="aggregateServiceGroupEntryContent" value="true"/>

This parameter enables storing aggregated Service Data as ServiceGroupEntryContent.

<parameter name="aggregateServiceData" value="true"/>

This parameter enables storing aggregated Service Data as an array of Service Data values inside a named Service Data Element.

<parameter name="promiscuousCache" value="true"/>

This parameter indicates that the aggregator component should cache messages even if it cannot locate a subscription for the service data contained in a received message.

<parameter name="messageGateway" value="false"/>

This parameter enables the relay of incoming messages to any listening subscribers of the SDE named "MessageGateway". This can be used to remotely monitor the messages received by the Index service.

<parameter name="minNotificationInterval" value="5"/>

This parameter limits outbound message traffic by the specified number of seconds.  For any given subscription, messages will be sent no faster than the interval specified.  Subscribing services may override this setting on a per-subscription basis by specifying a minInterval in the subscription request.  This parameter may also be removed from server-config.wsdd if message delivery rate limiting is not desired.

Server Configuration File: serviceConfig

The serviceConfig section in the default server-config.wsdd file appears as follows:

<parameter name="serviceConfig" value="etc/index-service-config.xml"/>

This parameter is the path to the Index Service configuration file.  It is a required parameter.  Although the default index-service-config.xml file is provided in the GT3.2 installation, this file can be copied and modified, and then this descriptor entry can be updated to reflect the location and name of the new configuration file to use.

Server Configuration File: Xindice

<parameter name="xindiceEnabled" value="false"/>
<parameter name="xindiceURI" value="xindice-embed:///db"/>

These optional parameters indicate, respectively, whether or not the Xindice XML database package should be used to persist service data, and if Xindice is to be used, the URI of the Xindice database root. This option is disabled by default (see above). 

Enabling Xindice

The GT3.2 version of the Index Service does support transparent service data persistence through the use of the Apache Xindice XML-native database platform.  To enable Xindice, the xindiceEnabled parameter in this descriptor should be set to true:

<parameter name="xindiceEnabled" value="true"/>