Erocci java-dbus integration

Progress dashboard

Progress development dashboard

Prerequisite

• JDK
• Maven

See "troubleshooting" part below in case of error.

Quickstart

Some dependancies are not available from Maven repositories. They are installed from local jar with:

mvn initialize

Then, build the backend with:

$ mvn install

Project format

src/main/dbus/ contains the XML file describing the erocci DBus interface.

pom.xml imports the maven-dbus-plugin (to generate a java interface) and specifies dependencies (to compile).

Note: the maven-dbus-plugin version is the one available online at maven central (0.1). To compile locally your own version from sources, set version to 0.2-SNAPSHOT in pom.xml.

Code generation

$ mvn clean install

The java interface is generated in src/generated/java, then compiled in target/classes .

Launch as standalone service (outside Eclipse/IDE)

$ mvn exec:java -Djava.library.path=/path/to/jni/dir -Dexec.mainClass="org.ow2.erocci.backend.BackendDBusService"

You can execute with a cloud designer extension and connector with the following command (replace the dependencies path by your paths) :

$ make
$ java -Djava.library.path=/path/to/kni/dir -cp ./target/erocci-dbus-java-1.0-SNAPSHOT-jar-with-dependencies.jar:/your/path/org.occiware.clouddesigner.occi.infrastructure-0.1.0-SNAPSHOT.jar:/your/path/org.occiware.clouddesigner.occi.infrastructure.connector.dummy-0.1.0-SNAPSHOT.jar org.ow2.erocci.backend.BackendDBusService

Please don't forget to add your jars dependencies on classpath and to generate Erocci xml files on your Cloud Designer extension project. To ease up adding your jar dependencies, consider writing a Maven POM file such as here.

The dbus service is called "org.ow2.erocci.backend".

See "troubleshooting" part below in case of error.

Interface with erocci

An erocci-dbus-java.config file is provided (in the project's home directory). Launch erocci with this file used as configuration; for example, in the erocci directory:

./start.sh -c ../erocci-dbus-java/erocci-dbus-java.config

Troubleshooting

• "Failed to connect to bus unknown address type kernel"

Check the DBUS_SESSION_BUS_ADDRESS environment variable. It is a list of one or more items (separated by semicolons). The 1st item should start with "unix:". If its starts with "kernel:", remove the 1st item from the list. Example:

$ printenv DBUS_SESSION_BUS_ADDRESS
kernel:path=/sys/fs/kdbus/1000-user/bus;unix:path=/run/user/1000/bus
$ export DBUS_SESSION_BUS_ADDRESS=unix:path=/run/user/1000/bus

(can also be done using a sed command:

DBUS_SESSION_BUS_ADDRESS=$(printenv DBUS_SESSION_BUS_ADDRESS | sed -e 's/kernel:.*;//' ).

Installation from scratch

On Ubuntu 15.10

• Install openjdk 8 : sudo apt-get install openjdk-8-jdk
• Download Erlang 1.8.x for Ubuntu on the website editor (https://www.erlang-solutions.com/resources/download.html) or use : sudo apt-get install erlang
• Git Clone the Erocci project
• Git Clone the Erocci-dbus-java project
• Install maven3 using sudo apt-get install maven
• Install dbus binaries for java : sudo apt-get install dbus-java-bin
• Copy jni file like this : cp /usr/lib/jni/libunix-java.so /usr/lib/jvm/java-1.8.0-openjdk-amd64/lib/amd64/
• Go to erocci-dbus-java root directory
• make deps
• make
• Go to Erocci root directory
• launch ./bootstrap , ./configure and then make after the message "release successfully created" will display if all ok.
• Launch erocci-dbus-java on first place before Erocci
• Launch Erocci as describe upper.

On Mac OSX platform (El capitan)

• Install XCode, java jdk 8 and set env variable JAVA_HOME
• Install D-BUS with : brew install dbus, it may be installed on path : /usr/local/Cellar/d-bus/1.10.6/
• If you don't have maven installed : brew install maven , this will install maven 3 in /usr/local/Cellar/maven/3.3.9/
• Download and build libmatthew-java :
  • cd $JAVA_HOME/include/
  • sudo ln -s darwin linux
  • Go to your favorite directory to clone libmatthew-java project (for ex: cd ~/myworkspace/)
  • git clone https://github.com/abstractj/libmatthew-java
  • cd libmatthew-java
  • mvn install
• Copy jni libraries libunix-java.so to your lib native path like this (note that extension is .dylib) : sudo cp ./libmatthew-java/libunix/target/libunix-java.so $JAVA_HOME/jre/lib/libunix-java.dylib
• Launch dbus :
  • if necessary create directory ~/Library/LaunchAgents/
  • Create a symbolic link : ln -sfv /usr/local/opt/d-bus/*.plist ~/Library/LaunchAgents
  • Edit your .bash_profile file and add : export DBUS_SESSION_BUS_ADDRESS=unix:path=$DBUS_LAUNCHD_SESSION_BUS_SOCKET
  • Edit the file : /usr/local/Cellar/d-bus/1.10.6/share/dbus-1/session.conf , Add this lines after EXTERNAL auth :
    <auth>ANONYMOUS</auth>  
<allow_anonymous/>
  • Launch dbus agent : launchctl load ~/Library/LaunchAgents/org.freedesktop.dbus-session.plist
  • Restart your system
• build erocci-dbus-java :
  • ./dbus-java-install.sh
  • make
  • make run
• For Erocci, use these instruction for Mac OSX : https://github.com/erocci/erocci
• Some links that may help :
  • http://blog.roderickmann.org/2015/03/using-dbus-on-os-x-yosemite/
  • https://github.com/brianmcgillion/DBus/blob/master/README.launchd
• Special usage with docker :
  • Install docker-tools 1.8.3 (not the last version, a lot of api updates give error on docker connector after this version, this will be updated has soon as possible, stay tuned).
  • If you have El capitan, you must disable the apple root security added from this version of OS X, this is mandatory for making aliases on docker-machine and VBoxManage binary.
  • Aliases on binary :
    • sudo ln -s /usr/local/bin/VBoxManage /usr/bin/VBoxManage
    • sudo ln -s /usr/local/bin/docker-machine /usr/bin/docker-machine
  • Launch docker default virtual box machine
  • Launch erocci-dbus-java with Cloud designer dependencies on classpath (replace paths of your dependencies) :
    • make
    • java -cp ./target/erocci-dbus-java-1.0-SNAPSHOT-jar-with-dependencies.jar:/your/path/org.occiware.clouddesigner.occi.infrastructure-0.1.0-SNAPSHOT.jar:/your/path/org.occiware.clouddesigner.occi.infrastructure.connector.dummy-0.1.0-SNAPSHOT.jar:/your/path/org.occiware.clouddesigner.occi.docker-0.1.0-SNAPSHOT.jar:/your/path/org.occiware.clouddesigner.occi.docker.connector-0.1.0-SNAPSHOT.jar org.ow2.erocci.backend.BackendDBusService
  • Launch Erocci :
    • ./start.sh -c ../erocci-dbus-java/erocci-dbus-java.config

CI

Visit CI results on http://travis-ci.org/occiware/erocci-dbus-java