Provided as a JAR file, a ConnId connector bundle implements a consistent generic layer between Syncope and external resources.

The specific connector bundle is always a pre-requisite to link a particular external resource.

There is a connector bundle for each linkable external resource type. Obviously, a single connector bundle can be used to link more than one resources of the same type.

Connector bundles can be added:

1. at project definition time;
2. at run-time.

Add bundles at project definition time

Connector bundles are added at project definition time by modifying the Maven project.

For each new connector bundle you have to perform the following steps.

• modify the global pom.xml file by adding the following properties and dependency.

  <properties>
     ...
     <connid.bundle.version> ... </connid.bundle.version>
     <connid.bundle.name> ... </connid.bundle.name>
  </properties>
  
  <dependencies>
     ...
     <dependency>
        <groupId>org.connid.bundles</groupId>
        <artifactId>${connid.bundle.name}</artifactId>
        <version>${connid.bundle.version}</version>
        <scope>test</scope>
     </dependency>
  </dependencies>
  

• modify core/pom.xml file by adding the following dependency element.

  <dependencies>
     ...
     <dependency>
        <groupId>org.connid.bundles</groupId>
        <artifactId>${connid.bundle.name}</artifactId>
        <scope>test</scope>
     </dependency>
  </dependencies>
  

  and adding the following rows to maven-dependency-plugin

  <configuration>
              <artifactItems>
                <artifactItem>
                  <groupId>org.connid.bundles</groupId>
                  <artifactId>org.connid.bundles.ad</artifactId>
                  <version>1.0.1</version>
                  <outputDirectory>${bundles.directory}</outputDirectory>
                </artifactItem>
              </artifactItems>
  </configuration>
  

• modify console/pom.xml file by adding the following artifactItem element.

  <artifactItems>
     ...
     <artifactItem>
        <groupId>org.connid.bundles</groupId>
        <artifactId>${connid.bundle.name}</artifactId>
        <version>${connid.bundle.version}</version>
        <outputDirectory>${bundles.directory}</outputDirectory>
     </artifactItem>
  </artifactItems>
  

At build time all added connector bundles will be downloaded and copied into the specified bundle directory.

mvn clean package -Dbundles.directory=/opt/syncope/bundles -Dlog.directory=/opt/syncope/log

where bundles.directory is the connector bundle directory where the bundle JAR files are located and log.directory is the directory where will be located the syncope, core and console, logs (directories must be created before).

Look for available ConnId bundles.

Add bundles at run-time

Connector bundles can be added at run-time just performing the following two steps.

1. Download needed connector bundle JAR file.
2. Copy downloaded JAR file into the connector bundles directory specified into the configuration parameter connid.bundles.directory (stored into the local repository).