You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@karaf.apache.org by jb...@apache.org on 2013/03/22 23:18:57 UTC
svn commit: r1460031 [16/19] - in
/karaf/site/production/manual/latest-2.2.x: ./ commands/ css/ css/scalate/
developers-guide/ images/ users-guide/
Added: karaf/site/production/manual/latest-2.2.x/quick-start.html
URL: http://svn.apache.org/viewvc/karaf/site/production/manual/latest-2.2.x/quick-start.html?rev=1460031&view=auto
==============================================================================
--- karaf/site/production/manual/latest-2.2.x/quick-start.html (added)
+++ karaf/site/production/manual/latest-2.2.x/quick-start.html Fri Mar 22 22:18:53 2013
@@ -0,0 +1,227 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML Basic 1.1//EN" "http://www.w3.org/TR/xhtml-basic/xhtml-basic11.dtd">
+<html lang="en">
+ <head>
+ <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
+ <meta name="description" content="description goes here"/>
+ <meta name="keywords" content="keywords,goes,here"/>
+ <meta name="author" content="The Apache Karaf Team"/>
+ <link href="css/style.css" rel="stylesheet" type="text/css"/>
+ <link href="css/pygmentize.css" rel="stylesheet" type="text/css"/>
+ <title>
+ Apache Karaf 2.2.11-SNAPSHOT Guides
+ </title>
+ </head>
+ <body>
+ <table width="100%" cellpadding="0" cellspacing="0">
+ <tr width="100%">
+ <td id="cell-0-0" colspan="2">
+
+ </td>
+ <td id="cell-0-1">
+
+ </td>
+ <td id="cell-0-2" colspan="2">
+
+ </td>
+ </tr>
+ <tr width="100%">
+ <td id="cell-1-0">
+
+ </td>
+ <td id="cell-1-1">
+
+ </td>
+ <td id="cell-1-2">
+ <div style="padding: 5px;">
+ <div id="banner">
+ <table border="0" cellpadding="0" cellspacing="0" width="100%">
+ <tr>
+ <td align="left" class="topbardiv" nowrap="">
+<a href="http://karaf.apache.org/" title="A server side OSGi distribution">
+ <img border="0" src="images/karaf-logo.png" width="400px"></img>
+</a>
+ </td>
+ <td align="right" nowrap="">
+<a href="http://www.apache.org/" title="The Apache Sofware Foundation">
+ <img border="0" src="images/asf-logo.png">
+</a>
+ </td>
+ </tr>
+ </table>
+
+ </div>
+ <div id="top-menu">
+ <table border="0" cellpadding="1" cellspacing="0" width="100%">
+ <tr>
+ <td>
+ <div align="left"></div>
+ </td>
+ <td>
+ <div align="right">
+ <p>
+<a href="index.html" title="Home">Home</a>
+|
+<a href="users-guide/index.html" title="Users Guide">Users Guide</a>
+|
+<a href="developers-guide/index.html" title="Developers Guide">Developers Guide</a>
+</p>
+
+
+ </div>
+ </td>
+ </tr>
+ </table>
+ </div>
+ </div>
+ </td>
+ <td id="cell-1-3">
+
+ </td>
+ <td id="cell-1-4">
+
+ </td>
+ </tr>
+ <tr width="100%">
+ <td id="cell-2-0" colspan="2">
+
+ </td>
+ <td id="cell-2-1">
+ <table>
+ <tr height="100%" valign="top">
+ <td height="100%">
+ <div id="wrapper-menu-page-right">
+ <div id="wrapper-menu-page-top">
+ <div id="wrapper-menu-page-bottom">
+ <div id="menu-page">
+ <h3 id="Homeindex"><a href="index.html">Home</a></h3><ul style="list-style: square"><li><a href="overview.html">Overview</a></li><li><a href="quick-start.html">Quick Start</a></li></ul><h3 id="UsersGuideusersguideindex"><a href="users-guide/index.html">Users Guide</a></h3><ul style="list-style: square"><li><a href="users-guide/installation.html">Installing Karaf</a></li><li><a href="users-guide/directory-structure.html">Directory Structure</a></li><li><a href="users-guide/start-stop.html">Starting and stopping Karaf</a></li><li><a href="users-guide/wrapper.html">OS integration</a></li><li><a href="users-guide/using-console.html">Using the console</a></li><li><a href="users-guide/remote-console.html">Remote console</a></li><li><a href="users-guide/web-console.html">Web console</a></li><li><a href="users-guide/child-instances.html">Child instances</a></li><li><a href="users-guide/security.html">Security</a></li><li><a href="users-guide/failover.html">Fa
ilover Deployments</a></li><li><a href="users-guide/logging-system.html">Logging system</a></li><li><a href="users-guide/deployer.html">Deployer</a></li><li><a href="users-guide/provisioning.html">Provisioning</a></li><li><a href="users-guide/kar.html">KAR archive</a></li><li><a href="users-guide/configuration.html">Configuration</a></li><li><a href="users-guide/http.html">HTTP service</a></li><li><a href="users-guide/web-applications.html">Web applications</a></li><li><a href="users-guide/jre-tuning.html">JRE tuning</a></li><li><a href="users-guide/jmx.html">JMX for administration and monitoring</a></li></ul><h3 id="DevelopersGuidedevelopersguideindex"><a href="developers-guide/index.html">Developers Guide</a></h3><ul style="list-style: square"><li><a href="developers-guide/archetypes.html">Maven Archetypes</a></li><li><a href="developers-guide/branding-console.html">Branding the Console</a></li><li><a href="developers-guide/extending-console.html">Extending the Console</a>
</li><li><a href="developers-guide/custom-distribution.html">Custom Distribution</a></li><li><a href="developers-guide/security-framework.html">Security Framework</a></li><li><a href="developers-guide/features-maven-plugin.html">Using the features-maven-plugin</a></li><li><a href="developers-guide/debugging.html">Troubleshooting, Debugging and Profiling</a></li><li><a href="developers-guide/connect-console.html">Programmatically connect to the console</a></li><li><a href="developers-guide/writing-tests.html">Writing integration tests</a></li><li><a href="developers-guide/creating-bundles.html">Creating bundles</a></li><li><a href="developers-guide/shell-syntax.html">Shell syntax</a></li></ul><h3 id="Commandscommandscommands"><a href="commands/commands.html">Commands</a></h3>
+ </div>
+ </div>
+ </div>
+ </div>
+ </td>
+ <td height="100%" width="100%">
+ <div class="wiki-content">
+<h1 id="a1.QuickStart">1. Quick Start</h1><p>If you are in a hurry to have Apache Karaf 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.</p><p>All you need is 5 to 10 minutes and to follow these basic steps.</p><ul><li><a href="#Background.html">Background</a></li><li><a href="#Gettingthesoftware.html">Getting the software</a></li><li><a href="#Starttheserver.html">Start the server</a></li><li><a href="#Deployasampleapplication.html">Deploy a sample application</a></li></ul><h2 id="Background">Background</h2><p>Apache Karaf is a small and lightweight OSGi based runtime. This provides a small lightweight container onto which various bundles can be deployed.</p><p>Apache Karaf started life as the <a href="http://servicemix.apache.org">Apache ServiceMix</a> ke
rnel and then moved as a <a href="http://felix.apache.org">Apache Felix</a> subproject before becoming a top level project.</p><h2 id="Gettingthesoftware">Getting the software</h2><p>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 Karaf up and running in the fastest way only the binary download will be covered at this time.</p><h3 id="Prerequisites">Prerequisites</h3><p>Although this installation path is the fastest one, you will still need to install some software before installing Karaf.</p><p>Karaf requires a Java SE 5 environment to run. Refer to <a href="http://www.oracle.com/technetwork/java/javase/">http://www.oracle.com/technetwork/java/javase/</a> for details on how to download and install Java SE 1.5 or greater.</p><h3 id="Downloadbinaries">Download binaries</h3><p>You will need to select the appropriate installation image
for the platform you're using to run Karaf. Open a Web browser and access the following URL, there you will find the available packages for download (binaries and source code).</p><p><a href="http://karaf.apache.org/index/community/download.html">http://karaf.apache.org/index/community/download.html</a></p><p>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:\karaf - from now on this directory will be referenced as <KARAF_HOME>. Please remember the restrictions concerning illegal characters in Java paths, e.g. !, % etc.</p><p>The installation of Karaf is as simple as uncompressing the .zip or .tar.gz files. The next step is to start the server.</p><h2 id="Starttheserver">Start the server</h2><p>With Karaf already installed, open a command line console and change directory to <KARAF_HOME>. To start
the server, run the following command in Windows:</p><pre>
+bin\karaf.bat
+</pre><p>respectively on Unix:</p><pre>
+bin/karaf
+</pre><p>You should see the following information on the command line console:</p><p>You can now run your first command. Simply type the <tt><tab></tt> key in the console.</p><pre>
+karaf@root>
+
+admin:change-port admin:connect admin:create admin:destroy
+admin:list admin:start admin:stop config:cancel
+config:edit config:list config:propappend config:propdel
+config:proplist config:propset config:update dev:dynamic-import
+dev:framework dev:print-stack-traces dev:show-tree features:addUrl
+features:info features:install features:list features:listUrl
+features:refreshUrl features:removeUrl features:uninstall log:display
+log:display-exception log:get log:set osgi:bundle-level
+osgi:headers osgi:install osgi:list osgi:ls
+osgi:refresh osgi:resolve osgi:restart osgi:shutdown
+osgi:start osgi:start-level osgi:stop osgi:uninstall
+osgi:update packages:exports packages:imports shell:cat
+shell:clear shell:each shell:echo shell:exec
+shell:grep shell:history shell:if shell:info
+shell:java shell:logout shell:new shell:printf
+shell:sleep shell:sort shell:tac ssh:ssh
+ssh:sshd cat clear each
+echo exec grep history
+if info java logout
+new printf sleep sort
+tac bundle-level headers install
+list ls refresh resolve
+restart shutdown start start-level
+stop uninstall update
+karaf@root>
+</pre><p>You can then grab more specific help for a given command using the <tt>--help</tt> option for this command:</p><pre>
+karaf@root> admin:create --help
+DESCRIPTION
+ admin:create
+
+ Create a new instance.
+
+SYNTAX
+ admin:create [options] name
+
+ARGUMENTS
+ name
+ The name of the new container instance
+
+OPTIONS
+ --help
+ Display this help message
+ -f, --feature
+ Initial features. This option can be specified multiple times to enable multiple initial
+ features
+ -p, --port
+ Port number for remote shell connection
+ -l, --location
+ Location of the new container instance in the file system
+ -furl, --featureURL
+ Additional feature descriptor URLs. This option can be specified multiple times to add
+ multiple URLs
+
+karaf@root>
+</pre><p>Note that the console supports tab completion, so you just need to enter <tt>ad <tab> cr <tab></tt> instead of <tt>admin:create</tt>.</p><h2 id="Deployasampleapplication">Deploy a sample application</h2><p>While you will learn in the Karaf user's guide how to fully use and leverage Apache Karaf, let's install a sample <a href="http://camel.apache.org">Apache Camel</a> application for now:</p><p>In the console, run the following commands:</p><pre>
+features:addurl mvn:org.apache.camel/camel-example-osgi/2.10.0/xml/features
+features:install camel-example-osgi
+</pre><p>The example installed is using Camel to start a timer every 2 seconds and output a message on the console.<br/>The previous commands download the Camel features descriptor and install the example feature.</p><pre>
+>>>> SpringDSL set body: Fri Jan 07 11:59:51 CET 2011
+>>>> SpringDSL set body: Fri Jan 07 11:59:53 CET 2011
+>>>> SpringDSL set body: Fri Jan 07 11:59:55 CET 2011
+
+</pre><h3 id="Stoppinganduninstallingthesampleapplication">Stopping and uninstalling the sample application</h3><p>To stop this demo, run the following command:</p><pre>
+features:uninstall camel-example-osgi
+</pre><h3 id="CommonProblems">Common Problems</h3><ol><li>Launching Karaf can result in a deadlock in Felix during module dependency resolution.<p>This is often a result of sending a SIGINT (control-C) to the process when it will not cleanly exit.<br/>This can corrupt the caches and cause startup problems in the very next launch. It is fixed by emptying the component cache:</p><pre>
+rm -rf data/cache/*
+</pre></li></ol><h2 id="StoppingKaraf">Stopping Karaf</h2><p>To stop Karaf from the console, enter <tt>^D</tt> in the console:</p><pre>
+^D
+</pre><p>Alternatively, you can also run the following command:</p><pre>
+osgi:shutdown
+</pre><h2 id="Summary">Summary</h2><p>This document showed how simple it is to have Apache Karaf up and running. The overall time for getting the server running should be less than five<br/>minutes if you have the prerequisite (Java 1.5) already installed. Additionally, this article also showed you how to deploy and test a simple<br/>Apache Camel application.</p>
+ </div>
+ </td>
+ </tr>
+ </table>
+ </td>
+ <td id="cell-2-2" colspan="2">
+
+ </td>
+ </tr>
+ <tr width="100%">
+ <td id="cell-3-0">
+
+ </td>
+ <td id="cell-3-1">
+
+ </td>
+ <td id="cell-3-2">
+ <div id="footer">
+ <div id="site-footer">
+ © 2008-2011 The Apache Software Foundation
+ <br/>
+ Apache Karaf, Karaf, Apache, the Apache feather logo, and the Apache Karaf project logo are trademarks of The Apache Software Foundation.
+ </div>
+ </div>
+ </td>
+ <td id="cell-3-3">
+
+ </td>
+ <td id="cell-3-4">
+
+ </td>
+ </tr>
+ <tr width="100%">
+ <td id="cell-4-0" colspan="2">
+
+ </td>
+ <td id="cell-4-1">
+
+ </td>
+ <td id="cell-4-2" colspan="2">
+
+ </td>
+ </tr>
+ </table>
+ </body>
+</html>
\ No newline at end of file
Added: karaf/site/production/manual/latest-2.2.x/users-guide/child-instances.html
URL: http://svn.apache.org/viewvc/karaf/site/production/manual/latest-2.2.x/users-guide/child-instances.html?rev=1460031&view=auto
==============================================================================
--- karaf/site/production/manual/latest-2.2.x/users-guide/child-instances.html (added)
+++ karaf/site/production/manual/latest-2.2.x/users-guide/child-instances.html Fri Mar 22 22:18:53 2013
@@ -0,0 +1,209 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML Basic 1.1//EN" "http://www.w3.org/TR/xhtml-basic/xhtml-basic11.dtd">
+<html lang="en">
+ <head>
+ <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
+ <meta name="description" content="description goes here"/>
+ <meta name="keywords" content="keywords,goes,here"/>
+ <meta name="author" content="The Apache Karaf Team"/>
+ <link href="../css/style.css" rel="stylesheet" type="text/css"/>
+ <link href="../css/pygmentize.css" rel="stylesheet" type="text/css"/>
+ <title>
+ Apache Karaf 2.2.11-SNAPSHOT Guides
+ </title>
+ </head>
+ <body>
+ <table width="100%" cellpadding="0" cellspacing="0">
+ <tr width="100%">
+ <td id="cell-0-0" colspan="2">
+
+ </td>
+ <td id="cell-0-1">
+
+ </td>
+ <td id="cell-0-2" colspan="2">
+
+ </td>
+ </tr>
+ <tr width="100%">
+ <td id="cell-1-0">
+
+ </td>
+ <td id="cell-1-1">
+
+ </td>
+ <td id="cell-1-2">
+ <div style="padding: 5px;">
+ <div id="banner">
+ <table border="0" cellpadding="0" cellspacing="0" width="100%">
+ <tr>
+ <td align="left" class="topbardiv" nowrap="">
+<a href="http://karaf.apache.org/" title="A server side OSGi distribution">
+ <img border="0" src="../images/karaf-logo.png" width="400px"></img>
+</a>
+ </td>
+ <td align="right" nowrap="">
+<a href="http://www.apache.org/" title="The Apache Sofware Foundation">
+ <img border="0" src="../images/asf-logo.png">
+</a>
+ </td>
+ </tr>
+ </table>
+
+ </div>
+ <div id="top-menu">
+ <table border="0" cellpadding="1" cellspacing="0" width="100%">
+ <tr>
+ <td>
+ <div align="left"></div>
+ </td>
+ <td>
+ <div align="right">
+ <p>
+<a href="../index.html" title="Home">Home</a>
+|
+<a href="index.html" title="Users Guide">Users Guide</a>
+|
+<a href="../developers-guide/index.html" title="Developers Guide">Developers Guide</a>
+</p>
+
+
+ </div>
+ </td>
+ </tr>
+ </table>
+ </div>
+ </div>
+ </td>
+ <td id="cell-1-3">
+
+ </td>
+ <td id="cell-1-4">
+
+ </td>
+ </tr>
+ <tr width="100%">
+ <td id="cell-2-0" colspan="2">
+
+ </td>
+ <td id="cell-2-1">
+ <table>
+ <tr height="100%" valign="top">
+ <td height="100%">
+ <div id="wrapper-menu-page-right">
+ <div id="wrapper-menu-page-top">
+ <div id="wrapper-menu-page-bottom">
+ <div id="menu-page">
+ <h3 id="Homeindex"><a href="../index.html">Home</a></h3><ul style="list-style: square"><li><a href="../overview.html">Overview</a></li><li><a href="../quick-start.html">Quick Start</a></li></ul><h3 id="UsersGuideusersguideindex"><a href="index.html">Users Guide</a></h3><ul style="list-style: square"><li><a href="installation.html">Installing Karaf</a></li><li><a href="directory-structure.html">Directory Structure</a></li><li><a href="start-stop.html">Starting and stopping Karaf</a></li><li><a href="wrapper.html">OS integration</a></li><li><a href="using-console.html">Using the console</a></li><li><a href="remote-console.html">Remote console</a></li><li><a href="web-console.html">Web console</a></li><li><a href="child-instances.html">Child instances</a></li><li><a href="security.html">Security</a></li><li><a href="failover.html">Failover Deployments</a></li><li><a href="logging-system.html">Logging system</a></li><li><a href="deployer.html">Deployer</a
></li><li><a href="provisioning.html">Provisioning</a></li><li><a href="kar.html">KAR archive</a></li><li><a href="configuration.html">Configuration</a></li><li><a href="http.html">HTTP service</a></li><li><a href="web-applications.html">Web applications</a></li><li><a href="jre-tuning.html">JRE tuning</a></li><li><a href="jmx.html">JMX for administration and monitoring</a></li></ul><h3 id="DevelopersGuidedevelopersguideindex"><a href="../developers-guide/index.html">Developers Guide</a></h3><ul style="list-style: square"><li><a href="../developers-guide/archetypes.html">Maven Archetypes</a></li><li><a href="../developers-guide/branding-console.html">Branding the Console</a></li><li><a href="../developers-guide/extending-console.html">Extending the Console</a></li><li><a href="../developers-guide/custom-distribution.html">Custom Distribution</a></li><li><a href="../developers-guide/security-framework.html">Security Framework</a></li><li><a href="../developers-guide/features-
maven-plugin.html">Using the features-maven-plugin</a></li><li><a href="../developers-guide/debugging.html">Troubleshooting, Debugging and Profiling</a></li><li><a href="../developers-guide/connect-console.html">Programmatically connect to the console</a></li><li><a href="../developers-guide/writing-tests.html">Writing integration tests</a></li><li><a href="../developers-guide/creating-bundles.html">Creating bundles</a></li><li><a href="../developers-guide/shell-syntax.html">Shell syntax</a></li></ul><h3 id="Commandscommandscommands"><a href="../commands/commands.html">Commands</a></h3>
+ </div>
+ </div>
+ </div>
+ </div>
+ </td>
+ <td height="100%" width="100%">
+ <div class="wiki-content">
+<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>admin: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/44444.</p><pre>
+karaf@root> admin:create alpha
+Creating new instance on SSH port 8102 and RMI ports 1100/44445 at: /x3/karaf/test/apache-karaf-2.2.4/instances/alpha
+Creating dir: /x3/karaf/test/apache-karaf-2.2.4/instances/alpha/bin
+Creating dir: /x3/karaf/test/apache-karaf-2.2.4/instances/alpha/etc
+Creating dir: /x3/karaf/test/apache-karaf-2.2.4/instances/alpha/system
+Creating dir: /x3/karaf/test/apache-karaf-2.2.4/instances/alpha/deploy
+Creating dir: /x3/karaf/test/apache-karaf-2.2.4/instances/alpha/data
+Creating file: /x3/karaf/test/apache-karaf-2.2.4/instances/alpha/etc/config.properties
+Creating file: /x3/karaf/test/apache-karaf-2.2.4/instances/alpha/etc/jre.properties
+Creating file: /x3/karaf/test/apache-karaf-2.2.4/instances/alpha/etc/custom.properties
+Creating file: /x3/karaf/test/apache-karaf-2.2.4/instances/alpha/etc/java.util.logging.properties
+Creating file: /x3/karaf/test/apache-karaf-2.2.4/instances/alpha/etc/org.apache.felix.fileinstall-deploy.cfg
+Creating file: /x3/karaf/test/apache-karaf-2.2.4/instances/alpha/etc/org.apache.karaf.log.cfg
+Creating file: /x3/karaf/test/apache-karaf-2.2.4/instances/alpha/etc/org.apache.karaf.features.cfg
+Creating file: /x3/karaf/test/apache-karaf-2.2.4/instances/alpha/etc/org.ops4j.pax.logging.cfg
+Creating file: /x3/karaf/test/apache-karaf-2.2.4/instances/alpha/etc/org.ops4j.pax.url.mvn.cfg
+Creating file: /x3/karaf/test/apache-karaf-2.2.4/instances/alpha/etc/startup.properties
+Creating file: /x3/karaf/test/apache-karaf-2.2.4/instances/alpha/etc/users.properties
+Creating file: /x3/karaf/test/apache-karaf-2.2.4/instances/alpha/etc/system.properties
+Creating file: /x3/karaf/test/apache-karaf-2.2.4/instances/alpha/etc/org.apache.karaf.shell.cfg
+Creating file: /x3/karaf/test/apache-karaf-2.2.4/instances/alpha/etc/org.apache.karaf.management.cfg
+Creating file: /x3/karaf/test/apache-karaf-2.2.4/instances/alpha/bin/karaf
+Creating file: /x3/karaf/test/apache-karaf-2.2.4/instances/alpha/bin/start
+Creating file: /x3/karaf/test/apache-karaf-2.2.4/instances/alpha/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>
+ </td>
+ </tr>
+ </table>
+ </td>
+ <td id="cell-2-2" colspan="2">
+
+ </td>
+ </tr>
+ <tr width="100%">
+ <td id="cell-3-0">
+
+ </td>
+ <td id="cell-3-1">
+
+ </td>
+ <td id="cell-3-2">
+ <div id="footer">
+ <div id="site-footer">
+ © 2008-2011 The Apache Software Foundation
+ <br/>
+ Apache Karaf, Karaf, Apache, the Apache feather logo, and the Apache Karaf project logo are trademarks of The Apache Software Foundation.
+ </div>
+ </div>
+ </td>
+ <td id="cell-3-3">
+
+ </td>
+ <td id="cell-3-4">
+
+ </td>
+ </tr>
+ <tr width="100%">
+ <td id="cell-4-0" colspan="2">
+
+ </td>
+ <td id="cell-4-1">
+
+ </td>
+ <td id="cell-4-2" colspan="2">
+
+ </td>
+ </tr>
+ </table>
+ </body>
+</html>
\ No newline at end of file
Added: karaf/site/production/manual/latest-2.2.x/users-guide/configuration.html
URL: http://svn.apache.org/viewvc/karaf/site/production/manual/latest-2.2.x/users-guide/configuration.html?rev=1460031&view=auto
==============================================================================
--- karaf/site/production/manual/latest-2.2.x/users-guide/configuration.html (added)
+++ karaf/site/production/manual/latest-2.2.x/users-guide/configuration.html Fri Mar 22 22:18:53 2013
@@ -0,0 +1,152 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML Basic 1.1//EN" "http://www.w3.org/TR/xhtml-basic/xhtml-basic11.dtd">
+<html lang="en">
+ <head>
+ <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
+ <meta name="description" content="description goes here"/>
+ <meta name="keywords" content="keywords,goes,here"/>
+ <meta name="author" content="The Apache Karaf Team"/>
+ <link href="../css/style.css" rel="stylesheet" type="text/css"/>
+ <link href="../css/pygmentize.css" rel="stylesheet" type="text/css"/>
+ <title>
+ Apache Karaf 2.2.11-SNAPSHOT Guides
+ </title>
+ </head>
+ <body>
+ <table width="100%" cellpadding="0" cellspacing="0">
+ <tr width="100%">
+ <td id="cell-0-0" colspan="2">
+
+ </td>
+ <td id="cell-0-1">
+
+ </td>
+ <td id="cell-0-2" colspan="2">
+
+ </td>
+ </tr>
+ <tr width="100%">
+ <td id="cell-1-0">
+
+ </td>
+ <td id="cell-1-1">
+
+ </td>
+ <td id="cell-1-2">
+ <div style="padding: 5px;">
+ <div id="banner">
+ <table border="0" cellpadding="0" cellspacing="0" width="100%">
+ <tr>
+ <td align="left" class="topbardiv" nowrap="">
+<a href="http://karaf.apache.org/" title="A server side OSGi distribution">
+ <img border="0" src="../images/karaf-logo.png" width="400px"></img>
+</a>
+ </td>
+ <td align="right" nowrap="">
+<a href="http://www.apache.org/" title="The Apache Sofware Foundation">
+ <img border="0" src="../images/asf-logo.png">
+</a>
+ </td>
+ </tr>
+ </table>
+
+ </div>
+ <div id="top-menu">
+ <table border="0" cellpadding="1" cellspacing="0" width="100%">
+ <tr>
+ <td>
+ <div align="left"></div>
+ </td>
+ <td>
+ <div align="right">
+ <p>
+<a href="../index.html" title="Home">Home</a>
+|
+<a href="index.html" title="Users Guide">Users Guide</a>
+|
+<a href="../developers-guide/index.html" title="Developers Guide">Developers Guide</a>
+</p>
+
+
+ </div>
+ </td>
+ </tr>
+ </table>
+ </div>
+ </div>
+ </td>
+ <td id="cell-1-3">
+
+ </td>
+ <td id="cell-1-4">
+
+ </td>
+ </tr>
+ <tr width="100%">
+ <td id="cell-2-0" colspan="2">
+
+ </td>
+ <td id="cell-2-1">
+ <table>
+ <tr height="100%" valign="top">
+ <td height="100%">
+ <div id="wrapper-menu-page-right">
+ <div id="wrapper-menu-page-top">
+ <div id="wrapper-menu-page-bottom">
+ <div id="menu-page">
+ <h3 id="Homeindex"><a href="../index.html">Home</a></h3><ul style="list-style: square"><li><a href="../overview.html">Overview</a></li><li><a href="../quick-start.html">Quick Start</a></li></ul><h3 id="UsersGuideusersguideindex"><a href="index.html">Users Guide</a></h3><ul style="list-style: square"><li><a href="installation.html">Installing Karaf</a></li><li><a href="directory-structure.html">Directory Structure</a></li><li><a href="start-stop.html">Starting and stopping Karaf</a></li><li><a href="wrapper.html">OS integration</a></li><li><a href="using-console.html">Using the console</a></li><li><a href="remote-console.html">Remote console</a></li><li><a href="web-console.html">Web console</a></li><li><a href="child-instances.html">Child instances</a></li><li><a href="security.html">Security</a></li><li><a href="failover.html">Failover Deployments</a></li><li><a href="logging-system.html">Logging system</a></li><li><a href="deployer.html">Deployer</a
></li><li><a href="provisioning.html">Provisioning</a></li><li><a href="kar.html">KAR archive</a></li><li><a href="configuration.html">Configuration</a></li><li><a href="http.html">HTTP service</a></li><li><a href="web-applications.html">Web applications</a></li><li><a href="jre-tuning.html">JRE tuning</a></li><li><a href="jmx.html">JMX for administration and monitoring</a></li></ul><h3 id="DevelopersGuidedevelopersguideindex"><a href="../developers-guide/index.html">Developers Guide</a></h3><ul style="list-style: square"><li><a href="../developers-guide/archetypes.html">Maven Archetypes</a></li><li><a href="../developers-guide/branding-console.html">Branding the Console</a></li><li><a href="../developers-guide/extending-console.html">Extending the Console</a></li><li><a href="../developers-guide/custom-distribution.html">Custom Distribution</a></li><li><a href="../developers-guide/security-framework.html">Security Framework</a></li><li><a href="../developers-guide/features-
maven-plugin.html">Using the features-maven-plugin</a></li><li><a href="../developers-guide/debugging.html">Troubleshooting, Debugging and Profiling</a></li><li><a href="../developers-guide/connect-console.html">Programmatically connect to the console</a></li><li><a href="../developers-guide/writing-tests.html">Writing integration tests</a></li><li><a href="../developers-guide/creating-bundles.html">Creating bundles</a></li><li><a href="../developers-guide/shell-syntax.html">Shell syntax</a></li></ul><h3 id="Commandscommandscommands"><a href="../commands/commands.html">Commands</a></h3>
+ </div>
+ </div>
+ </div>
+ </div>
+ </td>
+ <td height="100%" width="100%">
+ <div class="wiki-content">
+<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="con
fluenceTd"> 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>
+ </td>
+ </tr>
+ </table>
+ </td>
+ <td id="cell-2-2" colspan="2">
+
+ </td>
+ </tr>
+ <tr width="100%">
+ <td id="cell-3-0">
+
+ </td>
+ <td id="cell-3-1">
+
+ </td>
+ <td id="cell-3-2">
+ <div id="footer">
+ <div id="site-footer">
+ © 2008-2011 The Apache Software Foundation
+ <br/>
+ Apache Karaf, Karaf, Apache, the Apache feather logo, and the Apache Karaf project logo are trademarks of The Apache Software Foundation.
+ </div>
+ </div>
+ </td>
+ <td id="cell-3-3">
+
+ </td>
+ <td id="cell-3-4">
+
+ </td>
+ </tr>
+ <tr width="100%">
+ <td id="cell-4-0" colspan="2">
+
+ </td>
+ <td id="cell-4-1">
+
+ </td>
+ <td id="cell-4-2" colspan="2">
+
+ </td>
+ </tr>
+ </table>
+ </body>
+</html>
\ No newline at end of file
Added: karaf/site/production/manual/latest-2.2.x/users-guide/deployer.html
URL: http://svn.apache.org/viewvc/karaf/site/production/manual/latest-2.2.x/users-guide/deployer.html?rev=1460031&view=auto
==============================================================================
--- karaf/site/production/manual/latest-2.2.x/users-guide/deployer.html (added)
+++ karaf/site/production/manual/latest-2.2.x/users-guide/deployer.html Fri Mar 22 22:18:53 2013
@@ -0,0 +1,274 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML Basic 1.1//EN" "http://www.w3.org/TR/xhtml-basic/xhtml-basic11.dtd">
+<html lang="en">
+ <head>
+ <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
+ <meta name="description" content="description goes here"/>
+ <meta name="keywords" content="keywords,goes,here"/>
+ <meta name="author" content="The Apache Karaf Team"/>
+ <link href="../css/style.css" rel="stylesheet" type="text/css"/>
+ <link href="../css/pygmentize.css" rel="stylesheet" type="text/css"/>
+ <title>
+ Apache Karaf 2.2.11-SNAPSHOT Guides
+ </title>
+ </head>
+ <body>
+ <table width="100%" cellpadding="0" cellspacing="0">
+ <tr width="100%">
+ <td id="cell-0-0" colspan="2">
+
+ </td>
+ <td id="cell-0-1">
+
+ </td>
+ <td id="cell-0-2" colspan="2">
+
+ </td>
+ </tr>
+ <tr width="100%">
+ <td id="cell-1-0">
+
+ </td>
+ <td id="cell-1-1">
+
+ </td>
+ <td id="cell-1-2">
+ <div style="padding: 5px;">
+ <div id="banner">
+ <table border="0" cellpadding="0" cellspacing="0" width="100%">
+ <tr>
+ <td align="left" class="topbardiv" nowrap="">
+<a href="http://karaf.apache.org/" title="A server side OSGi distribution">
+ <img border="0" src="../images/karaf-logo.png" width="400px"></img>
+</a>
+ </td>
+ <td align="right" nowrap="">
+<a href="http://www.apache.org/" title="The Apache Sofware Foundation">
+ <img border="0" src="../images/asf-logo.png">
+</a>
+ </td>
+ </tr>
+ </table>
+
+ </div>
+ <div id="top-menu">
+ <table border="0" cellpadding="1" cellspacing="0" width="100%">
+ <tr>
+ <td>
+ <div align="left"></div>
+ </td>
+ <td>
+ <div align="right">
+ <p>
+<a href="../index.html" title="Home">Home</a>
+|
+<a href="index.html" title="Users Guide">Users Guide</a>
+|
+<a href="../developers-guide/index.html" title="Developers Guide">Developers Guide</a>
+</p>
+
+
+ </div>
+ </td>
+ </tr>
+ </table>
+ </div>
+ </div>
+ </td>
+ <td id="cell-1-3">
+
+ </td>
+ <td id="cell-1-4">
+
+ </td>
+ </tr>
+ <tr width="100%">
+ <td id="cell-2-0" colspan="2">
+
+ </td>
+ <td id="cell-2-1">
+ <table>
+ <tr height="100%" valign="top">
+ <td height="100%">
+ <div id="wrapper-menu-page-right">
+ <div id="wrapper-menu-page-top">
+ <div id="wrapper-menu-page-bottom">
+ <div id="menu-page">
+ <h3 id="Homeindex"><a href="../index.html">Home</a></h3><ul style="list-style: square"><li><a href="../overview.html">Overview</a></li><li><a href="../quick-start.html">Quick Start</a></li></ul><h3 id="UsersGuideusersguideindex"><a href="index.html">Users Guide</a></h3><ul style="list-style: square"><li><a href="installation.html">Installing Karaf</a></li><li><a href="directory-structure.html">Directory Structure</a></li><li><a href="start-stop.html">Starting and stopping Karaf</a></li><li><a href="wrapper.html">OS integration</a></li><li><a href="using-console.html">Using the console</a></li><li><a href="remote-console.html">Remote console</a></li><li><a href="web-console.html">Web console</a></li><li><a href="child-instances.html">Child instances</a></li><li><a href="security.html">Security</a></li><li><a href="failover.html">Failover Deployments</a></li><li><a href="logging-system.html">Logging system</a></li><li><a href="deployer.html">Deployer</a
></li><li><a href="provisioning.html">Provisioning</a></li><li><a href="kar.html">KAR archive</a></li><li><a href="configuration.html">Configuration</a></li><li><a href="http.html">HTTP service</a></li><li><a href="web-applications.html">Web applications</a></li><li><a href="jre-tuning.html">JRE tuning</a></li><li><a href="jmx.html">JMX for administration and monitoring</a></li></ul><h3 id="DevelopersGuidedevelopersguideindex"><a href="../developers-guide/index.html">Developers Guide</a></h3><ul style="list-style: square"><li><a href="../developers-guide/archetypes.html">Maven Archetypes</a></li><li><a href="../developers-guide/branding-console.html">Branding the Console</a></li><li><a href="../developers-guide/extending-console.html">Extending the Console</a></li><li><a href="../developers-guide/custom-distribution.html">Custom Distribution</a></li><li><a href="../developers-guide/security-framework.html">Security Framework</a></li><li><a href="../developers-guide/features-
maven-plugin.html">Using the features-maven-plugin</a></li><li><a href="../developers-guide/debugging.html">Troubleshooting, Debugging and Profiling</a></li><li><a href="../developers-guide/connect-console.html">Programmatically connect to the console</a></li><li><a href="../developers-guide/writing-tests.html">Writing integration tests</a></li><li><a href="../developers-guide/creating-bundles.html">Creating bundles</a></li><li><a href="../developers-guide/shell-syntax.html">Shell syntax</a></li></ul><h3 id="Commandscommandscommands"><a href="../commands/commands.html">Commands</a></h3>
+ </div>
+ </div>
+ </div>
+ </div>
+ </td>
+ <td height="100%" width="100%">
+ <div class="wiki-content">
+<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="Blueprintdeployer">Blueprint deployer</h2><p>Karaf includes a deployer that is able to deploy plain blueprint 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]
+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 blueprint configuration:</p><pre>
+<blueprint xmlns="http://www.osgi.org/xmlns/blueprint/v1.0.0">
+ <manifest xmlns="http://karaf.apache.org/xmlns/deployer/blueprint/v1.0.0">
+ Require-Bundle= my-bundle
+ </manifest>
+</pre><h2 id="Springdeployer">Spring deployer</h2><p>Similar to the blueprint deployer, you can deploy spring-dm configuration files.</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>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 xmlns="http://karaf.apache.org/xmlns/deployer/spring/v1.0.0">
+ 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><p>You may set the manifest headers by specifying them as URL parameters, '$' is used separate the hierarch path and query parts of the URL, with standard URL syntax for query parameters of key=value pairs joined by '&'.</p><p>On the command line you must use single quotes around the URL to prevent the shell from attempting variable expansion, and if present, you must escape exclamation marks with a backslash.</p><pre>
+install -s 'wrap:mvn:jboss/jbossall-client/4.2.3.GA/$Bundle-SymbolicName=jbossall-client&Bundle-Version=4.2.3.GA&Export-Package=org.jboss.remoting;version="4.2.3.GA",\!*'
+</pre><p>When defined in a features.xml file, it's necessary to escape any ampersands and quotes, or use a CDATA tag.</p><pre>
+<bundle>wrap:mvn:jboss/jbossall-client/4.3.2.GA/$Bundle-SymbolicName=jbossall-client&undle-Version=4.3.2.GA&xport-Package=org.jboss.remoting;version=".3.2.GA"!*</bundle>
+</pre>
+ </div>
+ </td>
+ </tr>
+ </table>
+ </td>
+ <td id="cell-2-2" colspan="2">
+
+ </td>
+ </tr>
+ <tr width="100%">
+ <td id="cell-3-0">
+
+ </td>
+ <td id="cell-3-1">
+
+ </td>
+ <td id="cell-3-2">
+ <div id="footer">
+ <div id="site-footer">
+ © 2008-2011 The Apache Software Foundation
+ <br/>
+ Apache Karaf, Karaf, Apache, the Apache feather logo, and the Apache Karaf project logo are trademarks of The Apache Software Foundation.
+ </div>
+ </div>
+ </td>
+ <td id="cell-3-3">
+
+ </td>
+ <td id="cell-3-4">
+
+ </td>
+ </tr>
+ <tr width="100%">
+ <td id="cell-4-0" colspan="2">
+
+ </td>
+ <td id="cell-4-1">
+
+ </td>
+ <td id="cell-4-2" colspan="2">
+
+ </td>
+ </tr>
+ </table>
+ </body>
+</html>
\ No newline at end of file
Added: karaf/site/production/manual/latest-2.2.x/users-guide/directory-structure.html
URL: http://svn.apache.org/viewvc/karaf/site/production/manual/latest-2.2.x/users-guide/directory-structure.html?rev=1460031&view=auto
==============================================================================
--- karaf/site/production/manual/latest-2.2.x/users-guide/directory-structure.html (added)
+++ karaf/site/production/manual/latest-2.2.x/users-guide/directory-structure.html Fri Mar 22 22:18:53 2013
@@ -0,0 +1,150 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML Basic 1.1//EN" "http://www.w3.org/TR/xhtml-basic/xhtml-basic11.dtd">
+<html lang="en">
+ <head>
+ <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
+ <meta name="description" content="description goes here"/>
+ <meta name="keywords" content="keywords,goes,here"/>
+ <meta name="author" content="The Apache Karaf Team"/>
+ <link href="../css/style.css" rel="stylesheet" type="text/css"/>
+ <link href="../css/pygmentize.css" rel="stylesheet" type="text/css"/>
+ <title>
+ Apache Karaf 2.2.11-SNAPSHOT Guides
+ </title>
+ </head>
+ <body>
+ <table width="100%" cellpadding="0" cellspacing="0">
+ <tr width="100%">
+ <td id="cell-0-0" colspan="2">
+
+ </td>
+ <td id="cell-0-1">
+
+ </td>
+ <td id="cell-0-2" colspan="2">
+
+ </td>
+ </tr>
+ <tr width="100%">
+ <td id="cell-1-0">
+
+ </td>
+ <td id="cell-1-1">
+
+ </td>
+ <td id="cell-1-2">
+ <div style="padding: 5px;">
+ <div id="banner">
+ <table border="0" cellpadding="0" cellspacing="0" width="100%">
+ <tr>
+ <td align="left" class="topbardiv" nowrap="">
+<a href="http://karaf.apache.org/" title="A server side OSGi distribution">
+ <img border="0" src="../images/karaf-logo.png" width="400px"></img>
+</a>
+ </td>
+ <td align="right" nowrap="">
+<a href="http://www.apache.org/" title="The Apache Sofware Foundation">
+ <img border="0" src="../images/asf-logo.png">
+</a>
+ </td>
+ </tr>
+ </table>
+
+ </div>
+ <div id="top-menu">
+ <table border="0" cellpadding="1" cellspacing="0" width="100%">
+ <tr>
+ <td>
+ <div align="left"></div>
+ </td>
+ <td>
+ <div align="right">
+ <p>
+<a href="../index.html" title="Home">Home</a>
+|
+<a href="index.html" title="Users Guide">Users Guide</a>
+|
+<a href="../developers-guide/index.html" title="Developers Guide">Developers Guide</a>
+</p>
+
+
+ </div>
+ </td>
+ </tr>
+ </table>
+ </div>
+ </div>
+ </td>
+ <td id="cell-1-3">
+
+ </td>
+ <td id="cell-1-4">
+
+ </td>
+ </tr>
+ <tr width="100%">
+ <td id="cell-2-0" colspan="2">
+
+ </td>
+ <td id="cell-2-1">
+ <table>
+ <tr height="100%" valign="top">
+ <td height="100%">
+ <div id="wrapper-menu-page-right">
+ <div id="wrapper-menu-page-top">
+ <div id="wrapper-menu-page-bottom">
+ <div id="menu-page">
+ <h3 id="Homeindex"><a href="../index.html">Home</a></h3><ul style="list-style: square"><li><a href="../overview.html">Overview</a></li><li><a href="../quick-start.html">Quick Start</a></li></ul><h3 id="UsersGuideusersguideindex"><a href="index.html">Users Guide</a></h3><ul style="list-style: square"><li><a href="installation.html">Installing Karaf</a></li><li><a href="directory-structure.html">Directory Structure</a></li><li><a href="start-stop.html">Starting and stopping Karaf</a></li><li><a href="wrapper.html">OS integration</a></li><li><a href="using-console.html">Using the console</a></li><li><a href="remote-console.html">Remote console</a></li><li><a href="web-console.html">Web console</a></li><li><a href="child-instances.html">Child instances</a></li><li><a href="security.html">Security</a></li><li><a href="failover.html">Failover Deployments</a></li><li><a href="logging-system.html">Logging system</a></li><li><a href="deployer.html">Deployer</a
></li><li><a href="provisioning.html">Provisioning</a></li><li><a href="kar.html">KAR archive</a></li><li><a href="configuration.html">Configuration</a></li><li><a href="http.html">HTTP service</a></li><li><a href="web-applications.html">Web applications</a></li><li><a href="jre-tuning.html">JRE tuning</a></li><li><a href="jmx.html">JMX for administration and monitoring</a></li></ul><h3 id="DevelopersGuidedevelopersguideindex"><a href="../developers-guide/index.html">Developers Guide</a></h3><ul style="list-style: square"><li><a href="../developers-guide/archetypes.html">Maven Archetypes</a></li><li><a href="../developers-guide/branding-console.html">Branding the Console</a></li><li><a href="../developers-guide/extending-console.html">Extending the Console</a></li><li><a href="../developers-guide/custom-distribution.html">Custom Distribution</a></li><li><a href="../developers-guide/security-framework.html">Security Framework</a></li><li><a href="../developers-guide/features-
maven-plugin.html">Using the features-maven-plugin</a></li><li><a href="../developers-guide/debugging.html">Troubleshooting, Debugging and Profiling</a></li><li><a href="../developers-guide/connect-console.html">Programmatically connect to the console</a></li><li><a href="../developers-guide/writing-tests.html">Writing integration tests</a></li><li><a href="../developers-guide/creating-bundles.html">Creating bundles</a></li><li><a href="../developers-guide/shell-syntax.html">Shell syntax</a></li></ul><h3 id="Commandscommandscommands"><a href="../commands/commands.html">Commands</a></h3>
+ </div>
+ </div>
+ </div>
+ </div>
+ </td>
+ <td height="100%" width="100%">
+ <div class="wiki-content">
+<h1 id="Directorystructure">Directory structure</h1><p>The directory layout of a Karaf installation is as follows:</p><ul><li><tt>/bin</tt>: startup scripts</li><li><tt>/etc</tt>: configuration files</li><li><tt>/data</tt>: working directory <ul><li><tt>/cache</tt>: OSGi framework bundle cache</li><li><tt>/generated-bundles</tt>: temporary folder used by the deployer</li><li><tt>/log</tt>: log files</li></ul></li><li><tt>/deploy</tt>: hot deploy directory</li><li><tt>/instances</tt>: directory containing <a href="child-instances.html">child instances</a></li><li><tt>/lib</tt>: contains the bootstrap libraries<ul><li><tt>/lib/ext</tt>: directory for JRE extensions</li><li><tt>/lib/endorsed</tt>: directory for endorsed libraries</li></ul></li><li><tt>/system</tt>: OSGi bundles repository, laid out as a Maven 2 repository</li></ul><div class="tip" style="border: 1px solid #090;background-color: #dfd;margin: 20px;padding: 0px 6px 0px 6px;"><p>The <tt>data</tt> folder contains al
l 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>
+ </td>
+ </tr>
+ </table>
+ </td>
+ <td id="cell-2-2" colspan="2">
+
+ </td>
+ </tr>
+ <tr width="100%">
+ <td id="cell-3-0">
+
+ </td>
+ <td id="cell-3-1">
+
+ </td>
+ <td id="cell-3-2">
+ <div id="footer">
+ <div id="site-footer">
+ © 2008-2011 The Apache Software Foundation
+ <br/>
+ Apache Karaf, Karaf, Apache, the Apache feather logo, and the Apache Karaf project logo are trademarks of The Apache Software Foundation.
+ </div>
+ </div>
+ </td>
+ <td id="cell-3-3">
+
+ </td>
+ <td id="cell-3-4">
+
+ </td>
+ </tr>
+ <tr width="100%">
+ <td id="cell-4-0" colspan="2">
+
+ </td>
+ <td id="cell-4-1">
+
+ </td>
+ <td id="cell-4-2" colspan="2">
+
+ </td>
+ </tr>
+ </table>
+ </body>
+</html>
\ No newline at end of file
Added: karaf/site/production/manual/latest-2.2.x/users-guide/failover.html
URL: http://svn.apache.org/viewvc/karaf/site/production/manual/latest-2.2.x/users-guide/failover.html?rev=1460031&view=auto
==============================================================================
--- karaf/site/production/manual/latest-2.2.x/users-guide/failover.html (added)
+++ karaf/site/production/manual/latest-2.2.x/users-guide/failover.html Fri Mar 22 22:18:53 2013
@@ -0,0 +1,205 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML Basic 1.1//EN" "http://www.w3.org/TR/xhtml-basic/xhtml-basic11.dtd">
+<html lang="en">
+ <head>
+ <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
+ <meta name="description" content="description goes here"/>
+ <meta name="keywords" content="keywords,goes,here"/>
+ <meta name="author" content="The Apache Karaf Team"/>
+ <link href="../css/style.css" rel="stylesheet" type="text/css"/>
+ <link href="../css/pygmentize.css" rel="stylesheet" type="text/css"/>
+ <title>
+ Apache Karaf 2.2.11-SNAPSHOT Guides
+ </title>
+ </head>
+ <body>
+ <table width="100%" cellpadding="0" cellspacing="0">
+ <tr width="100%">
+ <td id="cell-0-0" colspan="2">
+
+ </td>
+ <td id="cell-0-1">
+
+ </td>
+ <td id="cell-0-2" colspan="2">
+
+ </td>
+ </tr>
+ <tr width="100%">
+ <td id="cell-1-0">
+
+ </td>
+ <td id="cell-1-1">
+
+ </td>
+ <td id="cell-1-2">
+ <div style="padding: 5px;">
+ <div id="banner">
+ <table border="0" cellpadding="0" cellspacing="0" width="100%">
+ <tr>
+ <td align="left" class="topbardiv" nowrap="">
+<a href="http://karaf.apache.org/" title="A server side OSGi distribution">
+ <img border="0" src="../images/karaf-logo.png" width="400px"></img>
+</a>
+ </td>
+ <td align="right" nowrap="">
+<a href="http://www.apache.org/" title="The Apache Sofware Foundation">
+ <img border="0" src="../images/asf-logo.png">
+</a>
+ </td>
+ </tr>
+ </table>
+
+ </div>
+ <div id="top-menu">
+ <table border="0" cellpadding="1" cellspacing="0" width="100%">
+ <tr>
+ <td>
+ <div align="left"></div>
+ </td>
+ <td>
+ <div align="right">
+ <p>
+<a href="../index.html" title="Home">Home</a>
+|
+<a href="index.html" title="Users Guide">Users Guide</a>
+|
+<a href="../developers-guide/index.html" title="Developers Guide">Developers Guide</a>
+</p>
+
+
+ </div>
+ </td>
+ </tr>
+ </table>
+ </div>
+ </div>
+ </td>
+ <td id="cell-1-3">
+
+ </td>
+ <td id="cell-1-4">
+
+ </td>
+ </tr>
+ <tr width="100%">
+ <td id="cell-2-0" colspan="2">
+
+ </td>
+ <td id="cell-2-1">
+ <table>
+ <tr height="100%" valign="top">
+ <td height="100%">
+ <div id="wrapper-menu-page-right">
+ <div id="wrapper-menu-page-top">
+ <div id="wrapper-menu-page-bottom">
+ <div id="menu-page">
+ <h3 id="Homeindex"><a href="../index.html">Home</a></h3><ul style="list-style: square"><li><a href="../overview.html">Overview</a></li><li><a href="../quick-start.html">Quick Start</a></li></ul><h3 id="UsersGuideusersguideindex"><a href="index.html">Users Guide</a></h3><ul style="list-style: square"><li><a href="installation.html">Installing Karaf</a></li><li><a href="directory-structure.html">Directory Structure</a></li><li><a href="start-stop.html">Starting and stopping Karaf</a></li><li><a href="wrapper.html">OS integration</a></li><li><a href="using-console.html">Using the console</a></li><li><a href="remote-console.html">Remote console</a></li><li><a href="web-console.html">Web console</a></li><li><a href="child-instances.html">Child instances</a></li><li><a href="security.html">Security</a></li><li><a href="failover.html">Failover Deployments</a></li><li><a href="logging-system.html">Logging system</a></li><li><a href="deployer.html">Deployer</a
></li><li><a href="provisioning.html">Provisioning</a></li><li><a href="kar.html">KAR archive</a></li><li><a href="configuration.html">Configuration</a></li><li><a href="http.html">HTTP service</a></li><li><a href="web-applications.html">Web applications</a></li><li><a href="jre-tuning.html">JRE tuning</a></li><li><a href="jmx.html">JMX for administration and monitoring</a></li></ul><h3 id="DevelopersGuidedevelopersguideindex"><a href="../developers-guide/index.html">Developers Guide</a></h3><ul style="list-style: square"><li><a href="../developers-guide/archetypes.html">Maven Archetypes</a></li><li><a href="../developers-guide/branding-console.html">Branding the Console</a></li><li><a href="../developers-guide/extending-console.html">Extending the Console</a></li><li><a href="../developers-guide/custom-distribution.html">Custom Distribution</a></li><li><a href="../developers-guide/security-framework.html">Security Framework</a></li><li><a href="../developers-guide/features-
maven-plugin.html">Using the features-maven-plugin</a></li><li><a href="../developers-guide/debugging.html">Troubleshooting, Debugging and Profiling</a></li><li><a href="../developers-guide/connect-console.html">Programmatically connect to the console</a></li><li><a href="../developers-guide/writing-tests.html">Writing integration tests</a></li><li><a href="../developers-guide/creating-bundles.html">Creating bundles</a></li><li><a href="../developers-guide/shell-syntax.html">Shell syntax</a></li></ul><h3 id="Commandscommandscommands"><a href="../commands/commands.html">Commands</a></h3>
+ </div>
+ </div>
+ </div>
+ </div>
+ </td>
+ <td height="100%" width="100%">
+ <div class="wiki-content">
+<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>Update the classpath to include the JDBC driver</li><li>Update the <tt>$KARAF_HOME/bin/karaf</tt> script to have a unique JMX remote port set if instances reside on the same host</li><li>Update the <tt>$KARAF_HOME/etc/system.properties</tt> file as follows:</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>This process will fail if a JDBC driver is not on the classpath.</li><li>The "sample" database referred to above will be created if it does not exist.</li><li>The first Karaf instance to acquire the locking table is the master instance.</li><li>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.</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><p>The same rules apply when using derby. Make sure you have the driver jar file in the Karaf <tt>lib</tt> folder before starting Karaf.</p><p>Then make you update the properties in <tt>$KARAF_HOME/etc/system.properties</tt> to look something like this example:</p><pre>karaf.lock=true
+karaf.lock.class=org.apache.karaf.main.DerbyJDBCLock
+karaf.lock.jdbc.url=jdbc:derby://127.0.0.1:1527/dbname
+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><h3 id="MySQL">MySQL</h3><p>Make sure you have the MySQL driver jar file in the Karaf <tt>lib</tt> folder before starting Karaf.</p><p><strong>NOTE</strong>: for 2.2.x, 2.3.x you need to rename the MySQL Driver jar to prefix with 'karaf-' in order for karaf to pick it up, otherwise you will see karaf just hang on startup and the log will show you that it could not find the driver.</p><p>Then make you update the properties in <tt>$KARAF_HOME/etc/system.properties</tt> to look something like this example:</p><pre>karaf.lock=true
+karaf.lock.class=org.apache.karaf.main.MySQLJDBCLock
+karaf.lock.jdbc.url=jdbc:mysql://127.0.0.1:3306/dbname
+karaf.lock.jdbc.driver=com.mysql.jdbc.Driver
+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><h3 id="PostgreSQL">PostgreSQL</h3><p>Make sure you have the PostgreSQL driver jar file in the Karaf <tt>lib</tt> folder before starting Karaf.</p><p><strong>NOTE</strong>: for 2.2.x, 2.3.x you need to rename the PostgreSQL Driver jar to prefix with 'karaf-' in order for karaf to pick it up, otherwise you will see karaf just hang on startup and the log will show you that it could not find the driver.</p><p>Then make you update the properties in <tt>$KARAF_HOME/etc/system.properties</tt> to look something like this example:</p><pre>karaf.lock=true
+karaf.lock.class=org.apache.karaf.main.PostgreSQLJDBCLock
+karaf.lock.jdbc.url=jdbc:postgresql://127.0.0.1:5432/dbname
+karaf.lock.jdbc.driver=org.postgresql.Driver
+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=0
+</pre><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>
+ </td>
+ </tr>
+ </table>
+ </td>
+ <td id="cell-2-2" colspan="2">
+
+ </td>
+ </tr>
+ <tr width="100%">
+ <td id="cell-3-0">
+
+ </td>
+ <td id="cell-3-1">
+
+ </td>
+ <td id="cell-3-2">
+ <div id="footer">
+ <div id="site-footer">
+ © 2008-2011 The Apache Software Foundation
+ <br/>
+ Apache Karaf, Karaf, Apache, the Apache feather logo, and the Apache Karaf project logo are trademarks of The Apache Software Foundation.
+ </div>
+ </div>
+ </td>
+ <td id="cell-3-3">
+
+ </td>
+ <td id="cell-3-4">
+
+ </td>
+ </tr>
+ <tr width="100%">
+ <td id="cell-4-0" colspan="2">
+
+ </td>
+ <td id="cell-4-1">
+
+ </td>
+ <td id="cell-4-2" colspan="2">
+
+ </td>
+ </tr>
+ </table>
+ </body>
+</html>
\ No newline at end of file