DataPower Service Mapping Repository

Overview

The DataPowerMappingRepository is a data access component responsible for managing the persistence of service mappings discovered on DataPower gateway instances. It provides a durable storage layer for DataPowerServiceMapRecord objects, which represent the link between a public-facing service endpoint and its corresponding backend implementation.

This repository is used by internal administrative services to store, retrieve, and query the inventory of services proxied by DataPower. Its primary function is to translate service discovery data into a structured, queryable format in the platform's database.

All data access is strictly partitioned by tenant. Operations performed through this repository are automatically scoped to the caller's tenant, ensuring that one tenant cannot read, modify, or delete the mappings of another.

How it Works

The repository uses a JdbcTemplate to execute SQL statements against the s2r_datapower_service_map database table. It provides methods for atomic replacement of mappings, targeted deletions, and various query patterns.

Data Lifecycle

Create and Update

Mappings are managed using a "delete-then-insert" pattern for transactional consistency.

• replaceMappings: To update all mappings for a given DataPower instance, this method first deletes all existing records associated with that instanceId and then performs a batch insert of the new DataPowerServiceMapRecord objects.
• replaceMappingsForDomain: This method provides a more granular update, scoping the delete-and-insert operation to a specific domain within a DataPower instance.

The following diagram illustrates the sequence for replacing all mappings for an instance:

sequenceDiagram
    participant Caller
    participant Repo as DataPowerMappingRepository
    participant DB as Database

    Caller->>+Repo: replaceMappings(instanceId, mappings, actor)
    Repo->>DB: DELETE FROM s2r_datapower_service_map WHERE datapower_instance_id = ?
    DB-->>Repo: Acknowledge delete
    alt mappings is not empty
        Repo->>Repo: Prepare batch INSERT arguments
        Repo->>DB: batchUpdate(INSERT INTO s2r_datapower_service_map ...)
        DB-->>Repo: Acknowledge insert
    end
    Repo-->>-Caller: void

When inserting records, the tenant_id is automatically populated from the current session context, and the raw_summary map is serialized into a JSONB database column.

Delete

The repository supports several deletion patterns:

• By Instance: deleteByInstanceId removes all mappings for a specific DataPower instance.
• By Instance and Domain: replaceMappingsForDomain implicitly deletes by domain before inserting new records.
• By Exclusion: deleteByInstanceIdAndDomainNamesNotIn removes mappings for any domains within an instance that are not in a provided list of domain names to keep. This is useful for pruning stale domains after a discovery sync.

Data Retrieval

The repository provides several query methods to retrieve mappings:

• findByInstanceId: Fetches all raw DataPowerServiceMapRecord objects for a given instance.
• listForDisplay: Retrieves a formatted list of mappings for display, joining with the s2r_datapower_instance table to include the instance name. It can be filtered by a specific instance ID.
• findAllEnabledMappings: Returns all mappings from all DataPower instances that are marked as enabled.
• findEnabledMappingsByServiceUris: Finds all enabled mappings that match a given set of service URIs. This method includes special logic to handle WCF service URI conventions: for each URI provided, it also searches for a variant with or without a .svc suffix. For example, a query for /MyService will also match /MyService.svc, and vice-versa. All URI comparisons are case-insensitive.
• findDistinctMappingsForServiceUri: Groups mappings by a service URI to find all unique backend addresses associated with it.

Multi-Tenancy and Security

All SQL queries executed by this repository are augmented with a clause that filters by the current tenant ID. This is a fundamental security mechanism that enforces data isolation between tenants at the database level, preventing any cross-tenant data access.

flowchart TD
    subgraph "API Platform"
        A[API Caller] --> B{Admin Service};
        B --> C[DataPowerMappingRepository];
    end

    subgraph "Repository Logic"
        C -- "e.g., findByInstanceId(instanceId)" --> D{Build SQL Query};
        D -- "SELECT ... WHERE datapower_instance_id = ?" --> E[Append Tenant Scope];
        E -- "SELECT ... WHERE ... and tenant_id = '...'" --> F[Execute via JDBC];
    end

    subgraph "Database"
        F --> G[(s2r_datapower_service_map)];
        G -- "Returns only rows for current tenant" --> F;
    end

    F --> C;
    C -- "Returns tenant-scoped results" --> B;
    B --> A;

API Reference

The DataPowerMappingRepository exposes the following public methods for managing service mappings.

Data Model: DataPowerServiceMapRecord

The s2r_datapower_service_map table stores records with the following fields. These correspond to the properties of the DataPowerServiceMapRecord object.

Troubleshooting

Data Serialization Failures

When inserting or updating mappings, the raw_summary field (a Map) is serialized to a JSON string.

• Symptom: A call to replaceMappings or replaceMappingsForDomain fails with an IllegalArgumentException and the message "failed to serialize DataPower mapping".
• Cause: The raw_summary map contains an object that cannot be serialized to JSON by the underlying ObjectMapper.
• Resolution: Ensure that all values within the raw_summary map are JSON-serializable types.

Data Deserialization Failures

When retrieving mappings, the raw_summary JSON from the database is parsed back into a Map.

• Symptom: The rawSummary field of a returned DataPowerServiceMapRecord or map is empty ({}), even though the underlying database record contains data in the raw_summary column.
• Cause: The JSON string in the database is malformed or invalid. The repository's parseMap method catches the parsing exception and returns an empty map to prevent query failure.
• Resolution: Inspect the raw_summary column in the s2r_datapower_service_map table for the affected record to identify and correct the invalid JSON.

All SOAP-to-REST docs