GT 3.9.4 WS MDS Trigger Service: Developer's Guide

Introduction

[introduction to developers with reference to General Toolkit Developer's Guide for coding guidelines, porting guide, etc.]

Architecture and design overview

[link to architecture and design docs]

Public interface

The semantics and syntax of the APIs and WSDL for the component, along with descriptions of domain-specific structured interface data, can be found in the public interface guide.

A trigger service is an aggregating service group. Documentation on wire-side APIs (for example, service registration) can be found in the aggregator documentation.

Trigger Action Script API

Trigger action scripts take the form of native OS executables, and so can be written in any language that can generate such (for example, bash, PERL, C).

Information on the match that caused an action to fire is fed into the action script through stdin. Status information from the action script should be sent to stdout, and will reported in the content of the ServiceGroupEntry for the rule.

Format of action script stdin

An XML document of the following format will be piped to the stdin of the action script: 

  <fire>
    <message>
 The message which caused the rule to file.
    </message>

    <MemberEPR>
 The EPR of the service registered for the firing rule.
    </MemberEPR>

    <AggregatorConfig>
 The aggregator configuration element for this rule.
    </AggregatorConfig>
  </fire>

The presence of the aggregator configuration element allows for additional parameters to be passed to the action script in registrations.

Format of action script stdout

The action script should output an XML document to stdout. The xml document does not need to match any particular schema. This output will be included in the ServiceGroupEntry for the rule.

Usage scenarios

[describe how to use the programatic interfaces of the component, provide examples]

Tutorials

[add links to any tutorials - if no tutorials, say "There are no tutorials available at this time"]

Feature summary

Features new in release 3.9.4

  • Not applicable

Other Supported Features

  • Monitors resource properties for matching trigger conditions
  • When a trigger condition matches, fires a customisable action: for example, sends email to an administrator.
  • Monitored services are managed through service group-based registration API, allowing use of many of the same clients that can be used in the index service.

Deprecated Features

  • Not applicable

Tested platforms

Tested Platforms for [component name]

  • platform #1
  • ...
  • platform #n

Backward compatibility summary

The Trigger Service is a new component for GT 3.9.4 and so has no compatibility statement.

Technology dependencies

The Trigger Service depends on the following GT components:

  • WSRF Core

The Trigger Service depends on the following 3rd party software:

  • None

Security considerations

[describe security considerations relevant for this component]

Troubleshooting

[help for common problems developers may experience]

Related Documentation

[could link to pdfs and whitepapers about protocols, etc re: the component]