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:
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=http://repo1.maven.org/maven2 \ -DarchetypeVersion=1.4.3.0 |
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:
Maven will create a project for you, in a newly created directory named after the value of the artifactId
property you specified.
Take a look at available releases of the archetype project at central Maven repository, then change the archetypeVersion
in the mvn
command above accordingly.
As development go on, snapshot releases are published at OSS Sonatype repository.
If you want to test a snapshot release, be sure to:
use
mvn org.apache.maven.plugins:maven-archetype-plugin:2.4:generate \ -DarchetypeGroupId=net.tirasa.connid \ -DarchetypeArtifactId=connector-archetype \ -DarchetypeRepository=https://oss.sonatype.org/content/repositories/snapshots \ -DarchetypeVersion=1.4.3.0-SNAPSHOT |
add the following code right before </project>
in root pom.xml
of the generated project:
<repositories> <repository> <id>sonatype</id> <url>https://oss.sonatype.org/content/repositories/snapshots/</url> <snapshots> <enabled>true</enabled> </snapshots> </repository> </repositories> |
Now build your project using the following command in the root folder of your project:
mvn clean package |