IBM DataPower Service Discovery via REST Management Interface

Overview

The DataPower Management Discovery Service provides a mechanism to automatically discover and catalog services hosted on an IBM DataPower Gateway. It connects to the gateway's REST Management Interface to enumerate configured services, extracts their metadata, and persists this information into the platform's database.

This service solves the problem of keeping the platform's service registry synchronized with the configuration of a DataPower instance. It operates by polling the gateway, identifying all active services, and updating the central s2r_discovered_service table. Services that are added, updated, or removed on the gateway are reflected in the registry after the discovery process runs.

The service is invoked by calling the runDiscovery method with the target gateway instance's identifier. It reads connection credentials from the LbConnectorCredentialService, communicates with the DataPower API, and writes results to the database.

How it Works

The discovery process follows a precise sequence of steps to query the DataPower Gateway and synchronize its state with the platform's service registry.

sequenceDiagram
    participant System as API Publisher
    participant DiscoveryService as DataPowerMgmtDiscoveryService
    participant CredentialStore as Credential Store
    participant DataPower as DataPower Gateway
    participant Database

    System->>DiscoveryService: runDiscovery(gatewayType, instanceName)
    DiscoveryService->>CredentialStore: Load credentials for instance
    CredentialStore-->>DiscoveryService: Return host, port, credentials
    DiscoveryService->>DataPower: GET /mgmt/domains/config/ (List domains)
    DataPower-->>DiscoveryService: List of domain names
    loop For each domain
        DiscoveryService->>DataPower: GET /mgmt/config/{domain}/{ServiceClass}
        DataPower-->>DiscoveryService: List of services for that class
    end
    DiscoveryService->>DiscoveryService: Process all discovered services
    Note right of DiscoveryService: - Generate vendor_service_id<br/>- Resolve frontend/backend endpoints<br/>- Prepare raw_metadata
    DiscoveryService->>Database: UPSERT discovered services into s2r_discovered_service
    DiscoveryService->>Database: Mark services not seen in this run as inactive
    Database-->>DiscoveryService: Confirm persistence
    DiscoveryService-->>System: Return DiscoveryResult (counts, errors)

The workflow consists of the following steps:

1. Load Credentials: The service retrieves the decrypted credentials (host, port, username, password) for the specified gateway instance from the s2r_lb_connector_credentials table.
2. List Domains: It connects to the DataPower REST Management Interface and issues a GET /mgmt/domains/config/ request to retrieve a list of all configured application domains.
3. Enumerate Services: For each domain, the service iterates through a predefined list of five service classes and queries the corresponding endpoint (GET /mgmt/config/{domain}/{ClassName}) to get a list of all configured services of that type. The service classes are:
   • MultiProtocolGateway
   • WSGateway
   • XMLFirewallService
   • HTTPService
   • WebAppFW
4. Extract Metadata: For each service discovered, the service attempts to extract key metadata:
   • Vendor Service ID: A unique identifier is constructed with the format "domain:className:serviceName".
   • Frontend Endpoint: The frontend host and port are resolved from the LocalAddress and LocalPort fields of the service configuration, if present. The protocol (http or https a) is inferred based on the service class.
   • Backend Endpoint: The backend URI is resolved on a best-effort basis depending on the service class:
     • MultiProtocolGateway: From the BackendURL field.
     • WSGateway: From the Re<customer>eEndpoint field.
     • Other classes: No backend URI is resolved from a specific field; the full configuration is available in the raw metadata.
   • Raw Metadata: The complete JSON configuration object returned by the DataPower API is saved for auditing and troubleshooting.
5. Persist Data: The service opens a database transaction to update the s2r_discovered_service table:
   • It performs an "upsert" operation for each discovered service, matching on gateway_type, instance_name, and vendor_service_id. New services are inserted, and existing services are updated with the latest metadata and last_seen_at timestamp.
   • Any services for the target instance that were previously marked as active but were not found during the current discovery run are marked as inactive (is_active = false).
6. Return Result: The service returns a DiscoveryResult object containing statistics on the number of services discovered, added, updated, and marked inactive, along with a list of any errors encountered.

Configuration and Prerequisites

Before running discovery, you must configure the connection details for the target IBM DataPower Gateway instance. The service relies on the LbConnectorCredentialService to provide these details.

The following connection parameters are required:

API Reference

The service exposes a single public method to initiate the discovery process.

runDiscovery

Triggers a full discovery pass for a given DataPower gateway instance.

DiscoveryResult runDiscovery(String gatewayType, String instanceName)

Parameters

Returns

A DiscoveryResult object summarizing the outcome of the discovery run.

Throws

• LbConnectorCredentialService.NotFoundException: Thrown if credentials for the specified gatewayType and instanceName are not registered in the system.

Persisted Data Model

The discovery service writes its findings to the s2r_discovered_service table. The following fields are populated specifically by this service.

| Field | Data Type | Description -| --- | --- | |vendor_service_id| String | The unique identifier for the service within the DataPower instance. Format:"domain:className:serviceName". Example: default:MultiProtocolGateway:MyService. - | backend_pool_name | String | A logical grouping for the backend, constructed as "domain:className". -|frontend_protocol| String | The inferred frontend protocol. The inference logic is:WSGateway, XMLFirewallService, and WebAppFWdefault tohttps; all others default to http. - | backend_members | JSONB | A JSON array containing the resolved backend URI. For DataPower, this will be an array with a single object [{"uri": "..."}] if a backend was resolved, or an empty array [] if not. -|raw_metadata| JSONB | The full, unmodified JSON configuration object for the service as returned by the DataPower REST Management Interface. The internalclassName field added by the client is removed before persistence. - | is_active | Boolean | Set to true if the service was found in the latest discovery run, or false if it was not. -`

Troubleshooting

The service logs errors with specific codes to aid in diagnostics.

See Also

• Citrix Service Discovery: This service follows a similar discovery pattern to the CitrixDiscoveryService.
• Credential Management: For details on how to configure connection credentials, see the documentation for the LbConnectorCredentialService.

All SOAP-to-REST docs