You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@felix.apache.org by bu...@apache.org on 2015/09/01 08:05:20 UTC
svn commit: r963800 [2/16] - in /websites/staging/felix/trunk/content: ./
documentation/ documentation/community/ documentation/development/
documentation/faqs/ documentation/subprojects/
documentation/subprojects/apache-felix-commons/ documentation/su...
Modified: websites/staging/felix/trunk/content/documentation/development/coding-standards.html
==============================================================================
--- websites/staging/felix/trunk/content/documentation/development/coding-standards.html (original)
+++ websites/staging/felix/trunk/content/documentation/development/coding-standards.html Tue Sep 1 06:05:17 2015
@@ -39,7 +39,18 @@
</div>
<div class="menu">
- <p><a href="/news.html">news</a> <br />
+ <style type="text/css">
+/* The following code is added by mdx_elementid.py
+ It was originally lifted from http://subversion.apache.org/style/site.css */
+/*
+ * Hide class="elementid-permalink", except when an enclosing heading
+ * has the :hover property.
+ */
+.headerlink, .elementid-permalink {
+ visibility: hidden;
+}
+h2:hover > .headerlink, h3:hover > .headerlink, h1:hover > .headerlink, h6:hover > .headerlink, h4:hover > .headerlink, h5:hover > .headerlink, dt:hover > .elementid-permalink { visibility: visible }</style>
+<p><a href="/news.html">news</a> <br />
<a href="/license.html">license</a> <br />
<a href="/downloads.cgi">downloads</a> <br />
<a href="/documentation.html">documentation</a> <br />
@@ -66,17 +77,28 @@
</div>
<h1>Coding Standards</h1>
- <h1 id="coding-standards">Coding standards</h1>
-<h2 id="guidelines-summary">Guidelines Summary</h2>
+ <style type="text/css">
+/* The following code is added by mdx_elementid.py
+ It was originally lifted from http://subversion.apache.org/style/site.css */
+/*
+ * Hide class="elementid-permalink", except when an enclosing heading
+ * has the :hover property.
+ */
+.headerlink, .elementid-permalink {
+ visibility: hidden;
+}
+h2:hover > .headerlink, h3:hover > .headerlink, h1:hover > .headerlink, h6:hover > .headerlink, h4:hover > .headerlink, h5:hover > .headerlink, dt:hover > .elementid-permalink { visibility: visible }</style>
+<h1 id="coding-standards">Coding standards<a class="headerlink" href="#coding-standards" title="Permanent link">¶</a></h1>
+<h2 id="guidelines-summary">Guidelines Summary<a class="headerlink" href="#guidelines-summary" title="Permanent link">¶</a></h2>
<p>This style guide is intended to help the computer professional produce better Java programs. It presents a set of specific guidelines for using the features of Java in a disciplined manner. The goal is to develop high quality, reliable, reusable, portable software. For a number of reasons, no programming language can ensure the achievements of these desirable objectives on its own. Programming must be embedded in a disciplined development process that addresses a number of topics in a well managed way. The use of Java is one of those. It must conform to good programming practices be based on well established software engineering principles. This style guide is intended to bridge the gap between these principles and the actual practice of programming in Java.</p>
<p>Clear, readable, understandable source text eases program evolution, adaptation and maintenance. First, such source text is more likely to be correct and reliable. Second, effective code adaptation is a prerequisite to code reuse, a technique that has the potential for drastic reductions in system development costs. Easy adaptation requires thorough understanding of the software, and that is facilitated considerably by clarity. Finally, since maintenance (really evolution) is a costly process that continues throughout the life of a system, clarity plays a major role in keeping maintenance costs down. Over the entire life cycle, code has to be read and understood far more often than it is written; the investment of effort in writing readable, understandable code is thus well worthwhile. Many of the guidelines in this style guide are designed to promote clarity of the source text.</p>
<p>This style guide is intended for those involved in the development of real software systems written in Java. Different roles in a software project can exploit the style guide in different ways. The programmer can use it as a reference on good Java style. It can be used in code reviews as a common reference. Finally, lessons learned in real projects can be captured by extending the style guide.</p>
-<h2 id="class-layout-and-comments">Class layout and comments</h2>
-<h3 id="files-and-filenames">Files and filenames</h3>
+<h2 id="class-layout-and-comments">Class layout and comments<a class="headerlink" href="#class-layout-and-comments" title="Permanent link">¶</a></h2>
+<h3 id="files-and-filenames">Files and filenames<a class="headerlink" href="#files-and-filenames" title="Permanent link">¶</a></h3>
<p>Files longer than 2000 lines are cumbersome and should be avoided.</p>
-<h4 id="file-names">File names</h4>
+<h4 id="file-names">File names<a class="headerlink" href="#file-names" title="Permanent link">¶</a></h4>
<p>The file must be named after the class it represents. As for most cases each file contains only one class, this is an easy naming convention. For nested or inner classes the name of the main class must be the name of the file. As names in Java are case-sensitive, the filename is case-sensitive also.</p>
-<h4 id="file-organization">File organization</h4>
+<h4 id="file-organization">File organization<a class="headerlink" href="#file-organization" title="Permanent link">¶</a></h4>
<p>Each Java source file contains a single class or interface. Of course, this excludes inner classes as these must be defined without an (outer) class, and thus in the same file.</p>
<p>Java source files have the following ordering:</p>
<ul>
@@ -84,7 +106,7 @@
<li>Package and import statements</li>
<li>Class and interface declarations</li>
</ul>
-<h4 id="beginning-comments">Beginning comments</h4>
+<h4 id="beginning-comments">Beginning comments<a class="headerlink" href="#beginning-comments" title="Permanent link">¶</a></h4>
<p>All source files must begin with the comments shown in the following code sample.</p>
<div class="codehilite"><pre><span class="cm">/*</span>
<span class="cm"> * Licensed to the Apache Software Foundation (ASF) under one</span>
@@ -108,7 +130,7 @@
<p>Note that this comment part is not according to the JavaDoc style (See: How to write doc comments for JavaDoc - Sun Microsystems, Inc.) as this is file specific information that is not relevant in generated API documentation.</p>
-<h5 id="package-and-import-statements">Package and import Statements</h5>
+<h5 id="package-and-import-statements">Package and import Statements<a class="headerlink" href="#package-and-import-statements" title="Permanent link">¶</a></h5>
<p>The first non-comment line of most Java source files is a package statement. After an empty line import statements can follow. For example:</p>
<div class="codehilite"><pre><span class="n">package</span> <span class="n">org</span><span class="p">.</span><span class="n">apache</span><span class="p">.</span><span class="n">felix</span><span class="p">.</span><span class="n">whatever</span><span class="p">.</span><span class="n">this</span><span class="p">.</span><span class="n">is</span><span class="p">;</span>
@@ -125,7 +147,7 @@
They should be grouped by name. When the number of import statements of the same package exceeds the 'readability' limit (please use common sense), then import the complete package by adding '.*'.
1. Import order.
First in this section should be the standard Java imports like: java.lang.Throwable. Second should be the Java extensions (i.e. javax), third, the third party stuff. Finally the project-specific imports should be added.</p>
-<h5 id="class-and-interface-declarations">Class and interface Declarations</h5>
+<h5 id="class-and-interface-declarations">Class and interface Declarations<a class="headerlink" href="#class-and-interface-declarations" title="Permanent link">¶</a></h5>
<p>The following comment block is an example for the comment that belongs to the declaration of a class or an interface. The combination of JavaDoc syntax and keywords that are expanded by the source integrity tool result in the following block:</p>
<div class="codehilite"><pre><span class="cm">/**</span>
<span class="cm"> * This class is not really a class, because this file is just</span>
@@ -138,7 +160,7 @@
<p>The following table describes the parts of a class or interface declaration, in the order that they should appear.</p>
-<table>
+<table class="table">
<thead>
<tr>
<th>Part of Class/Interface Declaration</th>
@@ -180,11 +202,11 @@
</tr>
</tbody>
</table>
-<h3 id="indentation">Indentation</h3>
+<h3 id="indentation">Indentation<a class="headerlink" href="#indentation" title="Permanent link">¶</a></h3>
<p>Four spaces should be used as unit of indentation. Use spaces or let your editor convert tabs to spaces as some editors might show the tabs different than they were intended! Tabs must be set exactly every 4 spaces.</p>
-<h4 id="line-length">Line length</h4>
+<h4 id="line-length">Line length<a class="headerlink" href="#line-length" title="Permanent link">¶</a></h4>
<p>There is no explicit limit for the length of a line. Make sure that the flow of the code is clear and that, when printing the file, it is well formed when using a reasonable font. A reasonable length would be around 80 characters.</p>
-<h4 id="wrapping-lines">Wrapping lines</h4>
+<h4 id="wrapping-lines">Wrapping lines<a class="headerlink" href="#wrapping-lines" title="Permanent link">¶</a></h4>
<p>When an expression will not fit on a single line, break it according to these general principles:
- break after a comma;
- break before an operator;
@@ -199,8 +221,8 @@
</pre></div>
-<h3 id="comment">Comment</h3>
-<h4 id="comment-styles">Comment styles</h4>
+<h3 id="comment">Comment<a class="headerlink" href="#comment" title="Permanent link">¶</a></h3>
+<h4 id="comment-styles">Comment styles<a class="headerlink" href="#comment-styles" title="Permanent link">¶</a></h4>
<p>The Java language supports three different kinds of comments:</p>
<div class="codehilite"><pre><span class="c1">// text</span>
</pre></div>
@@ -217,7 +239,7 @@
<p>This indicates a documentation comment (doc comment, for short). The compiler ignores this kind of comment, just like it ignores comments that use /<em> and </em>/. The JDK JavaDoc tool uses doc comments when preparing automatically generated documentation (See: JavaDoc keywords and HTML tags). But JavaDoc only uses this documentation when it occurs at an expected position in the file like the class definition or a member declaration. </p>
-<h4 id="block-comments">Block comments</h4>
+<h4 id="block-comments">Block comments<a class="headerlink" href="#block-comments" title="Permanent link">¶</a></h4>
<p>Block comments are used to provide English descriptions of the contents of files, the task of methods and the description of data structures and algorithms. Block comments should be used at the beginning of each file and before each method. They can also be used in other places, such as within methods.</p>
<p>For a description of class comment see 2.1.3.3 Class and Interface Declarations. A method block comment looks as follows:</p>
<div class="codehilite"><pre><span class="cm">/**</span>
@@ -235,10 +257,10 @@
</pre></div>
-<h4 id="javadoc-keywords-and-html-tags">JavaDoc keywords and HTML tags</h4>
+<h4 id="javadoc-keywords-and-html-tags">JavaDoc keywords and HTML tags<a class="headerlink" href="#javadoc-keywords-and-html-tags" title="Permanent link">¶</a></h4>
<p>For class headers, method headers and member variables JavaDoc is used in order to generate API documentation from the source later on (See: JavaDoc homepage - Sun Microsystems, Inc.).
A few specific JavaDoc keywords are:</p>
-<table>
+<table class="table">
<thead>
<tr>
<th>Keyword</th>
@@ -273,7 +295,7 @@ A few specific JavaDoc keywords are:</p>
</tbody>
</table>
<p>Some HTML-tags that can be used in order to make the comment blocks more readable:</p>
-<table>
+<table class="table">
<thead>
<tr>
<th>Tag</th>
@@ -322,8 +344,8 @@ A few specific JavaDoc keywords are:</p>
</pre></div>
-<h2 id="java-syntax-and-its-layout">Java syntax and its layout</h2>
-<h3 id="declarations">Declarations</h3>
+<h2 id="java-syntax-and-its-layout">Java syntax and its layout<a class="headerlink" href="#java-syntax-and-its-layout" title="Permanent link">¶</a></h2>
+<h3 id="declarations">Declarations<a class="headerlink" href="#declarations" title="Permanent link">¶</a></h3>
<p>When declaring a variable or method make the accessibility as restrictive as possible. When using multiple keywords use the following ordering of keywords:</p>
<ol>
<li>accessibility
@@ -341,7 +363,7 @@ A few specific JavaDoc keywords are:</p>
</pre></div>
-<h4 id="number-per-line">Number per line</h4>
+<h4 id="number-per-line">Number per line<a class="headerlink" href="#number-per-line" title="Permanent link">¶</a></h4>
<p>One declaration per line is recommended since it encourages commenting and it does not lead to confusing code. It also is more clear about the explicit initialization of variables as discussed in Initialization.</p>
<p>Example:</p>
<div class="codehilite"><pre><span class="n">int</span> <span class="n">level</span> <span class="p">=</span> 0<span class="p">;</span> <span class="o">//</span> <span class="n">level</span> <span class="n">where</span> <span class="n">user</span> <span class="n">enters</span> <span class="n">the</span> <span class="n">system</span>
@@ -354,12 +376,12 @@ A few specific JavaDoc keywords are:</p>
</pre></div>
-<h4 id="placement">Placement</h4>
+<h4 id="placement">Placement<a class="headerlink" href="#placement" title="Permanent link">¶</a></h4>
<p>In a method, declare local variables just before they are needed. This overcomes the problem of a big list of parameters at the beginning of a method and the use of a variable becomes more clearly in the context of the code, .e.g. its initialization.</p>
-<h4 id="initialization">Initialization</h4>
+<h4 id="initialization">Initialization<a class="headerlink" href="#initialization" title="Permanent link">¶</a></h4>
<p>The initialization of class variables is strictly not necessary because of the default initialization that takes place for these kinds of members. For some types, e.g. Booleans, this requires detailed knowledge of all the default values so it is more clear and explicit to initialize each member.
Variables that are used and declared within methods must always be initialized explicitly (the compiler will generate an error when you forget this).</p>
-<h4 id="class-and-interface-declarations_1">Class and Interface Declarations</h4>
+<h4 id="class-and-interface-declarations_1">Class and Interface Declarations<a class="headerlink" href="#class-and-interface-declarations_1" title="Permanent link">¶</a></h4>
<p>When coding Java classes and interfaces, the following formatting rules should be followed:</p>
<ul>
<li>no space between a method and its parameter list</li>
@@ -381,8 +403,8 @@ Variables that are used and declared wit
</pre></div>
-<h3 id="statements">Statements</h3>
-<h4 id="simple-statements">Simple statements</h4>
+<h3 id="statements">Statements<a class="headerlink" href="#statements" title="Permanent link">¶</a></h3>
+<h4 id="simple-statements">Simple statements<a class="headerlink" href="#simple-statements" title="Permanent link">¶</a></h4>
<p>Each line should contain at most one statement.</p>
<p>Example:</p>
<div class="codehilite"><pre><span class="c1">// Do not use this</span>
@@ -390,14 +412,14 @@ Variables that are used and declared wit
</pre></div>
-<h4 id="compound-statements">Compound statements</h4>
+<h4 id="compound-statements">Compound statements<a class="headerlink" href="#compound-statements" title="Permanent link">¶</a></h4>
<p>Compound statements are statements that contain lists of statements enclosed in braces ("{...}"):</p>
<ul>
<li>The enclosed statements should be indented one more level than the compound statement.</li>
<li>The opening brace should be at the end of the line that begins the compound statement; the closing brace should begin a line and be indented to the beginning of the compound statement. </li>
<li>Braces are used around all statements, even single statements, when they are part of a control structure, such as a if-else or for statement. This makes it easier to add statements without accidentally introducing bugs due to forgetting to add braces. </li>
</ul>
-<h4 id="if-if-else-if-else-if-else-statements">if, if-else, if else-if else statements</h4>
+<h4 id="if-if-else-if-else-if-else-statements">if, if-else, if else-if else statements<a class="headerlink" href="#if-if-else-if-else-if-else-statements" title="Permanent link">¶</a></h4>
<p>There are a lot of nested possibilities for if-else constructions. All these variations can be programmed in very cryptic ways that easily and often will lead to buggy code. By being more explicit in the used coding style a lot of confusion can be taken away.</p>
<p>Note: When using only one statement in a compound block brackets are optional. It can be a good practice to use always brackets because mistakes can be made easily when adding a second statement and brackets are forgotten.</p>
<p>The following example illustrates the correct use of brackets in a few different if-then-else constructions:</p>
@@ -430,7 +452,7 @@ Variables that are used and declared wit
<p>Note that in the example the else if construction is started at a new line so the statement can not be overlooked.</p>
-<h4 id="switch">switch</h4>
+<h4 id="switch">switch<a class="headerlink" href="#switch" title="Permanent link">¶</a></h4>
<p>When using a switch statement use following guidelines:</p>
<ul>
<li>Every switch statement should include a default case. The break in the default case is redundant, but it prevents a fall-through error if later another case is added. </li>
@@ -452,7 +474,7 @@ Variables that are used and declared wit
</pre></div>
-<h4 id="try-catch">try - catch</h4>
+<h4 id="try-catch">try - catch<a class="headerlink" href="#try-catch" title="Permanent link">¶</a></h4>
<p>A try - catch statement should have the following format:</p>
<div class="codehilite"><pre><span class="k">try</span>
<span class="p">{</span>
@@ -482,8 +504,8 @@ Variables that are used and declared wit
<p>Note that the catch and the finally start at a new line in order to be compliant to the guidelines for if-then-else statements.</p>
-<h3 id="white-space">White Space</h3>
-<h4 id="blank-lines">Blank lines</h4>
+<h3 id="white-space">White Space<a class="headerlink" href="#white-space" title="Permanent link">¶</a></h3>
+<h4 id="blank-lines">Blank lines<a class="headerlink" href="#blank-lines" title="Permanent link">¶</a></h4>
<p>Blank lines improve readability by setting of sections of code that are logically related.</p>
<p>Two blank lines should always be used in the following circumstances:</p>
<ul>
@@ -496,15 +518,14 @@ Variables that are used and declared wit
<li>before a block or single line comment;</li>
<li>between logical sections inside a method to improve readability.</li>
</ul>
-<h4 id="blank-spaces">Blank spaces</h4>
+<h4 id="blank-spaces">Blank spaces<a class="headerlink" href="#blank-spaces" title="Permanent link">¶</a></h4>
<p>Blank spaces should be used in the following circumstances:</p>
<ul>
<li>
<p>A keyword followed by a parenthesis should be separated by a space.</p>
-<p>while (ready == false)
-{
- ...
-}</p>
+<p _="
+" class="..
+">while (ready == false)</p>
</li>
</ul>
<p>Note that blanks should not be used between a method call and its opening parenthesis. This helps to distinguish keywords from function calls.
@@ -526,17 +547,32 @@ Variables that are used and declared wit
<p>myInstance.doIt((TreeFrame) frame);</p>
</li>
</ul>
-<h3 id="naming-conventions">Naming conventions</h3>
+<h3 id="naming-conventions">Naming conventions<a class="headerlink" href="#naming-conventions" title="Permanent link">¶</a></h3>
<p>Naming conventions make programs more understandable by making them easier to read. They can also give information about the function of the identifier.</p>
-<p>|Identifier Type|Rules for Naming|Examples|
-|--|--|--|</p>
-<p>|Interfaces|Interface names should be capitalized like class names.|interface Enumeration;|
-|Methods|Methods should be verbs in mixed case with the first letter lowercase. Within each method name capital letters separate words. Property methods or get-set methods are used as follows:</p>
+<table class="table">
+<thead>
+<tr>
+<th>Identifier Type</th>
+<th>Rules for Naming</th>
+<th>Examples</th>
+</tr>
+</thead>
+<tbody></tbody>
+</table>
+<table class="table">
+<thead>
+<tr>
+<th>Interfaces</th>
+<th align="right">Interface names should be capitalized like class names.</th>
+</tr>
+</thead>
+<tbody></tbody>
+</table>
<p>|Constant (static final) variables|Names should be all uppercase with words separated by underscores ("_").|public static final int BLACK = 99;|
|Exceptions|Like class names; always ending in "Exception"|InputException|
|Packages|Lowercase only; avoid lengthy package names; always start with org.apache.felix.|org.apache.felix.demo.bundle|</p>
<p>Note: All Java identifiers are case sensitive.</p>
-<h2 id="references">References</h2>
+<h2 id="references">References<a class="headerlink" href="#references" title="Permanent link">¶</a></h2>
<ul>
<li>Java Code Conventions - Sun Microsystems, Inc.
No ref. number, only hyperlink: http://java.sun.com/docs/codeconv/</li>
@@ -547,7 +583,7 @@ Variables that are used and declared wit
<li><a href="https://issues.apache.org/jira/secure/attachment/12419890/Apache+Felix+Eclipse+Template.xml">Eclipse formatting template</a>.</li>
</ul>
<div class="timestamp" style="margin-top: 30px; font-size: 80%; text-align: right;">
- Rev. 1422427 by fmeschbe on Sun, 16 Dec 2012 00:36:51 +0000
+ Rev. 1700393 by cziegeler on Tue, 1 Sep 2015 06:04:06 +0000
</div>
<div class="trademarkFooter">
Apache Felix, Felix, Apache, the Apache feather logo, and the Apache Felix project
Modified: websites/staging/felix/trunk/content/documentation/development/dependencies-file-template.html
==============================================================================
--- websites/staging/felix/trunk/content/documentation/development/dependencies-file-template.html (original)
+++ websites/staging/felix/trunk/content/documentation/development/dependencies-file-template.html Tue Sep 1 06:05:17 2015
@@ -39,7 +39,18 @@
</div>
<div class="menu">
- <p><a href="/news.html">news</a> <br />
+ <style type="text/css">
+/* The following code is added by mdx_elementid.py
+ It was originally lifted from http://subversion.apache.org/style/site.css */
+/*
+ * Hide class="elementid-permalink", except when an enclosing heading
+ * has the :hover property.
+ */
+.headerlink, .elementid-permalink {
+ visibility: hidden;
+}
+h2:hover > .headerlink, h3:hover > .headerlink, h1:hover > .headerlink, h6:hover > .headerlink, h4:hover > .headerlink, h5:hover > .headerlink, dt:hover > .elementid-permalink { visibility: visible }</style>
+<p><a href="/news.html">news</a> <br />
<a href="/license.html">license</a> <br />
<a href="/downloads.cgi">downloads</a> <br />
<a href="/documentation.html">documentation</a> <br />
@@ -66,7 +77,18 @@
</div>
<h1>DEPENDENCIES file template</h1>
- <p>Each released software archive must contain a DEPENDENCIES file in it to declare third-party dependencies and their licenses. The following template should be used:</p>
+ <style type="text/css">
+/* The following code is added by mdx_elementid.py
+ It was originally lifted from http://subversion.apache.org/style/site.css */
+/*
+ * Hide class="elementid-permalink", except when an enclosing heading
+ * has the :hover property.
+ */
+.headerlink, .elementid-permalink {
+ visibility: hidden;
+}
+h2:hover > .headerlink, h3:hover > .headerlink, h1:hover > .headerlink, h6:hover > .headerlink, h4:hover > .headerlink, h5:hover > .headerlink, dt:hover > .elementid-permalink { visibility: visible }</style>
+<p>Each released software archive must contain a DEPENDENCIES file in it to declare third-party dependencies and their licenses. The following template should be used:</p>
<div class="codehilite"><pre><span class="n">Apache</span> <span class="n">Felix</span> <span class="n">AAA</span>
<span class="n">Copyright</span> <span class="n">BBB</span> <span class="n">The</span> <span class="n">Apache</span> <span class="n">Software</span> <span class="n">Foundation</span>
@@ -106,7 +128,7 @@
<p>If you need additional examples on how to fill out a DEPENDENCIES file, look at other examples in the SVN repo or ask on the dev@felix mailing list.</p>
<div class="timestamp" style="margin-top: 30px; font-size: 80%; text-align: right;">
- Rev. 1422427 by fmeschbe on Sun, 16 Dec 2012 00:36:51 +0000
+ Rev. 1700393 by cziegeler on Tue, 1 Sep 2015 06:04:06 +0000
</div>
<div class="trademarkFooter">
Apache Felix, Felix, Apache, the Apache feather logo, and the Apache Felix project
Modified: websites/staging/felix/trunk/content/documentation/development/dependencies.html
==============================================================================
--- websites/staging/felix/trunk/content/documentation/development/dependencies.html (original)
+++ websites/staging/felix/trunk/content/documentation/development/dependencies.html Tue Sep 1 06:05:17 2015
@@ -39,7 +39,18 @@
</div>
<div class="menu">
- <p><a href="/news.html">news</a> <br />
+ <style type="text/css">
+/* The following code is added by mdx_elementid.py
+ It was originally lifted from http://subversion.apache.org/style/site.css */
+/*
+ * Hide class="elementid-permalink", except when an enclosing heading
+ * has the :hover property.
+ */
+.headerlink, .elementid-permalink {
+ visibility: hidden;
+}
+h2:hover > .headerlink, h3:hover > .headerlink, h1:hover > .headerlink, h6:hover > .headerlink, h4:hover > .headerlink, h5:hover > .headerlink, dt:hover > .elementid-permalink { visibility: visible }</style>
+<p><a href="/news.html">news</a> <br />
<a href="/license.html">license</a> <br />
<a href="/downloads.cgi">downloads</a> <br />
<a href="/documentation.html">documentation</a> <br />
@@ -66,10 +77,21 @@
</div>
<h1>Dependencies</h1>
- <h1 id="dependencies">Dependencies</h1>
+ <style type="text/css">
+/* The following code is added by mdx_elementid.py
+ It was originally lifted from http://subversion.apache.org/style/site.css */
+/*
+ * Hide class="elementid-permalink", except when an enclosing heading
+ * has the :hover property.
+ */
+.headerlink, .elementid-permalink {
+ visibility: hidden;
+}
+h2:hover > .headerlink, h3:hover > .headerlink, h1:hover > .headerlink, h6:hover > .headerlink, h4:hover > .headerlink, h5:hover > .headerlink, dt:hover > .elementid-permalink { visibility: visible }</style>
+<h1 id="dependencies">Dependencies<a class="headerlink" href="#dependencies" title="Permanent link">¶</a></h1>
<p>TODO determine how we want to list our dependencies</p>
<div class="timestamp" style="margin-top: 30px; font-size: 80%; text-align: right;">
- Rev. 1422427 by fmeschbe on Sun, 16 Dec 2012 00:36:51 +0000
+ Rev. 1700393 by cziegeler on Tue, 1 Sep 2015 06:04:06 +0000
</div>
<div class="trademarkFooter">
Apache Felix, Felix, Apache, the Apache feather logo, and the Apache Felix project
Modified: websites/staging/felix/trunk/content/documentation/development/integrating-felix-with-eclipse.html
==============================================================================
--- websites/staging/felix/trunk/content/documentation/development/integrating-felix-with-eclipse.html (original)
+++ websites/staging/felix/trunk/content/documentation/development/integrating-felix-with-eclipse.html Tue Sep 1 06:05:17 2015
@@ -39,7 +39,18 @@
</div>
<div class="menu">
- <p><a href="/news.html">news</a> <br />
+ <style type="text/css">
+/* The following code is added by mdx_elementid.py
+ It was originally lifted from http://subversion.apache.org/style/site.css */
+/*
+ * Hide class="elementid-permalink", except when an enclosing heading
+ * has the :hover property.
+ */
+.headerlink, .elementid-permalink {
+ visibility: hidden;
+}
+h2:hover > .headerlink, h3:hover > .headerlink, h1:hover > .headerlink, h6:hover > .headerlink, h4:hover > .headerlink, h5:hover > .headerlink, dt:hover > .elementid-permalink { visibility: visible }</style>
+<p><a href="/news.html">news</a> <br />
<a href="/license.html">license</a> <br />
<a href="/downloads.cgi">downloads</a> <br />
<a href="/documentation.html">documentation</a> <br />
@@ -66,26 +77,37 @@
</div>
<h1>Integrating Felix with Eclipse</h1>
- <h1 id="integrating-felix-with-eclipse">Integrating Felix with Eclipse</h1>
+ <style type="text/css">
+/* The following code is added by mdx_elementid.py
+ It was originally lifted from http://subversion.apache.org/style/site.css */
+/*
+ * Hide class="elementid-permalink", except when an enclosing heading
+ * has the :hover property.
+ */
+.headerlink, .elementid-permalink {
+ visibility: hidden;
+}
+h2:hover > .headerlink, h3:hover > .headerlink, h1:hover > .headerlink, h6:hover > .headerlink, h4:hover > .headerlink, h5:hover > .headerlink, dt:hover > .elementid-permalink { visibility: visible }</style>
+<h1 id="integrating-felix-with-eclipse">Integrating Felix with Eclipse<a class="headerlink" href="#integrating-felix-with-eclipse" title="Permanent link">¶</a></h1>
<p>This document explains how to launch Felix inside the Eclipse IDE. Then, it is possible to use Eclipse debugging facilities to debug bundles.</p>
-<h2 id="preliminaries">Preliminaries</h2>
+<h2 id="preliminaries">Preliminaries<a class="headerlink" href="#preliminaries" title="Permanent link">¶</a></h2>
<p>To integrate Felix inside Eclipse, you need Felix, Eclipse and nothing else.</p>
-<h3 id="installing-eclipse">Installing Eclipse</h3>
+<h3 id="installing-eclipse">Installing Eclipse<a class="headerlink" href="#installing-eclipse" title="Permanent link">¶</a></h3>
<p>First, you need Eclipse. To download the Eclipse IDE, go to:<a href="http://www.eclipse.org/downloads/">http://www.eclipse.org/downloads/</a>. This tutorial works for Eclipse 3.X.X, but may works on older version.</p>
-<h3 id="creation-of-the-felix-binaries">Creation of the Felix binaries</h3>
+<h3 id="creation-of-the-felix-binaries">Creation of the Felix binaries<a class="headerlink" href="#creation-of-the-felix-binaries" title="Permanent link">¶</a></h3>
<p>To integrate Felix inside Eclipse, you have three possibilities
<em> Using Pax Cursor to launch easily any supported OSGi framework inside Eclipse.
</em> Integrating the Felix release as a Java project
* Integrating the Felix trunk (latest version) as a Java project</p>
-<h4 id="using-pax-cursor">Using Pax Cursor</h4>
+<h4 id="using-pax-cursor">Using Pax Cursor<a class="headerlink" href="#using-pax-cursor" title="Permanent link">¶</a></h4>
<p><a href="http://wiki.ops4j.org/confluence/display/ops4j/Pax+Cursor">Pax Cursor</a> is an Eclipse Plugin that adds Eclipse launch configurations for all platforms / versions supported by Pax Runner.</p>
-<h4 id="usign-the-felix-release-as-a-java-project">Usign the Felix release as a Java Project</h4>
+<h4 id="usign-the-felix-release-as-a-java-project">Usign the Felix release as a Java Project<a class="headerlink" href="#usign-the-felix-release-as-a-java-project" title="Permanent link">¶</a></h4>
<p>Once, Eclipse is installed, you need to download Felix. You will find this Felix release on <a href="http://felix.apache.org/site/downloads.cgi">http://felix.apache.org/site/downloads.cgi</a>. Choose a binary release in your preferred archive format. Then, unzip the release in a temporary folder. We will copy the files elsewhere later.</p>
-<h4 id="building-and-using-the-felix-trunk">Building and Using the Felix Trunk</h4>
+<h4 id="building-and-using-the-felix-trunk">Building and Using the Felix Trunk<a class="headerlink" href="#building-and-using-the-felix-trunk" title="Permanent link">¶</a></h4>
<p>If you want to use the Felix trunk, follows the <a href="http://felix.apache.org/site/building-felix.html">instructions</a> to checkout and build it. The Felix binaries are created in the <em>main</em> project. We will copy the files elsewhere later.</p>
-<h2 id="installing-felix">Installing Felix</h2>
+<h2 id="installing-felix">Installing Felix<a class="headerlink" href="#installing-felix" title="Permanent link">¶</a></h2>
<p>The integration uses a Java project. This project will contain Felix. This section explains how-to create the new project, how-to copy the Felix release inside the project and finally, how-to configure it.</p>
-<h3 id="creation-of-the-felix-java-project">Creation of the Felix Java project</h3>
+<h3 id="creation-of-the-felix-java-project">Creation of the Felix Java project<a class="headerlink" href="#creation-of-the-felix-java-project" title="Permanent link">¶</a></h3>
<p>First, launch Eclipse, and select your preferred workspace. The integration will be attached to this workspace.</p>
<p>Then, click on File -> New -> Project... as depicts on the Figure 1.</p>
<p>!new<em>project</em>1.png!
@@ -98,29 +120,29 @@
{color:#4f81bd}{<em>}Figure{</em>}{color}{color:#4f81bd} {<em>}3{</em>}{color}{color:#4f81bd}<em>: Configuration of the Felix project{</em>}{color}</p>
<p>On this new wizard page, you need only to change the default output folder (Felix/bin) to another (classes for example, as presented on Figure 4).</p>
<p>!new<em>project</em>4.png!
-{color:#4f81bd}{<em>}Figure{</em>}{color}{color:#4f81bd} {<em>}4{</em>}{color}{color:#4f81bd}<em>: Change the "Default output folder"</em>{color}</p>
+{color:#4f81bd}{<em>}Figure{</em>}{color}{color:#4f81bd} {<em>}4{</em>}{color}{color:#4f81bd}<em color="color">: Change the "Default output folder"</em></p>
<p>After that, click on the "Finish" button. You need to see the following structure (Figure 5). Check that the <em>bin</em> folder appears.</p>
<p>!new<em>project</em>5.png!
{color:#4f81bd}{<em>}Figure 5: Our new Java Project{</em>}{color}</p>
-<h3 id="copying-felix-inside-the-created-project">Copying Felix inside the created project</h3>
+<h3 id="copying-felix-inside-the-created-project">Copying Felix inside the created project<a class="headerlink" href="#copying-felix-inside-the-created-project" title="Permanent link">¶</a></h3>
<p>Now, remember where you uncompress the Felix release, or where is the Felix main project. Move these files inside the created project. Override the <em>bin</em> folder when asked.</p>
<p>!copy_1.png!
{color:#4f81bd}{<em>}Figure{</em>}{color}{color:#4f81bd} {<em>}6{</em>}{color}{color:#4f81bd}<em>: Overwrite the "bin" folder{</em>}{color}</p>
<p>Once copied, refresh the project. You should see something as presented on the Figure 7.</p>
<p>!copy_2.png!
{color:#4f81bd}{<em>}Figure{</em>}{color}{color:#4f81bd} {<em>}7{</em>}{color}{color:#4f81bd}<em>: The Felix project after the copy{</em>}{color}</p>
-<h3 id="preparing-the-felix-project">Preparing the Felix project</h3>
+<h3 id="preparing-the-felix-project">Preparing the Felix project<a class="headerlink" href="#preparing-the-felix-project" title="Permanent link">¶</a></h3>
<p>The Felix main jar is bin/Felix.jar. So, we need to add this jar in the project build path as presented on Figure 8. Right-click on the felix.jar file and then choose Build Path -> Add to Build Path.</p>
<p>!build<em>path</em>1.png!
{color:#4f81bd}{<em>}Figure{</em>}{color}{color:#4f81bd} {<em>}8{</em>}{color}{color:#4f81bd}<em>: Add the felix.jar file to the project build path{</em>}{color}</p>
-<h2 id="run-felix">Run Felix</h2>
-<h3 id="create-a-run-configuration">Create a Run configuration</h3>
+<h2 id="run-felix">Run Felix<a class="headerlink" href="#run-felix" title="Permanent link">¶</a></h2>
+<h3 id="create-a-run-configuration">Create a Run configuration<a class="headerlink" href="#create-a-run-configuration" title="Permanent link">¶</a></h3>
<p>Now, the Felix project is ready. But, we need to configure a <em>Run{</em>}configuration to launch Felix. To achieve this, right-click on the Felix project and select Run As -> Run... (Figure 9)</p>
<p>!run_1.png!
{color:#4f81bd}{<em>}Figure{</em>}{color}{color:#4f81bd} {<em>}9{</em>}{color}{color:#4f81bd}<em>: Create a Run configuration to launch Felix{</em>}{color}</p>
<p>This action launch the Run configuration windows. Create a new Java Application (Right-click on Java Application and select <em>new</em>) (Figure 10)</p>
<p>!run_2.png!
-{color:#4f81bd}{<em>}Figure 10:</em>{color} {color:#4f81bd}{<em>}Create{</em>}{color} {color:#4f81bd}{<em>}a new Java Application{</em>}{color}</p>
+{color:#4f81bd}{<em color="color">}Figure 10:</em> {color:#4f81bd}{<em>}Create{</em>}{color} {color:#4f81bd}{<em>}a new Java Application{</em>}{color}</p>
<p>On the configuration wizard, enter a configuration name. Afterward, check the project name (it should be Felix if you choose Felix as project name). Then, Tick the "Include libraries when searching for a main class" option. You should obtain something as presented on the Figure 11.</p>
<p>!run_3.png!
{color:#4f81bd}{<em>}Figure{</em>}{color}{color:#4f81bd} {<em>}11{</em>}{color}{color:#4f81bd}<em>: Felix run configuration{</em>}{color}</p>
@@ -135,24 +157,24 @@
</pre></div>
-<h3 id="first-execution">First Execution</h3>
+<h3 id="first-execution">First Execution<a class="headerlink" href="#first-execution" title="Permanent link">¶</a></h3>
<p>Once launched, you should see in the Eclipse console view:</p>
<p>!run_6.png!
-{color:#4f81bd}{<em>}Figure{</em>}{color}{color:#4f81bd} {<em>}14{</em>}{color}{color:#4f81bd}<em>: Endly Felix inside Eclipse!</em>{color}</p>
+{color:#4f81bd}{<em>}Figure{</em>}{color}{color:#4f81bd} {<em>}14{</em>}{color}{color:#4f81bd}<em color="color">: Endly Felix inside Eclipse!</em></p>
<p>You can use the console as the "normal" Felix console. In fact it is the normal Felix console in color. Enter a profile name as "integration_test" and then use the console normally (Figure 15).</p>
<p>To stop Felix, either type <em>shutdown</em> in the console, either clicks on the red square ("terminate") in the console toolbar.</p>
<p>!run_7.png!
{color:#4f81bd}{<em>}Figure{</em>}{color}{color:#4f81bd} {<em>}15{</em>}{color}{color:#4f81bd}<em>: Use the Felix console normally{</em>}{color}</p>
-<h3 id="re-launching-felix">Re-launching Felix</h3>
+<h3 id="re-launching-felix">Re-launching Felix<a class="headerlink" href="#re-launching-felix" title="Permanent link">¶</a></h3>
<p>Once the run configuration for Felix is created (and launched a first time), you can launch Felix directly by clicking on the Run icon and by choosing Felix (Figure 16). Moreover, you can use Eclipse debugging features by launching Felix in debug mode. To achieve this, click on the debug icon and then choose Felix (Figure 17).</p>
<p><em>Note:</em> You can launch Felix in profiling mode too, if you have installed TPTP.</p>
<p>!run_8.png!
{color:#4f81bd}{<em>}Figure{</em>}{color}{color:#4f81bd} {<em>}16{</em>}{color}{color:#4f81bd}<em>: Launching directly Felix from the icon bar{</em>}{color}</p>
<p>!run_9.png!
{color:#4f81bd}{<em>}Figure{</em>}{color}{color:#4f81bd} {<em>}17{</em>}{color}{color:#4f81bd}<em>: Launch Felix in debug mode{</em>}{color}</p>
-<h2 id="felix-configuration">Felix Configuration</h2>
+<h2 id="felix-configuration">Felix Configuration<a class="headerlink" href="#felix-configuration" title="Permanent link">¶</a></h2>
<p>Obviously, you can modify the Felix configuration. The Felix configuration file is in the <em>conf</em> folder (config.properties). This section presents briefly two modifications. To go further, look at the Felix documentation.</p>
-<h3 id="configure-the-felix-cache-location">Configure the Felix cache location</h3>
+<h3 id="configure-the-felix-cache-location">Configure the Felix cache location<a class="headerlink" href="#configure-the-felix-cache-location" title="Permanent link">¶</a></h3>
<p>Felix store profiles and deployed bundle inside a cache. Normally this cache is located at<em>$user</em>home/.felix._ It is possible to change this location in order to clean it quickly.</p>
<p>Open the configuration file. Then, add a new line with felix.cache.dir=cache (Figure 18). Now, when you will start Felix, it will create a new{<em>}cache</em> folder (in your project)(Figure 19). All profiles will be stored in. To clean your cache, just delete the cache directory.</p>
<p><em>Note: refresh your project; else the folder does not appear.</em></p>
@@ -160,18 +182,18 @@
{color:#4f81bd}{<em>}Figure{</em>}{color}{color:#4f81bd} {<em>}18{</em>}{color}{color:#4f81bd}<em>: Customize the Felix cache location{</em>}{color}</p>
<p>!conf_2.png!
{color:#4f81bd}{<em>}Figure{</em>}{color}{color:#4f81bd} {<em>}19{</em>}{color}{color:#4f81bd}<em>: The Felix cache inside your project{</em>}{color}</p>
-<h3 id="add-auto-started-bundles">Add auto-started bundles</h3>
+<h3 id="add-auto-started-bundles">Add auto-started bundles<a class="headerlink" href="#add-auto-started-bundles" title="Permanent link">¶</a></h3>
<p>Often, you want that Felix deploy automatically some bundles. By modifying the felix.auto.start.1 (or 2), it is possible to configure which bundle will be deployed at startup.</p>
<p>To achieve this, open the configuration file and add your needed bundle path to the felix.auto.start.1 property (Figure 20). Be careful to the / in your path, to the \ at the end of the line, and to leave a space to the beginning of a new line.</p>
<p>!conf_3.png!
{color:#4f81bd}{<em>}Figure{</em>}{color}{color:#4f81bd} {<em>}20{</em>}{color}{color:#4f81bd}<em>: Add auto-started bundles{</em>}{color}</p>
-<h2 id="debugging-bundles">Debugging bundles</h2>
+<h2 id="debugging-bundles">Debugging bundles<a class="headerlink" href="#debugging-bundles" title="Permanent link">¶</a></h2>
<p>Now that we are able to launch Felix as a Java Application, we can use the debugging and profiling features of Eclipse. To debug bundles, create a new project for your bundle. Then develop your bundle normally. Afterward, compile / package your bundle to obtain the bundle Jar file. You can use Eclipse PDE, Maven, BND, iPOJO, etc... to package your bundle.</p>
<p>To debug, your code, first place a breakpoint inside your code. Launch Felix in debug mode. Then deploy your bundle Jar file. When the execution reaches the breakpoint, Eclipse opens the debug perspective. You can use all debugging features normally.</p>
-<h2 id="conclusion">Conclusion</h2>
+<h2 id="conclusion">Conclusion<a class="headerlink" href="#conclusion" title="Permanent link">¶</a></h2>
<p>This document has presented how-to integrate Felix inside Eclipse. For any questions or feedback, subscribe to the Felix users mailing list by sending a message to <a href="">users-subscribe@felix.apache.org</a>; after subscribing, email questions or feedback to [users@felix.apache.org|mailto:users@felix.apache.org].</p>
<div class="timestamp" style="margin-top: 30px; font-size: 80%; text-align: right;">
- Rev. 1422427 by fmeschbe on Sun, 16 Dec 2012 00:36:51 +0000
+ Rev. 1700393 by cziegeler on Tue, 1 Sep 2015 06:04:06 +0000
</div>
<div class="trademarkFooter">
Apache Felix, Felix, Apache, the Apache feather logo, and the Apache Felix project
Modified: websites/staging/felix/trunk/content/documentation/development/integrating-felix-with-netbeans.html
==============================================================================
--- websites/staging/felix/trunk/content/documentation/development/integrating-felix-with-netbeans.html (original)
+++ websites/staging/felix/trunk/content/documentation/development/integrating-felix-with-netbeans.html Tue Sep 1 06:05:17 2015
@@ -39,7 +39,18 @@
</div>
<div class="menu">
- <p><a href="/news.html">news</a> <br />
+ <style type="text/css">
+/* The following code is added by mdx_elementid.py
+ It was originally lifted from http://subversion.apache.org/style/site.css */
+/*
+ * Hide class="elementid-permalink", except when an enclosing heading
+ * has the :hover property.
+ */
+.headerlink, .elementid-permalink {
+ visibility: hidden;
+}
+h2:hover > .headerlink, h3:hover > .headerlink, h1:hover > .headerlink, h6:hover > .headerlink, h4:hover > .headerlink, h5:hover > .headerlink, dt:hover > .elementid-permalink { visibility: visible }</style>
+<p><a href="/news.html">news</a> <br />
<a href="/license.html">license</a> <br />
<a href="/downloads.cgi">downloads</a> <br />
<a href="/documentation.html">documentation</a> <br />
@@ -66,32 +77,43 @@
</div>
<h1>Integrating Felix with NetBeans</h1>
- <h1 id="integrating-felix-with-netbeans">Integrating Felix with NetBeans</h1>
+ <style type="text/css">
+/* The following code is added by mdx_elementid.py
+ It was originally lifted from http://subversion.apache.org/style/site.css */
+/*
+ * Hide class="elementid-permalink", except when an enclosing heading
+ * has the :hover property.
+ */
+.headerlink, .elementid-permalink {
+ visibility: hidden;
+}
+h2:hover > .headerlink, h3:hover > .headerlink, h1:hover > .headerlink, h6:hover > .headerlink, h4:hover > .headerlink, h5:hover > .headerlink, dt:hover > .elementid-permalink { visibility: visible }</style>
+<h1 id="integrating-felix-with-netbeans">Integrating Felix with NetBeans<a class="headerlink" href="#integrating-felix-with-netbeans" title="Permanent link">¶</a></h1>
<p>This document explains how to launch Felix inside of the NetBeans IDE, which makes it possible to use NetBeans debugging and profiling facilities on bundles. </p>
-<h2 id="preliminaries">Preliminaries</h2>
+<h2 id="preliminaries">Preliminaries<a class="headerlink" href="#preliminaries" title="Permanent link">¶</a></h2>
<p>To integrate Felix inside of NetBeans you need Felix and NetBeans and nothing else. </p>
-<h3 id="installing-netbeans">Installing NetBeans</h3>
+<h3 id="installing-netbeans">Installing NetBeans<a class="headerlink" href="#installing-netbeans" title="Permanent link">¶</a></h3>
<p>First, you need to <a href="http://download.netbeans.org/netbeans/6.1/final/">download the NetBeans IDE</a>. This tutorial was done using NetBeans 6.1, but it should work on NetBeans 6.0. </p>
-<h3 id="creation-of-the-felix-binaries">Creation of the Felix binaries</h3>
+<h3 id="creation-of-the-felix-binaries">Creation of the Felix binaries<a class="headerlink" href="#creation-of-the-felix-binaries" title="Permanent link">¶</a></h3>
<p>To integrate Felix with NetBeans, you have two options:</p>
<ol>
<li>Integrate the Felix release as a Java project. This is what we are going to cover in this tutorial.</li>
<li>Integrateg the Felix release using the Maven plugin. This option is slightly more complex and will be covered in another tutorial. </li>
</ol>
-<h3 id="using-the-felix-release-as-a-java-project">Using the Felix release as a Java Project</h3>
+<h3 id="using-the-felix-release-as-a-java-project">Using the Felix release as a Java Project<a class="headerlink" href="#using-the-felix-release-as-a-java-project" title="Permanent link">¶</a></h3>
<p>Once, NetBeans is installed, you need to <a href="http://felix.apache.org/site/downloads.cgi">download Felix</a>. Choose the binary Felix release in your preferred archive format. Extract the release into a temporary directory. We will copy the files into our project later. </p>
-<h3 id="building-and-using-the-felix-trunk">Building and using the Felix trunk</h3>
+<h3 id="building-and-using-the-felix-trunk">Building and using the Felix trunk<a class="headerlink" href="#building-and-using-the-felix-trunk" title="Permanent link">¶</a></h3>
<p>If you want to use the Felix trunk, follow the <a href="http://felix.apache.org/site/building-felix.html">instructions</a> on the Felix web site to checkout and build the trunk. The Felix binaries are created in the "<code>main</code>" project directory. We will copy these files into our project later.</p>
-<h2 id="using-felix-with-netbeans">Using Felix with NetBeans</h2>
+<h2 id="using-felix-with-netbeans">Using Felix with NetBeans<a class="headerlink" href="#using-felix-with-netbeans" title="Permanent link">¶</a></h2>
<p>This integration tutorial uses a Java project for the integration. This new project will contain Felix. In the following sections it will be explained how to do this. </p>
-<h3 id="creation-of-a-felix-java-project">Creation of a Felix Java project</h3>
+<h3 id="creation-of-a-felix-java-project">Creation of a Felix Java project<a class="headerlink" href="#creation-of-a-felix-java-project" title="Permanent link">¶</a></h3>
<p>First launch NetBeans. Then click on "<code>File->New->Project...</code>" menu entry as shown in Figure 1.</p>
<p>!new-project-menu.png!</p>
<p>This action will launch the project creation wizard. From the "<code>Categories</code>" list choose "<code>Java</code>" and from the "<code>Projects</code>" list choose "<code>Java Application</code>" as shown in Figure 2, then press the "<code>Next ></code>" button.</p>
<p>!new-project-type.png!</p>
<p>Enter the project name ("<code>Felix</code>" for example), select your project directory, and uncheck the "<code>Create Main Class</code>" check box then press the finished button. See Figure 3.</p>
<p>!new-project-properties.png!</p>
-<h3 id="copying-felix-to-the-newly-created-project">Copying Felix to the newly created project</h3>
+<h3 id="copying-felix-to-the-newly-created-project">Copying Felix to the newly created project<a class="headerlink" href="#copying-felix-to-the-newly-created-project" title="Permanent link">¶</a></h3>
<p>Now, remember where you extracted the Felix release or, if you built from source, where the Felix <code>main</code> subproject directory is. Go into the release directory or the <code>main</code> subproject directory and copy its entire contents into your project directory. You can do this any way that is easiest for you. On a Linux box you would do something like this from inside the appropriate release or <code>main</code> directory:</p>
<div class="codehilite"><pre><span class="n">cp</span> <span class="o">-</span><span class="n">r</span> <span class="o">./*</span> <span class="o">/</span><span class="n">project</span><span class="o">-</span><span class="n">path</span><span class="o">/</span>
</pre></div>
@@ -99,7 +121,7 @@
<p>Where "<code>/project-path/</code>" is the path to your project directory.</p>
<p>Once you have copied the files, collapse and expand the project. This will make NetBeans refresh the project. If that does not work for you (on NetBeans 6.0 it may not) just close and open it.</p>
-<h3 id="preparing-the-felix-project">Preparing the Felix project</h3>
+<h3 id="preparing-the-felix-project">Preparing the Felix project<a class="headerlink" href="#preparing-the-felix-project" title="Permanent link">¶</a></h3>
<p>The first thing you will notice is that our new project has a red exclamation point on it. What this means is that when NetBeans parsed the Java files it could not find all the library dependencies, so let's fix that.
Right-click on the newly created project and select the properties as shown in Figure 4.</p>
<p>!project-properties-menu.png!</p>
@@ -116,26 +138,26 @@ Right-click on the newly created project
<p>After you press the "<code>OK</code>" button in the "<code>Run Project</code>" dialog, Felix will be launched and the output window will open with the Felix command line tool running as shown in Figure 10.</p>
<p>!output-window.png!</p>
<p>At this point you can enter your preferred profile and interact with Felix as if you had launched Felix from a command line shell.</p>
-<h3 id="re-launching-felix">Re-launching Felix</h3>
+<h3 id="re-launching-felix">Re-launching Felix<a class="headerlink" href="#re-launching-felix" title="Permanent link">¶</a></h3>
<p>Now that our project is all set up, you only have to select the Run menu item from the project context menu to re-launch Felix. Or if you prefer, if you set Felix as the main project, then you can use "<code>Run</code>" menu on the main menubar. </p>
-<h3 id="felix-configuration">Felix Configuration</h3>
+<h3 id="felix-configuration">Felix Configuration<a class="headerlink" href="#felix-configuration" title="Permanent link">¶</a></h3>
<p>At this point, you may want to make some changes to the way Felix is configured. In NetBeans you will have to open the "<code>Files</code>" view. Expand the Felix folder and then the "<code>conf</code>" folder as shown in Figure 11. NOTE: When you do this the first time the cache folder will not be there. If you decide to make the configuration changes shown in the next section then it will be created the next time you run Felix.</p>
<p>!conf-folder.png!</p>
-<h3 id="configure-the-felix-cache-location">Configure the Felix cache location</h3>
+<h3 id="configure-the-felix-cache-location">Configure the Felix cache location<a class="headerlink" href="#configure-the-felix-cache-location" title="Permanent link">¶</a></h3>
<p>Felix stores profiles and deployed bundles inside a cache. Normally this cache is located at "<code>$userhome/.felix</code>". It is possible to change this location in order to clean it quickly and also to keep your development cache separated from other Felix-based applications you may be running on your computer. You may also want to set a default profile so you don't have to enter it every time you launch Felix. </p>
<p>Open the configuration file, called "<code>config.properties</code>". Then, add a new line with "<code>felix.cache.dir=cache</code>" (see Figure 12). And if you want to set a default profile, uncomment the "<code>felix.cache.profile=foo</code>" line and change it to what you want (Figure 12). To clean your cache, just delete the cache directory.</p>
<p>!config-properties-file.png!</p>
<p>The next time you run Felix, the cache directory will be created with in your project. To verify that it did or if you want to clean it use the "<code>Files</code>" view to expand the Felix folder; you should now see a cache folder that was not there before. You can refer to Figure 11 which displays the cache directory from a previous execution of Felix. </p>
-<h3 id="add-auto-started-bundles">Add auto-started bundles</h3>
+<h3 id="add-auto-started-bundles">Add auto-started bundles<a class="headerlink" href="#add-auto-started-bundles" title="Permanent link">¶</a></h3>
<p>Often you will want Felix to automatically deploy some bundles that you need for your development. You can do this by modifying the "<code>felix.auto.start.1</code>" (or 2) property in the "<code>config.properties</code>" file. For more information on configuring Felix, refer to Felix' <a href="/documentation/subprojects/apache-felix-framework/apache-felix-framework-usage-documentation.html">usage document</a>.</p>
<p>When editing this property, the bundles can be relative or absolute file paths to the bundles you want to auto load. Also don't forget to put the line continuation marker "\" and the end of each line except the last one. In figure 13 you can see the default configuration that is shipped with Felix.</p>
<p>!default-config-properties-file.png!</p>
-<h3 id="debugging-bundles">Debugging bundles</h3>
+<h3 id="debugging-bundles">Debugging bundles<a class="headerlink" href="#debugging-bundles" title="Permanent link">¶</a></h3>
<p>Now that we are able to launch Felix as a Java Application we can use the debugging and profiling features of NetBeans. Future tutorials will go into more detail on how to do this. </p>
-<h2 id="conclusion">Conclusion</h2>
+<h2 id="conclusion">Conclusion<a class="headerlink" href="#conclusion" title="Permanent link">¶</a></h2>
<p>This document has presented one way in which you can integrate Felix with NetBeans. For any questions or feedback, subscribe to the Felix users mailing list by sending a message to <a href="">users-subscribe@felix.apache.org</a>; after subscribing, email questions or feedback to [users@felix.apache.org|mailto:users@felix.apache.org].</p>
<div class="timestamp" style="margin-top: 30px; font-size: 80%; text-align: right;">
- Rev. 1422427 by fmeschbe on Sun, 16 Dec 2012 00:36:51 +0000
+ Rev. 1700393 by cziegeler on Tue, 1 Sep 2015 06:04:06 +0000
</div>
<div class="trademarkFooter">
Apache Felix, Felix, Apache, the Apache feather logo, and the Apache Felix project
Modified: websites/staging/felix/trunk/content/documentation/development/issue-tracking.html
==============================================================================
--- websites/staging/felix/trunk/content/documentation/development/issue-tracking.html (original)
+++ websites/staging/felix/trunk/content/documentation/development/issue-tracking.html Tue Sep 1 06:05:17 2015
@@ -39,7 +39,18 @@
</div>
<div class="menu">
- <p><a href="/news.html">news</a> <br />
+ <style type="text/css">
+/* The following code is added by mdx_elementid.py
+ It was originally lifted from http://subversion.apache.org/style/site.css */
+/*
+ * Hide class="elementid-permalink", except when an enclosing heading
+ * has the :hover property.
+ */
+.headerlink, .elementid-permalink {
+ visibility: hidden;
+}
+h2:hover > .headerlink, h3:hover > .headerlink, h1:hover > .headerlink, h6:hover > .headerlink, h4:hover > .headerlink, h5:hover > .headerlink, dt:hover > .elementid-permalink { visibility: visible }</style>
+<p><a href="/news.html">news</a> <br />
<a href="/license.html">license</a> <br />
<a href="/downloads.cgi">downloads</a> <br />
<a href="/documentation.html">documentation</a> <br />
@@ -66,12 +77,23 @@
</div>
<h1>Issue Tracking</h1>
- <h1 id="issue-tracking">Issue tracking</h1>
+ <style type="text/css">
+/* The following code is added by mdx_elementid.py
+ It was originally lifted from http://subversion.apache.org/style/site.css */
+/*
+ * Hide class="elementid-permalink", except when an enclosing heading
+ * has the :hover property.
+ */
+.headerlink, .elementid-permalink {
+ visibility: hidden;
+}
+h2:hover > .headerlink, h3:hover > .headerlink, h1:hover > .headerlink, h6:hover > .headerlink, h4:hover > .headerlink, h5:hover > .headerlink, dt:hover > .elementid-permalink { visibility: visible }</style>
+<h1 id="issue-tracking">Issue tracking<a class="headerlink" href="#issue-tracking" title="Permanent link">¶</a></h1>
<p>This project uses <a href="http://www.atlassian.com/software/jira">JIRA</a>, a J2EE-based, issue tracking and project management application. We use it for bugs, tasks and code contributions.</p>
<p>Before creating a new issue, please make sure nobody has already added the issue you're reporting. When you do add an issue, please try to make it as informative as possible.</p>
<p>The issue tracker can be found at <a href="http://issues.apache.org/jira/browse/FELIX">http://issues.apache.org/jira/browse/FELIX</a></p>
<div class="timestamp" style="margin-top: 30px; font-size: 80%; text-align: right;">
- Rev. 1422427 by fmeschbe on Sun, 16 Dec 2012 00:36:51 +0000
+ Rev. 1700393 by cziegeler on Tue, 1 Sep 2015 06:04:06 +0000
</div>
<div class="trademarkFooter">
Apache Felix, Felix, Apache, the Apache feather logo, and the Apache Felix project
Modified: websites/staging/felix/trunk/content/documentation/development/roadmap.html
==============================================================================
--- websites/staging/felix/trunk/content/documentation/development/roadmap.html (original)
+++ websites/staging/felix/trunk/content/documentation/development/roadmap.html Tue Sep 1 06:05:17 2015
@@ -39,7 +39,18 @@
</div>
<div class="menu">
- <p><a href="/news.html">news</a> <br />
+ <style type="text/css">
+/* The following code is added by mdx_elementid.py
+ It was originally lifted from http://subversion.apache.org/style/site.css */
+/*
+ * Hide class="elementid-permalink", except when an enclosing heading
+ * has the :hover property.
+ */
+.headerlink, .elementid-permalink {
+ visibility: hidden;
+}
+h2:hover > .headerlink, h3:hover > .headerlink, h1:hover > .headerlink, h6:hover > .headerlink, h4:hover > .headerlink, h5:hover > .headerlink, dt:hover > .elementid-permalink { visibility: visible }</style>
+<p><a href="/news.html">news</a> <br />
<a href="/license.html">license</a> <br />
<a href="/downloads.cgi">downloads</a> <br />
<a href="/documentation.html">documentation</a> <br />
@@ -66,15 +77,26 @@
</div>
<h1>Roadmap</h1>
- <h1 id="roadmap">Roadmap</h1>
-<h2 id="release-08">Release 0.8</h2>
+ <style type="text/css">
+/* The following code is added by mdx_elementid.py
+ It was originally lifted from http://subversion.apache.org/style/site.css */
+/*
+ * Hide class="elementid-permalink", except when an enclosing heading
+ * has the :hover property.
+ */
+.headerlink, .elementid-permalink {
+ visibility: hidden;
+}
+h2:hover > .headerlink, h3:hover > .headerlink, h1:hover > .headerlink, h6:hover > .headerlink, h4:hover > .headerlink, h5:hover > .headerlink, dt:hover > .elementid-permalink { visibility: visible }</style>
+<h1 id="roadmap">Roadmap<a class="headerlink" href="#roadmap" title="Permanent link">¶</a></h1>
+<h2 id="release-08">Release 0.8<a class="headerlink" href="#release-08" title="Permanent link">¶</a></h2>
<p>Release done while the project was in incubation.</p>
-<h2 id="release-10">Release 1.0</h2>
+<h2 id="release-10">Release 1.0<a class="headerlink" href="#release-10" title="Permanent link">¶</a></h2>
<p>First official release after becoming a top level project.</p>
-<h2 id="release-1x">Release 1.x</h2>
+<h2 id="release-1x">Release 1.x<a class="headerlink" href="#release-1x" title="Permanent link">¶</a></h2>
<p>Under development.</p>
<div class="timestamp" style="margin-top: 30px; font-size: 80%; text-align: right;">
- Rev. 1422427 by fmeschbe on Sun, 16 Dec 2012 00:36:51 +0000
+ Rev. 1700393 by cziegeler on Tue, 1 Sep 2015 06:04:06 +0000
</div>
<div class="trademarkFooter">
Apache Felix, Felix, Apache, the Apache feather logo, and the Apache Felix project
Modified: websites/staging/felix/trunk/content/documentation/development/source-code.html
==============================================================================
--- websites/staging/felix/trunk/content/documentation/development/source-code.html (original)
+++ websites/staging/felix/trunk/content/documentation/development/source-code.html Tue Sep 1 06:05:17 2015
@@ -39,7 +39,18 @@
</div>
<div class="menu">
- <p><a href="/news.html">news</a> <br />
+ <style type="text/css">
+/* The following code is added by mdx_elementid.py
+ It was originally lifted from http://subversion.apache.org/style/site.css */
+/*
+ * Hide class="elementid-permalink", except when an enclosing heading
+ * has the :hover property.
+ */
+.headerlink, .elementid-permalink {
+ visibility: hidden;
+}
+h2:hover > .headerlink, h3:hover > .headerlink, h1:hover > .headerlink, h6:hover > .headerlink, h4:hover > .headerlink, h5:hover > .headerlink, dt:hover > .elementid-permalink { visibility: visible }</style>
+<p><a href="/news.html">news</a> <br />
<a href="/license.html">license</a> <br />
<a href="/downloads.cgi">downloads</a> <br />
<a href="/documentation.html">documentation</a> <br />
@@ -66,11 +77,22 @@
</div>
<h1>Source Code</h1>
- <p>This project uses <a href="http://subversion.apache.org/">Subversion</a> to manage its source code. Instructions on Subversion use can be found at [http://svnbook.red-bean.com/].</p>
-<h1 id="web-access">Web Access</h1>
+ <style type="text/css">
+/* The following code is added by mdx_elementid.py
+ It was originally lifted from http://subversion.apache.org/style/site.css */
+/*
+ * Hide class="elementid-permalink", except when an enclosing heading
+ * has the :hover property.
+ */
+.headerlink, .elementid-permalink {
+ visibility: hidden;
+}
+h2:hover > .headerlink, h3:hover > .headerlink, h1:hover > .headerlink, h6:hover > .headerlink, h4:hover > .headerlink, h5:hover > .headerlink, dt:hover > .elementid-permalink { visibility: visible }</style>
+<p>This project uses <a href="http://subversion.apache.org/">Subversion</a> to manage its source code. Instructions on Subversion use can be found at [http://svnbook.red-bean.com/].</p>
+<h1 id="web-access">Web Access<a class="headerlink" href="#web-access" title="Permanent link">¶</a></h1>
<p>The following is a link to the online source repository.</p>
<p><a href="http://svn.apache.org/viewvc/felix/">http://svn.apache.org/viewvc/felix/</a></p>
-<h1 id="anonymous-access">Anonymous access</h1>
+<h1 id="anonymous-access">Anonymous access<a class="headerlink" href="#anonymous-access" title="Permanent link">¶</a></h1>
<p>The Felix trunk can be checked out anonymously with the following command:</p>
<div class="codehilite"><pre><span class="nv">$ </span>svn checkout http://svn.apache.org/repos/asf/felix/trunk felix-trunk
</pre></div>
@@ -78,9 +100,9 @@
<p>If you are a Felix committer, you should use <code>https</code> as the protocol in the above URL.</p>
<p>The source for individual subprojects can be checked out by simply adding their directory name in the repository to the end of the above trunk URL. Use the "web access" link above to determine the precise portion of the repository you wish to check out.</p>
-<h1 id="access-from-behind-a-firewall">Access from behind a firewall</h1>
+<h1 id="access-from-behind-a-firewall">Access from behind a firewall<a class="headerlink" href="#access-from-behind-a-firewall" title="Permanent link">¶</a></h1>
<p>Refer to the documentation of the SCM used for more information about an access behind a firewall.</p>
-<h1 id="access-through-a-proxy">Access through a proxy</h1>
+<h1 id="access-through-a-proxy">Access through a proxy<a class="headerlink" href="#access-through-a-proxy" title="Permanent link">¶</a></h1>
<p>The Subversion client can go through a proxy, if you configure it to do so. First, edit your <code>servers</code> configuration file to indicate which proxy to use. The files location depends on your operating system. On Linux or Unix it is located in the directory <code>~/.subversion</code>. On Windows it is in <code>%APPDATA%\Subversion</code>. (Try <code>echo %APPDATA%</code>, note this is a hidden directory.)</p>
<p>There are comments in the file explaining what to do. If you don't have that file, get the latest Subversion client and run any command; this will cause the configuration directory and template files to be created.</p>
<p>Example : Edit the <code>servers</code> file and add something like :</p>
@@ -90,7 +112,7 @@
</pre></div>
-<h1 id="migrating-your-repository">Migrating your repository</h1>
+<h1 id="migrating-your-repository">Migrating your repository<a class="headerlink" href="#migrating-your-repository" title="Permanent link">¶</a></h1>
<p>For people with checked out copies of the original incubator repository, you will need to use the "svn switch" command to associate your workspace with the new URL. The command for doing this for the trunk is:</p>
<div class="codehilite"><pre><span class="nv">$ </span>svn switch https://svn.apache.org/repos/asf/felix/trunk
</pre></div>
@@ -98,7 +120,7 @@
<p>If you have other directories checked out, e.g., sandbox or releases, then you will need to do for those too, modifying the above URL accordingly.</p>
<div class="timestamp" style="margin-top: 30px; font-size: 80%; text-align: right;">
- Rev. 1422427 by fmeschbe on Sun, 16 Dec 2012 00:36:51 +0000
+ Rev. 1700393 by cziegeler on Tue, 1 Sep 2015 06:04:06 +0000
</div>
<div class="trademarkFooter">
Apache Felix, Felix, Apache, the Apache feather logo, and the Apache Felix project
Modified: websites/staging/felix/trunk/content/documentation/development/svn-repository-structure.html
==============================================================================
--- websites/staging/felix/trunk/content/documentation/development/svn-repository-structure.html (original)
+++ websites/staging/felix/trunk/content/documentation/development/svn-repository-structure.html Tue Sep 1 06:05:17 2015
@@ -39,7 +39,18 @@
</div>
<div class="menu">
- <p><a href="/news.html">news</a> <br />
+ <style type="text/css">
+/* The following code is added by mdx_elementid.py
+ It was originally lifted from http://subversion.apache.org/style/site.css */
+/*
+ * Hide class="elementid-permalink", except when an enclosing heading
+ * has the :hover property.
+ */
+.headerlink, .elementid-permalink {
+ visibility: hidden;
+}
+h2:hover > .headerlink, h3:hover > .headerlink, h1:hover > .headerlink, h6:hover > .headerlink, h4:hover > .headerlink, h5:hover > .headerlink, dt:hover > .elementid-permalink { visibility: visible }</style>
+<p><a href="/news.html">news</a> <br />
<a href="/license.html">license</a> <br />
<a href="/downloads.cgi">downloads</a> <br />
<a href="/documentation.html">documentation</a> <br />
@@ -66,7 +77,18 @@
</div>
<h1>SVN repository structure</h1>
- <p>The Felix SVN repository <code>trunk</code> contains a directory for each sub-project, where sub-projects may be further divided into modules as appropriate for the specific sub-project. Each sub-project has a single directory in the trunk whose name corresponds to the unique base name for the sub-project. Consider the following examples:</p>
+ <style type="text/css">
+/* The following code is added by mdx_elementid.py
+ It was originally lifted from http://subversion.apache.org/style/site.css */
+/*
+ * Hide class="elementid-permalink", except when an enclosing heading
+ * has the :hover property.
+ */
+.headerlink, .elementid-permalink {
+ visibility: hidden;
+}
+h2:hover > .headerlink, h3:hover > .headerlink, h1:hover > .headerlink, h6:hover > .headerlink, h4:hover > .headerlink, h5:hover > .headerlink, dt:hover > .elementid-permalink { visibility: visible }</style>
+<p>The Felix SVN repository <code>trunk</code> contains a directory for each sub-project, where sub-projects may be further divided into modules as appropriate for the specific sub-project. Each sub-project has a single directory in the trunk whose name corresponds to the unique base name for the sub-project. Consider the following examples:</p>
<div class="codehilite"><pre><span class="n">felix</span><span class="o">/</span>
<span class="n">trunk</span><span class="o">/</span>
<span class="n">framework</span><span class="o">/</span>
@@ -125,7 +147,7 @@
<span class="p">...</span>
</pre></div>
<div class="timestamp" style="margin-top: 30px; font-size: 80%; text-align: right;">
- Rev. 1422427 by fmeschbe on Sun, 16 Dec 2012 00:36:51 +0000
+ Rev. 1700393 by cziegeler on Tue, 1 Sep 2015 06:04:06 +0000
</div>
<div class="trademarkFooter">
Apache Felix, Felix, Apache, the Apache feather logo, and the Apache Felix project
Modified: websites/staging/felix/trunk/content/documentation/faqs.html
==============================================================================
--- websites/staging/felix/trunk/content/documentation/faqs.html (original)
+++ websites/staging/felix/trunk/content/documentation/faqs.html Tue Sep 1 06:05:17 2015
@@ -39,7 +39,18 @@
</div>
<div class="menu">
- <p><a href="/news.html">news</a> <br />
+ <style type="text/css">
+/* The following code is added by mdx_elementid.py
+ It was originally lifted from http://subversion.apache.org/style/site.css */
+/*
+ * Hide class="elementid-permalink", except when an enclosing heading
+ * has the :hover property.
+ */
+.headerlink, .elementid-permalink {
+ visibility: hidden;
+}
+h2:hover > .headerlink, h3:hover > .headerlink, h1:hover > .headerlink, h6:hover > .headerlink, h4:hover > .headerlink, h5:hover > .headerlink, dt:hover > .elementid-permalink { visibility: visible }</style>
+<p><a href="/news.html">news</a> <br />
<a href="/license.html">license</a> <br />
<a href="/downloads.cgi">downloads</a> <br />
<a href="/documentation.html">documentation</a> <br />
@@ -66,7 +77,18 @@
</div>
<h1>FAQs</h1>
- <h1 id="frequently-asked-questions">Frequently Asked Questions</h1>
+ <style type="text/css">
+/* The following code is added by mdx_elementid.py
+ It was originally lifted from http://subversion.apache.org/style/site.css */
+/*
+ * Hide class="elementid-permalink", except when an enclosing heading
+ * has the :hover property.
+ */
+.headerlink, .elementid-permalink {
+ visibility: hidden;
+}
+h2:hover > .headerlink, h3:hover > .headerlink, h1:hover > .headerlink, h6:hover > .headerlink, h4:hover > .headerlink, h5:hover > .headerlink, dt:hover > .elementid-permalink { visibility: visible }</style>
+<h1 id="frequently-asked-questions">Frequently Asked Questions<a class="headerlink" href="#frequently-asked-questions" title="Permanent link">¶</a></h1>
<ul>
<li><a href="/documentation/tutorials-examples-and-presentations/apache-felix-osgi-faq.html">OSGi FAQ</a> - Contains answers to general OSGi-related questions.</li>
<li><a href="/documentation/subprojects/apache-felix-framework/apache-felix-framework-faq.html">Framework FAQ</a> - Contains answers to questions that are specifically related to Felix' OSGi framework implementation.</li>
@@ -74,7 +96,7 @@
<li><a href="/documentation/faqs/apache-felix-scr-plugin-faq.html">SCR Plugin FAQ</a> - Contains answers to questions about the Felix maven-scr-plugin</li>
</ul>
<div class="timestamp" style="margin-top: 30px; font-size: 80%; text-align: right;">
- Rev. 1422427 by fmeschbe on Sun, 16 Dec 2012 00:36:51 +0000
+ Rev. 1700393 by cziegeler on Tue, 1 Sep 2015 06:04:06 +0000
</div>
<div class="trademarkFooter">
Apache Felix, Felix, Apache, the Apache feather logo, and the Apache Felix project
Modified: websites/staging/felix/trunk/content/documentation/faqs/apache-felix-bundle-plugin-faq.html
==============================================================================
--- websites/staging/felix/trunk/content/documentation/faqs/apache-felix-bundle-plugin-faq.html (original)
+++ websites/staging/felix/trunk/content/documentation/faqs/apache-felix-bundle-plugin-faq.html Tue Sep 1 06:05:17 2015
@@ -39,7 +39,18 @@
</div>
<div class="menu">
- <p><a href="/news.html">news</a> <br />
+ <style type="text/css">
+/* The following code is added by mdx_elementid.py
+ It was originally lifted from http://subversion.apache.org/style/site.css */
+/*
+ * Hide class="elementid-permalink", except when an enclosing heading
+ * has the :hover property.
+ */
+.headerlink, .elementid-permalink {
+ visibility: hidden;
+}
+h2:hover > .headerlink, h3:hover > .headerlink, h1:hover > .headerlink, h6:hover > .headerlink, h4:hover > .headerlink, h5:hover > .headerlink, dt:hover > .elementid-permalink { visibility: visible }</style>
+<p><a href="/news.html">news</a> <br />
<a href="/license.html">license</a> <br />
<a href="/downloads.cgi">downloads</a> <br />
<a href="/documentation.html">documentation</a> <br />
@@ -66,7 +77,18 @@
</div>
<h1>Apache Felix Bundle Plugin FAQ</h1>
- <h1 id="apache-felix-bundle-plugin-frequently-asked-questions">Apache Felix Bundle Plugin Frequently Asked Questions</h1>
+ <style type="text/css">
+/* The following code is added by mdx_elementid.py
+ It was originally lifted from http://subversion.apache.org/style/site.css */
+/*
+ * Hide class="elementid-permalink", except when an enclosing heading
+ * has the :hover property.
+ */
+.headerlink, .elementid-permalink {
+ visibility: hidden;
+}
+h2:hover > .headerlink, h3:hover > .headerlink, h1:hover > .headerlink, h6:hover > .headerlink, h4:hover > .headerlink, h5:hover > .headerlink, dt:hover > .elementid-permalink { visibility: visible }</style>
+<h1 id="apache-felix-bundle-plugin-frequently-asked-questions">Apache Felix Bundle Plugin Frequently Asked Questions<a class="headerlink" href="#apache-felix-bundle-plugin-frequently-asked-questions" title="Permanent link">¶</a></h1>
<div class="toc">
<ul>
<li><a href="#apache-felix-bundle-plugin-frequently-asked-questions">Apache Felix Bundle Plugin Frequently Asked Questions</a><ul>
@@ -80,7 +102,7 @@
</li>
</ul>
</div>
-<h2 id="when-i-embed-a-dependency-why-do-i-see-duplicated-content">When I embed a dependency why do I see duplicated content?</h2>
+<h2 id="when-i-embed-a-dependency-why-do-i-see-duplicated-content">When I embed a dependency why do I see duplicated content?<a class="headerlink" href="#when-i-embed-a-dependency-why-do-i-see-duplicated-content" title="Permanent link">¶</a></h2>
<p>Having two copies of classes, both unpacked and embedded as jars, is a sign that your Embed-Dependency and Export-Package instructions are overlapping. Export-Package tells BND to pull in classes found in the named packages from the build classpath and add them to the bundle, Embed-Dependency tells BND to embed (or inline if enabled) whole artifacts in the bundle.</p>
<p>so say I have:</p>
<div class="codehilite"><pre><span class="n">Export</span><span class="o">-</span><span class="n">Package</span><span class="p">:</span> <span class="n">org</span><span class="p">.</span><span class="n">objectweb</span><span class="p">.</span><span class="n">asm</span><span class="o">.*</span>
@@ -107,7 +129,7 @@
</pre></div>
-<h2 id="why-do-i-see-more-classes-in-my-bundle-after-upgrading-to-maven-bundle-plugin-200">Why do I see more classes in my bundle after upgrading to maven-bundle-plugin 2.0.0?</h2>
+<h2 id="why-do-i-see-more-classes-in-my-bundle-after-upgrading-to-maven-bundle-plugin-200">Why do I see more classes in my bundle after upgrading to maven-bundle-plugin 2.0.0?<a class="headerlink" href="#why-do-i-see-more-classes-in-my-bundle-after-upgrading-to-maven-bundle-plugin-200" title="Permanent link">¶</a></h2>
<p>Before 2.0.0 the maven-bundle-plugin only passed local classes and compile scope dependencies to bnd. This was because the main BundlePlugin mojo used "@requiresDependencyResolution runtime" which asks Maven to only resolve dependencies of compile or runtime scope (the maven-bundle-plugin also explicitly filtered runtime scope dependencies from the classpath passed to bnd). Because bnd only had a fraction of the original classpath used to compile the bundle classes it meant that imported packages weren't augmented with additional information (such as versions and attributes) available from the complete classpath.</p>
<p>In 2.0.0 a conscious decision was made to pass the complete classpath to bnd so it would have the complete set of information used during compilation. To do this the @requiresDependencyResolution setting was changed to "test" so all dependencies will now be resolved. Furthermore only test scope artifacts are now filtered from the final classpath passed to bnd.</p>
<p>For most users passing more of the original compilation classpath to bnd simply means you get more accurate and consistent results. However, if you happened to rely on the old behaviour (perhaps by setting Private-Package: * to pull in all local and compile scope classes) then you will see more classes added to your bundle as the wildcard matches against additional content in the classpath.</p>
@@ -127,7 +149,7 @@
</ul>
<p>This second option effectively switches the maven-bundle-plugin back to the old 1.X behaviour.</p>
<p>Please also note that since 2.0.0 the maven-bundle-plugin also sets default Export-Package and Private-Package instructions based on your local source files, so you might well find that simply removing any Private-Package and/or Export-Package instructions from your pom.xml will actually produce the correct result.</p>
-<h2 id="why-do-i-get-an-exception-unsupported-majorminor-version-490-when-i-build-with-a-14-or-earlier-jdk">Why do I get an exception (Unsupported major.minor version 49.0) when I build with a 1.4 or earlier JDK?</h2>
+<h2 id="why-do-i-get-an-exception-unsupported-majorminor-version-490-when-i-build-with-a-14-or-earlier-jdk">Why do I get an exception (Unsupported major.minor version 49.0) when I build with a 1.4 or earlier JDK?<a class="headerlink" href="#why-do-i-get-an-exception-unsupported-majorminor-version-490-when-i-build-with-a-14-or-earlier-jdk" title="Permanent link">¶</a></h2>
<p>The latest maven-bundle-plugin (2.0.0) uses a new release of bnd which requires Java5. This means you now have to build your bundle projects using a Java5 (or later) JDK. Note that you can still compile classes for earlier releases of the JVM by setting the appropriate source and target levels in your pom.xml:</p>
<div class="codehilite"><pre><span class="nt"><plugin></span>
<span class="nt"><artifactId></span>maven-compiler-plugin<span class="nt"></artifactId></span>
@@ -139,11 +161,11 @@
</pre></div>
-<h2 id="when-i-build-a-bundle-some-classes-are-built-in-targetclasses-but-theyre-not-included-in-the-final-jar">When I build a bundle, some classes are built in "target/classes" but they're not included in the final jar.</h2>
+<h2 id="when-i-build-a-bundle-some-classes-are-built-in-targetclasses-but-theyre-not-included-in-the-final-jar">When I build a bundle, some classes are built in "target/classes" but they're not included in the final jar.<a class="headerlink" href="#when-i-build-a-bundle-some-classes-are-built-in-targetclasses-but-theyre-not-included-in-the-final-jar" title="Permanent link">¶</a></h2>
<p>The only classes that will appear in the bundle are the ones you ask it to include using Export-Package, Private-Package, Include-Resource, and Embed-Dependency - so just because a file exists under target/classes does NOT mean it will end up in the bundle. This is because this is the way the underlying <a href="http://aqute.biz/Code/Bnd">BND</a> tool works (it is primarily pull-based).</p>
<p>Now the bundleplugin will look at your Maven project and add appropriate BND instructions to pull in resource files - and version 2.0.0 will also look at your source directory to set reasonable defaults for Export-Package and Private-Package (unless you set these yourself). So when using bundleplugin 2.0.0 I'd use the default Private-Package and Export-Package to begin with - I would then move towards using an explicit list of packages in Export-Package to add versioning, directives, etc.</p>
<p>The only time I would set Private-Package would be to have more control over what ends up in the bundle - either to remove certain packages or perhaps pull in additional packages not found by the source scanner. Also note that both Export-Package and Private-Package accept wildcards such as "org.example.*" which can reduce the number of entries in the list, but you should be careful not to set either the export or private instruction to "*" as this would pull in the entire classpath... dependencies and all!</p>
-<h2 id="how-do-i-remove-the-generated-maven-information-from-the-resulting-bundle-jar-file">How do I remove the generated Maven information from the resulting bundle JAR file?</h2>
+<h2 id="how-do-i-remove-the-generated-maven-information-from-the-resulting-bundle-jar-file">How do I remove the generated Maven information from the resulting bundle JAR file?<a class="headerlink" href="#how-do-i-remove-the-generated-maven-information-from-the-resulting-bundle-jar-file" title="Permanent link">¶</a></h2>
<p>Use the following archive setting:</p>
<div class="codehilite"><pre><span class="nt"><configuration></span>
<span class="nt"><archive></span>
@@ -154,10 +176,10 @@
<p>Put this in either the JAR or bundle plugin configuration.</p>
-<h2 id="why-do-some-generated-resources-such-as-declarative-services-xml-files-appear-in-the-final-jar-but-others-dont">Why do some generated resources (such as Declarative Services XML files) appear in the final jar, but others don't?</h2>
+<h2 id="why-do-some-generated-resources-such-as-declarative-services-xml-files-appear-in-the-final-jar-but-others-dont">Why do some generated resources (such as Declarative Services XML files) appear in the final jar, but others don't?<a class="headerlink" href="#why-do-some-generated-resources-such-as-declarative-services-xml-files-appear-in-the-final-jar-but-others-dont" title="Permanent link">¶</a></h2>
<p>When you use the Service-Component instruction to specify Declarative Services the BND tool scans the project classpath for components and automatically adds its generated XML to the final bundle, therefore Include-Resource is not necessary. But if you generate files under OSGI-INF using another mechanism then they won't end up in the bundle unless you add that directory using Include-Resource (this goes back to the core design decision that BND pulls classes and resources into the bundle, rather than just taking everything under target/classes). We try to provide reasonable defaults on the Maven side in the bundleplugin so local classes and resources will end up in the bundle without additional configuration, but we do this by looking at the effective pom and src/ folder rather than the generated target/classes content.</p>
<div class="timestamp" style="margin-top: 30px; font-size: 80%; text-align: right;">
- Rev. 1422427 by fmeschbe on Sun, 16 Dec 2012 00:36:51 +0000
+ Rev. 1700393 by cziegeler on Tue, 1 Sep 2015 06:04:06 +0000
</div>
<div class="trademarkFooter">
Apache Felix, Felix, Apache, the Apache feather logo, and the Apache Felix project
Modified: websites/staging/felix/trunk/content/documentation/getting-started.html
==============================================================================
--- websites/staging/felix/trunk/content/documentation/getting-started.html (original)
+++ websites/staging/felix/trunk/content/documentation/getting-started.html Tue Sep 1 06:05:17 2015
@@ -39,7 +39,18 @@
</div>
<div class="menu">
- <p><a href="/news.html">news</a> <br />
+ <style type="text/css">
+/* The following code is added by mdx_elementid.py
+ It was originally lifted from http://subversion.apache.org/style/site.css */
+/*
+ * Hide class="elementid-permalink", except when an enclosing heading
+ * has the :hover property.
+ */
+.headerlink, .elementid-permalink {
+ visibility: hidden;
+}
+h2:hover > .headerlink, h3:hover > .headerlink, h1:hover > .headerlink, h6:hover > .headerlink, h4:hover > .headerlink, h5:hover > .headerlink, dt:hover > .elementid-permalink { visibility: visible }</style>
+<p><a href="/news.html">news</a> <br />
<a href="/license.html">license</a> <br />
<a href="/downloads.cgi">downloads</a> <br />
<a href="/documentation.html">documentation</a> <br />
@@ -66,7 +77,18 @@
</div>
<h1>Getting Started</h1>
- <h1 id="getting-started">Getting Started</h1>
+ <style type="text/css">
+/* The following code is added by mdx_elementid.py
+ It was originally lifted from http://subversion.apache.org/style/site.css */
+/*
+ * Hide class="elementid-permalink", except when an enclosing heading
+ * has the :hover property.
+ */
+.headerlink, .elementid-permalink {
+ visibility: hidden;
+}
+h2:hover > .headerlink, h3:hover > .headerlink, h1:hover > .headerlink, h6:hover > .headerlink, h4:hover > .headerlink, h5:hover > .headerlink, dt:hover > .elementid-permalink { visibility: visible }</style>
+<h1 id="getting-started">Getting Started<a class="headerlink" href="#getting-started" title="Permanent link">¶</a></h1>
<p>For first-time users, here are a few links that might get you started more quickly:</p>
<ul>
<li><a href="http://felix.apache.org/site/downloads.cgi">Downloads</a> - Go to the download page and download and extract the Felix release.</li>
@@ -77,7 +99,7 @@
</ul>
<p>If you are unable to find the documentation you need, please ask on the <a href="/mailinglists.html">mailing lists</a>. Also, feedback on improving the documentation and/or organization of this site is welcome.</p>
<div class="timestamp" style="margin-top: 30px; font-size: 80%; text-align: right;">
- Rev. 1422427 by fmeschbe on Sun, 16 Dec 2012 00:36:51 +0000
+ Rev. 1700393 by cziegeler on Tue, 1 Sep 2015 06:04:06 +0000
</div>
<div class="trademarkFooter">
Apache Felix, Felix, Apache, the Apache feather logo, and the Apache Felix project