1. Quick start

If you are in a hurry to have Apache ServiceMix Runtime up and running right away, this section will provide you with some basic steps for downloading, building (when needed) and running the server in no time. This is clearly not a complete guide so you may want to check other sections of this guide for further information.

All you need is 5 to 10 minutes and to follow these basic steps.

• #Background
• #Getting the software
• #Start the server
• #Deploy a sample application

Background

Apache ServiceMix Runtime is a small and lightweight OSGi based runtime. This provides a small lightweight container onto which various bundles can be deployed.

#top

Getting the software

At this time you have one option to get the software. The fastest and easiest way is to get the binary directly from the Apache site. Since this article is intended to help you to have Apache ServiceMix Runtime up and running in the fastest way only the binary download will be covered at this time.

Prerequisites

Although this installation path is the fastest one, still you will need to install some software before installing ServiceMix Runtime.

ServiceMix Runtime requires a Java 5 environment to run. Refer to http://java.sun.com for details on how to download and install J2SE 1.5 or greater.

Download binaries

Depending on the platform you plan to install and run Apache ServiceMix you will select the appropriate installation image. Open a Web browser and access the following URL, there you will find the available packages for download (binaries and source code).

http://servicemix.apache.org/download.html

Select the file compression format compatible with your system (zip for windows, tar.gz for unixes) by clicking directly on the link, download it and expand the binary to your hard drive in a new directory; for example in z:\servicemix - from now on this directory will be referenced as <SERVICEMIX_HOME>. Please remember the restrictions concerning illegal characters in Java paths, e.g. !, % etc.

The installation of Apache ServiceMix Runtime is as simple as uncompressing the .zip or .tar files. The next step is to start the server.

#top

Start the server

With Apache ServiceMix Runtime already installed, open a command line console and change directory to <SERVICEMIX_HOME>. To start the server, run the following command in Windows:

bin\servicemix.bat

respectively on Unix:

bin/servicemix

You should see the following informations on the command line console:

 ____                  _          __  __ _
/ ___|  ___ _ ____   _(_) ___ ___|  \/  (_)_  __
\___ \ / _ \ '__\ \ / / |/ __/ _ \ |\/| | \ \/ /
 ___) |  __/ |   \ V /| | (_|  __/ |  | | |>  <
|____/ \___|_|    \_/ |_|\___\___|_|  |_|_/_/\_\

 ServiceMix (1.0-m1)

Type 'help' for more information.
--------------------------------------------------------------------------------------------------------------------------------
gnodet@Guillaume-Nodets-MacPro.local:/>

You can now run your first command. Simply enter help in the console followed by a carriage return.

gnodet@Guillaume-Nodets-MacPro.local:/> help

For information about ServiceMix, visit:
    http://servicemix.apache.org 

Available commands:
  .                     Alias to: source
  ?                     Alias to: help
  clear                 Clear the terminal screen
  create                Create a new ServiceMix instance
  echo                  Echo or print arguments to STDOUT
  exit                  Exit the (sub)shell
  help                  Show command help
  info                  Show system informations
  set                   Set a variable
  source                Load a file/url into the current shell
  unset                 Unset a variable

Available shells:
  features
  obr
  osgi
  remote
  wrapper

#top

Deploy a sample application

While you will learn in the remainder of this guide how to use and leverage Apache ServiceMix Runtime, we will just use the pre-built packaging for now.

In the console, run the following commands:

obr addUrl http://svn.apache.org/repos/asf/servicemix/smx4/obr-repo/repository-snapshot.xml
obr start org.apache.servicemix.bundles.jaxb-impl-2.0.3 camel-spring camel-example-osgi

This commands will download, install and start the specified jars and their dependencies.

gnodet@Guillaume-Nodets-MacPro.local:/> obr addUrl http://svn.apache.org/repos/asf/servicemix/smx4/obr-repo/repository-snapshot.xml
gnodet@Guillaume-Nodets-MacPro.local:/> obr start org.apache.servicemix.bundles.jaxb-impl-2.0.3 camel-spring camel-example-osgi
Target resource(s):
-------------------
   ServiceMix OSGI Common Bundles: jaxb-impl (1.0.0.SNAPSHOT)
   camel-example-osgi (1.3.0.SNAPSHOT)
   camel-spring (1.3.0.SNAPSHOT)

Required resource(s):
---------------------
   geronimo-activation_1.1_spec (1.0.1)
   ServiceMix OSGI Common Bundles: jaxb-api (1.0.0.SNAPSHOT)
   camel-core (1.3.0.SNAPSHOT)
   spring-tx (2.5.0)

Deploying...done.

The example installed is using Camel to start a timer every 2 seconds and output a message on the console.

>>>> MyTransform set body:  Wed Jan 02 23:34:19 CET 2008
>>>> MyTransform set body:  Wed Jan 02 23:34:21 CET 2008

Stopping and uninstalling the sample application

To stop this demo, run the following command:

osgi list

In the output, locate the line containing camel-example-osgi and note the id of the bundle in the first column. Then launch the following command:

osgi stop [id]

If you wish, you can start again the sample by using the following command:

osgi start [id]

To uninstall the demo, run the following command:

osgi uninstall [id]

Summary

This document showed you how simple it is to have Apache ServiceMix up and running. The overall time for getting the server running should be less than five minutes if you have the prerequisite (Java 1.5) already installed. Additionally, this article also showed you how to deploy and test a simple Web Service in less than five minutes.

#top