Table of Contents | ||
---|---|---|
|
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:
- at project definition time;
- 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.
Code Block <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.
and adding the following rows to maven-dependency-pluginCode Block <dependencies> ... <dependency> <groupId>org.connid.bundles</groupId> <artifactId>${connid.bundle.name}</artifactId> <scope>test</scope> </dependency> </dependencies>
Code Block <configuration> <artifactItems> <artifactItem> <groupId>org.connid.bundles</groupId> <artifactId>${connid.bundle.name}</artifactId> <version>${connid.bundle.version}</version> <outputDirectory>${bundles.directory}</outputDirectory> </artifactItem> </artifactItems> </configuration>
- modify console/pom.xml file by adding the following artifactItem element.
Code Block <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.
Code Block |
---|
mvn clean package -Dbundles.directory=/opt/syncope/bundles -Dlog.directory=/opt/syncope/log |
where bundles.directory
is the directory path where the bundle JAR files are located and log.directory
is the directory the log files will be created (paths must exist in advance).
Look for available ConnId bundles.
Add bundles at run-time
Connector bundles can be added at run-time just performing the following two steps.
- Download needed connector bundle JAR file.
- Copy downloaded JAR file into the connector bundles directory specified into the configuration parameter
bundles.directory
(stored into the local repository).