Optional Components

As additional features are developed and released our public facing repository is updated; so you can always browse the repository directly to keep up to date.

Component List

How to install

For optional components that come with the installer; all you need to do is to copy the contents of optional/[required-component] into ${adapter.home}/lib and restart your adapter. This will automatically enable those components for runtime and use within the UI. There are some components that will require additional jars (e.g. SAP, WebsphereMQ, Tibco, Oracle) which you will need to source from your installation / 3rd party provider.

Manual install

For components that are not normally delivered with the installer; the recommended installation is via a dependency management system. This will automagically download everything that is required for the optional component in question.

You should always match the version number with your primary Interlok installation version; so if you wanted adp-simple-csv and your Interlok version is 3.0.2 then you would configure your ivy dependency :

<dependency org="com.adaptris" name="adp-simple-csv" rev="3.0.2-RELEASE"/>

or add something to your POM file

<dependency>
	<groupId>com.adaptris</groupId>
	<artifactId>adp-simple-csv</artifactId>
	<version>3.0.2-RELEASE</version>
</dependency>

Javadoc

Interlok comes automatically with some javadocs for its installed components. The javadocs file can be found into ${adapter.home}/docs/javadocs. You can access the javadocs by opening a browser at http://localhost:8080/interlok/javadocs if the adapter is started.

You can also see the javadocs for a specific component when using the settings modal in the UI config page by hovering the (i) icon near the setting name.

If the tooltip has Help not found it’s most likely that the setting does not have any javadoc or the javadocs jar has not been added to ${adapter.home}/docs/javadocs.

Optional components javadocs can be opened in two ways:

• The javadocs are within a folder: Open your browser at http://localhost:8080/interlok/javadocs/optional/your-component/index.html e.g. http://localhost:8080/interlok/javadocs/optional/xml-security/index.html.
• The javadocs are in a jar file: Open your browser at http://localhost:8080/interlok/javadocs/your-component.jar/index.html e.g. http://localhost:8080/interlok/javadocs/optional/adp-swiftmq-3.0.3-RELEASE-javadoc.jar/index.html.

If you’ve added an optional components following the steps explained above you can copy the javadocs jar file into ${adapter.home}/docs/javadocs to be able to access it via the browser. You will have to restart your adapter to be able to access the javadocs.

Optional Components prior to 3.7.3

In release 3.8.0; we renamed all the artefacts so that they consistently started with interlok-; the list of associated artefacts that were renamed is listed below.