trunk/examples/camel-nmr/README.txt - servicemix-features - Git at Google

 /*
  * Licensed to the Apache Software Foundation (ASF) under one or more
  * contributor license agreements.  See the NOTICE file distributed with
  * this work for additional information regarding copyright ownership.
  * The ASF licenses this file to You under the Apache License, Version 2.0
  * (the "License"); you may not use this file except in compliance with
  * the License.  You may obtain a copy of the License at
  *
  *      http://www.apache.org/licenses/LICENSE-2.0
  *
  * Unless required by applicable law or agreed to in writing, software
  * distributed under the License is distributed on an "AS IS" BASIS,
  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */

 CAMEL OSGI NMR EXAMPLE
 ======================

 Purpose
 -------
 Deploys two Camel EIP routes that communicate with each other
 via the ServiceMix NMR.


 Explanation
 -----------
 The NMR is a general-purpose message bus that applications can
 use to communicate within the ServiceMix OSGi container. It is
 modeled on the Normalized Message Router (NMR) defined in the
 Java Business Integration (JBI) specification.

 The Camel routes are defined in the beans.xml file that is located
 in the src/main/resources/META-INF/spring directory of this example.
 The contents of the beans.xml file can be explained as follows:

 1. Imports the camel-nmr.xml file, which instantiates and
    initializes the NMR component.

 2. Defines a route that generates a heartbeat message every
    2000ms and sends it to the NMR.

 3. Defines a second route that receives the message from the NMR,
    transforms the heartbeat into a message containing the current
    date and time, and logs the message.

 The routes are deployed in an OSGi bundle.


 Prerequisites for Building and Running the Example
 --------------------------------------------------
 1. You must have the following installed on your machine:

    - JDK 1.5 or higher

    - Maven 2.0.9 or higher (for building)

   For more information, see the README in the top-level examples
   directory.


 2. Start ServiceMix by running the following command:

   <servicemix_home>/bin/servicemix          (on UNIX)
   <servicemix_home>\bin\servicemix          (on Windows)


 Running the Example
 -------------------
 You can run the example in two ways:

 - A. Using a Prebuilt Deployment Bundle: Quick and Easy
   This option is useful if you want to see the example up and
   running quickly.

 - B. Building the Example Bundle Yourself
   This option is useful if you want to change the example in any
   way. It tells you how to build and deploy the example. This
   option might be slower than option A because if you do not
   already have the required bundles in your local Maven
   repository, Maven will have to download the bundles it needs.

 A. Using a Prebuilt Deployment Bundle:Quick and Easy
 ----------------------------------------------------
 To install and run a prebuilt version of this example, enter
 the following command in the ServiceMix console:

   features:install examples-camel-nmr

 This command makes use of the ServiceMix features facility. For
 more information about the features facility, see the README.txt
 file in the examples parent directory.

 Once the example is running you should see output similar to
 the following being logged to the console screen:

 >>>> MyTransform set body:  Wed Aug 05 11:52:40 BST 2009
 >>>> MyTransform set body:  Wed Aug 05 11:52:42 BST 2009
 >>>> MyTransform set body:  Wed Aug 05 11:52:44 BST 2009

 For information on how to stop and/or uninstall the example,
 see "Stopping and Uninstalling the Example" below.

 B. Building the Example Bundle Yourself
 ---------------------------------------
 To install and run the example where you build the example
 bundle yourself, complete the following steps:

 1. If you have already run the example using the prebuilt
    version as described above, you must first uninstall the
    examples-camel-nmr feature by entering the following command
    in the ServiceMix console:

      features:uninstall examples-camel-nmr

 2. Build the example by opening a command prompt, changing
    directory to examples/camel-nmr (this example) and entering
    the following Maven command:

      mvn install

    If all of the required OSGi bundles are available in your
    local Maven repository, the example will build quickly.
    Otherwise it may take some time for Maven to download
    everything it needs.

    The mvn install command builds the example deployment bundle and
    copies it to your local Maven repository and to the target
    directory of this example.

 3. Install the example by entering the following command in
    the ServiceMix console:

      features:install examples-camel-nmr

    This command makes use of the ServiceMix features facility. For
    more information about the features facility, see the README.txt
    file in the examples parent directory.

 Once the example is running you should see output similar to the
 following being logged to the console screen:

 >>>> MyTransform set body:  Wed Aug 05 11:52:40 BST 2009
 >>>> MyTransform set body:  Wed Aug 05 11:52:42 BST 2009
 >>>> MyTransform set body:  Wed Aug 05 11:52:44 BST 2009


 Stopping and Uninstalling the Example
 -------------------------------------
 To stop the example, first you must know the bundle ID that ServiceMix
 has assigned to it. To get the bundle ID, enter the following command
 in the ServiceMix console (Note, the text you are typing will
 intermingle with the output being logged. This is nothing to worry
 about.):

   osgi:list

 At the end of the listing, you should see an entry similar to the
 following:

   [160] [Active     ] [Started] [  60] Apache ServiceMix Example :: Camel NMR (4.1.0.0)

 In this case, the bundle ID is 160.

 To stop the example, enter the following command in the ServiceMix
 console:

   osgi:stop <bundle_id>

 For example:

   osgi:stop 160

 To uninstall the example, enter one of the following commands
 in the ServiceMix console:

   features:uninstall examples-camel-nmr

 or

   osgi:uninstall <bundle_id>


 Viewing the Log Entries
 -----------------------
 You can view the entries in the log file in the data/log
 directory of your ServiceMix installation, or by typing the
 following command in the ServiceMix console:

   log:display
	/*
	* Licensed to the Apache Software Foundation (ASF) under one or more
	* contributor license agreements. See the NOTICE file distributed with
	* this work for additional information regarding copyright ownership.
	* The ASF licenses this file to You under the Apache License, Version 2.0
	* (the "License"); you may not use this file except in compliance with
	* the License. You may obtain a copy of the License at
	*
	* http://www.apache.org/licenses/LICENSE-2.0
	*
	* Unless required by applicable law or agreed to in writing, software
	* distributed under the License is distributed on an "AS IS" BASIS,
	* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
	* See the License for the specific language governing permissions and
	* limitations under the License.
	*/

	CAMEL OSGI NMR EXAMPLE
	======================

	Purpose
	-------
	Deploys two Camel EIP routes that communicate with each other
	via the ServiceMix NMR.


	Explanation
	-----------
	The NMR is a general-purpose message bus that applications can
	use to communicate within the ServiceMix OSGi container. It is
	modeled on the Normalized Message Router (NMR) defined in the
	Java Business Integration (JBI) specification.

	The Camel routes are defined in the beans.xml file that is located
	in the src/main/resources/META-INF/spring directory of this example.
	The contents of the beans.xml file can be explained as follows:

	1. Imports the camel-nmr.xml file, which instantiates and
	initializes the NMR component.

	2. Defines a route that generates a heartbeat message every
	2000ms and sends it to the NMR.

	3. Defines a second route that receives the message from the NMR,
	transforms the heartbeat into a message containing the current
	date and time, and logs the message.

	The routes are deployed in an OSGi bundle.


	Prerequisites for Building and Running the Example
	--------------------------------------------------
	1. You must have the following installed on your machine:

	- JDK 1.5 or higher

	- Maven 2.0.9 or higher (for building)

	For more information, see the README in the top-level examples
	directory.


	2. Start ServiceMix by running the following command:

	<servicemix_home>/bin/servicemix (on UNIX)
	<servicemix_home>\bin\servicemix (on Windows)


	Running the Example
	-------------------
	You can run the example in two ways:

	- A. Using a Prebuilt Deployment Bundle: Quick and Easy
	This option is useful if you want to see the example up and
	running quickly.

	- B. Building the Example Bundle Yourself
	This option is useful if you want to change the example in any
	way. It tells you how to build and deploy the example. This
	option might be slower than option A because if you do not
	already have the required bundles in your local Maven
	repository, Maven will have to download the bundles it needs.

	A. Using a Prebuilt Deployment Bundle:Quick and Easy
	----------------------------------------------------
	To install and run a prebuilt version of this example, enter
	the following command in the ServiceMix console:

	features:install examples-camel-nmr

	This command makes use of the ServiceMix features facility. For
	more information about the features facility, see the README.txt
	file in the examples parent directory.

	Once the example is running you should see output similar to
	the following being logged to the console screen:

	>>>> MyTransform set body: Wed Aug 05 11:52:40 BST 2009
	>>>> MyTransform set body: Wed Aug 05 11:52:42 BST 2009
	>>>> MyTransform set body: Wed Aug 05 11:52:44 BST 2009

	For information on how to stop and/or uninstall the example,
	see "Stopping and Uninstalling the Example" below.

	B. Building the Example Bundle Yourself
	---------------------------------------
	To install and run the example where you build the example
	bundle yourself, complete the following steps:

	1. If you have already run the example using the prebuilt
	version as described above, you must first uninstall the
	examples-camel-nmr feature by entering the following command
	in the ServiceMix console:

	features:uninstall examples-camel-nmr

	2. Build the example by opening a command prompt, changing
	directory to examples/camel-nmr (this example) and entering
	the following Maven command:

	mvn install

	If all of the required OSGi bundles are available in your
	local Maven repository, the example will build quickly.
	Otherwise it may take some time for Maven to download
	everything it needs.

	The mvn install command builds the example deployment bundle and
	copies it to your local Maven repository and to the target
	directory of this example.

	3. Install the example by entering the following command in
	the ServiceMix console:

	features:install examples-camel-nmr

	This command makes use of the ServiceMix features facility. For
	more information about the features facility, see the README.txt
	file in the examples parent directory.

	Once the example is running you should see output similar to the
	following being logged to the console screen:

	>>>> MyTransform set body: Wed Aug 05 11:52:40 BST 2009
	>>>> MyTransform set body: Wed Aug 05 11:52:42 BST 2009
	>>>> MyTransform set body: Wed Aug 05 11:52:44 BST 2009


	Stopping and Uninstalling the Example
	-------------------------------------
	To stop the example, first you must know the bundle ID that ServiceMix
	has assigned to it. To get the bundle ID, enter the following command
	in the ServiceMix console (Note, the text you are typing will
	intermingle with the output being logged. This is nothing to worry
	about.):

	osgi:list

	At the end of the listing, you should see an entry similar to the
	following:

	[160] [Active ] [Started] [ 60] Apache ServiceMix Example :: Camel NMR (4.1.0.0)

	In this case, the bundle ID is 160.

	To stop the example, enter the following command in the ServiceMix
	console:

	osgi:stop <bundle_id>

	For example:

	osgi:stop 160

	To uninstall the example, enter one of the following commands
	in the ServiceMix console:

	features:uninstall examples-camel-nmr

	or

	osgi:uninstall <bundle_id>


	Viewing the Log Entries
	-----------------------
	You can view the entries in the log file in the data/log
	directory of your ServiceMix installation, or by typing the
	following command in the ServiceMix console:

	log:display