Skip to content

Using Third Party Components

jamesdbaker edited this page Oct 20, 2017 · 2 revisions

One of the strengths of Baleen is it's ability to include third party components, such as annotators, consumers and collection readers. To do this, the classes or JAR files need to be on the classpath. You can achieve this by using the following command to start Baleen.

For Windows:

java -classpath .;baleen-2.4.0.jar;my-first-additional.jar;my-second-additional.jar uk.gov.dstl.baleen.runner.Baleen

For Linux:

java -classpath .:baleen-2.4.0.jar:my-first-additional.jar:my-second-additional.jar uk.gov.dstl.baleen.runner.Baleen

In both cases above, the two third party JARs my-first-additional.jar and my-second-additional.jar will now be available to pipelines, and should appear in the REST API when querying the available components (assuming that the additional components correctly inherit from the Baleen base classes).

When resolving pipeline components, Baleen assumes that they exist in the following packages:

  • uk.gov.dstl.baleen.annotators (Annotators)
  • uk.gov.dstl.baleen.collectionreaders (Collection Readers)
  • uk.gov.dstl.baleen.consumers (Consumers)

If your additional components don't exist in these packages, then you will need to specify the full class name (including package) in your pipeline definition.