Purpose

This use-case describes the means to test the availability and authenticity of a deployed web service.

The test should be generally accessible (local or Internet), provide a result with or without authentication as well as with or without an existing authorization. Also, the test should be available on all listeners, in all protocols/dialects, and with all transport security options.

The test should not be rely on any particular eventing model. The test should not dilute metrics. The requested operation should always respond, with exception for avoiding denial of service.

Actors

System Administrators

Applications

Student Information System

High-level Story (Abstract)

A college or university deploys a web service such as the Academic History Web Service and wants to proactively detect problems by testing the service.

Detailed Story

After deploying and testing the web service, the appropriate administrator of an organization's monitoring tools configures that tool to invoke a Status request on the service at a desired interval.

If the invocation fails, that failure is reported by the monitoring tool.

A successful invocation includes the status (success or failure) of invocation attributes including authentication and authorization (if specific metrics were requested) as well as dynamic/negotiated details (e.g. transport security attributes).

The metrics are compared with threshold values set in the monitoring tool, and the appropriate administrators are alerted if thresholds are exceeded.

  1. The service is deployed with a SOAP endpoint using SSL.
  2. The monitor is configured to invoke the 'Status' operation, with an authentication token for 'operator'.
  3. The service is responding, so the Status invocation succeeds. The reply include various name-value pairs.

Status

result

success

authn

operator

cipher

AES256-SHA

Metrics

uptime-seconds

5520

ops-per-hour

5.22

op.readPerson.success

7

op.readPerson.avg-response-time

8.03

op.readPerson.failed

2

To Do

Rewrite the detailed story with specifics, when available.