KIARA Installation and Administration Guide¶

Windows installation¶

Download newest gradle-x.x.x-all.zip from http://www.gradle.org/downloads.

Open CLI (cmd.exe)

unzip ~\Download\gradle-x.x.x-all.zip -d C:\Program Files
setx GRADLE_HOME C:\Program Files\gradle-x.x.x /M
setx PATH %PATH%;%GRADLE_HOME%\bin /M

/M sets the value on a machine level, which means for all users. The values are stored permanently and will be available in any new cmd.exe session.

Unix (Linux / OS X / Solaris / FreeBSD) manual installation¶

Download newest gradle-x.x.x-all.zip from http://www.gradle.org/downloads.

Open a shell:

$ sudo unzip ~/gradle-x.x.x-all.zip -d /usr/share/
$ sudo ln -s /usr/share/gradle-x.x.x /usr/share/gradle

Open ~/.profile (single user) or /etc/profile (all users) and add the following lines:

export GRADLE_HOME=/usr/share/gradle
export PATH=$PATH:$GRADLE_HOME/bin

Unix (Linux / OS X / Solaris / FreeBSD) installation using gvm¶

An alternative and simpler option to install gradle for a single user is to use the Groovy enVironment Manager (gvm) to install and update Gradle. You need the commands/packages curl and unzip to be installed on your system.

Open shell:

$ curl -s get.gvmtool.net | bash
... follow instructions
$ gvm install gradle

See gvm help to get more infos about other options of gvm, like updating or switching between different versions.

Verify installation¶

Open a new shell or cmd.exe session and test if gradle is available:

$ gradle -v
------------------------------------------------------------
Gradle 2.2.1
------------------------------------------------------------

Build time:   2014-11-24 09:45:35 UTC
Build number: none
Revision:     6fcb59c06f43a4e6b1bcb401f7686a8601a1fb4a

Groovy:       2.3.6
Ant:          Apache Ant(TM) version 1.9.3 compiled on December 23 2013
JVM:          1.7.0_65 (Oracle Corporation 24.65-b04)
OS:           Linux 3.13.0-34-generic amd64

Windows installation¶

Follow process in the install instructions.

Unix (Linux / OS X / Solaris / FreeBSD) manual installation¶

Download newest apache-maven-x.x.x-bin.zip from http://maven.apache.org/download.html.

Open shell:

$ sudo unzip ~/apache-maven-x.x.x-bin.zip -d /usr/share/
$ sudo ln -s apache-maven-x.x.x /usr/share/maven

Open ~/.profile (single user) or /etc/profile (all users) and add the following lines:

export M2_HOME=/usr/share/maven
export PATH=$PATH:$M2_HOME/bin

Unix (Linux / OS X / Solaris / FreeBSD) installation using package manager¶

An alternative option to install maven is to use the package manager of the unix system.

• on DEB based systems (Debian,Ubuntu,...) $ sudo apt-get install maven (this is a quite outdated version 3.0.x)
• on RPM based systems (RedHat,CentOS,Fedora,...) exists no official package (use above manual instructions).
• on OS X you can install Maven using a packet manager for OS X like Homebrew or MacPorts. Because the packages are usually compiled during installation you need to install Xcode beforehand. This is recommended especially, if you already have Xcode installed or you would like to install also other common unix packages.

Homebrew (http://brew.sh):

::

$ brew install maven

MacPorts (http://www.macports.org/install.php):

::

$ port install maven2

$ mvn -version
Apache Maven 3.2.3 (33f8c3e1027c3ddde99d3cdebad2656a31e8fdf4; 2014-08-11T22:58:10+02:00)
Maven home: /usr/local/Cellar/maven/3.2.3/libexec
Java version: 1.8.0_20, vendor: Oracle Corporation
Java home: /Library/Java/JavaVirtualMachines/jdk1.8.0_20.jdk/Contents/Home/jre
Default locale: en_US, platform encoding: UTF-8
OS name: mac os x, version: 10.10.2, arch: x86_64, family: mac

On Windows:¶

• There are two ways of obtaining the kiaragen software:

• Download the file kiaragen-x.x.x-cli.jar from Maven Central and place it into a directory (e.g. subdirectory kiaragen).

• To make the execution simpler you can also download the kiaragen.bat script from the kiaragen project (https://github.com/FIWARE-Middleware/kiaragen) and copy it into the scripts directory (create if not not created yet).

  Please take into account that the script will look for the kiaragen-x.x.x-cli.jar file inside the kiaragen subdirectory.

• Now the tool can be called using: kiaragen.bat when the scripts folder in the installation dir is in the execute path or with a relative path ./scripts/kiaragen.bat for project local installations.

On Linux / OS X:¶

• Download the file kiaragen-x.x.x-cli.jar from Maven Central

• Place it in a directory of your shells execute path (e.g. /usr/local/bin). Alternatively you can also add it to your project dir and call it with a relative path (./scripts/kiaragen.sh).

• To make the execution simpler you can also download the kiaragen.sh script from the kiaragen project (https://github.com/FIWARE-Middleware/kiaragen) and copy it into the scripts directory.

  Please take into account that the script will look for the kiaragen-x.x.x-cli.jar file inside the kiaragen subdirectory.

• Now the tool can be called using: kiaragen.sh when the scripts folder in the installation dir is in the execute path or with a relative path ./scripts/kiaragen.sh for project local installations executable flag is lost while downloading, you can set it again using chmod a+x kiaragen

Set up the basic project structure¶

If you do not yet have a project you can setup the basic structure using the gradle init plugin:

$ mkdir calculator
$ cd calculator
$ gradle init --type java-library

This will create a basic directory structure for your source and test code and create a commented build.gradle file for a Java application.

Additionally the gradle wrapper is set up, which allows developers to execute gradle tasks without installing the gradle tool globally.

Configure your Gradle project to use KIARA¶

To use KIARA in your project you have to extend your build.gradle file:

apply plugin: 'java'

sourceCompatibility = 1.7
version = '1.0'

// In this section you declare where to find the dependencies of your project
repositories {
  mavenCentral()
}

// In this section declare the dependencies for your production and test code
dependencies {
    compile group: 'org.fiware.kiara', name: 'KIARA', version: '0.4.0'
    compile group: 'org.slf4j', name: 'slf4j-api', version: '1.7.7'
    testCompile group: 'junit', name: 'junit', version: '4.11'
}

The KIARA artefacts are available on the Maven Central repository. So you have to make sure, `mavenCentral() is part of your repositories section.

To include the KIARA artefacts you have to add the kiara main library to the dependencies section. All the depending libraries will be added automatically to your project.

The following is a typical file structure for a gradle project using KIARA:

.
├── build                                       // generated files
│   ├── classes                                 // compiled classes
│   │   └── main
│   │       └── com
│   │           └── example
│   │               ├── Calculator.class
│   │               ├── CalculatorAsync.class
│   │               ├── CalculatorClient.class
│   │               ├── CalculatorProcess.class
│   │               ├── CalculatorProxy.class
│   │               ├── CalculatorServant.class
│   │               ├── CalculatorServantExample.class
│   │               ├── ClientExample.class
│   │               ├── IDLText.class
│   │               └── ServerExample.class
│   ├── generated-src                           // generated support classes
│   │   └── kiara
│   │       └── com
│   │           └── example
│   │               ├── Calculator.java
│   │               ├── CalculatorAsync.java
│   │               ├── CalculatorClient.java
│   │               ├── CalculatorProcess.java
│   │               ├── CalculatorProxy.java
│   │               └── CalculatorServant.java
│   └── libs
│       └── Calculator-1.0.jar                 // packaged application
├── build.gradle                               // gradle build file
├── gradle
│   └── wrapper                                // gradle wrapper files
│       └── ...
├── gradlew                                    // gradle wrapper unix script
├── gradlew.bat                                // gradle wrapper windows script
├── settings.gradle
└── src                                        // source files
    ├── main
    │   ├── idl                                // IDL definitions for KIARA
    │   │   └── com
    │   │       └── example
    │   │           └── Calculator.idl
    │   └── java                               // application code
    │       └── com
    │           └── example
    │               ├── ClientExample.java               // client start code
    │               ├── ServerExample.java               // server start code
    │               └── CalculatorServantExample.java    // servant impl.
    └── test
        └── java

Set up the basic project structure¶

If you do not yet have a maven project you can setup the basic structure using the archetype plugin:

$ mvn archetype:generate \
 -DgroupId=mw.kiara \
 -DartifactId=calculator \
 -DarchetypeArtifactId=maven-archetype-quickstart -DinteractiveMode=false

This will create a basic directory structure for your source and test code and create a commented pom.xml file for a Java application.