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.
Here is the complete list of available ConnId bundles; if needed, new connector bundles can also be developed on-purpose.
Connector bundles can be added:
- only when creating new project from archetype, in project sources;
- for all deployment options, at run-time.
Add connector bundles in project sources
Set different version for predefined bundles
Add non-predefined connector bundles
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 root
pom.xml
file by adding the following properties:<properties> ... <connid.bundle.version> ... </connid.bundle.version> <connid.bundle.name> ... </connid.bundle.name> </properties>
modify
core/pom.xml
to ensure thatmaven-dependency-plugin
contains the followingartifactItem
(if necessary add the wholeconfiguration
):<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
to ensure thatmaven-dependency-plugin
contains the followingartifactItem
(if necessary add the wholeconfiguration
):<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 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).
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 by the configuration parameter
bundles.directory
.
Since Version 1.1.3 you need to update the connid properties in the classes folder of your deployment.
For example:
connid.locations=file:/D:/Syncope/connid_bundles/