Configuring your REST Connector Project

The starting point for building any custom Connector, not just a REST based connector, is your build tool. Boomi recommends you to use Gradle to build your connector. With Gradle and our Connector plugin, configuring your connector project is extremely simple.

Here is a minimal build.gradle file:

plugins {
    // The Connector plugin.
    // Get the latest plugin version from https://plugins.gradle.org/plugin/com.boomi.connector
    id "com.boomi.connector" version "0.4.3"
}

version="0.0.1-SNAPSHOT"
group = "com.boomi.connector"
description = "Sample Rest Connector"

java.sourceCompatibility = 1.8
java.targetCompatibility = 1.8

connector {
    // version of the Connector SDK. Get the latest version from the Connector SDK Changelog
    sdkVersion "2.28.3"
    // fully qualified name of your Connector class
    className "com.boomi.connector.samplerest.SampleRestConnector"
}

repositories {
    // Use Maven Central for resolving dependencies.
    mavenCentral()
}

dependencies {
    // Boomi Rest Connector library
    api "com.boomi.connsdk:connector-sdk-rest"
}

Recommended Gradle project structure for a Connector:

├── build.gradle
├── gradle
│   └── wrapper
│       ├── gradle-wrapper.jar
│       └── gradle-wrapper.properties
├── gradle.properties
├── gradlew
├── gradlew.bat
├── settings.gradle
└── src
├── main
│   ├── java
│   │   └── com
│   │       └── boomi
│   │           └── connector
│   │               └── samplerest
│   │                   ├── SampleRestBrowser.java
│   │                   ├── SampleRestClient.java
│   │                   ├── SampleRestConnector.java
│   │                   └── SampleRestOperationConnection.java
│   └── resources
│       └── META-INF
│           └── connector-descriptor.xml
└── test
    ├── java
    │   └── com
    │       └── boomi
    │           └── connector
    │               └── samplerest
    │                   ├── SampleRestBrowserTest.java
    │                   ├── SampleRestClientTest.java
    │                   ├── SampleRestConnectorTest.java
    │                   └── SampleRestOperationConnectionTest.java
    └── resources