Skip to content

Latest commit

 

History

History
132 lines (113 loc) · 5.81 KB

README.md

File metadata and controls

132 lines (113 loc) · 5.81 KB
Raw

kanna

A small shim on top of camel-blueprint-main which runs your OSGi Blueprints in sort of the same way that Apache Karaf does and with logging enabled via logback.

Usage

$ yourintegration/bin/yourintegration -h
[main] INFO  se.soy.kanna.Main - Starting Kanna
Apache Camel Runner takes the following options

  -h or -help = Displays the help screen
  -r or -routers <routerBuilderClasses> = Sets the router builder classes which will be loaded while starting the camel context
  -d or -duration <duration> = Sets the time duration (seconds) that the application will run for before terminating.
  -dm or -durationMaxMessages <durationMaxMessages> = Sets the duration of maximum number of messages that the application will process before terminating.
  -di or -durationIdle <durationIdle> = Sets the idle time duration (seconds) duration that the application can be idle before terminating.
  -t or -trace = Enables tracing
  -e or -exitcode <exitcode> = Sets the exit code if duration was hit
  -pl or -propertiesLocation <propertiesLocation> = Sets location(s) to load properties, such as from classpath or file system.
  -ac or -applicationContext <applicationContext> = Sets the classpath based OSGi Blueprint
  -fa or -fileApplicationContext <fileApplicationContext> = Sets the filesystem based OSGi Blueprint
  -pid or -configAdminPid <configAdminPid> = Sets the ConfigAdmin persistentId
  -pf or -configAdminFileName <configAdminFileName> = Sets the ConfigAdmin persistent file name
  -is or -includeSelfAsBundle <includeSelfAsBundle> = Include self as Bundle
  -bn or -bundleName <bundleName> = Set the name of the bundle
[main] INFO  org.apache.camel.main.MainSupport - MainSupport exiting code: 0

So you can put your OSGi Blueprint every where you'd like and use it with -fileApplicationContext or put it inside your .jar and use it with -applicationContext. You can also specify a -configAdminFileName file to save sensitive or ever changing things in like passwords, URLs etc in.

Gradle

  1. Create a new Gradle project in a folder e.g. yourintegration
  2. Change your build.gradle to: 
    plugins {
  id 'application'
}

mainClassName = 'se.soy.kanna.Main'
group = 'tld.example.your.integrations'
version = '1.0.0'

ext {
  versions = [
    camel       : '3.3.0',
    kanna       : '1.0.0',
  ]
}

repositories {
  mavenCentral()
}

dependencies {
  runtimeOnly "se.soy.kanna:kanna:$versions.kanna"

  // What ever Camel Components you need https://camel.apache.org/components/latest/
  // camel-blueprint-main is obligatory though, otherwise nothing will work.
  implementation "org.apache.camel.karaf:camel-blueprint-main:$versions.camel"
  implementation "org.apache.camel:camel-log:$versions.camel"
  implementation "org.apache.camel:camel-timer:$versions.camel"
}
  3. Add an OSGi Blueprint to src/main/resources/OSGI-INF/blueprint/yourintegration.xml: 
    <?xml version="1.0" encoding="UTF-8"?>
<blueprint xmlns="http://www.osgi.org/xmlns/blueprint/v1.0.0"
           xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
           xmlns:cm="http://aries.apache.org/blueprint/xmlns/blueprint-cm/v1.1.0"
           xsi:schemaLocation="
         http://www.osgi.org/xmlns/blueprint/v1.0.0 https://www.osgi.org/xmlns/blueprint/v1.0.0/blueprint.xsd
         http://camel.apache.org/schema/blueprint http://camel.apache.org/schema/blueprint/camel-blueprint.xsd
         http://aries.apache.org/blueprint/xmlns/blueprint-cm/v1.1.0 http://aries.apache.org/schemas/blueprint-cm/blueprint-cm-1.1.0.xsd">

  <camelContext id="yourContext" xmlns="http://camel.apache.org/schema/blueprint">
    <route id="yourRoute">
      <from uri="timer:yourTimer?period=60000"/>
      <log message="Hello world!"/>
    </route>
  </camelContext>
</blueprint>
  4. Build it 
    $ ./gradlew installDist
[...]
BUILD SUCCESSFUL in 2s
5 actionable tasks: 5 executed
  5. And run it 
    $ env JAVA_OPTS="-Xms50m -Xmx50m" build/install/yourintegration/bin/yourintegration \
-bundleName yourintegration \
-applicationContext '/OSGI-INF/blueprint/yourintegration.xml'
[main] INFO se.soy.kanna.Main - Starting Kanna
[...]
[Camel (yourContext) thread #1 - timer://yourTimer] INFO yourRoute - Hello world!

Maven

  1. FIXME Use the maven-assembly-plugin somehow, see this blog-post.

Caveats

  • Unfortunately I haven't figured out use this in an uberjar. When packages as an uberjar camel-blueprint-main can't find the needed bundles, probably because shadow/shade trashes something in /META-INF/ in the jars in some way. It's not related to services because shadow/shade handles that. dist{Tar,Zip} works perfectly though!
  • Your blueprints aren't automatically loaded from /OSGI-INF/blueprint/*.xml as it should, so you need -ac /OSGI-INF/blueprint/your-blueprint.xml as an argument sadly.

TODO

  • How can we provided sane defaults? bundleName, configAdmin{Pid,FileName}, applicationContext and fileApplicationContext based on project name. In the distribution script or Main.java? Or maybe via the manifest and Implementation-Name?
  • Investigate how to be used as uberjar
  • Be able to set bundle version?
  • Why doesn't it load /OSGI-INF/blueprint/*.xml automatically?