You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 12 Next »

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 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 that maven-dependency-plugin contains the following artifactItem (if necessary add the whole configuration):

    <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 that maven-dependency-plugin contains the following artifactItem (if necessary add the whole configuration):

    <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).

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 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:

webapps/syncope/WEB-INF/classes/connid.properties
connid.locations=file:/D:/Syncope/connid_bundles/
  • No labels