Skip to content

mizcausevic-dev/ibm-custom-connector-starter

Repository files navigation

ibm-custom-connector-starter

Java starter template for IBM App Connect custom connectors with descriptor, factory, packaging, and readiness guidance.

Why this repo exists

Most connector examples show the happy path of compiling a bundle, but they do not make the descriptor, registration hook, and packaging trail easy to review. This repo treats IBM App Connect connector work like a handoff surface: operation contracts, descriptor fields, starter assets, and packaging checkpoints are all exposed in one reviewable starter.

What it proves

  • IBM-flavored starter UX for connector anatomy, descriptor review, packaging flow, and verification posture
  • Java + Spring Boot reference surface for starter metadata and JSON APIs
  • Copyable starter assets for descriptor JSON, Java factory code, operation handler, service registration, and assembly descriptor
  • Review-first packaging guidance instead of opaque archive-only output

Screenshots

Overview proof Connector anatomy proof Descriptor proof Verification proof

Routes

HTML

  • /
  • /connector-anatomy
  • /descriptor
  • /packaging
  • /verification
  • /docs

JSON

  • /api/dashboard/summary
  • /api/connector
  • /api/operations
  • /api/descriptor
  • /api/packaging
  • /api/review
  • /api/assets
  • /api/sample
  • /api/health

Starter asset layout

starter/
  connector-template/
    assembly/assembly-descriptor.xml
    descriptor/connector-descriptor.json
    java/src/main/java/com/example/appconnect/connector/AccountLookupConnectorFactory.java
    java/src/main/java/com/example/appconnect/connector/LookupAccountOperation.java
    java/src/main/resources/META-INF/services/com.ibm.appconnect.sdk.spi.ConnectorProvider

Run locally

$env:JAVA_HOME = "C:\Program Files\Microsoft\jdk-21.0.11.10-hotspot"
$env:Path = "$env:JAVA_HOME\bin;$env:Path"
.\mvnw.cmd spring-boot:run

Open http://127.0.0.1:5096/.

Validate

$env:JAVA_HOME = "C:\Program Files\Microsoft\jdk-21.0.11.10-hotspot"
$env:Path = "$env:JAVA_HOME\bin;$env:Path"
.\mvnw.cmd test
.\mvnw.cmd package
powershell -ExecutionPolicy Bypass -File .\scripts\smoke_check.ps1
powershell -ExecutionPolicy Bypass -File .\scripts\render_readme_assets.ps1

Docs

About

Java starter template for IBM App Connect custom connectors with descriptor, factory, packaging, and readiness guidance.

Topics

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

No releases published

Packages

 
 
 

Contributors