Summary

Before developing a connector, ensure the following components are available.

  1. Prerequisites

    1. JDK 21

    2. Maven

    3. oe_csp_sdk_core built and installed, or available in your Maven repository (provides csp-sdk-core)

  2. Connector Implementation

    1. Each connector module implements:

      1. AppsConnector

      2. MetadataService

      3. QueryService

    2. The connector must also include SPI registration.

    3. Optional quick app for standalone connector testing

  3. Build Process

    1. Build connectors using: mvn clean install

    2. Use the build script (./build-csp-sdk.sh) to generate the assembly JAR.

  4. Testing

    1. Connectors can be tested using:

      1. csp-api unified testing API

      2. standalone connector quick application

  5. Adding a New Connector

    1. Create a new module

    2. Implement the required connector contracts

    3. Add the SPI registration file

    4. Add the module and dependencies to:

      1. Parent POM

      2. csp-api

      3. Assembly module

    5. Build and test


Copyright © 2026, OvalEdge LLC, Peachtree Corners, GA, USA.

Last updated

Was this helpful?