Added: servicemix/site/production/docs/7.x/users-guide/configuration.html URL: http://svn.apache.org/viewvc/servicemix/site/production/docs/7.x/users-guide/configuration.html?rev=1730131&view=auto ============================================================================== --- servicemix/site/production/docs/7.x/users-guide/configuration.html (added) +++ servicemix/site/production/docs/7.x/users-guide/configuration.html Fri Feb 12 22:27:08 2016 @@ -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-2014 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/7.x/users-guide/deployer.html URL: http://svn.apache.org/viewvc/servicemix/site/production/docs/7.x/users-guide/deployer.html?rev=1730131&view=auto ============================================================================== --- servicemix/site/production/docs/7.x/users-guide/deployer.html (added) +++ servicemix/site/production/docs/7.x/users-guide/deployer.html Fri Feb 12 22:27:08 2016 @@ -0,0 +1,247 @@ + +<!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="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> + </div> + + </div> + <div id="siteFooter"> + © 2008-2014 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/7.x/users-guide/directory-structure.html URL: http://svn.apache.org/viewvc/servicemix/site/production/docs/7.x/users-guide/directory-structure.html?rev=1730131&view=auto ============================================================================== --- servicemix/site/production/docs/7.x/users-guide/directory-structure.html (added) +++ servicemix/site/production/docs/7.x/users-guide/directory-structure.html Fri Feb 12 22:27:08 2016 @@ -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 # 090;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-2014 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/7.x/users-guide/failover.html URL: http://svn.apache.org/viewvc/servicemix/site/production/docs/7.x/users-guide/failover.html?rev=1730131&view=auto ============================================================================== --- servicemix/site/production/docs/7.x/users-guide/failover.html (added) +++ servicemix/site/production/docs/7.x/users-guide/failover.html Fri Feb 12 22:27:08 2016 @@ -0,0 +1,182 @@ + +<!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.lo ck=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><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 bundles. 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-2014 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/7.x/users-guide/http.html URL: http://svn.apache.org/viewvc/servicemix/site/production/docs/7.x/users-guide/http.html?rev=1730131&view=auto ============================================================================== --- servicemix/site/production/docs/7.x/users-guide/http.html (added) +++ servicemix/site/production/docs/7.x/users-guide/http.html Fri Feb 12 22:27:08 2016 @@ -0,0 +1,144 @@ + +<!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="PaxWebOSGiHttpService">Pax Web (OSGi HttpService)</h1><p>The Karaf http feature enables the Pax Web implementation of the OSGi HTTP service.</p><h2 id="InstallingtheHTTPfeature">Installing the HTTP feature</h2><pre> +root@karaf> features:install http +</pre><p>Create a file <tt>etc/org.ops4j.pax.web.cfg</tt> with the following content:</p><pre> +org.osgi.service.http.port=8080 +</pre><p>This tells Pax Web to listen to the port 8080. As soon as the http feature is installed and the config<br/>file is present, the following URL will be reachable:</p><pre> +http://localhost:8080/ +</pre><h2 id="RegisteringaservletwiththeHttpServicemanually">Registering a servlet with the HttpService manually</h2><p>See <a href="http://felix.apache.org/site/apache-felix-http-service.html";>Apache Felix HTTP Service</a>.</p><h2 id="UsingthePaxWebwhiteboardextender">Using the Pax Web whiteboard extender</h2><p>The Pax Web whiteboard extender is part of the war feature. So use the following command to install:</p><pre> +root@karaf> features:install war +</pre><p>The <a href="http://wiki.ops4j.org/display/ops4j/Pax+Web+Extender+-+Whiteboard";>Pax Web whiteboard</a> extender listens to services<br/>of interface type HttpServlet and Filter.<br/>It will register each of these interfaces with the HttpService and remove them as soon as the service goes down.<br/>So it is much more convenient than registering with the HttpService directly.</p><pre> +<blueprint xmlns="http://www.osgi.org/xmlns/blueprint/v1.0.0";> + <service interface="javax.servlet.http.HttpServlet"> + <service-properties> + <entry key="alias" value="/myservlet"/> + </service-properties> + <bean id="myServlet" class="com.example.MyServlet"/> + </service> +</blueprint> +</pre><p>The above snippet publishes the Servlet MyServlet on http://localhost:8080/myServlet.</p><p>Please keep in mind that the Whiteboard pattern for Servlets is not standardized and only works with Pax Web.</p> + </div> + + </div> + <div id="siteFooter"> + © 2008-2014 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/7.x/users-guide/index.html URL: http://svn.apache.org/viewvc/servicemix/site/production/docs/7.x/users-guide/index.html?rev=1730131&view=auto ============================================================================== --- servicemix/site/production/docs/7.x/users-guide/index.html (added) +++ servicemix/site/production/docs/7.x/users-guide/index.html Fri Feb 12 22:27:08 2016 @@ -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="KarafUsersGuide">Karaf Users Guide</h1><ul><li><p><a href="installation.html">Installing Karaf</a></p></li><li><p><a href="directory-structure.html">Directory Structure</a></p></li><li><p><a href="start-stop.html">Starting and stopping Karaf</a></p></li><li><p><a href="using-console.html">Using the console</a></p></li><li><p><a href="wrapper.html">Service Wrapper</a></p></li><li><p><a href="web-console.html">Web console</a></p></li><li><p><a href="remote-console.html">Remote console</a></p></li><li><p><a href="child-instances.html">Child instances</a></p></li><li><p><a href="security.html">Security</a></p></li><li><p><a href="failover.html">Failover Deployments</a></p></li><li><p><a href="logging-system.html">Logging system</a></p></li><li><p><a href="deployer.html">Deployer</a></p></li><li><p><a href="provisioning.html">Provisioning</a><br/>* <a href="provisioning-schema.html">Provisioning Schema</a></p></li><li><p><a href="kar.html">Karaf Archive</a></p></li><li><p><a href="configuration.html">Configuration</a></p></li><li><p><a href="http.html">Pax Web (OSGi HttpService)</a></p></li><li><p><a href="web-applications.html">Web applications</a></p></li><li><p><a href="wrapper.html">OS integration</a></p></li><li><p><a href="jre-tuning.html">JRE packages tuning</a></p></li><li><p><a href="jmx.html">Monitoring and Administration using JMX</a></p></li></ul> + </div> + + </div> + <div id="siteFooter"> + © 2008-2014 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/7.x/users-guide/installation.html URL: http://svn.apache.org/viewvc/servicemix/site/production/docs/7.x/users-guide/installation.html?rev=1730131&view=auto ============================================================================== --- servicemix/site/production/docs/7.x/users-guide/installation.html (added) +++ servicemix/site/production/docs/7.x/users-guide/installation.html Fri Feb 12 22:27:08 2016 @@ -0,0 +1,148 @@ + +<!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="Installation">Installation</h1><p>This chapter describes how to install Apache Karaf for both Unix and Windows platforms, including<br/>prerequisite software and necessary download links.</p><h2 id="PreInstallationRequirements">Pre-Installation Requirements</h2><p><strong>Hardware:</strong></p><ul><li><p>20 MB of free disk space for the Apache Karaf x.y binary distribution.</p></li></ul><p><strong>Operating Systems:</strong></p><ul><li><p>Windows: Windows Vista, Windows XP SP2, Windows 2000.</p></li><li><p>Unix: Ubuntu Linux, Powerdog Linux, MacOS, AIX, HP-UX, Solaris, any Unix platform that supports Java.</p></li></ul><p><strong>Environment:</strong></p><ul><li><p>Java SE Development Kit 1.5.x or greater (<a href="http://www.oracle.com/technetwork/java/javase/";>http://www.oracle.com/technetwork/java/javase/</a>).</p></li><li><p>The JAVA_HOME environment variable must be set to the directory where the Java runtime is installed, e.g., <tt>c:\Prog ram Files\jdk.1.5.0_06</tt>. To accomplish that, press Windows key and Break key together, switch to "Advanced" tab and click on "Environment Variables". Here, check for the variable and, if necessary, add it.</p></li></ul><h2 id="BuildingfromSources">Building from Sources</h2><p>If you intend to build Karaf from the sources, the requirements are a bit different:</p><p><strong>Hardware:</strong></p><ul><li><p>200 MB of free disk space for the Apache Karaf x.y source distributions or SVN checkout, the Maven build and the dependencies Maven downloads.</p></li></ul><p><strong>Environment:</strong></p><ul><li><p>Java SE Developement Kit 1.5.x or greater (<a href="http://www.oracle.com/technetwork/java/javase/";>http://www.oracle.com/technetwork/java/javase/</a>).</p></li><li><p>Apache Maven 2.2.1 (<a href="http://maven.apache.org/download.html";>http://maven.apache.org/download.html</a>).</p></li></ul><h3 id="BuildingonWindows">Building on Windows</h3><p>This procedure explains how to dow nload and install the source distribution on a Windows system. <strong>NOTE:</strong> Karaf requires Java 5 is compile, build and run.</p><ol><li><p>From a browser, navigate to <a href="http://karaf.apache.org/index/community/download.html";>http://karaf.apache.org/index/community/download.html</a>.</p></li><li><p>Scroll down to the "Apache Karaf" section and select the desired distribution.<br/>For a source distribution, the filename will be similar to: <tt>apache-karaf-x.y-src.zip</tt>.</p></li><li><p>Extract Karaf from the ZIP file into a directory of your choice. Please remember the restrictions concerning illegal characters in Java paths, e.g. !, % etc.</p></li><li><p><span id="WindowsSourceInstallation"></span> Build Karaf using Maven 2.2.1 or greater and Java 5.<br/>The recommended method of building Karaf is the following:</p><pre> +cd [karaf_install_dir]\src +</pre><p> where <tt>[karaf_install_dir]</tt> is the directory in which Karaf was installed.</p><pre> +mvn +</pre><p>Both steps take around 10 to 15 minutes.</p></li><li><p>Unzip the distribution using your favorite zip tool. The windows distribution is available at</p><pre> +[karaf_install_dir]\assembly\target\apache-karaf-x.y.zip +</pre></li><li><p>Proceed to the <a href="start-stop#Starting Karaf.html">Starting Karaf</a> chapter.</p></li></ol><h3 id="BuildingonUnix">Building on Unix</h3><p>This procedure explains how to download and install the source distribution on a Unix system. This procedure assumes the Unix machine has a browser. Please see the previous <a href="#UnixBinaryInstallation.html">Unix Binary Installation</a> section for ideas on how to install Karaf without a browser. <strong>NOTE:</strong> Karaf requires Java 5 to compile, build and run.</p><ol><li><p>From a browser, navigate to <a href="http://karaf.apache.org/download.html";>http://karaf.apache.org/download.html</a>.</p></li><li><p>Scroll down to the "Apache Karaf" section and select the desired distribution.<br/>For a source distribution, the filename will be similar to: <tt>apache-karaf-x.y-src.tar.gz</tt>.</p></li><li><p>Extract the files from the ZIP file into a directory of your choice. For example:</p><pre> +gunzip apache-karaf-x.y-src.tar.gz +tar xvf apache-karaf-x.y-src.tar +</pre><p>Please remember the restrictions concerning illegal characters in Java paths, e.g. !, % etc.</p></li><li><p>Build Karaf using Maven:<br/>The preferred method of building Karaf is the following:</p><pre> +cd [karaf_install_dir]/src +</pre><p> where [karaf_install_dir] is the directory in which Karaf was installed.</p><pre> +mvn +</pre></li><li><p>Uncompress the distribution that has just been created</p><pre> +cd [karaf_install_dir]/assembly/target +gunzip apache-karaf-x.y.tar.gz +tar xvf apache-karaf-x.y.tar +</pre></li><li><p>Proceed to the <a href="start-stop#Starting Karaf.html">Starting Karaf</a> chapter.</p></li></ol><h2 id="InstallationProcedureforWindows">Installation Procedure for Windows</h2><p>This procedure explains how to download and install the binary distribution on a Windows system.</p><ol><li><p>From a browser, navigate to <a href="http://karaf.apache.org/index/community/download.html";>http://karaf.apache.org/index/community/download.html</a>.</p></li><li><p>Scroll down to the "Apache Karaf" section and select the desired distribution.<br/>For a binary distribution, the filename will be similar to: <tt>apache-karaf-x.y.zip</tt>.</p></li><li><p>Extract the files from the ZIP file into a directory of your choice. Please remember the restrictions concerning illegal characters in Java paths, e.g. !, % etc.</p></li><li><p>Proceed to the <a href="start-stop#Starting Karaf.html">Starting Karaf</a> chapter.</p></li><li><p>Optional: see <a href="colorized-console.html">enabling C olorized Console Output On Windows</a></p></li></ol><div class="tip" style="border: 1px solid #090;background-color: #dfd;margin: 20px;padding: 0px 6px 0px 6px;"><p><b>Handy Hint</b></p><p>In case you have to install Karaf into a very deep path or a path containing illegal characters for Java paths, e.g. !, % etc., you may add a bat file to <em>start \-> startup</em> that executes</p><pre>subst S: "C:\your very % problematic path!\KARAF" +</pre><p>so your Karaf root directory is S: <del>-</del> which works for sure and is short to type.</p></div><h2 id="InstallationProcedureForUnix">Installation Procedure For Unix</h2><p>This procedure explains how to download and install the binary distribution on a Unix system.</p><ol><li><p>From a browser, navigate to <a href="http://karaf.apache.org/download.html";>http://karaf.apache.org/download.html</a>.</p></li><li><p>Scroll down to the "Apache Karaf" section and select the desired distribution.<br/>For a binary Unix distribution, the filename will be similar to: apache-karaf-x.y.tar.gz.</p></li><li><p>Extract the files from the gzip file into a directory of your choice. For example:</p><pre> +gunzip apache-karaf-x.y.tar.gz +tar xvf apache-karaf-x.y.tar +</pre><p>Please remember the restrictions concerning illegal characters in Java paths, e.g. !, % etc.</p></li><li><p>Proceed to the <a href="start-stop#Starting Karaf.html">Starting Karaf</a> chapter.</p></li></ol><h2 id="PostInstallationsteps">Post-Installation steps</h2><p>Thought it is not always required, it is strongly advised to set up the <tt>JAVA_HOME</tt> environment property to point to the JDK you want Karaf to use before starting it.<br/>This property is used to locate the <tt>java</tt> executable and should be configured to point to the home directory of the Java SE 5 or 6 installation.</p> + </div> + + </div> + <div id="siteFooter"> + © 2008-2014 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/7.x/users-guide/jmx.html URL: http://svn.apache.org/viewvc/servicemix/site/production/docs/7.x/users-guide/jmx.html?rev=1730131&view=auto ============================================================================== --- servicemix/site/production/docs/7.x/users-guide/jmx.html (added) +++ servicemix/site/production/docs/7.x/users-guide/jmx.html Fri Feb 12 22:27:08 2016 @@ -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="MonitoringandAdministrationusingJMX">Monitoring and Administration using JMX</h1><p>Apache Karaf provides a large set of MBeans that allow you to fully monitore and administrate Karaf using any JMX client<br/>(like jconsole for instance).</p><p>You can find more or less the same actions that you can do using the shell commands on the JMX layer.</p><p>Apache Karaf provides the following MBeans:</p><ul><li><p>org.apache.karaf:type=admin to administrate the child instances</p></li><li><p>org.apache.karaf:type=bundles to manipulate the OSGi bundles</p></li><li><p>org.apache.karaf:type=config to manipulate the Karaf configuration files (in the etc folder) and the ConfigAdmin layer</p></li><li><p>org.apache.karaf:type=dev to get information and manipulate the OSGi framework</p></li><li><p>org.apache.karaf:type=diagnostic to create information file (dump) about Karaf activity</p></li><li><p>org.apache.karaf:type=features to manipulate the Karaf feature s</p></li><li><p>org.apache.karaf:type=log to manipulate to logging layer</p></li><li><p>org.apache.karaf:type=packages to manipulate to PackageAdmin layer and get information about exported and imported packages</p></li><li><p>org.apache.karaf:type=services to get information about the OSGi services</p></li><li><p>org.apache.karaf:type=system to shutdown the Karaf container itself</p></li><li><p>org.apache.karaf:type=web to get information about the Web bundles (installed with the war feature)</p></li><li><p>org.apache.karaf:type=obr to manipulate the OBR layer (installed with the obr feature)</p></li></ul> + </div> + + </div> + <div id="siteFooter"> + © 2008-2014 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
