Waiting for engine...
Skip to main content

Connector SDK artifacts

The Connector SDK artifacts available from the public Maven or Gradle repositories contain everything you need to extend the Boomi Enterprise Platform with a connector and integrate with any application.

It is recommended you review the artifact contents and are familiar with them before building a connector.

SDK and artifact versioning​

The Connector SDK is available in all editions including the Trial edition.

Boomi recommends you build a connector with the latest Connector SDK version, but you are not required to update connectors when the SDK is updated. The API is backwards compatible with all Connector SDK releases with the same major API version. For example, a connector built against any 1.x.x API release works with any newer 1.x.x API release. Review the Connector SDK changelog for information on the latest features and enhancements.

note

Artifact versions are not always updated with each version of the Connector SDK.

Accessing the SDK artifacts​

If you're using Gradle or Maven as your build tools, you should have access to the artifacts as defined in the build scripts. If your project was built with any other build tool, you must point your build tool to Boomi’s public Maven repository to access the artifacts.

note

Boomi recommends using Gradle or Apache Maven to manage your connector projects and has included steps to do so.

Gradle provides an init task that can be used to generate the structure for a Java project and additional configuration files need to be added manually. You may also init a basic project and structure it as you wish, but the following instructions are for initializing a java-library project.

To reference Connector SDK Artifacts in a Gradle project, add this code to your build.gradle file:

repositories {
            maven {
                name = "Connector SDK Repository"
                url = "https://boomisdk.s3.amazonaws.com/releases"
            }
}

Artifact contents​

Each of the connector-sdk-<version>.jar artifacts have javadoc and source files associated with them in each SDK version. For example, the connector-sdk-samples-2.28.3.jar has a connector-sdk-samples-2.28.3-javadoc.jar and connector-sdk-samples-2.28.3-sources.jar. These are the Connector SDK artifacts you use in your local project and in building a connector.

Connector public Project Object Models (POM)​

Three Maven POM files (connector-common-public, connector-parent-public, connector-assembly-public) are available in the repository providing dependencies, Maven plugins, and assembly files. These files are useful when building a connector using Maven. Set the connector's parent as follows to utilize these POMs:


<parent>
    <groupId>com.boomi.connector</groupId>
    <artifactId>connector-common-public</artifactId>
    <version>${connector-public-version}</version>
</parent>

note

Replace ${connector-public-version} with the available version of the project.

File Name

Apache Axis Nspatch

This JAR file is made available and required to work in conjunction with common webservices and the connector-sdk-ws artifact.

  • groupId: org.apache.axis

  • artifactId: axis-nspatch

  • Version: 1.4

boomi-json-util

The JAR file containing common JSON util libraries that the SDK uses to help handle common use cases and connector functionality.

  • groupId: com.boomi.util

  • artifactId: boomi-json-util

  • Versions:

    • 1.1.9
    • 1.1.10
    • 1.1.11
    • 1.2.1
    • 1.2.2
    • 1.2.3
    • 1.2.4

  • Classifiers: javadoc

boomi-restlet-util

The JAR file containing common restlet util libraries that the SDK uses to help handle common use cases and connector functionality.

  • groupId: com.boomi.restlet.util

  • artifactId: boomi-restlet-util

  • Version: 2.1.16

  • Classifiers: javadoc

boomi-util

The JAR file containing common util libraries used by the SDK to help handle common use cases and connector functionality.

  • groupId: com.boomi.util

  • artifactId: boomi-util

  • Versions:

    • 2.3.8
    • 2.3.12
    • 3.0.14

Boomi XJC Plug-in The POM file (.pom file extension) of the xjc Plug-in that can be used when building a connector. Provides custom helper methods to the generated JAXB classes.

  • groupId: com.boomi.xjc-plugin

  • artifactId: boomi-xjc-plugin-public

  • Version: 1.1.9

common-apache-http

The JAR file containing common apache client logic that the Connector SDK uses to help handle RESTful requests and responses.

  • groupId: com.boomi.common

  • artifactId: common-apache-http

  • Versions:

    • Version: 0.11
    • Version: 0.13

  • Classifiers: javadoc

common-aws

The JAR file containing common-aws libraries that the SDK uses to help handle common use cases and connector functionality.

  • groupId: com.boomi.common

  • artifactId: common-aws

  • Versions: 1.2.5

  • Classifiers: javadoc

common-lite

The JAR file containing common-lite to help handle common use cases and connector functionality.

  • groupId: com.boomi.util

  • artifactId: common-lite

  • Version: 1.1.0

  • Classifiers: javadoc

common-sdk

The JAR file containing common SDK libraries to help handle common use cases and connector functionality.

  • groupId: com.boomi.commonsdk

  • artifactId: common-sdk

  • Versions:

    • 1.1.9
    • 1.1.11 In Version 1.1.11, the PayloadMetadata interface in the Common SDK model is updated with two new methods the developer can use to set document-level Tracked Group Properties. After being set, process builders can retrieve document property group values by key. You can view sources online in the Javadocs.

  • Classifiers: javadoc

Common Webservices

Dependency containing common webservices libraries. These libraries can be used to facilitate the creation of a web services based connector with the connector-sdk-ws artifacts.

  • groupId: com.boomi.redsky.common.webservices

  • artifactId: common-webservices

  • Version: 4.3.1

  • Classifiers: javadoc, sources

Common Webservices Model

Dependency containing common webservices model classes. This library can be used to facilitate the creation of a web services-based connector with the connector-sdk-ws artifacts.

  • groupId: com.boomi.redsky.common.webservices

  • artifactId: common-webservices-model

  • Version: 4.3.1

  • Classifiers: javadoc, sources

Connector Assembly Public

The POM file (.pom file extension) containing the connector-assembly-public JAR file providing the assembly files (assembly.xml and descriptor.xml) helping with the creation of the -car.zip file.

  • groupId: com.boomi.connector

  • artifactId: connector-assembly-public

  • Version: 1.0

Connector Common Public

The POM file (.pom file extension) containing public dependencies used to assist when performing a Maven build for a connector built using the Connector Software Development Kit (SDK).

  • groupId: com.boomi.connector

  • artifactId: connector-common-public

  • Version: 1.0

Connector Parent Public

The POM file (.pom file extension) containing the Maven plugins used to perform a Maven build.

  • groupId: com.boomi.connector

  • artifactId: connector-parent-public

  • Version: 1.0

Connector SDK Archetype

The JAR file containing the Maven Archetype Plug-in used for creating a Maven connector project.

  • groupId: com.boomi.connsdk

  • artifactId: connector-sdk-archetype

  • Version: 2.4.1

connector-sdk-api

The main connector SDK JAR file, which contains all of the Java interfaces.

  • groupId: com.boomi.connsdk

  • artifactId: connector-sdk-api

  • Version: 2.28.3

  • Classifiers: javadoc, sources

connector-sdk-model

A JAR file containing schemas that used to live in the Connector SDK distribution.

  • groupId: com.boomi.connsdk

  • artifactId: connector-sdk-model

  • Version: 2.28.3

  • Classifiers: javadoc, sources

Here are the connector-sdk-model schemas contained within the JAR:

  • genericconfig.xsd - A portion of the XML schema describing the connector descriptor XML structure.

  • genericconnector.xsd - The XML schema describing the connector config XML structure.

  • genericconnectordesc.xsd - The XML schema describing the connector descriptor XML structure.

  • genericdeleteprofile.xsd - The XML schema for passing XML into a Delete operation.

  • genericgetprofile.xsd - The XML schema for passing XML into a Get operation.

  • oauthtypes.xsd - The XML schema describing the XML structure of supported OAuth 2 Authorization Grant Types.

connector-sdk-openapi

A utility JAR file containing OpenAPI specification operations that can be extended to build a connector. You can view sources online in the SDK Javadocs.

  • groupId: com.boomi.connsdk

  • artifactId: connector-sdk-openapi

  • Version: 0.1

  • Classifiers: javadoc, sources

connector-sdk-rest

A utility JAR file to execute REST requests that can be extended to build a connector. You can view sources online in the SDK Javadocs.

  • groupId: com.boomi.connsdk

  • artifactId: connector-sdk-rest

  • Version: 0.1

  • Classifiers: javadoc, sources

connector-sdk-rest-<version>.descriptor

REST Client connector descriptor file, describing the capabilities of the connector built using the Connector SDK.

  • groupId: com.boomi.connsdk

  • artifactId: connector-sdk-rest-<version\>-descriptor

  • Version: 0.1

  • Classifiers: javadoc,sources

connector-sdk-samples

A JAR file containing samples of connector code for referential use.

  • groupId: com.boomi.connsdk

  • artifactId: connector-sdk-samples

  • Version: 2.28.3

  • Classifiers: javadoc, sources

connector-sdk-test-util

A test utility JAR file containing a test harness that you can use for testing connectors.

  • groupId: com.boomi.connsdk

  • artifactId: connector-sdk-test-util

  • Version: 2.28.3

  • Classifiers: javadoc, sources

connector-sdk-util

A utility JAR file containing base objects that can be extended to build a connector. You can view sources online in the SDK Javadocs.

  • groupId: com.boomi.connsdk

  • artifactId: connector-sdk-util

  • Version: 2.28.3

  • Classifiers: javadoc, sources

connector-sdk-ws

A JAR file containing the webservices utilities.

  • groupId: com.boomi.connsdk

  • artifactId: connector-sdk-ws

  • Version: 2.28.3

  • Classifiers: javadoc, sources

wsdl4j-boomi

The patched version of wdsl4j.jar, providing security features for parsing.

  • groupId: wsdl4j-boomi

  • artifactId: wsdl4j

  • Version: 1.6.4

On this Page