Purpose

Resolves: https://github.com/wso2/product-micro-integrator/issues/4121

Fixes an issue in the Integration Control Plane (ICP) where connector dependency JARs (such as kafka-clients, avro, jedis, scala-library) were incorrectly displayed as connectors in the Carbon Applications detailed view.
This caused confusion for users trying to identify actual connectors versus their transitive dependencies.

Problem Statement

When the Management API returns Carbon Application artifacts, it includes all artifacts of type synapse/lib without distinguishing between:

• ✅ Actual connectors (e.g., mi-connector-kafka, mi-inbound-kafka)

• ❌ Dependency libraries (e.g., kafka-clients-3.7.0, avro-1.11.3, jedis-3.6.0)

This resulted in:

• Cluttered ICP Dashboard with unnecessary dependency JARs

• Confusion identifying actual connectors

• Poor user experience in managing Carbon Applications

• Difficulty troubleshooting connector issues

Solution

Implemented intelligent filtering logic in CarbonAppResource.java to distinguish actual connectors from dependency JARs.

Highlights

• Added new isActualConnector() method with pattern matching

• Filters out known dependency patterns (kafka-clients, avro, jedis, commons, netty, etc.)

• Retains actual connectors (mi-connector-*, mi-inbound-*, org.wso2.carbon.connector*)

• Handles edge cases with versioned or non-standard artifact names

• Logs filtered dependencies at DEBUG level for transparency

Changes Made

Modified File

components/org.wso2.micro.integrator.extensions/
└── org.wso2.micro.integrator.management.apis/
    └── src/main/java/org/wso2/micro/integrator/management/apis/CarbonAppResource.java

Key Updates

• Added isActualConnector(String artifactName) (lines 98–146)

  • Identifies actual connectors

  • Filters common dependency patterns

  • Handles version suffixes safely

• Enhanced convertCarbonAppToJsonObject() (lines 493–500)

  • Filters out dependencies from synapse/lib artifacts

  • Includes only actual connectors in JSON response

Code Snippet

// Filter out dependency JARs for synapse/lib type
if ("lib".equals(type) && !isActualConnector(artifactName)) {
    if (log.isDebugEnabled()) {
        log.debug("Filtering out dependency artifact: " + artifactName);
    }
    continue;
}

Testing Performed

Environment

• OS: Windows 11

• Java: Adoptium OpenJDK 11.0.28

• Product: WSO2 Micro Integrator 4.5.0-SNAPSHOT

• Tools: PowerShell (Invoke-RestMethod), Management API

Test Scenarios

✅ Kafka Connector CApp:
Only mi-connector-kafka appears; dependencies (kafka-clients, avro, etc.) excluded.
✅ MongoDB Connector CApp:
Only actual connector shown; jedis, mongo-java-driver filtered.
✅ File Connector CApp:
Only connector visible; commons-vfs removed.
✅ Multiple Connectors:
Confirmed multiple connectors display cleanly with no dependencies.

API Endpoints Tested

• GET /management/applications

• GET /management/applications?carbonAppName={name}

Before Fix

{
  "name": "BankIntegration",
  "artifacts": [
    {"name": "mi-connector-kafka", "type": "lib"},
    {"name": "kafka-clients-3.7.0", "type": "lib"},
    {"name": "avro-1.11.3", "type": "lib"},
    {"name": "jedis-3.6.0", "type": "lib"}
  ]
}

After Fix

{
  "name": "BankIntegration",
  "artifacts": [
    {"name": "mi-connector-kafka", "type": "lib"}
  ]
}

Filtered Dependency Patterns

Security Considerations

• ✅ Followed secure coding practices (OWASP)

• ✅ No exposure of sensitive data

• ✅ No changes to authentication or authorization layers

• ✅ No information disclosure risks

• ✅ Backward-compatible behavior maintained

Backward Compatibility

• ✅ No breaking changes to Management API contract

• ✅ Same JSON response structure maintained

• ✅ Only removes unnecessary dependency artifacts

• ✅ ICP Dashboard & automation scripts remain unaffected

Release Note

Fixed Management API Carbon Applications endpoint to filter out connector dependency libraries (kafka-clients, avro, etc.) from artifact listings.
Only actual connectors (mi-connector-*, mi-inbound-*) are now displayed, improving usability and reducing dashboard clutter.

Performance Impact

• ⚙️ Minimal overhead (simple in-memory string pattern checks)

• 🚫 No additional DB or network operations

• 🧠 Per-artifact filtering within existing JSON serialization step

Future Enhancements

• Externalize dependency patterns via configuration file

• Introduce explicit dependency=true/false metadata in artifact.xml

• Extend filtering to other artifact types if needed

Edge Cases Handled

• Artifacts with version suffixes (library-1.2.3)

• Non-standard naming conventions

• Mixed connector and non-connector libs in the same Carbon App

Checklist

• Code follows WSO2 conventions

• Self-reviewed

• Added JavaDoc for new methods

• Added debug logs for filtered artifacts

• Tested locally with multiple connector scenarios

• No compiler warnings introduced

• No deprecated APIs used

• Related issue linked in PR

Screenshots

Before Fix (ICP Dashboard)

Shows dependencies mixed with connectors:

mi-connector-redis
mi-connector-kafka
mi-inbound-kafka
kafka-clients-3.7.0
avro-1.11.3
jedis-3.6.0
scala-library-2.13.2
common-config-7.6.0

After Fix (ICP Dashboard)

Displays only actual connectors:

mi-connector-redis
mi-connector-kafka
mi-inbound-kafka