You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@servicemix.apache.org by ge...@apache.org on 2013/02/08 21:35:05 UTC
svn commit: r1444219 [17/20] - in /servicemix/site/production/docs/4.4.x: ./
activemq/ architecture/ camel/ camel/deployment/ commands/
developers-guide/ images/ jbi/ jbi/components/ karaf/developers-guide/
karaf/users-guide/ nmr/ quickstart/ user/ use...
Added: servicemix/site/production/docs/4.4.x/user/technology-selection.html
URL: http://svn.apache.org/viewvc/servicemix/site/production/docs/4.4.x/user/technology-selection.html?rev=1444219&view=auto
==============================================================================
--- servicemix/site/production/docs/4.4.x/user/technology-selection.html (added)
+++ servicemix/site/production/docs/4.4.x/user/technology-selection.html Fri Feb 8 20:35:02 2013
@@ -0,0 +1,94 @@
+
+<!DOCTYPE html>
+<html>
+<head>
+ <title>Apache ServiceMix Documentation - </title>
+
+ <link href="../theme/master.css" rel="stylesheet" type="text/css" />
+ <link href="../theme/pygmentize.css" rel="stylesheet" type="text/css" />
+
+ <script type="text/javascript" src="../scripts/jquery.js"></script>
+ <script type="text/javascript" src="../scripts/jquery.cookie.js"></script>
+ <script type="text/javascript" src="../scripts/jquery.jstree.js"></script>
+
+ <script>
+ $(document).ready(function(){
+ $("#nav").jstree({
+ "themes": {
+ "theme": "apple", "dots": false
+ },
+ "plugins" : [ "themes", "html_data", "cookies", "themes" ]
+ });
+ });
+ </script>
+ <script type="text/javascript">
+ var _gaq = _gaq || [];
+ _gaq.push(['_setAccount', 'UA-398545-1']);
+ _gaq.push(['_trackPageview']);
+
+ (function() {
+ var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
+ ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
+ var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
+ })();
+ </script>
+</head>
+<body>
+ <div id="page">
+ <div id="siteHeader">
+ <table width="100%">
+ <tr valign="middle">
+ <td align="left">
+ <a href="http://servicemix.apache.org/" title="An open source ESB">
+ <img border="0" src="../images/logodesign.png" height="80"/><img border="0" height="80" src="../images/new-logo.png" />
+ </a>
+ </td>
+ <td align="right">
+ <a href="http://www.apache.org/" title="The Apache Sofware Foundation">
+ <img border="0" height="60" src="../images/ASF-logo.png">
+ </a>
+ <ul class="siteNav">
+ <li><a href="../index.html" title="Overview">Guides Overview</a></li>
+ <li><a href="../contribute.html" title="Contributing?">Contributing?</a></li>
+ <li>
+ <form action="http://www.google.com/search" method="get" style="font-size: 10px;">
+ <input name="ie" type="hidden" value="UTF-8"></input>
+ <input name="oe" type="hidden" value="UTF-8"></input>
+ <input maxlength="255" name="q" size="15" type="text" value=""></input>
+ <input name="btnG" type="submit" value="Search"></input>
+ <input name="domains" type="hidden" value="servicemix.apache.org/docs/4.4.x"></input>
+ <input name="sitesearch" type="hidden" value="servicemix.apache.org/docs/4.4.x"></input>
+ </form>
+ </li>
+ </ul>
+ </td>
+ </tr>
+ </table>
+ </div>
+ <div id="content">
+ <div id="nav">
+ <ul>
+ <li id="introduction">
+ <a href="index.html">Introduction</a>
+ </li>
+ <li id="what-is-smx4">
+ <a href="what-is-smx4.html">What is (in) Apache ServiceMix?</a>
+ </li>
+ <li id="basic-commands">
+ <a href="technology-selection.html">Technology selection guidelines</a>
+ </li>
+</ul>
+ </div>
+ <div id="body">
+ <h2 id="Technologyselectionguide">Technology selection guide</h2><p>ServiceMix 4 offers a set of different messaging and integration technologies:</p><ul><li><p>ActiveMQ</p></li><li><p>Camel</p></li><li><p>CXF</p></li><li><p>JBI</p></li><li><p>NMR</p></li></ul><p>Depending on the solution you're building, you want to select one or more of these technologies. Below are some guidelines to help you pick the right mix for your problem.</p><h3 id="WhentouseCamel">When to use Camel?</h3><p>For any integration scenario, we recommend to start as simple as possible. Camel allows you to build routes for integration scenario's quickly and efficiently. You can deploy these routes directly on ServiceMix by deploying the plain Spring XML route or by packaging the route in an OSGi bundle.</p><p>As you need more (advanced) features, start combining Camel with ActiveMQ, CXF and/or the NMR</p><h3 id="WhentouseActiveMQ">When to use ActiveMQ?</h3><p>ActiveMQ is a JMS mess
age broker, featuring support for clustering, pluggable persistence mechanism, master-slave configuration for failover, ...</p><p>ServiceMix 4 includes an instance of the ActiveMQ broker, which can be combined with Camel to provide easy-to-use message persistence and reliable messaging.</p><p>After setting up multiple instances of ActiveMQ (or ServiceMix 4) on the network, you can configure ActiveMQ clustering or master-slave mode to allow for a more reliable and scalable set-up.</p><h3 id="WhentouseCXF">When to use CXF?</h3><p>CXF is an open-source services framework that you can use to suit your WS-* standards integration needs. It allows you to use common programming APIs like JAX-RS or JAX-WS for building your own services and to expose them to the outside world.</p><p>You can use CXF from within your Camel routes with the Camel CXF component.</p><h3 id="WhentouseNMR">When to use NMR?</h3><p>The NMR provides the basic ESB features for ServiceMix 4. You can use it to co
nnect multiple camel routes in a lightweight way. It can also be used as a common transport on which you can add container-level auditing by registering your own ExchangeListener implementation.</p><h3 id="WhentouseJBI">When to use JBI?</h3><p>We still support JBI 1.0 in ServiceMix 4 so you can leverage your previous investments and move your existing JBI artifacts from ServiceMix 3 to the new container with no/minimal changes before migrating them to use Camel and/or CXF directly. For new projects, you should consider JBI deprecated and always use Camel and/or CXF inside ServiceMix instead.</p>
+ </div>
+
+ </div>
+ <div id="siteFooter">
+ © 2008-2012 The Apache Software Foundation - <a href="http://servicemix.apache.org/site/privacy-policy.html">Privacy Policy</a>
+ <br/>
+ Apache ServiceMix, ServiceMix, Apache, the Apache feather logo, and the Apache ServiceMix project logo are trademarks of The Apache Software Foundation.
+ </div>
+ </div>
+</body>
+</html>
\ No newline at end of file
Added: servicemix/site/production/docs/4.4.x/user/toc.html
URL: http://svn.apache.org/viewvc/servicemix/site/production/docs/4.4.x/user/toc.html?rev=1444219&view=auto
==============================================================================
--- servicemix/site/production/docs/4.4.x/user/toc.html (added)
+++ servicemix/site/production/docs/4.4.x/user/toc.html Fri Feb 8 20:35:02 2013
@@ -0,0 +1,104 @@
+
+<!DOCTYPE html>
+<html>
+<head>
+ <title>Apache ServiceMix Documentation - </title>
+
+ <link href="../theme/master.css" rel="stylesheet" type="text/css" />
+ <link href="../theme/pygmentize.css" rel="stylesheet" type="text/css" />
+
+ <script type="text/javascript" src="../scripts/jquery.js"></script>
+ <script type="text/javascript" src="../scripts/jquery.cookie.js"></script>
+ <script type="text/javascript" src="../scripts/jquery.jstree.js"></script>
+
+ <script>
+ $(document).ready(function(){
+ $("#nav").jstree({
+ "themes": {
+ "theme": "apple", "dots": false
+ },
+ "plugins" : [ "themes", "html_data", "cookies", "themes" ]
+ });
+ });
+ </script>
+ <script type="text/javascript">
+ var _gaq = _gaq || [];
+ _gaq.push(['_setAccount', 'UA-398545-1']);
+ _gaq.push(['_trackPageview']);
+
+ (function() {
+ var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
+ ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
+ var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
+ })();
+ </script>
+</head>
+<body>
+ <div id="page">
+ <div id="siteHeader">
+ <table width="100%">
+ <tr valign="middle">
+ <td align="left">
+ <a href="http://servicemix.apache.org/" title="An open source ESB">
+ <img border="0" src="../images/logodesign.png" height="80"/><img border="0" height="80" src="../images/new-logo.png" />
+ </a>
+ </td>
+ <td align="right">
+ <a href="http://www.apache.org/" title="The Apache Sofware Foundation">
+ <img border="0" height="60" src="../images/ASF-logo.png">
+ </a>
+ <ul class="siteNav">
+ <li><a href="../index.html" title="Overview">Guides Overview</a></li>
+ <li><a href="../contribute.html" title="Contributing?">Contributing?</a></li>
+ <li>
+ <form action="http://www.google.com/search" method="get" style="font-size: 10px;">
+ <input name="ie" type="hidden" value="UTF-8"></input>
+ <input name="oe" type="hidden" value="UTF-8"></input>
+ <input maxlength="255" name="q" size="15" type="text" value=""></input>
+ <input name="btnG" type="submit" value="Search"></input>
+ <input name="domains" type="hidden" value="servicemix.apache.org/docs/4.4.x"></input>
+ <input name="sitesearch" type="hidden" value="servicemix.apache.org/docs/4.4.x"></input>
+ </form>
+ </li>
+ </ul>
+ </td>
+ </tr>
+ </table>
+ </div>
+ <div id="content">
+ <div id="nav">
+ <ul>
+ <li id="introduction">
+ <a href="index.html">Introduction</a>
+ </li>
+ <li id="what-is-smx4">
+ <a href="what-is-smx4.html">What is (in) Apache ServiceMix?</a>
+ </li>
+ <li id="basic-commands">
+ <a href="technology-selection.html">Technology selection guidelines</a>
+ </li>
+</ul>
+ </div>
+ <div id="body">
+ <ul>
+ <li id="introduction">
+ <a href="index.html">Introduction</a>
+ </li>
+ <li id="what-is-smx4">
+ <a href="what-is-smx4.html">What is (in) Apache ServiceMix?</a>
+ </li>
+ <li id="basic-commands">
+ <a href="technology-selection.html">Technology selection guidelines</a>
+ </li>
+</ul>
+ </div>
+
+ </div>
+ <div id="siteFooter">
+ © 2008-2012 The Apache Software Foundation - <a href="http://servicemix.apache.org/site/privacy-policy.html">Privacy Policy</a>
+ <br/>
+ Apache ServiceMix, ServiceMix, Apache, the Apache feather logo, and the Apache ServiceMix project logo are trademarks of The Apache Software Foundation.
+ </div>
+ </div>
+</body>
+</html>
\ No newline at end of file
Added: servicemix/site/production/docs/4.4.x/user/what-is-smx4.html
URL: http://svn.apache.org/viewvc/servicemix/site/production/docs/4.4.x/user/what-is-smx4.html?rev=1444219&view=auto
==============================================================================
--- servicemix/site/production/docs/4.4.x/user/what-is-smx4.html (added)
+++ servicemix/site/production/docs/4.4.x/user/what-is-smx4.html Fri Feb 8 20:35:02 2013
@@ -0,0 +1,94 @@
+
+<!DOCTYPE html>
+<html>
+<head>
+ <title>Apache ServiceMix Documentation - </title>
+
+ <link href="../theme/master.css" rel="stylesheet" type="text/css" />
+ <link href="../theme/pygmentize.css" rel="stylesheet" type="text/css" />
+
+ <script type="text/javascript" src="../scripts/jquery.js"></script>
+ <script type="text/javascript" src="../scripts/jquery.cookie.js"></script>
+ <script type="text/javascript" src="../scripts/jquery.jstree.js"></script>
+
+ <script>
+ $(document).ready(function(){
+ $("#nav").jstree({
+ "themes": {
+ "theme": "apple", "dots": false
+ },
+ "plugins" : [ "themes", "html_data", "cookies", "themes" ]
+ });
+ });
+ </script>
+ <script type="text/javascript">
+ var _gaq = _gaq || [];
+ _gaq.push(['_setAccount', 'UA-398545-1']);
+ _gaq.push(['_trackPageview']);
+
+ (function() {
+ var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
+ ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
+ var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
+ })();
+ </script>
+</head>
+<body>
+ <div id="page">
+ <div id="siteHeader">
+ <table width="100%">
+ <tr valign="middle">
+ <td align="left">
+ <a href="http://servicemix.apache.org/" title="An open source ESB">
+ <img border="0" src="../images/logodesign.png" height="80"/><img border="0" height="80" src="../images/new-logo.png" />
+ </a>
+ </td>
+ <td align="right">
+ <a href="http://www.apache.org/" title="The Apache Sofware Foundation">
+ <img border="0" height="60" src="../images/ASF-logo.png">
+ </a>
+ <ul class="siteNav">
+ <li><a href="../index.html" title="Overview">Guides Overview</a></li>
+ <li><a href="../contribute.html" title="Contributing?">Contributing?</a></li>
+ <li>
+ <form action="http://www.google.com/search" method="get" style="font-size: 10px;">
+ <input name="ie" type="hidden" value="UTF-8"></input>
+ <input name="oe" type="hidden" value="UTF-8"></input>
+ <input maxlength="255" name="q" size="15" type="text" value=""></input>
+ <input name="btnG" type="submit" value="Search"></input>
+ <input name="domains" type="hidden" value="servicemix.apache.org/docs/4.4.x"></input>
+ <input name="sitesearch" type="hidden" value="servicemix.apache.org/docs/4.4.x"></input>
+ </form>
+ </li>
+ </ul>
+ </td>
+ </tr>
+ </table>
+ </div>
+ <div id="content">
+ <div id="nav">
+ <ul>
+ <li id="introduction">
+ <a href="index.html">Introduction</a>
+ </li>
+ <li id="what-is-smx4">
+ <a href="what-is-smx4.html">What is (in) Apache ServiceMix?</a>
+ </li>
+ <li id="basic-commands">
+ <a href="technology-selection.html">Technology selection guidelines</a>
+ </li>
+</ul>
+ </div>
+ <div id="body">
+ <h2 id="WhatisServiceMix4">What is ServiceMix 4?</h2><p>Apache ServiceMix is an open source ESB (Enterprise Service Bus) that combines the functionality of a Service Oriented Architecture (SOA) and the modularity. The adoption of a Service Bus allows to decouple the applicatons together and reduce dependencies. Messages are used to wired the applications (=services) and/or connectors to exchange information using different protocols or communications mode like FTP, HTTP, WebServices, ...</p><p>This new version of Apache ServiceMix is more than an evolution of the previous as the kernel of the platform has been completety rewritten and is designed top of the OSGI specification. Using OSGI framework brings a new important feature for SOA development : modularity. That means that we can handle classloading and application lifecycle differently between the components.</p><p>ServiceMix is lightweight and easily embeddable, has integrated Spring support and can
be run at the edge of the network (inside a client or server), as a standalone ESB provider or as a service within another ESB. You can use ServiceMix in Java SE or Java EE application server.</p><h3 id="Platformpresentation">Platform presentation</h3><p>Apache ServiceMix is an distributed ESB built from the ground up on the Java Business Integration (JBI) specification JSR 208 and released under the Apache license. The goal of JBI is to allow components and services to be integrated in a vendor independent way, allowing users and vendors to plug and play.</p><p>ServiceMix uses ActiveMQ to provide remoting, clustering, reliability and distributed failover.</p><p>ServiceMix is completely integrated into Apache Geronimo, which allows you to deploy JBI components and services directly into Geronimo. ServiceMix is being JBI certified as part of the Geronimo project.</p><p>ServiceMix can be embedded into a JEE application server such as JBoss, Oracle Weblogic or IBM Websphere.</
p><p>ServiceMix includes a complete JBI container supporting all parts of the JBI specification including:</p><ul><li><p>NMR (Normalized Message Router)</para></p></li><li><p>JBI Management MBeans</p></li><li><p>full support for the JBI deployment units with hot-deployment of JBI components</p></li></ul><p>ServiceMix also provides a simple to use client API for working with JBI components and services.</p><p>ServiceMix includes many JBI components including HTTP, JMX, CXF, BPEL, etc.</p><h3 id="OSGiforDummies">OSGi for Dummies</h3><p><a href="http://www.osgi.org/About/Technology">OSGi technology</a> is the dynamic module system for <a href="http://www.oracle.com/technetwork/java/index.html">Java</a>. The OSGi Service Platform provides functionality to Java that makes Java the premier environment for software integration and thus for development. Java provides the portability that is required to support products on many different platforms. The OSGi technology provides the
standardized primitives that allow applications to be constructed from small, reusable and collaborative components. These components can be composed into an application and deployed.</p><p>The OSGi Service Platform provides the functions to change the composition dynamically on the device of a variety of networks, without requiring restarts. To minimize the coupling, as well as make these couplings managed, the OSGi technology provides a service-oriented architecture that enables these components to dynamically discover each other for collaboration. The OSGi Alliance has developed many standard component interfaces for common functions like HTTP servers, configuration, logging, security, user administration, XML and many more. Plug-compatible implementations of these components can be obtained from different vendors with different optimizations and costs. However, service interfaces can also be developed on a proprietary basis.</p><p>OSGi technology adopters benefit from i
mproved time-to-market and reduced development costs because OSGi technology provides for the integration of pre-built and pre-tested component subsystems. The technology also reduces maintenance costs and enables unique new aftermarket opportunities because components can be dynamically delivered to devices in the field.</p><p>For more information, check out the <a href="http://www.osgi.org/Main/HomePage">OSGi Alliance website</a></p><h3 id="PoweredbyApacheKaraf">Powered by Apache Karaf</h3><p>Apache ServiceMix is based on <a href="http://karaf.apache.org/">Apache Karaf</a>. Apache Karaf is a small <a href="http://www.osgi.org/Main/HomePage">OSGi-based</a> runtime which provides a lightweight container onto which various components and applications can be deployed.</p><p>Here is a short list of features supported by the Karaf:</p><p>Hot deployment: Karaf supports hot deployment of OSGi bundles by monitoring jar files inside the $home/deploy directory. Each time a jar is cop
ied in this folder, it will be installed inside the runtime. You can then update or delete it and changes will be handled automatically. In addition, the Karaf also supports exploded bundles and custom deployers (blueprint and spring ones are included by default).</p><p>Dynamic configuration: Services are usually configured through the ConfigurationAdmin OSGi service. Such configuration can be defined in Karaf using property files inside the $home/etc directory. These configurations are monitored and changes on the properties files will be propagated to the services.</p><p>Logging System: using a centralized logging back end supported by Log4J, Karaf supports a number of different APIs (JDK 1.4, JCL, SLF4J, Avalon, Tomcat, OSGi)</p><p>Provisioning: Provisioning of libraries or applications can be done through a number of different ways, by which they will be downloaded locally, installed and started.</p><p>Native OS integration: Karaf can be integrated into your own Operatin
g System as a service so that the lifecycle will be bound to your Operating System.</p><p>Extensible Shell console: Karaf features a nice text console where you can manage the services, install new applications or libraries and manage their state. This shell is easily extensible by deploying new commands dynamically along with new features or applications.</p><p>Remote access: use any SSH client to connect to Karaf and issue commands in the console </p><p>Security framework based on JAAS</p><p>Managing instances: Karaf provides simple commands for managing multiple instances. You can easily create, delete, start and stop instances of Karaf through the console.</p><p>For more information, check out the <a href="http://karaf.apache.org/">Apache Karaf project page</a></p><h3 id="JBIContainerampIntegrationwithOSGI">JBI Container &Integration with OSGI</h3><p>// TODO: write this bit</p><h3 id="NormalizedMessageRouter">Normalized Message Router</h3><p>The Normalized Message Ro
uter (NMR) is a general-purpose message bus used for communication between bundles in the OSGi container.<br/>It's modeled after the Normalized Message Router (NMR) defined in the Java Business Integration (JBI) specification (<a href="http://www.jcp.org/en/jsr/detail?id=208">http://www.jcp.org/en/jsr/detail?id=208</a>).</p><p>It can be used to transport XML messages as well as other message body types, optionally augumented with headers and attachments.</p><p>For more information, check out the <a href="../nmr/index.html">Using the Normalized Message Router User Guide</a></p><h3 id="ApacheCamel">Apache Camel</h3><p>Apache Camel is a powerful open source integration framework based on known <a href="http://camel.apache.org/enterprise-integration-patterns.html">Enterprise Integration Patterns</a> with powerful <a href="http://camel.apache.org/bean-integration.html">Bean Integration</a>.</p><p>Apache Camel lets you create the <a href="http://camel.apache.org/enterprise-integra
tion-patterns.html">Enterprise Integration Patterns</a> to implement routing and mediation rules in either a Java based <a href="http://camel.apache.org/dsl.html">Domain Specific Language (or Fluent API)</a>, via <a href="http://camel.apache.org/spring.html">Spring based Xml Configuration</a> files or via the <a href="http://camel.apache.org/scala-dsl.html">Scala DSL</a>.</p><p>For more information, check out the <a href="../camel/index.html">Using Apache Camel in ServiceMix User Guide</a>.</p><h3 id="Servicesproposed">Services proposed</h3><p>// TODO: write this bit</p><h4 id="MessageBrokerApacheActiveMQ">Message Broker : Apache ActiveMQ</h4><p>Apache ServiceMix ships with an embedded instance of <a href="http://activemq.apache.org">Apache ActiveMQ</a> out-of-the-box.</p><p>It is a fully functional Apache ActiveMQ message broker instance listening for <a href="http://activemq.apache.org/openwire.html">TCP</a> connections on port 61616 and <a href="http://activemq.apache.org
/stomp.html">STOMP</a> connections on port 61613.</p><p>The <a href="http://activemq.apache.org/xml-configuration.html">default configuration for the Apache ActiveMQ</a> message broker resides in the ServiceMix installation directory under the etc sub-directory. The ActiveMQ configuration file is named activemq-broker.xml. It's configured with reasonable default information like <a href="http://activemq.apache.org/persistence.html">Persistence (KahaDB)</a> and <a href="http://activemq.apache.org/producer-flow-control.html">Producer Flow Control</a> (essentially to make sure the broker does not run out of memory).</p><p>The configuration file also makes use of a reusable connection pool available to all OSGi bundles exposing a <a href="http://docs.oracle.com/javaee/1.4/api/javax/jms/ConnectionFactory.html">javax.jms.ConnectionFactory</a> as a service for consumption. You can re-use this connection pool via tools such as <a href="http://activemq.apache.org/osgi-integration.htm
l">spring-dm or blueprint</a>.</p><p>The ActiveMQ message broker allows several components such as servicemix-cluster, <a href="http://camel.apache.org/jms.html">camel-jms</a>, <a href="http://camel.apache.org/activemq.html">camel-activemq</a>, <a href="http://cxf.apache.org/docs/jms-transport.html">cxf-jms transport</a> to be utilized without any additional configuration.</p><h4 id="TransactionGeronimoTransactionManager">Transaction : Geronimo Transaction Manager</h4><p>// TODO: write this bit</p><h4 id="RoutingandMediationApacheCamel">Routing and Mediation : Apache Camel</h4><h4 id="WebServicesApacheCXF">Web Services : Apache CXF</h4><p>// TODO: write this bit</p><h4 id="WebContainer">Web Container</h4><p>// TODO: write this bit</p><h4 id="SOAplatform">SOA platform</h4><p>// TODO: write this bit</p><h5 id="SpringDMcontainer">Spring DM container</h5><p>// TODO: write this bit</p><h5 id="BlueprintOSGIcontainer">Blueprint OSGI container</h5><p>// TODO: write this bit</p><h5 i
d="EJBContainer">EJB Container</h5><p>// TODO: write this bit</p>
+ </div>
+
+ </div>
+ <div id="siteFooter">
+ © 2008-2012 The Apache Software Foundation - <a href="http://servicemix.apache.org/site/privacy-policy.html">Privacy Policy</a>
+ <br/>
+ Apache ServiceMix, ServiceMix, Apache, the Apache feather logo, and the Apache ServiceMix project logo are trademarks of The Apache Software Foundation.
+ </div>
+ </div>
+</body>
+</html>
\ No newline at end of file
Added: servicemix/site/production/docs/4.4.x/users-guide/child-instances.html
URL: http://svn.apache.org/viewvc/servicemix/site/production/docs/4.4.x/users-guide/child-instances.html?rev=1444219&view=auto
==============================================================================
--- servicemix/site/production/docs/4.4.x/users-guide/child-instances.html (added)
+++ servicemix/site/production/docs/4.4.x/users-guide/child-instances.html Fri Feb 8 20:35:02 2013
@@ -0,0 +1,183 @@
+
+<!DOCTYPE html>
+<html>
+<head>
+ <title>Apache ServiceMix Documentation - </title>
+
+ <link href="../theme/master.css" rel="stylesheet" type="text/css" />
+ <link href="../theme/pygmentize.css" rel="stylesheet" type="text/css" />
+
+ <script type="text/javascript" src="../scripts/jquery.js"></script>
+ <script type="text/javascript" src="../scripts/jquery.cookie.js"></script>
+ <script type="text/javascript" src="../scripts/jquery.jstree.js"></script>
+
+ <script>
+ $(document).ready(function(){
+ $("#nav").jstree({
+ "themes": {
+ "theme": "apple", "dots": false
+ },
+ "plugins" : [ "themes", "html_data", "cookies", "themes" ]
+ });
+ });
+ </script>
+ <script type="text/javascript">
+ var _gaq = _gaq || [];
+ _gaq.push(['_setAccount', 'UA-398545-1']);
+ _gaq.push(['_trackPageview']);
+
+ (function() {
+ var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
+ ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
+ var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
+ })();
+ </script>
+</head>
+<body>
+ <div id="page">
+ <div id="siteHeader">
+ <table width="100%">
+ <tr valign="middle">
+ <td align="left">
+ <a href="http://servicemix.apache.org/" title="An open source ESB">
+ <img border="0" src="../images/logodesign.png" height="80"/><img border="0" height="80" src="../images/new-logo.png" />
+ </a>
+ </td>
+ <td align="right">
+ <a href="http://www.apache.org/" title="The Apache Sofware Foundation">
+ <img border="0" height="60" src="../images/ASF-logo.png">
+ </a>
+ <ul class="siteNav">
+ <li><a href="../index.html" title="Overview">Guides Overview</a></li>
+ <li><a href="../contribute.html" title="Contributing?">Contributing?</a></li>
+ <li>
+ <form action="http://www.google.com/search" method="get" style="font-size: 10px;">
+ <input name="ie" type="hidden" value="UTF-8"></input>
+ <input name="oe" type="hidden" value="UTF-8"></input>
+ <input maxlength="255" name="q" size="15" type="text" value=""></input>
+ <input name="btnG" type="submit" value="Search"></input>
+ <input name="domains" type="hidden" value="servicemix.apache.org/docs/4.4.x"></input>
+ <input name="sitesearch" type="hidden" value="servicemix.apache.org/docs/4.4.x"></input>
+ </form>
+ </li>
+ </ul>
+ </td>
+ </tr>
+ </table>
+ </div>
+ <div id="content">
+ <div id="nav">
+ <ul>
+ <li id="karaf-users-guide">
+ <a href="#">User's Guide</a>
+ <ul>
+ <li id="karaf-installation">
+ <a href="installation.html">Installation</a>
+ </li>
+ <li id="karaf-directory-structure">
+ <a href="directory-structure.html">Directory structure</a>
+ </li>
+ <li id="karaf-starting-and-stopping">
+ <a href="start-stop.html">Starting and stopping Karaf</a>
+ </li>
+ <li id="using-console">
+ <a href="using-console.html">Using the console</a>
+ </li>
+ <li id="web-console">
+ <a href="web-console.html">Web console</a>
+ </li>
+ <li id="remote-console">
+ <a href="remote-console.html">Remote console</a>
+ </li>
+ <li id="child-instances">
+ <a href="child-instances.html">Child instances</a>
+ </li>
+ <li id="security">
+ <a href="security.html">Security</a>
+ </li>
+ <li id="failover">
+ <a href="failover.html">Failover deployments</a>
+ </li>
+ <li id="logging-system">
+ <a href="logging-system.html">Logging system</a>
+ </li>
+ <li id="deployer">
+ <a href="deployer.html">Deployer</a>
+ </li>
+ <li id="configuration">
+ <a href="configuration.html">Configuration</a>
+ </li>
+ </ul>
+ </li>
+</ul>
+
+ </div>
+ <div id="body">
+ <h1 id="Managingchildinstances">Managing child instances</h1><p>A child instance of Karaf is a copy that you can launch separately and deploy applications into. An instance does not contain the full copy of Karaf, but only a copy of the configuration files and data folder which contains all the runtime information, logs and temporary files.</p><h2 id="Usingtheadminconsolecommands">Using the admin console commands</h2><p>The <strong>admin</strong> console commands allow you to create and manage instances of Karaf on the same machine. Each new runtime is a child instance of the runtime that created it. You can easily manage the children using names instead of network addresses. For details on the <strong>admin</strong> commands, see the <a href="../commands/admin.html"><tt>admin</tt> commands</a>.</p> <h2 id="Creatingchildinstances">Creating child instances</h2><p>You create a new runtime instance by typing <a href="../commands/admin-create.html"><tt>a
dmin:create</tt></a> in the Karaf console.</p><p>As shown in the following example, <tt>admin:create</tt> causes the runtime to create a new runtime installation in the active runtime's {{instances/<a href="name.html">name</a>} directory. The new instance is a new Karaf instance and is assigned an SSH port number based on an incremental count starting at 8101 and a RMI registry port number based on an incremental count starting at 1099.</p><pre>
+karaf@root> admin:create finn
+Creating new instance on SSH port 8106 and RMI port 1100 at: /home/fuse/esb4/instances/finn
+Creating dir: /home/fuse/esb4/instances/finn/bin
+Creating dir: /home/fuse/esb4/instances/finn/etc
+Creating dir: /home/fuse/esb4/instances/finn/system
+Creating dir: /home/fuse/esb4/instances/finn/deploy
+Creating dir: /home/fuse/esb4/instances/finn/data
+Creating file: /home/fuse/esb4/instances/finn/etc/config.properties
+Creating file: /home/fuse/esb4/instances/finn/etc/java.util.logging.properties
+Creating file: /home/fuse/esb4/instances/finn/etc/org.apache.felix.fileinstall-deploy.cfg
+Creating file: /home/fuse/esb4/instances/finn/etc/org.apache.karaf.log.cfg
+Creating file: /home/fuse/esb4/instances/finn/etc/org.apache.karaf.features.cfg
+Creating file: /home/fuse/esb4/instances/finn/etc/org.ops4j.pax.logging.cfg
+Creating file: /home/fuse/esb4/instances/finn/etc/org.ops4j.pax.url.mvn.cfg
+Creating file: /home/fuse/esb4/instances/finn/etc/startup.properties
+Creating file: /home/fuse/esb4/instances/finn/etc/system.properties
+Creating file: /home/fuse/esb4/instances/finn/etc/org.apache.karaf.shell.cfg
+Creating file: /home/fuse/esb4/instances/finn/etc/org.apache.karaf.management.cfg
+Creating file: /home/fuse/esb4/instances/finn/bin/karaf
+Creating file: /home/fuse/esb4/instances/finn/bin/start
+Creating file: /home/fuse/esb4/instances/finn/bin/stop
+karaf@root>
+</pre><h2 id="Changingachildsports">Changing a child's ports</h2><p>You can change the SSH port number assigned to a child instance using the <a href="../commands/admin-change-port.html"><tt>admin:change-ssh-port</tt></a> command. The syntax for the command is:</p><pre>
+admin:change-ssh-port instance port
+</pre><p>Note that the child instance has to be stopped in order to run this command.</p><p>In the same way, you can change the RMI registry port number assigned to a child instance using the <a href="../commands/admin-change-rmi-registry-port.html"><tt>admin:change-rmi-registry-port</tt></a> command. The syntax for the command is:</p><pre>
+admin:change-rmi-registry-port instance port
+</pre><p>Note that the child instance has to be stopped in order to run this command.</p><h2 id="Startingchildinstances">Starting child instances</h2><p>New instances are created in a stopped state. To start a child instance and make it ready to host applications, use the <a href="../commands/admin-start.html"><tt>admin:start</tt></a> command. This command takes a single argument <tt><a href="instance-name.html">instance-name</a></tt> that identifies the child you want started.</p><h2 id="Listingallcontainerinstances">Listing all container instances</h2><p>To see a list of all Karaf instances running under a particular installation, use the <a href="../commands/admin-list.html"><tt>admin:list</tt></a> command.</p><pre>
+karaf@root>admin:list
+ SSH Port RMI Port State Pid Name
+[ 8107] [ 1106] [Started ] [10628] harry
+[ 8101] [ 1099] [Started ] [20076] root
+[ 8106] [ 1105] [Stopped ] [15924] dick
+[ 8105] [ 1104] [Started ] [18224] tom
+karaf@root>
+</pre><h2 id="Connectingtoachildinstance">Connecting to a child instance</h2><p>You can connect to a started child instance's remote console using the <a href="../commands/admin-connect.html"><tt>admin:connect</tt></a> command which takes three arguments:</p><pre>
+admin:connect [-u username] [-p password] instance
+</pre><p>Once you are connected to the child instance, the Karaf prompt changes to display the name of the current instance, as shown:</p><pre>
+karaf@harry>
+</pre><h2 id="Stoppingachildinstance">Stopping a child instance</h2><p>To stop a child instance from within the instance itself, type <tt>osgi:shutdown</tt> or simply <tt>shutdown</tt>.</p><p>To stop a child instance remotely, in other words, from a parent or sibling instance, use the <a href="../commands/admin-stop.html"><tt>admin:stop</tt></a>:</p><pre>
+admin:stop instance
+</pre><h2 id="Destroyingachildinstance">Destroying a child instance</h2><p>You can permanently delete a stopped child instance using the <a href="../commands/admin-destroy.html"><tt>admin:destroy</tt></a> command:</p><pre>
+admin:destroy instance
+</pre><p>Note that only stopped instances can be destroyed.</p><h2 id="Usingtheadminscript">Using the admin script</h2><p>You can also manage the local instances of Karaf. The <tt>admin</tt> script in the <tt><a href="karaf-install-dir.html">karaf-install-dir</a>/bin</tt> directory provides the same commands as the <tt>admin</tt> console commands, apart from <a href="../commands/admin-connect.html"><tt>admin:connect</tt></a>.</p> <pre>
+> bin/admin
+Available commands:
+ change-ssh-port - Changes the secure shell port of an existing container instance.
+ change-rmi-registry-port - Changes the RMI registry port (used by management layer) of an existing container instance.
+ create - Creates a new container instance.
+ destroy - Destroys an existing container instance.
+ list - List all existing container instances.
+ start - Starts an existing container instance.
+ stop - Stops an existing container instance.
+Type 'command --help' for more help on the specified command.
+</pre><p>For example, to list all the instances of Karaf on the local machine, type:</p><pre>
+bin/admin list
+</pre>
+ </div>
+
+ </div>
+ <div id="siteFooter">
+ © 2008-2012 The Apache Software Foundation - <a href="http://servicemix.apache.org/site/privacy-policy.html">Privacy Policy</a>
+ <br/>
+ Apache ServiceMix, ServiceMix, Apache, the Apache feather logo, and the Apache ServiceMix project logo are trademarks of The Apache Software Foundation.
+ </div>
+ </div>
+</body>
+</html>
\ No newline at end of file
Added: servicemix/site/production/docs/4.4.x/users-guide/colorized-console.html
URL: http://svn.apache.org/viewvc/servicemix/site/production/docs/4.4.x/users-guide/colorized-console.html?rev=1444219&view=auto
==============================================================================
--- servicemix/site/production/docs/4.4.x/users-guide/colorized-console.html (added)
+++ servicemix/site/production/docs/4.4.x/users-guide/colorized-console.html Fri Feb 8 20:35:02 2013
@@ -0,0 +1,133 @@
+
+<!DOCTYPE html>
+<html>
+<head>
+ <title>Apache ServiceMix Documentation - </title>
+
+ <link href="../theme/master.css" rel="stylesheet" type="text/css" />
+ <link href="../theme/pygmentize.css" rel="stylesheet" type="text/css" />
+
+ <script type="text/javascript" src="../scripts/jquery.js"></script>
+ <script type="text/javascript" src="../scripts/jquery.cookie.js"></script>
+ <script type="text/javascript" src="../scripts/jquery.jstree.js"></script>
+
+ <script>
+ $(document).ready(function(){
+ $("#nav").jstree({
+ "themes": {
+ "theme": "apple", "dots": false
+ },
+ "plugins" : [ "themes", "html_data", "cookies", "themes" ]
+ });
+ });
+ </script>
+ <script type="text/javascript">
+ var _gaq = _gaq || [];
+ _gaq.push(['_setAccount', 'UA-398545-1']);
+ _gaq.push(['_trackPageview']);
+
+ (function() {
+ var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
+ ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
+ var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
+ })();
+ </script>
+</head>
+<body>
+ <div id="page">
+ <div id="siteHeader">
+ <table width="100%">
+ <tr valign="middle">
+ <td align="left">
+ <a href="http://servicemix.apache.org/" title="An open source ESB">
+ <img border="0" src="../images/logodesign.png" height="80"/><img border="0" height="80" src="../images/new-logo.png" />
+ </a>
+ </td>
+ <td align="right">
+ <a href="http://www.apache.org/" title="The Apache Sofware Foundation">
+ <img border="0" height="60" src="../images/ASF-logo.png">
+ </a>
+ <ul class="siteNav">
+ <li><a href="../index.html" title="Overview">Guides Overview</a></li>
+ <li><a href="../contribute.html" title="Contributing?">Contributing?</a></li>
+ <li>
+ <form action="http://www.google.com/search" method="get" style="font-size: 10px;">
+ <input name="ie" type="hidden" value="UTF-8"></input>
+ <input name="oe" type="hidden" value="UTF-8"></input>
+ <input maxlength="255" name="q" size="15" type="text" value=""></input>
+ <input name="btnG" type="submit" value="Search"></input>
+ <input name="domains" type="hidden" value="servicemix.apache.org/docs/4.4.x"></input>
+ <input name="sitesearch" type="hidden" value="servicemix.apache.org/docs/4.4.x"></input>
+ </form>
+ </li>
+ </ul>
+ </td>
+ </tr>
+ </table>
+ </div>
+ <div id="content">
+ <div id="nav">
+ <ul>
+ <li id="karaf-users-guide">
+ <a href="#">User's Guide</a>
+ <ul>
+ <li id="karaf-installation">
+ <a href="installation.html">Installation</a>
+ </li>
+ <li id="karaf-directory-structure">
+ <a href="directory-structure.html">Directory structure</a>
+ </li>
+ <li id="karaf-starting-and-stopping">
+ <a href="start-stop.html">Starting and stopping Karaf</a>
+ </li>
+ <li id="using-console">
+ <a href="using-console.html">Using the console</a>
+ </li>
+ <li id="web-console">
+ <a href="web-console.html">Web console</a>
+ </li>
+ <li id="remote-console">
+ <a href="remote-console.html">Remote console</a>
+ </li>
+ <li id="child-instances">
+ <a href="child-instances.html">Child instances</a>
+ </li>
+ <li id="security">
+ <a href="security.html">Security</a>
+ </li>
+ <li id="failover">
+ <a href="failover.html">Failover deployments</a>
+ </li>
+ <li id="logging-system">
+ <a href="logging-system.html">Logging system</a>
+ </li>
+ <li id="deployer">
+ <a href="deployer.html">Deployer</a>
+ </li>
+ <li id="configuration">
+ <a href="configuration.html">Configuration</a>
+ </li>
+ </ul>
+ </li>
+</ul>
+
+ </div>
+ <div id="body">
+ <h1 id="EnablingColorizedConsoleonWindows">Enabling Colorized Console on Windows</h1><p>The default Karaf installation does not produce colorized console output on Windows like it does on Unix based systems. To enable it, you must install LGPL licensed library <a href="https://jna.dev.java.net/">JNA</a>. This can be done using a few simple commands in the Karaf console:</p><p>You first need to install the JNA library:</p><pre>
+karaf@root> osgi:install wrap:mvn:http://download.java.net/maven/2!net.java.dev.jna/jna/3.1.0
+</pre><p>Next you need either restart karaf or you run the following Karaf commands to refresh the Karaf Console:</p><pre>
+karaf@root> osgi:list | grep "Apache Karaf :: Shell Console"
+</pre><p>Take note of the ID of the bundle, in my case it was 14 and then run:</p><pre>
+osgi:refresh 14
+</pre><div class="warning" style="border: 1px solid #c00;background-color: #fcc;margin: 20px;padding: 0px 6px 0px 6px;"><p>TODO: refactor that using a nicer script to find the correct bundle</p></div>
+ </div>
+
+ </div>
+ <div id="siteFooter">
+ © 2008-2012 The Apache Software Foundation - <a href="http://servicemix.apache.org/site/privacy-policy.html">Privacy Policy</a>
+ <br/>
+ Apache ServiceMix, ServiceMix, Apache, the Apache feather logo, and the Apache ServiceMix project logo are trademarks of The Apache Software Foundation.
+ </div>
+ </div>
+</body>
+</html>
\ No newline at end of file
Added: servicemix/site/production/docs/4.4.x/users-guide/configuration.html
URL: http://svn.apache.org/viewvc/servicemix/site/production/docs/4.4.x/users-guide/configuration.html?rev=1444219&view=auto
==============================================================================
--- servicemix/site/production/docs/4.4.x/users-guide/configuration.html (added)
+++ servicemix/site/production/docs/4.4.x/users-guide/configuration.html Fri Feb 8 20:35:02 2013
@@ -0,0 +1,129 @@
+
+<!DOCTYPE html>
+<html>
+<head>
+ <title>Apache ServiceMix Documentation - </title>
+
+ <link href="../theme/master.css" rel="stylesheet" type="text/css" />
+ <link href="../theme/pygmentize.css" rel="stylesheet" type="text/css" />
+
+ <script type="text/javascript" src="../scripts/jquery.js"></script>
+ <script type="text/javascript" src="../scripts/jquery.cookie.js"></script>
+ <script type="text/javascript" src="../scripts/jquery.jstree.js"></script>
+
+ <script>
+ $(document).ready(function(){
+ $("#nav").jstree({
+ "themes": {
+ "theme": "apple", "dots": false
+ },
+ "plugins" : [ "themes", "html_data", "cookies", "themes" ]
+ });
+ });
+ </script>
+ <script type="text/javascript">
+ var _gaq = _gaq || [];
+ _gaq.push(['_setAccount', 'UA-398545-1']);
+ _gaq.push(['_trackPageview']);
+
+ (function() {
+ var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
+ ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
+ var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
+ })();
+ </script>
+</head>
+<body>
+ <div id="page">
+ <div id="siteHeader">
+ <table width="100%">
+ <tr valign="middle">
+ <td align="left">
+ <a href="http://servicemix.apache.org/" title="An open source ESB">
+ <img border="0" src="../images/logodesign.png" height="80"/><img border="0" height="80" src="../images/new-logo.png" />
+ </a>
+ </td>
+ <td align="right">
+ <a href="http://www.apache.org/" title="The Apache Sofware Foundation">
+ <img border="0" height="60" src="../images/ASF-logo.png">
+ </a>
+ <ul class="siteNav">
+ <li><a href="../index.html" title="Overview">Guides Overview</a></li>
+ <li><a href="../contribute.html" title="Contributing?">Contributing?</a></li>
+ <li>
+ <form action="http://www.google.com/search" method="get" style="font-size: 10px;">
+ <input name="ie" type="hidden" value="UTF-8"></input>
+ <input name="oe" type="hidden" value="UTF-8"></input>
+ <input maxlength="255" name="q" size="15" type="text" value=""></input>
+ <input name="btnG" type="submit" value="Search"></input>
+ <input name="domains" type="hidden" value="servicemix.apache.org/docs/4.4.x"></input>
+ <input name="sitesearch" type="hidden" value="servicemix.apache.org/docs/4.4.x"></input>
+ </form>
+ </li>
+ </ul>
+ </td>
+ </tr>
+ </table>
+ </div>
+ <div id="content">
+ <div id="nav">
+ <ul>
+ <li id="karaf-users-guide">
+ <a href="#">User's Guide</a>
+ <ul>
+ <li id="karaf-installation">
+ <a href="installation.html">Installation</a>
+ </li>
+ <li id="karaf-directory-structure">
+ <a href="directory-structure.html">Directory structure</a>
+ </li>
+ <li id="karaf-starting-and-stopping">
+ <a href="start-stop.html">Starting and stopping Karaf</a>
+ </li>
+ <li id="using-console">
+ <a href="using-console.html">Using the console</a>
+ </li>
+ <li id="web-console">
+ <a href="web-console.html">Web console</a>
+ </li>
+ <li id="remote-console">
+ <a href="remote-console.html">Remote console</a>
+ </li>
+ <li id="child-instances">
+ <a href="child-instances.html">Child instances</a>
+ </li>
+ <li id="security">
+ <a href="security.html">Security</a>
+ </li>
+ <li id="failover">
+ <a href="failover.html">Failover deployments</a>
+ </li>
+ <li id="logging-system">
+ <a href="logging-system.html">Logging system</a>
+ </li>
+ <li id="deployer">
+ <a href="deployer.html">Deployer</a>
+ </li>
+ <li id="configuration">
+ <a href="configuration.html">Configuration</a>
+ </li>
+ </ul>
+ </li>
+</ul>
+
+ </div>
+ <div id="body">
+ <h1 id="Configuration">Configuration</h1><p>The files in the <tt>etc</tt> directory are used to set the startup configuration. </p><p>For dynamic configuration, Karaf provides a suite of command to administer the configuration service grouped under <tt>config</tt>. To learn about all currently supported configuration commands type:</p><div class="table-wrap"><table class="confluenceTable"><tr><th class="confluenceTh"> Command </th><th class="confluenceTh"> Description </th></tr><tr><td class="confluenceTd"> <a href="../commands/config-cancel.html"><tt>cancel</tt></a> </td><td class="confluenceTd"> Change the changes to the configuration being edited. </td></tr><tr><td class="confluenceTd"> <a href="../commands/config-edit.html"><tt>edit</tt></a> </td><td class="confluenceTd"> Create or edit a configuration. </td></tr><tr><td class="confluenceTd"> <a href="../commands/config-list.html"><tt>list</tt></a>
</td><td class="confluenceTd"> List existing configurations. </td></tr><tr><td class="confluenceTd"> <a href="../commands/config-propdel.html"><tt>propdel</tt></a> </td><td class="confluenceTd"> Delete a property from the edited configuration. </td></tr><tr><td class="confluenceTd"> <a href="../commands/config-proplist.html"><tt>proplist</tt></a> </td><td class="confluenceTd"> List properties from the edited configuration. </td></tr><tr><td class="confluenceTd"> <a href="../commands/config-propset.html"><tt>propset</tt></a> </td><td class="confluenceTd"> Set a property on the edited configuration. </td></tr><tr><td class="confluenceTd"> <a href="../commands/config-update.html"><tt>update</tt></a> </td><td class="confluenceTd"> Save and propagate changes from the configuration being edited. </td></tr></table></div><h2 id="Editing">Editing</h2><h3 id="SelectConfigurationToEdit">Select Configuration To Edit</h3><p>For example to edit configuration <tt>foo.bar</tt>:</p>
<pre>
+karaf@root> config:edit foo.bar
+</pre><h3 id="ModifyProperties">Modify Properties</h3><p>Use:</p> <p> * <a href="../commands/config-proplist.html"><tt>config:proplist</tt></a> to list existing properties<br/> * <a href="../commands/config-propdel.html"><tt>config:propdel</tt></a> to delete existing properties<br/> * <a href="../commands/config-propset.html"><tt>config:propset</tt></a> to set a new value for a property</p><p>Any number of properties can be modified within a single editing session. </p><h3 id="CommitOrRollbackChanges">Commit Or Rollback Changes</h3><p>Use</p><p> * <a href="../commands/config-update.html"><tt>config:update</tt></a> to commit all changes made in the current session<br/> * <a href="../commands/config-cancel.html"><tt>config:cancel</tt></a> to roll back any changes made in the current session</p>
+ </div>
+
+ </div>
+ <div id="siteFooter">
+ © 2008-2012 The Apache Software Foundation - <a href="http://servicemix.apache.org/site/privacy-policy.html">Privacy Policy</a>
+ <br/>
+ Apache ServiceMix, ServiceMix, Apache, the Apache feather logo, and the Apache ServiceMix project logo are trademarks of The Apache Software Foundation.
+ </div>
+ </div>
+</body>
+</html>
\ No newline at end of file
Added: servicemix/site/production/docs/4.4.x/users-guide/deployer.html
URL: http://svn.apache.org/viewvc/servicemix/site/production/docs/4.4.x/users-guide/deployer.html?rev=1444219&view=auto
==============================================================================
--- servicemix/site/production/docs/4.4.x/users-guide/deployer.html (added)
+++ servicemix/site/production/docs/4.4.x/users-guide/deployer.html Fri Feb 8 20:35:02 2013
@@ -0,0 +1,236 @@
+
+<!DOCTYPE html>
+<html>
+<head>
+ <title>Apache ServiceMix Documentation - </title>
+
+ <link href="../theme/master.css" rel="stylesheet" type="text/css" />
+ <link href="../theme/pygmentize.css" rel="stylesheet" type="text/css" />
+
+ <script type="text/javascript" src="../scripts/jquery.js"></script>
+ <script type="text/javascript" src="../scripts/jquery.cookie.js"></script>
+ <script type="text/javascript" src="../scripts/jquery.jstree.js"></script>
+
+ <script>
+ $(document).ready(function(){
+ $("#nav").jstree({
+ "themes": {
+ "theme": "apple", "dots": false
+ },
+ "plugins" : [ "themes", "html_data", "cookies", "themes" ]
+ });
+ });
+ </script>
+ <script type="text/javascript">
+ var _gaq = _gaq || [];
+ _gaq.push(['_setAccount', 'UA-398545-1']);
+ _gaq.push(['_trackPageview']);
+
+ (function() {
+ var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
+ ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
+ var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
+ })();
+ </script>
+</head>
+<body>
+ <div id="page">
+ <div id="siteHeader">
+ <table width="100%">
+ <tr valign="middle">
+ <td align="left">
+ <a href="http://servicemix.apache.org/" title="An open source ESB">
+ <img border="0" src="../images/logodesign.png" height="80"/><img border="0" height="80" src="../images/new-logo.png" />
+ </a>
+ </td>
+ <td align="right">
+ <a href="http://www.apache.org/" title="The Apache Sofware Foundation">
+ <img border="0" height="60" src="../images/ASF-logo.png">
+ </a>
+ <ul class="siteNav">
+ <li><a href="../index.html" title="Overview">Guides Overview</a></li>
+ <li><a href="../contribute.html" title="Contributing?">Contributing?</a></li>
+ <li>
+ <form action="http://www.google.com/search" method="get" style="font-size: 10px;">
+ <input name="ie" type="hidden" value="UTF-8"></input>
+ <input name="oe" type="hidden" value="UTF-8"></input>
+ <input maxlength="255" name="q" size="15" type="text" value=""></input>
+ <input name="btnG" type="submit" value="Search"></input>
+ <input name="domains" type="hidden" value="servicemix.apache.org/docs/4.4.x"></input>
+ <input name="sitesearch" type="hidden" value="servicemix.apache.org/docs/4.4.x"></input>
+ </form>
+ </li>
+ </ul>
+ </td>
+ </tr>
+ </table>
+ </div>
+ <div id="content">
+ <div id="nav">
+ <ul>
+ <li id="karaf-users-guide">
+ <a href="#">User's Guide</a>
+ <ul>
+ <li id="karaf-installation">
+ <a href="installation.html">Installation</a>
+ </li>
+ <li id="karaf-directory-structure">
+ <a href="directory-structure.html">Directory structure</a>
+ </li>
+ <li id="karaf-starting-and-stopping">
+ <a href="start-stop.html">Starting and stopping Karaf</a>
+ </li>
+ <li id="using-console">
+ <a href="using-console.html">Using the console</a>
+ </li>
+ <li id="web-console">
+ <a href="web-console.html">Web console</a>
+ </li>
+ <li id="remote-console">
+ <a href="remote-console.html">Remote console</a>
+ </li>
+ <li id="child-instances">
+ <a href="child-instances.html">Child instances</a>
+ </li>
+ <li id="security">
+ <a href="security.html">Security</a>
+ </li>
+ <li id="failover">
+ <a href="failover.html">Failover deployments</a>
+ </li>
+ <li id="logging-system">
+ <a href="logging-system.html">Logging system</a>
+ </li>
+ <li id="deployer">
+ <a href="deployer.html">Deployer</a>
+ </li>
+ <li id="configuration">
+ <a href="configuration.html">Configuration</a>
+ </li>
+ </ul>
+ </li>
+</ul>
+
+ </div>
+ <div id="body">
+ <h1 id="Deployer">Deployer</h1><p>The following picture describes the architecture of the deployer.</p><p><img border="0" src="../images/deployer.png"/></p><h2 id="Springdeployer">Spring deployer</h2><p>Karaf includes a deployer that is able to deploy plain blueprint or spring-dm configuration files.<br/>The deployer will transform on the fly any spring configuration file dropped into the <tt>deploy</tt> folder into a valid OSGi bundle.</p><p>The generated OSGi manifest will contain the following headers:</p><pre>
+Manifest-Version: 2
+Bundle-SymbolicName: [name of the file]
+Bundle-Version: [version of the file]
+Spring-Context: *;publish-context:=false;create-asynchronously:=true
+Import-Package: [required packages]
+DynamicImport-Package: *
+</pre><p>The <tt>name</tt> and <tt>version</tt> of the file are extracted using a heuristic that will match common patterns. For example <tt>my-config-1.0.1.xml</tt> will lead to <tt>name = my-config</tt> and <tt>version = 1.0.1</tt>.<br/>The default imported packages are extracted from the spring file definition and includes all classes referenced directly.</p><p>If you need to customize the generated manifest, you can do so by including an xml element in your spring configuration:</p><pre>
+<spring:beans ...>
+ <manifest>
+ Require-Bundle= my-bundle
+ </manifest>
+</pre><h2 id="Featuresdeployer">Features deployer</h2><p>To be able to hot deploy features from the deploy folder, you can just drop a feature descriptor on that folder. A bundle will be created and its installation (automatic) will trigger the installation of all features contained in the descriptor. Removing the file from the deploy folder will uninstall the features.<br/>If you want to install a single feature, you can do so by writing a feature descriptor like the following:</p><pre>
+<features>
+ <repository>mvn:org.apache.servicemix.nmr/apache-servicemix-nmr/1.0.0/xml/features</repository>
+ <feature name="nmr-only">
+ <feature>nmr</feature>
+ </feature>
+</features>
+</pre><p>For more informations about features, see the <a href="provisioning.html">provisioning section</a>.</p><h2 id="Wardeployer">War deployer</h2><p>To be able to hot deploy web application (war) from the deploy folder, you have to install the war feature:</p><pre>
+karaf@root> features:install war
+</pre><p>NB: you can use the -v or --verbose option to see exactly what is performed by the feature deployer.</p><pre>
+karaf@root> features:install -v war
+Installing feature war 2.1.99-SNAPSHOT
+Installing feature http 2.1.99-SNAPSHOT
+Installing feature jetty 7.2.2.v20101205
+Installing bundle mvn:org.apache.geronimo.specs/geronimo-servlet_2.5_spec/1.1.2
+Found installed bundle: org.apache.servicemix.bundles.asm [9]
+Installing bundle mvn:org.eclipse.jetty/jetty-util/7.2.2.v20101205
+Installing bundle mvn:org.eclipse.jetty/jetty-io/7.2.2.v20101205
+Installing bundle mvn:org.eclipse.jetty/jetty-http/7.2.2.v20101205
+Installing bundle mvn:org.eclipse.jetty/jetty-continuation/7.2.2.v20101205
+Installing bundle mvn:org.eclipse.jetty/jetty-server/7.2.2.v20101205
+Installing bundle mvn:org.eclipse.jetty/jetty-security/7.2.2.v20101205
+Installing bundle mvn:org.eclipse.jetty/jetty-servlet/7.2.2.v20101205
+Installing bundle mvn:org.eclipse.jetty/jetty-xml/7.2.2.v20101205
+Checking configuration file mvn:org.apache.karaf/apache-karaf/2.1.99-SNAPSHOT/xml/jettyconfig
+Installing bundle mvn:org.ops4j.pax.web/pax-web-api/1.0.0
+Installing bundle mvn:org.ops4j.pax.web/pax-web-spi/1.0.0
+Installing bundle mvn:org.ops4j.pax.web/pax-web-runtime/1.0.0
+Installing bundle mvn:org.ops4j.pax.web/pax-web-jetty/1.0.0
+Installing bundle mvn:org.apache.karaf.shell/org.apache.karaf.shell.web/2.1.99-SNAPSHOT
+Installing bundle mvn:org.ops4j.pax.web/pax-web-jsp/1.0.0
+Installing bundle mvn:org.ops4j.pax.web/pax-web-extender-war/1.0.0
+Installing bundle mvn:org.ops4j.pax.web/pax-web-extender-whiteboard/1.0.0
+Installing bundle mvn:org.ops4j.pax.web/pax-web-deployer/1.0.0
+Installing bundle mvn:org.ops4j.pax.url/pax-url-war/1.2.5
+</pre><p>As you can see, the war feature uses PAX Web as war deployer.</p><p>You should now be able to see the PAX Web war deployer:</p><pre>
+karaf@root> osgi:list |grep -i war
+[ 57] [Active ] [ ] [ 60] OPS4J Pax Web - Extender - WAR (1.0.0)
+[ 60] [Active ] [ ] [ 60] OPS4J Pax Url - war:, war-i: (1.2.5)
+</pre><p>You can deploy a web application packaged in war or exploded in a directory.</p><p>Your web application should at least contain a WEB-INF/web.xml file.</p><h2 id="Wrapdeployer">Wrap deployer</h2><p>The wrap deployer allows you to hot deploy non-OSGi jar files ("classical" jar files) from the deploy folder.</p><p>It's a standard deployer (you don't need to install additional Karaf features):</p><pre>
+karaf@root> la|grep -i wrap
+[ 1] [Active ] [ ] [ 5] OPS4J Pax Url - wrap: (1.2.5)
+[ 32] [Active ] [Created ] [ 30] Apache Karaf :: Deployer :: Wrap Non OSGi Jar (2.1.99.SNAPSHOT)
+</pre><p>Karaf wrap deployer looks for jar files in the deploy folder. The jar files is considered as non-OSGi if the MANIFEST<br/>doesn't contain the Bundle-SymbolicName and Bundle-Version attributes, or if there is no MANIFEST at all.</p><p>The non-OSGi jar file is transformed into an OSGi bundle.</p><p>The deployer tries to populate the Bundle-SymbolicName and Bundle-Version extracted from the jar file path.</p><p>For example, if you simply copy commons-lang-2.3.jar (which is not an OSGi bundle) into the deploy folder, you<br/>will see:</p><pre>
+karaf@root> la|grep -i commons-lang
+[ 41] [Active ] [ ] [ 60] commons-lang (2.3)
+</pre><p>If you take a look on the commons-lang headers, you can see that the bundle exports all packages with optional resolution<br/>and that Bundle-SymbolicName and Bundle-Version have been populated:</p><pre>
+karaf@root> osgi:headers 41
+
+commons-lang (41)
+-----------------
+Specification-Title = Commons Lang
+Tool = Bnd-0.0.357
+Specification-Version = 2.3
+Specification-Vendor = Apache Software Foundation
+Implementation-Version = 2.3
+Generated-By-Ops4j-Pax-From = wrap:file:/home/onofreje/workspace/karaf/assembly/target/apache-karaf-2.99.99-SNAPSHOT/deploy/commons-lang-2.3.jar$Bundle-SymbolicName=commons-lang&Bundle-Version=2.3
+Implementation-Vendor-Id = org.apache
+Created-By = 1.6.0_21 (Sun Microsystems Inc.)
+Implementation-Title = Commons Lang
+Manifest-Version = 1.0
+Bnd-LastModified = 1297248243231
+X-Compile-Target-JDK = 1.1
+Originally-Created-By = 1.3.1_09-85 ("Apple Computer, Inc.")
+Ant-Version = Apache Ant 1.6.5
+Package = org.apache.commons.lang
+X-Compile-Source-JDK = 1.3
+Extension-Name = commons-lang
+Implementation-Vendor = Apache Software Foundation
+
+Bundle-Name = commons-lang
+Bundle-SymbolicName = commons-lang
+Bundle-Version = 2.3
+Bundle-ManifestVersion = 2
+
+Import-Package =
+ org.apache.commons.lang;resolution:=optional,
+ org.apache.commons.lang.builder;resolution:=optional,
+ org.apache.commons.lang.enum;resolution:=optional,
+ org.apache.commons.lang.enums;resolution:=optional,
+ org.apache.commons.lang.exception;resolution:=optional,
+ org.apache.commons.lang.math;resolution:=optional,
+ org.apache.commons.lang.mutable;resolution:=optional,
+ org.apache.commons.lang.text;resolution:=optional,
+ org.apache.commons.lang.time;resolution:=optional
+Export-Package =
+ org.apache.commons.lang;uses:="org.apache.commons.lang.builder,org.apache.commons.lang.math,org.apache.commons.lang.exception",
+ org.apache.commons.lang.builder;uses:="org.apache.commons.lang.math,org.apache.commons.lang",
+ org.apache.commons.lang.enum;uses:=org.apache.commons.lang,
+ org.apache.commons.lang.enums;uses:=org.apache.commons.lang,
+ org.apache.commons.lang.exception;uses:=org.apache.commons.lang,
+ org.apache.commons.lang.math;uses:=org.apache.commons.lang,
+ org.apache.commons.lang.mutable;uses:="org.apache.commons.lang,org.apache.commons.lang.math",
+ org.apache.commons.lang.text;uses:=org.apache.commons.lang,
+ org.apache.commons.lang.time;uses:=org.apache.commons.lang
+
+
+</pre>
+ </div>
+
+ </div>
+ <div id="siteFooter">
+ © 2008-2012 The Apache Software Foundation - <a href="http://servicemix.apache.org/site/privacy-policy.html">Privacy Policy</a>
+ <br/>
+ Apache ServiceMix, ServiceMix, Apache, the Apache feather logo, and the Apache ServiceMix project logo are trademarks of The Apache Software Foundation.
+ </div>
+ </div>
+</body>
+</html>
\ No newline at end of file
Added: servicemix/site/production/docs/4.4.x/users-guide/directory-structure.html
URL: http://svn.apache.org/viewvc/servicemix/site/production/docs/4.4.x/users-guide/directory-structure.html?rev=1444219&view=auto
==============================================================================
--- servicemix/site/production/docs/4.4.x/users-guide/directory-structure.html (added)
+++ servicemix/site/production/docs/4.4.x/users-guide/directory-structure.html Fri Feb 8 20:35:02 2013
@@ -0,0 +1,127 @@
+
+<!DOCTYPE html>
+<html>
+<head>
+ <title>Apache ServiceMix Documentation - </title>
+
+ <link href="../theme/master.css" rel="stylesheet" type="text/css" />
+ <link href="../theme/pygmentize.css" rel="stylesheet" type="text/css" />
+
+ <script type="text/javascript" src="../scripts/jquery.js"></script>
+ <script type="text/javascript" src="../scripts/jquery.cookie.js"></script>
+ <script type="text/javascript" src="../scripts/jquery.jstree.js"></script>
+
+ <script>
+ $(document).ready(function(){
+ $("#nav").jstree({
+ "themes": {
+ "theme": "apple", "dots": false
+ },
+ "plugins" : [ "themes", "html_data", "cookies", "themes" ]
+ });
+ });
+ </script>
+ <script type="text/javascript">
+ var _gaq = _gaq || [];
+ _gaq.push(['_setAccount', 'UA-398545-1']);
+ _gaq.push(['_trackPageview']);
+
+ (function() {
+ var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
+ ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
+ var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
+ })();
+ </script>
+</head>
+<body>
+ <div id="page">
+ <div id="siteHeader">
+ <table width="100%">
+ <tr valign="middle">
+ <td align="left">
+ <a href="http://servicemix.apache.org/" title="An open source ESB">
+ <img border="0" src="../images/logodesign.png" height="80"/><img border="0" height="80" src="../images/new-logo.png" />
+ </a>
+ </td>
+ <td align="right">
+ <a href="http://www.apache.org/" title="The Apache Sofware Foundation">
+ <img border="0" height="60" src="../images/ASF-logo.png">
+ </a>
+ <ul class="siteNav">
+ <li><a href="../index.html" title="Overview">Guides Overview</a></li>
+ <li><a href="../contribute.html" title="Contributing?">Contributing?</a></li>
+ <li>
+ <form action="http://www.google.com/search" method="get" style="font-size: 10px;">
+ <input name="ie" type="hidden" value="UTF-8"></input>
+ <input name="oe" type="hidden" value="UTF-8"></input>
+ <input maxlength="255" name="q" size="15" type="text" value=""></input>
+ <input name="btnG" type="submit" value="Search"></input>
+ <input name="domains" type="hidden" value="servicemix.apache.org/docs/4.4.x"></input>
+ <input name="sitesearch" type="hidden" value="servicemix.apache.org/docs/4.4.x"></input>
+ </form>
+ </li>
+ </ul>
+ </td>
+ </tr>
+ </table>
+ </div>
+ <div id="content">
+ <div id="nav">
+ <ul>
+ <li id="karaf-users-guide">
+ <a href="#">User's Guide</a>
+ <ul>
+ <li id="karaf-installation">
+ <a href="installation.html">Installation</a>
+ </li>
+ <li id="karaf-directory-structure">
+ <a href="directory-structure.html">Directory structure</a>
+ </li>
+ <li id="karaf-starting-and-stopping">
+ <a href="start-stop.html">Starting and stopping Karaf</a>
+ </li>
+ <li id="using-console">
+ <a href="using-console.html">Using the console</a>
+ </li>
+ <li id="web-console">
+ <a href="web-console.html">Web console</a>
+ </li>
+ <li id="remote-console">
+ <a href="remote-console.html">Remote console</a>
+ </li>
+ <li id="child-instances">
+ <a href="child-instances.html">Child instances</a>
+ </li>
+ <li id="security">
+ <a href="security.html">Security</a>
+ </li>
+ <li id="failover">
+ <a href="failover.html">Failover deployments</a>
+ </li>
+ <li id="logging-system">
+ <a href="logging-system.html">Logging system</a>
+ </li>
+ <li id="deployer">
+ <a href="deployer.html">Deployer</a>
+ </li>
+ <li id="configuration">
+ <a href="configuration.html">Configuration</a>
+ </li>
+ </ul>
+ </li>
+</ul>
+
+ </div>
+ <div id="body">
+ <h1 id="Directorystructure">Directory structure</h1><p>The directory layout of a Karaf installation is as follows:</p><ul><li><p><tt>/bin</tt>: startup scripts</p></li><li><p><tt>/etc</tt>: configuration files</p></li><li><p><tt>/data</tt>: working directory </p><ul><li><p><tt>/cache</tt>: OSGi framework bundle cache</p></li><li><p><tt>/generated-bundles</tt>: temporary folder used by the deployer</p></li><li><p><tt>/log</tt>: log files</p></li></ul></li><li><p><tt>/deploy</tt>: hot deploy directory</p></li><li><p><tt>/instances</tt>: directory containing <a href="child-instances.html">child instances</a></p></li><li><p><tt>/lib</tt>: contains the bootstrap libraries</p><ul><li><p><tt>/lib/ext</tt>: directory for JRE extensions</p></li><li><p><tt>/lib/endorsed</tt>: directory for endorsed libraries</p></li></ul></li><li><p><tt>/system</tt>: OSGi bundles repository, laid out as a Maven 2 repository</p></li></ul><div class="tip" style="border: 1px solid #09
0;background-color: #dfd;margin: 20px;padding: 0px 6px 0px 6px;"><p>The <tt>data</tt> folder contains all the working and temporary files for Karaf. If you want to restart from a clean state, you can wipe out this directory, which has the same effect as <a href="start-stop#Starting Karaf from clean.html">using the clean option</a>.</p></div>
+ </div>
+
+ </div>
+ <div id="siteFooter">
+ © 2008-2012 The Apache Software Foundation - <a href="http://servicemix.apache.org/site/privacy-policy.html">Privacy Policy</a>
+ <br/>
+ Apache ServiceMix, ServiceMix, Apache, the Apache feather logo, and the Apache ServiceMix project logo are trademarks of The Apache Software Foundation.
+ </div>
+ </div>
+</body>
+</html>
\ No newline at end of file
Added: servicemix/site/production/docs/4.4.x/users-guide/failover.html
URL: http://svn.apache.org/viewvc/servicemix/site/production/docs/4.4.x/users-guide/failover.html?rev=1444219&view=auto
==============================================================================
--- servicemix/site/production/docs/4.4.x/users-guide/failover.html (added)
+++ servicemix/site/production/docs/4.4.x/users-guide/failover.html Fri Feb 8 20:35:02 2013
@@ -0,0 +1,155 @@
+
+<!DOCTYPE html>
+<html>
+<head>
+ <title>Apache ServiceMix Documentation - </title>
+
+ <link href="../theme/master.css" rel="stylesheet" type="text/css" />
+ <link href="../theme/pygmentize.css" rel="stylesheet" type="text/css" />
+
+ <script type="text/javascript" src="../scripts/jquery.js"></script>
+ <script type="text/javascript" src="../scripts/jquery.cookie.js"></script>
+ <script type="text/javascript" src="../scripts/jquery.jstree.js"></script>
+
+ <script>
+ $(document).ready(function(){
+ $("#nav").jstree({
+ "themes": {
+ "theme": "apple", "dots": false
+ },
+ "plugins" : [ "themes", "html_data", "cookies", "themes" ]
+ });
+ });
+ </script>
+ <script type="text/javascript">
+ var _gaq = _gaq || [];
+ _gaq.push(['_setAccount', 'UA-398545-1']);
+ _gaq.push(['_trackPageview']);
+
+ (function() {
+ var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
+ ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
+ var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
+ })();
+ </script>
+</head>
+<body>
+ <div id="page">
+ <div id="siteHeader">
+ <table width="100%">
+ <tr valign="middle">
+ <td align="left">
+ <a href="http://servicemix.apache.org/" title="An open source ESB">
+ <img border="0" src="../images/logodesign.png" height="80"/><img border="0" height="80" src="../images/new-logo.png" />
+ </a>
+ </td>
+ <td align="right">
+ <a href="http://www.apache.org/" title="The Apache Sofware Foundation">
+ <img border="0" height="60" src="../images/ASF-logo.png">
+ </a>
+ <ul class="siteNav">
+ <li><a href="../index.html" title="Overview">Guides Overview</a></li>
+ <li><a href="../contribute.html" title="Contributing?">Contributing?</a></li>
+ <li>
+ <form action="http://www.google.com/search" method="get" style="font-size: 10px;">
+ <input name="ie" type="hidden" value="UTF-8"></input>
+ <input name="oe" type="hidden" value="UTF-8"></input>
+ <input maxlength="255" name="q" size="15" type="text" value=""></input>
+ <input name="btnG" type="submit" value="Search"></input>
+ <input name="domains" type="hidden" value="servicemix.apache.org/docs/4.4.x"></input>
+ <input name="sitesearch" type="hidden" value="servicemix.apache.org/docs/4.4.x"></input>
+ </form>
+ </li>
+ </ul>
+ </td>
+ </tr>
+ </table>
+ </div>
+ <div id="content">
+ <div id="nav">
+ <ul>
+ <li id="karaf-users-guide">
+ <a href="#">User's Guide</a>
+ <ul>
+ <li id="karaf-installation">
+ <a href="installation.html">Installation</a>
+ </li>
+ <li id="karaf-directory-structure">
+ <a href="directory-structure.html">Directory structure</a>
+ </li>
+ <li id="karaf-starting-and-stopping">
+ <a href="start-stop.html">Starting and stopping Karaf</a>
+ </li>
+ <li id="using-console">
+ <a href="using-console.html">Using the console</a>
+ </li>
+ <li id="web-console">
+ <a href="web-console.html">Web console</a>
+ </li>
+ <li id="remote-console">
+ <a href="remote-console.html">Remote console</a>
+ </li>
+ <li id="child-instances">
+ <a href="child-instances.html">Child instances</a>
+ </li>
+ <li id="security">
+ <a href="security.html">Security</a>
+ </li>
+ <li id="failover">
+ <a href="failover.html">Failover deployments</a>
+ </li>
+ <li id="logging-system">
+ <a href="logging-system.html">Logging system</a>
+ </li>
+ <li id="deployer">
+ <a href="deployer.html">Deployer</a>
+ </li>
+ <li id="configuration">
+ <a href="configuration.html">Configuration</a>
+ </li>
+ </ul>
+ </li>
+</ul>
+
+ </div>
+ <div id="body">
+ <h1 id="FailoverDeployments">Failover Deployments</h1><p>Karaf provides failover capability using either a simple lock file system or a JDBC locking mechanism. In both cases, a container-level lock system allows bundles to be preloaded into the slave Karaf instance in order to provide faster failover performance.</p><h2 id="Simplelockfile">Simple lock file</h2><p>The simple lock file mechanism is intended for failover configurations where instances reside on the same host machine.</p><p>To use this feature, edit the <tt>$KARAF_HOME/etc/system.properties</tt> file as follows on each system in the master/slave setup:</p><pre>karaf.lock=true
+karaf.lock.class=org.apache.karaf.main.SimpleFileLock
+karaf.lock.dir=<PathToLockFileDirectory>
+karaf.lock.delay=10
+</pre><p><strong>Note</strong>: Ensure that the <tt>karaf.lock.dir</tt> property points to the same directory for both the master and slave instance, so that the slave can acquire the lock only when the master releases it.</p><h2 id="JDBClocking">JDBC locking</h2><p>The JDBC locking mechanism is intended for failover configurations where instances exist on separate machines. In this deployment, the master instance holds a lock on a Karaf locking table hosted on a database. If the master loses the lock, a waiting slave process gains access to the locking table and fully starts its container. </p><p>To use this feature, do the following on each system in the master/slave setup:</p><ul><li><p>Update the classpath to include the JDBC driver</p></li><li><p>Update the <tt>$KARAF_HOME/bin/karaf</tt> script to have a unique JMX remote port set if instances reside on the same host</p></li><li><p>Update the <tt>$KARAF_HOME/etc/system.properties</tt> file as follows:</p></li></ul><pre>
karaf.lock=true
+karaf.lock.class=org.apache.karaf.main.DefaultJDBCLock
+karaf.lock.level=50
+karaf.lock.delay=10
+karaf.lock.jdbc.url=jdbc:derby://dbserver:1527/sample
+karaf.lock.jdbc.driver=org.apache.derby.jdbc.ClientDriver
+karaf.lock.jdbc.user=user
+karaf.lock.jdbc.password=password
+karaf.lock.jdbc.table=KARAF_LOCK
+karaf.lock.jdbc.clustername=karaf
+karaf.lock.jdbc.timeout=30
+</pre><p><strong>Note</strong>:</p><ul><li><p>This process will fail if a JDBC driver is not on the classpath.</p></li><li><p>The "sample" database referred to above will be created if it does not exist.</p></li><li><p>The first Karaf instance to acquire the locking table is the master instance.</p></li><li><p>If the connection to the database is lost, the master instance tries to gracefully shutdown, allowing a slave instance to become master when the database service is restored. The former master will require a manual restart.</p></li></ul><h3 id="JDBClockingonOracle">JDBC locking on Oracle</h3><p>If you are using Oracle as your database for JDBC locking, the <tt>karaf.lock.class</tt> property in the <tt>$KARAF_HOME/etc/system.properties</tt> file must point to <tt>org.apache.karaf.main.OracleJDBCLock</tt>.</p><p>Otherwise, configure the system.properties file as normal for your setup, for example:</p><pre>karaf.lock=true
+karaf.lock.class=org.apache.karaf.main.OracleJDBCLock
+karaf.lock.jdbc.url=jdbc:oracle:thin:@hostname:1521:XE
+karaf.lock.jdbc.driver=oracle.jdbc.OracleDriver
+karaf.lock.jdbc.user=user
+karaf.lock.jdbc.password=password
+karaf.lock.jdbc.table=KARAF_LOCK
+karaf.lock.jdbc.clustername=karaf
+karaf.lock.jdbc.timeout=30
+</pre><p>As with the default JDBC locking setup, the Oracle JDBC driver JAR file must be in your classpath. You can ensure this by copying the <tt>ojdbc14.jar</tt> into Karaf's <tt>lib</tt> folder before starting Karaf.</p><p><strong>Note</strong>: The <tt>karaf.lock.jdbc.url</tt> requires an active SID, which means you must manually create a database instance before using this particular lock.</p><h3 id="Derby">Derby</h3><div class="warning" style="border: 1px solid #c00;background-color: #fcc;margin: 20px;padding: 0px 6px 0px 6px;"><p>TODO</p></div><h3 id="MySQL">MySQL</h3><div class="warning" style="border: 1px solid #c00;background-color: #fcc;margin: 20px;padding: 0px 6px 0px 6px;"><p>TODO</p></div><p><span id="locklevel"></span></p><h2 id="Containerlevellocking">Container-level locking</h2><p>Container-level locking allows bundles to be preloaded into the slave kernel instance in order to provide faster failover performance. Container-level locking is supported in both
the simple file and JDBC locking mechanisms.</p><p>To implement container-level locking, add the following to the <tt>$KARAF_HOME/etc/system.properties</tt> file on each system in the master/slave setup:</p><pre>karaf.lock=true
+karaf.lock.level=50
+karaf.lock.delay=10
+</pre><p>The <tt>karaf.lock.level</tt> property tells the Karaf instance how far into the boot process to bring the OSGi container. All bundles with an ID equal or lower to this start level will be started in that Karaf instance.</p><p>Bundle start levels are specified in <tt>$KARAF_HOME/etc/startup.properties</tt>, in the format <tt>jar.name=level</tt>. The core system bundles have levels below 50, where user bundles have levels greater than 50.</p><div class="table-wrap"><table class="confluenceTable"><tr><th class="confluenceTh"> Level </th><th class="confluenceTh"> Behavior </th></tr><tr><td class="confluenceTd"> 1 </td><td class="confluenceTd"> A 'cold' standby instance. Core bundles are not loaded into container. Slaves will wait until lock acquired to start server. </td></tr><tr><td class="confluenceTd"> <50 </td><td class="confluenceTd"> A 'hot' standby instance. Core bundles are loaded into the container. Slaves will wait until lock acquired to start user level b
undles. The console will be accessible for each slave instance at this level. </td></tr><tr><td class="confluenceTd"> >50 </td><td class="confluenceTd"> This setting is not recommended as user bundles will end up being started. </td></tr></table></div><p><strong>Note</strong>: When using a 'hot' spare on the same host you need to set the JMX remote port to a unique value to avoid bind conflicts. You can edit the Karaf start script to include the following:</p><pre>DEFAULT_JAVA_OPTS="-server $DEFAULT_JAVA_OPTS -Dcom.sun.management.jmxremote.port=1100 -Dcom.sun.management.jmxremote.authenticate=false"
+</pre>
+ </div>
+
+ </div>
+ <div id="siteFooter">
+ © 2008-2012 The Apache Software Foundation - <a href="http://servicemix.apache.org/site/privacy-policy.html">Privacy Policy</a>
+ <br/>
+ Apache ServiceMix, ServiceMix, Apache, the Apache feather logo, and the Apache ServiceMix project logo are trademarks of The Apache Software Foundation.
+ </div>
+ </div>
+</body>
+</html>
\ No newline at end of file