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:07:47 UTC
svn commit: r1460030 [16/23] - in /karaf/site/production/manual/latest: ./
commands/ css/ css/scalate/ developers-guide/ images/ users-guide/
Added: karaf/site/production/manual/latest/developers-guide/extending-console.html
URL: http://svn.apache.org/viewvc/karaf/site/production/manual/latest/developers-guide/extending-console.html?rev=1460030&view=auto
==============================================================================
--- karaf/site/production/manual/latest/developers-guide/extending-console.html (added)
+++ karaf/site/production/manual/latest/developers-guide/extending-console.html Fri Mar 22 22:07:43 2013
@@ -0,0 +1,375 @@
+<!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 3.0.0-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="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/configuration.html">Configuration</a></li><li><a href="../users-guide/using-console.html">Using the console</a></li><li><a href="../users-guide/web-console.html">Web 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/deployer.html">Deployer</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">Failover Deployments</a></li><li><a href="../users-guide/logging-system.html">Logging system</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/jre-tuning.html">JRE tuning</a></li><li><a href="../users-guide/web-applications.html">Web applications</a></li><li><a href="../users-guide/http.html">HTTP service</a></li><li><a href="../users-guide/jmx.html">JMX for monitoring and administration</a></li></ul><h3 id="DevelopersGuidedevelopersguideindex"><a href="index.html">Developers Guide</a></h3><ul style="list-style: square"><li><a href="connect-console.html">Programmatically connect to the Console</a></li><li><a href="shell-syntax.html">
Shell syntax</a></li><li><a href="creating-bundles.html">Creating bundles</a></li><li><a href="debugging.html">Troubleshooting, Debugging and Profiling</a></li><li><a href="developer-command.html">Developer Commands</a></li><li><a href="archetypes.html">Maven Archetypes</a></li><li><a href="extending-console.html">Extending the Console</a></li><li><a href="branding-console.html">Branding the Console</a></li><li><a href="karaf-maven-plugin.html">Using the Karaf Maven plugin</a></li><li><a href="security-framework.html">Security Framework</a></li><li><a href="custom-distribution.html">Custom Distribution</a></li><li><a href="debugging.html">Troubleshooting, Debugging and Profiling</a></li><li><a href="connect-console.html">Programmatically connect to the console</a></li><li><a href="writing-tests.html">Writing integration tests</a></li><li><a href="creating-bundles.html">Creating bundles</a></li><li><a href="shell-syntax.html">Shell syntax</a></li><li><a href="github-contribut
ions.html">Github Contributions</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="Extendingtheconsole">Extending the console</h1><p>This chapter will guide you through the steps needed to extend the console and create a new shell.<br/>We will leverage Maven, Blueprint and OSGi, so you will need some knowledge of those products.</p><p>You may also find some information about the console at <a href="http://felix.apache.org/site/rfc-147-overview.html">http://felix.apache.org/site/rfc-147-overview.html</a>.</p><h2 id="Createtheprojectusingmaven">Create the project using maven</h2><p>We first need to create a project using Maven. Let's leverage Maven archetypes for that.</p><h3 id="Commandline">Command line</h3><p>Using the command line, we can create our project:</p><pre>
+mvn archetype:create \
+ -DarchetypeArtifactId=maven-archetype-quickstart \
+ -DgroupId=org.apache.karaf.shell.samples \
+ -DartifactId=shell-sample-commands \
+ -Dversion=1.0-SNAPSHOT
+</pre><p>This generate the main <tt>pom.xml</tt> and some additional packages.</p><h3 id="Interactiveshell">Interactive shell</h3><p>You can also use the interactive mode for creating the skeleton project:</p><pre>
+mvn archetype:generate
+</pre><p>Use the following values when prompted:</p><pre>
+Choose a number: (1/2/3/4/5/6/7/.../32/33/34/35/36) 15: : 15
+Define value for groupId: : org.apache.karaf.shell.samples
+Define value for artifactId: : shell-sample-commands
+Define value for version: 1.0-SNAPSHOT: :
+Define value for package: : org.apache.karaf.shell.samples
+</pre><h3 id="Manualcreation">Manual creation</h3><p>Alternatively, you can simply create the directory <tt>shell-sample-commands</tt> and create the <tt>pom.xml</tt> file inside it:</p><div class="syntax"><pre name='code' class='brush: xml; gutter: false;'><code>
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+
+ <modelVersion>4.0.0</modelVersion>
+
+ <groupId>org.apache.karaf.shell.samples</groupId>
+ <artifactId>shell-sample-commands<artifactId>
+ <packaging>bundle</packaging>
+ <version>1.0-SNAPSHOT</version>
+ <name>shell-sample-commmands</name>
+
+
+ <dependencies>
+ <dependency>
+ <groupId>org.apache.karaf.shell</groupId>
+ <artifactId>org.apache.karaf.shell.console</artifactId>
+ <version>3.0.0-SNAPSHOT</version>
+ </dependency>
+ <dependency>
+ <groupId>junit</groupId>
+ <artifactId>junit</artifactId>
+ <version>3.8.1</version>
+ <scope>test</scope>
+ </dependency>
+ </dependencies>
+
+ <build>
+ <plugins>
+ <plugin>
+ <groupId>org.apache.felix</groupId>
+ <artifactId>maven-bundle-plugin</artifactId>
+ <version>2.3.7</version>
+ <configuration>
+ <instructions>
+ <Import-Package>
+ org.apache.felix.service.command,
+ org.apache.karaf.shell.commands,
+ org.apache.karaf.shell.console,
+ *
+ </Import-Package>
+ </instructions>
+ </configuration>
+ </plugin>
+ </plugins>
+ </build>
+
+</project></code></pre></div><h2 id="ConfiguringforJava6">Configuring for Java 6</h2><p>We are using annotations to define commands, so we need to ensure Maven will actually use JDK 1.6 to compile the jar.<br/>Just add the following snippet after the <tt>dependencies</tt> section.</p><div class="syntax"><pre name='code' class='brush: xml; gutter: false;'><code>
+<build>
+ <plugins>
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-compiler-plugin</artifactId>
+ <configuration>
+ <target>1.6</target>
+ <source>1.6</source>
+ </configuration>
+ </plugin>
+ </plugins>
+</build></code></pre></div><h2 id="LoadingtheprojectinyourIDE">Loading the project in your IDE</h2><p>We can use Maven to generate the needed files for your IDE:</p><p>Inside the project, run the following command</p><pre>
+mvn eclipse:eclipse
+</pre><p>or</p><pre>
+mvn idea:idea
+</pre><p>The project files for your IDE should now be created. Just open the IDE and load the project.</p><h2 id="Creatingabasiccommandclass">Creating a basic command class</h2><p>We can now create the command class <tt>HelloShellCommand.java</tt></p><div class="syntax"><pre name='code' class='brush: java; gutter: false;'><code>
+package org.apache.karaf.shell.samples;
+
+import Command;
+import org.apache.karaf.shell.console.OsgiCommandSupport;
+
+@Command(scope = "test", name = "hello", description="Says hello")
+public class HelloShellCommand extends OsgiCommandSupport {
+
+ @Override
+ protected Object doExecute() throws Exception {
+ System.out.println("Executing Hello command");
+ return null;
+ }
+}</code></pre></div><h2 id="Creatingtheassociatedblueprintconfigurationfiles">Creating the associated blueprint configuration files</h2><p>The blueprint configuration file will be used to create the command and register it in the OSGi registry, which is the way to make the command available to Karaf console. This blueprint file must be located in the <tt>OSGI-INF/blueprint/</tt> directory inside the bundle.</p><p>If you don't have the <tt>src/main/resources</tt> directory yet, create it.</p><pre>
+mkdir src/main/resources
+</pre><p>Then, re-generate the IDE project files and reload it so that this folder is now recognized as a source folder.</p><p>Inside this directory, create the <tt>OSGI-INF/blueprint/</tt> directory and put the following file inside (the name of this file has no impact at all):</p><div class="syntax"><pre name='code' class='brush: xml; gutter: false;'><code>
+<blueprint xmlns="http://www.osgi.org/xmlns/blueprint/v1.0.0">
+
+ <command-bundle xmlns="http://karaf.apache.org/xmlns/shell/v1.1.0">
+ <command>
+ <action class="org.apache.karaf.shell.samples.HelloShellCommand"/>
+ </command>
+ </command-bundle>
+
+</blueprint></code></pre></div><h2 id="Compilingthejar">Compiling the jar</h2><p>Let's try to build the jar. Remove the test classes and sample classes if you used the artifact, then from the command line, run:</p><pre>
+mvn install
+</pre><p>The end of the maven output should look like:</p><pre>
+[INFO] ------------------------------------------------------------------------
+[INFO] BUILD SUCCESSFUL
+[INFO] ------------------------------------------------------------------------
+</pre><h2 id="TestinKaraf">Test in Karaf</h2><p>Launch a Karaf instance and run the following command to install the newly created bundle:</p><pre>
+karaf@root> bundles:install -s mvn:org.apache.karaf.shell.samples/shell-sample-commands/1.0-SNAPSHOT
+</pre><p>Let's try running the command:</p><pre>
+karaf@root> test:hello
+Executing Hello command
+</pre><h1 id="Commandcompleter">Command completer</h1><p>A completer allows you to automatically complete a command argument using <tab>. A completer is simply a bean which is<br/>injected to a command.</p><p>Of course to be able to complete it, the command should require an argument.</p><h2 id="Commandargument">Command argument</h2><p>We add an argument to the HelloCommand:</p><pre>
+package org.apache.karaf.shell.samples;
+
+import Command;
+import Argument;
+import org.apache.karaf.shell.console.OsgiCommandSupport;
+
+@Command(scope = "test", name = "hello", description="Says hello")
+public class HelloShellCommand extends OsgiCommandSupport {
+
+ @Argument(index = 0, name = "name", description = "The name that sends the greet.", required = true, multiValued = false)
+ String name = null;
+
+ @Override
+ protected Object doExecute() throws Exception {
+ System.out.println("Hello " + name);
+ return null;
+ }
+}
+</pre><p>The Blueprint configuration file is the same as previously.</p><h2 id="Completerbean">Completer bean</h2><p>A completer is a bean which implements the Completer interface:</p><pre>
+package org.apache.karaf.shell.samples;
+
+import org.apache.karaf.shell.console.completer.StringsCompleter;
+import org.apache.karaf.shell.console.Completer;
+
+/**
+ * <p>
+ * A very simple completer.
+ * </p>
+ */
+public class SimpleNameCompleter implements Completer {
+
+ /**
+ * @param buffer the beginning string typed by the user
+ * @param cursor the position of the cursor
+ * @param candidates the list of completions proposed to the user
+ */
+ public int complete(String buffer, int cursor, List candidates) {
+ StringsCompleter delegate = new StringsCompleter();
+ delegate.getStrings().add("Mike");
+ delegate.getStrings().add("Eric");
+ delegate.getStrings().add("Jenny");
+ return delegate.complete(buffer, cursor, candidates);
+ }
+
+}
+</pre><h2 id="Blueprintconfigurationfile">Blueprint configuration file</h2><p>Using Blueprint, you can "inject" the completer linked to your command. The same completer could be used for several commands and a command can have several completers:</p><pre>
+<blueprint xmlns="http://www.osgi.org/xmlns/blueprint/v1.0.0">
+
+ <command-bundle xmlns="http://karaf.apache.org/xmlns/shell/v1.1.0">
+ <command>
+ <action class="org.apache.karaf.shell.samples.HelloShellCommand"/>
+ <completers>
+ <ref component-id="simpleNameCompleter"/>
+ <null/>
+ </completers>
+ </command>
+ </command-bundle>
+
+ <bean id="simpleNameCompleter" class="org.apache.karaf.shell.samples.SimpleNameCompleter"/>
+
+</blueprint>
+</pre><p>You can have multiple completers for a single class, each matching a command argument.<br/>The order of the completers must match the order of the arguments, in order to have the desirable results.</p><h2 id="Completersforoptionvalues">Completers for option values</h2><p>Quite often your commands will not have just arguments, but also options. You can provide completers for option values.<br/>The snippet below shows the HelloShellCommand with an option to specify what the greet message will be.</p><pre>
+package org.apache.karaf.shell.samples;
+
+import Command;
+import Argument;
+import org.apache.karaf.shell.console.OsgiCommandSupport;
+
+@Command(scope = "test", name = "hello", description="Says hello")
+public class HelloShellCommand extends OsgiCommandSupport {
+
+ @Argument(index = 0, name = "name", description = "The name that sends the greet.", required = true, multiValued = false)
+ String name = null;
+
+ @Option(name = "-g", aliases = "--greet", description = "The configuration pid", required = false, multiValued = false)
+ String greet = "Hello;
+
+ @Override
+ protected Object doExecute() throws Exception {
+ System.out.println(greet + " " + name);
+ return null;
+ }
+}
+</pre><p>We can now specify a completer for the greet option. All that is required is to add an optional-completer element in the<br/>blueprint configuration that will associate a completer with the -g option or its --greet alias.</p><pre>
+<blueprint xmlns="http://www.osgi.org/xmlns/blueprint/v1.0.0">
+
+ <command-bundle xmlns="http://karaf.apache.org/xmlns/shell/v1.1.0">
+ <command>
+ <action class="org.apache.karaf.shell.samples.HelloShellCommand"/>
+ <completers>
+ <ref component-id="simpleNameCompleter"/>
+ <null/>
+ </completers>
+ <optional-completers>
+ <entry key="-g" value-ref="greetCompleter"/>
+ </optional-completers>
+ </command>
+ </command-bundle>
+
+ <bean id="simpleNameCompleter" class="org.apache.karaf.shell.samples.SimpleNameCompleter"/>
+ <bean id="greetCompleter" class="org.apache.karaf.shell.samples.GreetCompleter"/>
+
+</blueprint>
+</pre><h2 id="Completerswithstate.">Completers with state.</h2><p>Some times we want to tune the behavior of the completer depending on the commands already executed, in the current shell<br/>or even the rest of the arguments that have been already passed to the command. Such example is the config:set-property<br/>command which will provide auto completion for only for the properties of the pid specified by a previously issued config:edit<br/>command or by the option --pid.</p><p>This is done by accessing the CommandSession object which holds the state of the console. To get access to the CommandSession:</p><pre>
+CommandSession session = CommandSessionHolder.getSession();
+</pre><p>CommandSession provides map like methods for storing key/value pairs and can be used to put/get the state.</p><p>If you want to get access to the list of arguments that is already passed to the command, you can simply:</p><pre>
+ArgumentCompleter.ArgumentList list = (ArgumentCompleter.ArgumentList) commandSession.get(ArgumentCompleter.ARGUMENTS_LIST);
+</pre><h2 id="TestinKaraf2">Test in Karaf</h2><p>Launch a Karaf instance and run the following command to install the newly created bundle:</p><pre>
+karaf@root> bundles:install -s mvn:org.apache.karaf.shell.samples/shell-sample-commands/1.0-SNAPSHOT
+</pre><p>Let's try running the command:</p><pre>
+karaf@root> test:hello <tab>
+ one two three
+</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/developers-guide/github-contributions.html
URL: http://svn.apache.org/viewvc/karaf/site/production/manual/latest/developers-guide/github-contributions.html?rev=1460030&view=auto
==============================================================================
--- karaf/site/production/manual/latest/developers-guide/github-contributions.html (added)
+++ karaf/site/production/manual/latest/developers-guide/github-contributions.html Fri Mar 22 22:07:43 2013
@@ -0,0 +1,184 @@
+<!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 3.0.0-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="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/configuration.html">Configuration</a></li><li><a href="../users-guide/using-console.html">Using the console</a></li><li><a href="../users-guide/web-console.html">Web 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/deployer.html">Deployer</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">Failover Deployments</a></li><li><a href="../users-guide/logging-system.html">Logging system</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/jre-tuning.html">JRE tuning</a></li><li><a href="../users-guide/web-applications.html">Web applications</a></li><li><a href="../users-guide/http.html">HTTP service</a></li><li><a href="../users-guide/jmx.html">JMX for monitoring and administration</a></li></ul><h3 id="DevelopersGuidedevelopersguideindex"><a href="index.html">Developers Guide</a></h3><ul style="list-style: square"><li><a href="connect-console.html">Programmatically connect to the Console</a></li><li><a href="shell-syntax.html">
Shell syntax</a></li><li><a href="creating-bundles.html">Creating bundles</a></li><li><a href="debugging.html">Troubleshooting, Debugging and Profiling</a></li><li><a href="developer-command.html">Developer Commands</a></li><li><a href="archetypes.html">Maven Archetypes</a></li><li><a href="extending-console.html">Extending the Console</a></li><li><a href="branding-console.html">Branding the Console</a></li><li><a href="karaf-maven-plugin.html">Using the Karaf Maven plugin</a></li><li><a href="security-framework.html">Security Framework</a></li><li><a href="custom-distribution.html">Custom Distribution</a></li><li><a href="debugging.html">Troubleshooting, Debugging and Profiling</a></li><li><a href="connect-console.html">Programmatically connect to the console</a></li><li><a href="writing-tests.html">Writing integration tests</a></li><li><a href="creating-bundles.html">Creating bundles</a></li><li><a href="shell-syntax.html">Shell syntax</a></li><li><a href="github-contribut
ions.html">Github Contributions</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="GithubContributions">Github Contributions</h1><p>Some people prefer to make contributions to karaf source via github. If you are one of them, this is for you!</p><h2 id="Introduction">Introduction</h2><p>Apache Karaf is available as a periodically replicated mirror on: <a href="https://github.com/apache/karaf">https://github.com/apache/karaf</a> </p><h2 id="SuggestedWorkflow">Suggested Workflow</h2><ol><li>make a fork of karaf repo github mirror</li><li>do all your new work on your own karaf fork</li><li>when ready, file a jira issue <a href="https://issues.apache.org/jira/browse/KARAF">https://issues.apache.org/jira/browse/KARAF</a>, attach the link to your github pull request, and ask for a review</li><li>one of karaf committers will discuss your pull request on github; and at some point your pull request will be accepted </li><li>when your pull request is accepted, squash it into a single commit and attach single patch file to the original jira, with ASF grant che
ck box selected </li><li>now pray to your favorite ASF committer to really accept the patch :-)</li><li>when your patch is committed to the svn, and you can verify it in the latest karaf snapshot, close your pull request on github </li></ol><h2 id="LicenseReminder">License Reminder</h2><p>in order for your contributions to be accepted:</p><ul><li>all files must contain ASL license grant header</li></ul><ul><li>you must select ASF grant check box when attaching patch to the jira</li></ul><h2 id="HowtoGenerateaOneFilePatchViaThrowAwayBranch">How to Generate a One-File-Patch Via Throw-Away Branch</h2><p>here is one way to generate squash of your commits:</p><p><a href="http://stackoverflow.com/questions/616556/how-do-you-squash-commits-into-one-patch-with-git-format-patch">http://stackoverflow.com/questions/616556/how-do-you-squash-commits-into-one-patch-with-git-format-patch</a></p><pre>
+
+#
+# 'archon' referers to karaf mirror
+# 'origin' referers to your own fork
+#
+
+# attach karaf mirror as remote, if not done yet
+git remote add archon https://github.com/apache/karaf
+
+# fetch latest karaf mirror
+git fetch archon
+
+# ensure you are on your fork trunk
+git checkout origin/trunk
+
+# kill previous patch delivery, if you had one
+git branch -D delivery
+
+# make new delivery throw-away branch, based on latest karaf mirror
+git branch delivery archon/trunk
+
+# use it
+git checkout delivery
+
+# squash all your local development into a single commit
+git merge --squash trunk
+
+# commit it to the delivery branch
+git commit -m "delivery"
+
+# generate a patch file against the mirror
+git format-patch archon/trunk
+
+</pre><p>root of your karaf source now contains a file named "0001-delivery.patch.txt" (please attach the .txt ending;this will allow commiters to open your patch directly in the browser and give it a short look there) which you should attach to your karaf jira, and ask to commit to the svn trunk</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/developers-guide/index.html
URL: http://svn.apache.org/viewvc/karaf/site/production/manual/latest/developers-guide/index.html?rev=1460030&view=auto
==============================================================================
--- karaf/site/production/manual/latest/developers-guide/index.html (added)
+++ karaf/site/production/manual/latest/developers-guide/index.html Fri Mar 22 22:07:43 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 3.0.0-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="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/configuration.html">Configuration</a></li><li><a href="../users-guide/using-console.html">Using the console</a></li><li><a href="../users-guide/web-console.html">Web 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/deployer.html">Deployer</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">Failover Deployments</a></li><li><a href="../users-guide/logging-system.html">Logging system</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/jre-tuning.html">JRE tuning</a></li><li><a href="../users-guide/web-applications.html">Web applications</a></li><li><a href="../users-guide/http.html">HTTP service</a></li><li><a href="../users-guide/jmx.html">JMX for monitoring and administration</a></li></ul><h3 id="DevelopersGuidedevelopersguideindex"><a href="index.html">Developers Guide</a></h3><ul style="list-style: square"><li><a href="connect-console.html">Programmatically connect to the Console</a></li><li><a href="shell-syntax.html">
Shell syntax</a></li><li><a href="creating-bundles.html">Creating bundles</a></li><li><a href="debugging.html">Troubleshooting, Debugging and Profiling</a></li><li><a href="developer-command.html">Developer Commands</a></li><li><a href="archetypes.html">Maven Archetypes</a></li><li><a href="extending-console.html">Extending the Console</a></li><li><a href="branding-console.html">Branding the Console</a></li><li><a href="karaf-maven-plugin.html">Using the Karaf Maven plugin</a></li><li><a href="security-framework.html">Security Framework</a></li><li><a href="custom-distribution.html">Custom Distribution</a></li><li><a href="debugging.html">Troubleshooting, Debugging and Profiling</a></li><li><a href="connect-console.html">Programmatically connect to the console</a></li><li><a href="writing-tests.html">Writing integration tests</a></li><li><a href="creating-bundles.html">Creating bundles</a></li><li><a href="shell-syntax.html">Shell syntax</a></li><li><a href="github-contribut
ions.html">Github Contributions</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="DevelopersGuide">Developers Guide</h1><ul><li><a href="connect-console.html">Connect to the Console</a></li><li><a href="branding-console.html">Branding the Console</a></li><li><a href="archetypes.html">Maven Archetypes</a></li><li><a href="extending-console.html">Extending the Console</a></li><li><a href="custom-distribution.html">Custom Distribution</a></li><li><a href="security-framework.html">Security Framework</a></li><li><a href="karaf-maven-plugin.html">Using the karaf-maven-plugin</a></li><li><a href="debugging.html">Troubleshooting, Debugging, Profiling, and Monitoring</a></li><li><a href="developer-commands.html">Developer commands</a></li><li><a href="connect-console.html">Programmatically connect to the console</a></li><li><a href="writing-tests.html">Writing integration tests</a></li><li><a href="creating-bundles.html">Creating bundles</a></li><li><a href="shell-syntax.html">Shell syntax</a></li><li><a href="github-contributions.html">Github Contribution
s</a></li></ul>
+ </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/developers-guide/karaf-maven-plugin-commands-generate-help.html
URL: http://svn.apache.org/viewvc/karaf/site/production/manual/latest/developers-guide/karaf-maven-plugin-commands-generate-help.html?rev=1460030&view=auto
==============================================================================
--- karaf/site/production/manual/latest/developers-guide/karaf-maven-plugin-commands-generate-help.html (added)
+++ karaf/site/production/manual/latest/developers-guide/karaf-maven-plugin-commands-generate-help.html Fri Mar 22 22:07:43 2013
@@ -0,0 +1,174 @@
+<!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 3.0.0-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="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/configuration.html">Configuration</a></li><li><a href="../users-guide/using-console.html">Using the console</a></li><li><a href="../users-guide/web-console.html">Web 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/deployer.html">Deployer</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">Failover Deployments</a></li><li><a href="../users-guide/logging-system.html">Logging system</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/jre-tuning.html">JRE tuning</a></li><li><a href="../users-guide/web-applications.html">Web applications</a></li><li><a href="../users-guide/http.html">HTTP service</a></li><li><a href="../users-guide/jmx.html">JMX for monitoring and administration</a></li></ul><h3 id="DevelopersGuidedevelopersguideindex"><a href="index.html">Developers Guide</a></h3><ul style="list-style: square"><li><a href="connect-console.html">Programmatically connect to the Console</a></li><li><a href="shell-syntax.html">
Shell syntax</a></li><li><a href="creating-bundles.html">Creating bundles</a></li><li><a href="debugging.html">Troubleshooting, Debugging and Profiling</a></li><li><a href="developer-command.html">Developer Commands</a></li><li><a href="archetypes.html">Maven Archetypes</a></li><li><a href="extending-console.html">Extending the Console</a></li><li><a href="branding-console.html">Branding the Console</a></li><li><a href="karaf-maven-plugin.html">Using the Karaf Maven plugin</a></li><li><a href="security-framework.html">Security Framework</a></li><li><a href="custom-distribution.html">Custom Distribution</a></li><li><a href="debugging.html">Troubleshooting, Debugging and Profiling</a></li><li><a href="connect-console.html">Programmatically connect to the console</a></li><li><a href="writing-tests.html">Writing integration tests</a></li><li><a href="creating-bundles.html">Creating bundles</a></li><li><a href="shell-syntax.html">Shell syntax</a></li><li><a href="github-contribut
ions.html">Github Contributions</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">
+<h2 id="Goalkarafcommandsgeneratehelp">Goal <tt>karaf:commands-generate-help</tt></h2><p>The <tt>karaf:commands-generate-help</tt> goal generates documentation containing Karaf commands help.</p><p>It looks for Karaf commands in the current project class loader and generates the help as displayed with the --help<br/>option in the Karaf shell console.</p><h3 id="Example">Example</h3><p>The example below generates help for the commands in the current project:</p><div class="syntax"><pre name='code' class='brush: xml; gutter: false;'><code>
+<project>
+ <build>
+ <plugins>
+ <plugin>
+ <groupId>org.apache.karaf.tooling</groupId>
+ <artifactId>karaf-maven-plugin</artifactId>
+ <version>3.0.0-SNAPSHOT</version>
+
+ <executions>
+ <execution>
+ <id>document-commands</id>
+ <phase>generate-resources</phase>
+ <goals>
+ <goal>commands-generate-help</goal>
+ </goals>
+ <configuration>
+ <targetFolder>/home/jbonofre/workspace/karaf/karaf/manual/target/docbook/sources</targetFolder>
+ </configuration>
+ </execution>
+ </executions>
+ </plugin>
+ </plugins>
+ </build>
+</project></code></pre></div><h3 id="Parameters">Parameters</h3><div class="table-wrap"><table class="confluenceTable"><tr><th class="confluenceTh"> Name </th><th class="confluenceTh"> Type </th><th class="confluenceTh"> Description </th></tr><tr><td class="confluenceTd"> <tt>targetFolder</tt> </td><td class="confluenceTd"> <tt>File</tt> </td><td class="confluenceTd"> The directory where the documentation output files are to be generated <br/> Default value: /home/jbonofre/workspace/karaf/karaf/manual/target/docbkx/sources </td></tr><tr><td class="confluenceTd"> <tt>format</tt> </td><td class="confluenceTd"> <tt>String</tt> </td><td class="confluenceTd"> The output format (docbx or conf) of the commands documentation. <br/> Default value: docbx </td></tr><tr><td class="confluenceTd"> <tt>classLoader</tt> </td><td class="confluenceTd"> <tt>String</tt> </td><td class="confluenceTd"> The class loader to use in loading the commands. <br/> Default value: $ </td></tr></table
></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/developers-guide/karaf-maven-plugin-features-add-to-repository.html
URL: http://svn.apache.org/viewvc/karaf/site/production/manual/latest/developers-guide/karaf-maven-plugin-features-add-to-repository.html?rev=1460030&view=auto
==============================================================================
--- karaf/site/production/manual/latest/developers-guide/karaf-maven-plugin-features-add-to-repository.html (added)
+++ karaf/site/production/manual/latest/developers-guide/karaf-maven-plugin-features-add-to-repository.html Fri Mar 22 22:07:43 2013
@@ -0,0 +1,182 @@
+<!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 3.0.0-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="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/configuration.html">Configuration</a></li><li><a href="../users-guide/using-console.html">Using the console</a></li><li><a href="../users-guide/web-console.html">Web 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/deployer.html">Deployer</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">Failover Deployments</a></li><li><a href="../users-guide/logging-system.html">Logging system</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/jre-tuning.html">JRE tuning</a></li><li><a href="../users-guide/web-applications.html">Web applications</a></li><li><a href="../users-guide/http.html">HTTP service</a></li><li><a href="../users-guide/jmx.html">JMX for monitoring and administration</a></li></ul><h3 id="DevelopersGuidedevelopersguideindex"><a href="index.html">Developers Guide</a></h3><ul style="list-style: square"><li><a href="connect-console.html">Programmatically connect to the Console</a></li><li><a href="shell-syntax.html">
Shell syntax</a></li><li><a href="creating-bundles.html">Creating bundles</a></li><li><a href="debugging.html">Troubleshooting, Debugging and Profiling</a></li><li><a href="developer-command.html">Developer Commands</a></li><li><a href="archetypes.html">Maven Archetypes</a></li><li><a href="extending-console.html">Extending the Console</a></li><li><a href="branding-console.html">Branding the Console</a></li><li><a href="karaf-maven-plugin.html">Using the Karaf Maven plugin</a></li><li><a href="security-framework.html">Security Framework</a></li><li><a href="custom-distribution.html">Custom Distribution</a></li><li><a href="debugging.html">Troubleshooting, Debugging and Profiling</a></li><li><a href="connect-console.html">Programmatically connect to the console</a></li><li><a href="writing-tests.html">Writing integration tests</a></li><li><a href="creating-bundles.html">Creating bundles</a></li><li><a href="shell-syntax.html">Shell syntax</a></li><li><a href="github-contribut
ions.html">Github Contributions</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">
+<h2 id="Goalkaraffeaturesaddtorepository">Goal <tt>karaf:features-add-to-repository</tt></h2><p>Consider using the karaf-assembly packaging which makes it easy to assemble a custom distribution in one step instead of this individual goal.</p><p>The <tt>karaf:features-add-to-repository</tt> goal adds all the required bundles for a given set of features into directory. You can use this goal to create a <tt>/system</tt> directory for building your own Karaf-based distribution.</p><p>By default, the Karaf core features descriptors (standard and enterprise) are automatically included in the descriptors set.</p><h3 id="Example">Example</h3><p>The example below copies the bundles for the <tt>spring</tt> and <tt>war</tt> features defined in the Karaf features XML descriptor into the <tt>target/features-repo</tt> directory.</p><div class="syntax"><pre name='code' class='brush: xml; gutter: false;'><code>
+<project>
+ <build>
+ <plugins>
+ <plugin>
+ <groupId>org.apache.karaf.tooling</groupId>
+ <artifactId>karaf-maven-plugin</artifactId>
+ <version>3.0.0-SNAPSHOT</version>
+
+ <executions>
+ <execution>
+ <id>features-add-to-repo</id>
+ <phase>generate-resources</phase>
+ <goals>
+ <goal>features-add-to-repository</goal>
+ </goals>
+ <configuration>
+ <descriptors>
+ <descriptor>mvn:my.groupid/my.artifactid/1.0.0/xml/features</descriptor>
+ </descriptors>
+ <features>
+ <feature>spring</feature>
+ <feature>war</feature>
+ <feature>my</feature>
+ </features>
+ <repository>target/features-repo</repository>
+ </configuration>
+ </execution>
+ </executions>
+ </plugin>
+ </plugins>
+ </build>
+</project></code></pre></div><h3 id="Parameters">Parameters</h3><div class="table-wrap"><table class="confluenceTable"><tr><th class="confluenceTh"> Name </th><th class="confluenceTh"> Type </th><th class="confluenceTh"> Description </th></tr><tr><td class="confluenceTd"> <tt>descriptors</tt> </td><td class="confluenceTd"> <tt>String[]</tt> </td><td class="confluenceTd"> List of features XML descriptors where the features are defined <br/> NB: Karaf core features descriptors (standard and enteprise) are automatically added in this list </td></tr><tr><td class="confluenceTd"> <tt>features</tt> </td><td class="confluenceTd"> <tt>String[]</tt> </td><td class="confluenceTd"> List of features that bundles should be copied to the repository directory </td></tr><tr><td class="confluenceTd"> <tt>repository</tt> </td><td class="confluenceTd"> <tt>File</tt> </td><td class="confluenceTd"> The directory where the bundles will be copied by the plugin goal </td></tr><tr><td class="c
onfluenceTd"> <tt>karafVersion</tt> </td><td class="confluenceTd"> <tt>String</tt> </td><td class="confluenceTd"> Target Karaf version to use to resolve the Karaf core features descriptors (standard and enterprise) <br/> Default value is the Karaf plugin version </td></tr></table></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/developers-guide/karaf-maven-plugin-features-create-kar.html
URL: http://svn.apache.org/viewvc/karaf/site/production/manual/latest/developers-guide/karaf-maven-plugin-features-create-kar.html?rev=1460030&view=auto
==============================================================================
--- karaf/site/production/manual/latest/developers-guide/karaf-maven-plugin-features-create-kar.html (added)
+++ karaf/site/production/manual/latest/developers-guide/karaf-maven-plugin-features-create-kar.html Fri Mar 22 22:07:43 2013
@@ -0,0 +1,165 @@
+<!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 3.0.0-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="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/configuration.html">Configuration</a></li><li><a href="../users-guide/using-console.html">Using the console</a></li><li><a href="../users-guide/web-console.html">Web 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/deployer.html">Deployer</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">Failover Deployments</a></li><li><a href="../users-guide/logging-system.html">Logging system</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/jre-tuning.html">JRE tuning</a></li><li><a href="../users-guide/web-applications.html">Web applications</a></li><li><a href="../users-guide/http.html">HTTP service</a></li><li><a href="../users-guide/jmx.html">JMX for monitoring and administration</a></li></ul><h3 id="DevelopersGuidedevelopersguideindex"><a href="index.html">Developers Guide</a></h3><ul style="list-style: square"><li><a href="connect-console.html">Programmatically connect to the Console</a></li><li><a href="shell-syntax.html">
Shell syntax</a></li><li><a href="creating-bundles.html">Creating bundles</a></li><li><a href="debugging.html">Troubleshooting, Debugging and Profiling</a></li><li><a href="developer-command.html">Developer Commands</a></li><li><a href="archetypes.html">Maven Archetypes</a></li><li><a href="extending-console.html">Extending the Console</a></li><li><a href="branding-console.html">Branding the Console</a></li><li><a href="karaf-maven-plugin.html">Using the Karaf Maven plugin</a></li><li><a href="security-framework.html">Security Framework</a></li><li><a href="custom-distribution.html">Custom Distribution</a></li><li><a href="debugging.html">Troubleshooting, Debugging and Profiling</a></li><li><a href="connect-console.html">Programmatically connect to the console</a></li><li><a href="writing-tests.html">Writing integration tests</a></li><li><a href="creating-bundles.html">Creating bundles</a></li><li><a href="shell-syntax.html">Shell syntax</a></li><li><a href="github-contribut
ions.html">Github Contributions</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">
+<h2 id="Goalkaraffeaturescreatekar">Goal <tt>karaf:features-create-kar</tt></h2><p>Except in unusual circumstances, use the <packaging>kar</packaging> to run this goal.</p><p>The <tt>karaf:features-create-kar</tt> goal assembles a KAR archive from a features XML descriptor file, normally generated in the same project with the <tt>karaf:features-generate-descriptor</tt> mojo.</p><h2 id="karlayout">kar layout</h2><p>There are two important directories in a kar:<br/>repository/ contains a Maven structured repository of artifacts to be copied into the Karaf repository. The features descriptor and all the bundles mentioned in it are installed in this directory.<br/>resources/ contains other resources to be copied over the Karaf installation.</p><p>Everything in target/classes is copied into the kar. Therefore resources you want installed into Karaf need to be in e.g. src/main/resources/resources. This choice is so other resources such as legal files from the maven-remote
-resources-plugin can be included under META-INF in the kar, without getting installed into Karaf.</p><h3 id="Example">Example</h3><div class="syntax"><pre name='code' class='brush: xml; gutter: false;'><code>
+<project>
+...
+ <packaging>kar</packaging>
+ <build>
+ <plugins>
+ <plugin>
+ <groupId>org.apache.karaf.tooling</groupId>
+ <artifactId>karaf-maven-plugin</artifactId>
+ <version>3.0.0-SNAPSHOT</version>
+ <extensions>true</extensions>
+ <!-- There is no useful configuration for the kar mojo. The features-generate-descriptor mojo configuration may be useful -->
+ </plugin>
+ </plugins>
+ </build>
+</project></code></pre></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/developers-guide/karaf-maven-plugin-features-generate-descriptor.html
URL: http://svn.apache.org/viewvc/karaf/site/production/manual/latest/developers-guide/karaf-maven-plugin-features-generate-descriptor.html?rev=1460030&view=auto
==============================================================================
--- karaf/site/production/manual/latest/developers-guide/karaf-maven-plugin-features-generate-descriptor.html (added)
+++ karaf/site/production/manual/latest/developers-guide/karaf-maven-plugin-features-generate-descriptor.html Fri Mar 22 22:07:43 2013
@@ -0,0 +1,177 @@
+<!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 3.0.0-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="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/configuration.html">Configuration</a></li><li><a href="../users-guide/using-console.html">Using the console</a></li><li><a href="../users-guide/web-console.html">Web 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/deployer.html">Deployer</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">Failover Deployments</a></li><li><a href="../users-guide/logging-system.html">Logging system</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/jre-tuning.html">JRE tuning</a></li><li><a href="../users-guide/web-applications.html">Web applications</a></li><li><a href="../users-guide/http.html">HTTP service</a></li><li><a href="../users-guide/jmx.html">JMX for monitoring and administration</a></li></ul><h3 id="DevelopersGuidedevelopersguideindex"><a href="index.html">Developers Guide</a></h3><ul style="list-style: square"><li><a href="connect-console.html">Programmatically connect to the Console</a></li><li><a href="shell-syntax.html">
Shell syntax</a></li><li><a href="creating-bundles.html">Creating bundles</a></li><li><a href="debugging.html">Troubleshooting, Debugging and Profiling</a></li><li><a href="developer-command.html">Developer Commands</a></li><li><a href="archetypes.html">Maven Archetypes</a></li><li><a href="extending-console.html">Extending the Console</a></li><li><a href="branding-console.html">Branding the Console</a></li><li><a href="karaf-maven-plugin.html">Using the Karaf Maven plugin</a></li><li><a href="security-framework.html">Security Framework</a></li><li><a href="custom-distribution.html">Custom Distribution</a></li><li><a href="debugging.html">Troubleshooting, Debugging and Profiling</a></li><li><a href="connect-console.html">Programmatically connect to the console</a></li><li><a href="writing-tests.html">Writing integration tests</a></li><li><a href="creating-bundles.html">Creating bundles</a></li><li><a href="shell-syntax.html">Shell syntax</a></li><li><a href="github-contribut
ions.html">Github Contributions</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">
+<h2 id="Goalkaraffeaturesgeneratedescriptor">Goal <tt>karaf:features-generate-descriptor</tt></h2><p>Except in unusual circumstances, use the <packaging>feature</packaging> to run this goal.</p><p>The <tt>karaf:features-generate-descriptor</tt> goal generates a features XML file based on the Maven dependencies. By default, it will follow Maven transitive dependencies, stopping when it encounters bundles already present in features that are Maven dependencies.</p><p>A record of the dependency tree search can be found in target/history/treeListing.txt.</p><p>You can track dependency changes and warn or fail on change.</p><h2 id="Configuration">Configuration</h2><p>Specify the packaging as a top level element</p><pre>
+<packaging>feature</packaging>
+</pre><p>You can supply a feature descriptor to extend in src/main/feature/feature.xml.</p><div class="table-wrap"><table class="confluenceTable"><tr><th class="confluenceTh"> Parameter Name </th><th class="confluenceTh"> Type </th><th class="confluenceTh"> Description </th></tr><tr><td class="confluenceTd"> aggregateFeatures </td><td class="confluenceTd"> boolean (false) </td><td class="confluenceTd"> Specifies processing of feature repositories that are (transitive) Maven dependencies. If false, all features in these repositories become dependencies of the generated feature. If true, all features in these repositories are copied into the generated feature repository. </td></tr><tr><td class="confluenceTd"> startLevel </td><td class="confluenceTd"> int </td><td class="confluenceTd"> The start level for the bundles determined from Maven dependencies. This can be overridden by specifying the bundle in the source feature.xml with the desired startlevel. </td></tr><tr><td cla
ss="confluenceTd"> includeTransitiveDependency </td><td class="confluenceTd"> boolean (true) </td><td class="confluenceTd"> Whether to follow Maven transitive dependencies. </td></tr><tr><td class="confluenceTd"> checkDependencyChange </td><td class="confluenceTd"> boolean (false) </td><td class="confluenceTd"> Whether to record dependencies in src/main/history.dependencies.xml for change tracking. </td></tr><tr><td class="confluenceTd"> warnOnDependencyChange </td><td class="confluenceTd"> boolean (false) </td><td class="confluenceTd"> whether to fail on changed dependencies (false, default) or warn in the build output (true). </td></tr><tr><td class="confluenceTd"> logDependencyChanges </td><td class="confluenceTd"> boolean (false) </td><td class="confluenceTd"> If true, added and removed dependencies are shown in target/history. </td></tr><tr><td class="confluenceTd"> overwriteChangedDependencies </td><td class="confluenceTd"> boolean (false) </td><td class="confluenceTd"
> If true, the src/main/history/dependencies.xml file will be overwritten if it has changed. </td></tr></table></div><h3 id="Example">Example</h3><div class="syntax"><pre name='code' class='brush: xml; gutter: false;'><code>
+<project>
+...
+ <packaging>feature</packaging>
+ <dependencies>
+ <dependency>
+ <groupId>org.apache</groupId>
+ <artifactId>bundle1</artifactId>
+ <version>1.0</version>
+ </dependency>
+ </dependencies>
+ <build>
+ <plugins>
+ <plugin>
+ <groupId>org.apache.karaf.tooling</groupId>
+ <artifactId>karaf-maven-plugin</artifactId>
+ <version>3.0.0-SNAPSHOT</version>
+ <extensions>true</extensions>
+ <configuration>
+ <startLevel>80</startLevel>
+ <aggregateFeatures>true</aggregateFeatures>
+ </configuration>
+ </plugin>
+ </plugins>
+ </build>
+</project></code></pre></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