Create new connector


This document describes how to create a new ConnId connector.


The preferred way to create a ConnId connector project is to generate a Maven project starting from published archetype.

Hence you need:

  • Java SE Development Kit 6 (version 1.6.0-23 or higher) installed;
  • Apache Maven (version 3.0.3 or higher) installed;
  • Some basic knowledge about Maven;
  • Some basic knowledge about Maven archetypes.

Create new project

Maven archetypes are templates of projects. Maven can generate a new project from such a template.

In the folder in which the new project folder should be created, type the command shown below. On Windows, run the command on a single line and leave out the line continuation characters ('\').

mvn archetype:generate \
    -DarchetypeGroupId=net.tirasa.connid \
    -DarchetypeArtifactId=connector-archetype \
    -DarchetypeRepository= \

The archetype is configured with default values for all properties required by the archetype. If you want to customize any of these property values, type 'n' when prompted for confirmation.

You will be asked for:

  1. the groupId
    something like 'com.mycompany'
  2. the artifactId
    something like 'myproject'
  3. the version number
    You can use the default; it is good practice to have 'SNAPSHOT' in the version number during development and the maven release plugin makes use of that string. But ensure to comply to the desired numbering scheme for your project.
  4. the package name
    The java package name. A folder structure according to this name will be generated automatically; by default, equal to the groupId

Maven will create a project for you, in a newly created directory named after the value of the artifactId property you specified.

Stable releases

Take a look at available releases of the archetype project at central Maven repository, then change the archetypeVersion in the mvn command above accordingly.

Snapshot (development) releases

As development go on, snapshot releases are published at OSS Sonatype repository.

If you want to test a snapshot release, be sure to:

  1. use

    mvn org.apache.maven.plugins:maven-archetype-plugin:2.4:generate \
        -DarchetypeGroupId=net.tirasa.connid \
        -DarchetypeArtifactId=connector-archetype \
        -DarchetypeRepository= \
  2. add the following code right before </project> in root pom.xml of the generated project:


Build new project

Now build your project using the following command in the root folder of your project:

mvn clean package