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 2013/09/17 14:41:35 UTC
svn commit: r878806 - in /websites/staging/felix/trunk/content: ./
documentation/subprojects/
documentation/subprojects/apache-felix-maven-scr-plugin/
Author: buildbot
Date: Tue Sep 17 12:41:35 2013
New Revision: 878806
Log:
Staging update by buildbot for felix
Modified:
websites/staging/felix/trunk/content/ (props changed)
websites/staging/felix/trunk/content/documentation/subprojects/apache-felix-maven-scr-plugin.html
websites/staging/felix/trunk/content/documentation/subprojects/apache-felix-maven-scr-plugin/apache-felix-maven-scr-plugin-use.html
websites/staging/felix/trunk/content/documentation/subprojects/apache-felix-maven-scr-plugin/scr-annotations.html
Propchange: websites/staging/felix/trunk/content/
------------------------------------------------------------------------------
--- cms:source-revision (original)
+++ cms:source-revision Tue Sep 17 12:41:35 2013
@@ -1 +1 @@
-1523954
+1524011
Modified: websites/staging/felix/trunk/content/documentation/subprojects/apache-felix-maven-scr-plugin.html
==============================================================================
--- websites/staging/felix/trunk/content/documentation/subprojects/apache-felix-maven-scr-plugin.html (original)
+++ websites/staging/felix/trunk/content/documentation/subprojects/apache-felix-maven-scr-plugin.html Tue Sep 17 12:41:35 2013
@@ -68,7 +68,7 @@
<h1>Apache Felix Maven SCR Plugin</h1>
- <p>The Apache Felix Maven SCR Plugin is a great tool to ease the development of OSGi components and services. Components and services are defined through annotations and the plugin creates the necessary descriptors for the OSGi Declarative Services, Config Admin and Metatype services. Starting with version 1.4.0 of the plugin, OSGi Declarative Services versions 1.0 and 1.1 are supported.</p>
+ <p>The Apache Felix Maven SCR Plugin is a great tool to ease the development of OSGi components and services. Components and services are defined through annotations and the plugin creates the necessary descriptors for the OSGi Declarative Services, Config Admin and Metatype services. Recent versions of the plugin support OSGi Declarative Services versions 1.0, 1.1, and 1.2.</p>
<p>Make sure to see the <a href="/documentation/faqs/apache-felix-scr-plugin-faq.html">FAQ</a> for known problems.</p>
<h2 id="introduction">Introduction</h2>
<p>In OSGi based systems functionality is mainly provided through services. Unlike traditional systems but comparable to Spring, a service is not reqiured to implement a framework defined interface. Instead services implement one or more interfaces, which stipulate the type of service provided. It is the lifetime of the bundle, which defines the lifetime of the service: A service object may be instantiated when the bundle is started and will automatically be removed when the bundle is stopped (and the service has not already been unregistered).</p>
@@ -96,14 +96,14 @@
<h2 id="differences-between-javadoc-tags-and-annotations">Differences between JavaDoc tags and annotations</h2>
<p>In general both mechanisms provide the same functionality. There are some subtle difference which are listed in this section:</p>
<ul>
-<li>JavaDoc tags are not supported in recent versions of the plugin. New features
+<li>JavaDoc tags are not supported in recent versions of the plugin, support has been removed with version 1.8.0. New features
will only be implemented as annotations.</li>
<li>While the <code>metatype</code> flag is turned on by default for the JavaDoc tags, the default for the annotations is to generate no metadata. The reason for this is, that it turned out that services with metadata are less often used.</li>
<li>The JavaDoc support adds properties and references from super classes if the source is in the same module to a component even if the super class does not have the <code>@scr.component</code> tag. With the annotations the super class is required to have the <code>Component</code> annotation.</li>
<li>Property values are handled differently. While the JavaDoc version has an auto detection of types together with an explicit type parameter, the annotations version has several attributes. Each type has its own attribute (like <code>shortValue</code>, <code>intValue</code> and so on). This is because of a limitation in the Java annotations which only allow typed parameters.</li>
</ul>
<div class="timestamp" style="margin-top: 30px; font-size: 80%; text-align: right;">
- Rev. 1522730 by pderop on Thu, 12 Sep 2013 21:08:38 +0000
+ Rev. 1524011 by cziegeler on Tue, 17 Sep 2013 12:41:10 +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/subprojects/apache-felix-maven-scr-plugin/apache-felix-maven-scr-plugin-use.html
==============================================================================
--- websites/staging/felix/trunk/content/documentation/subprojects/apache-felix-maven-scr-plugin/apache-felix-maven-scr-plugin-use.html (original)
+++ websites/staging/felix/trunk/content/documentation/subprojects/apache-felix-maven-scr-plugin/apache-felix-maven-scr-plugin-use.html Tue Sep 17 12:41:35 2013
@@ -78,7 +78,7 @@
<span class="nt"><plugin></span>
<span class="nt"><groupId></span>org.apache.felix<span class="nt"></groupId></span>
<span class="nt"><artifactId></span>maven-scr-plugin<span class="nt"></artifactId></span>
- <span class="nt"><version></span>1.9.0<span class="nt"></version></span>
+ <span class="nt"><version></span>1.14.0<span class="nt"></version></span>
<span class="nt"><executions></span>
<span class="nt"><execution></span>
<span class="nt"><id></span>generate-scr-scrdescriptor<span class="nt"></id></span>
@@ -97,7 +97,7 @@
</pre></div>
-<p>The <code>scr</code> goal is bound to the <code>generate-resources</code> phase and will generate a single descriptor file as well as meta type file for all components found in the project. </p>
+<p>The <code>scr</code> goal is bound to the <code>generate-resources</code> phase and will generate a separate descriptor file for each component as well as a separate meta type file for each component which has metatype support enabled in the project. </p>
<p>The plugin may be configured with the following properties (Check the version column to make sure you use at least this version for the mentioned feature):</p>
<hr />
<p><strong><code>specVersion</code></strong> <br />
@@ -110,10 +110,11 @@ The plugin will generate a descriptor fo
<em>Since</em>: <br />
If this switch is turned on, the bind and unbind methods for unary references are automatically generated by the plugin.</p>
<hr />
-<p><strong><code>processAnnotations</code></strong> <br />
-<em>Default</em>: <code>true</code> <br />
-<em>Since</em>: 1.2.0 <br />
-If this switch is turned on, the java code is scanned for the scr annotations (see below).</p>
+<p><strong><code>scanClasses</code></strong> <br />
+<em>Default</em>: <code>false</code> <br />
+<em>Since</em>: 1.9.0 <br />
+By default the plugin scans the java source tree, if this is set to <code>true</code>,
+the generated classes directory is scanned instead.</p>
<hr />
<p><strong><code>sourceIncludes</code></strong> <br />
<em>Default</em>: <code>true</code> <br />
@@ -135,43 +136,20 @@ The plugin distinguishes between errors
<em>Since</em>: 1.2.0 <br />
A map of predefined properties. These properties are set to each component (if the component does not define the property already). This is a map where the property name is made up by the included element name and the value is the value of the element. </p>
<hr />
-<p><strong><code>finalName</code></strong> <br />
-<em>Default</em>: <code>serviceComponents.xml</code> or <code>scr.descriptor.name</code> system property <br />
-<em>Since</em>: 1.0.0 <br />
-The name of the descriptor file to create. This property only applies if
-the <code>generateSeparateDescriptors</code> is set to <code>false</code>.</p>
-<hr />
-<p><strong><code>metaTypeName</code></strong> <br />
-<em>Default</em>: <code>metatype.xml</code> <br />
-<em>Since</em>: 1.0.0 <br />
-The name of the descriptor file to create.</p>
-<hr />
<p><strong><code>outputDirectory</code></strong> <br />
<em>Default</em>: <code>${project.build.directory}/scr-plugin-generated</code> <br />
<em>Since</em>: 1.0.0 <br />
The directory where all files are generated in.</p>
<hr />
-<p><strong><code>generateSeparateDescriptors</code></strong> <br />
-<em>Default</em>: <code>true</code> <br />
-<em>Since</em>: 1.9.0 <br />
-If set to false, a single descriptor will be created.</p>
-<hr />
<p><strong><code>supportedProjectTypes</code></strong> <br />
<em>Default</em>: <code>jar, bundle</code> <br />
<em>Since</em>: 1.8.0 <br />
Project types which this plugin supports.</p>
<hr />
-<p><strong><code>scanClasses</code></strong> <br />
-<em>Default</em>: <code>false</code> <br />
-<em>Since</em>: 1.9.0 <br />
-By default the plugin scans the java source tree, if this is set to <code>true</code>,
-the generated classes directory is scanned instead.</p>
-<hr />
-<p>The Metatype file is generated in the <code>OSGI-INF/metatype/</code> directory and the Declarative Services descriptor file in the <code>OSGI-INF</code> directory. </p>
-<p><strong>Note</strong>: The location of the Metatype descriptor may not be changed as the OSGi Metatype Service Specification prescribes the location of the descriptors. </p>
-<p>The plugin will look for component definition tags in all Java files found in the source directories of the project unless the <code>scanClasses</code> property indicates the class files are to be scanned instead. This is usefull if the annotations are actually defined in JVM-based languages such as Groovy or Scala.</p>
+<p>The metatype files are generated in the <code>OSGI-INF/metatype/</code> directory and the Declarative Services descriptor files in the <code>OSGI-INF</code> directory. </p>
+<p>The plugin will look for component annotations in all Java files found in the source directories of the project unless the <code>scanClasses</code> property indicates the class files are to be scanned instead. This is usefull if the annotations are actually defined in JVM-based languages such as Groovy or Scala.</p>
<h3 id="using-the-descriptor">Using the descriptor</h3>
-<p>Currently the <code>maven-scr-plugin</code> only creates the component descriptor file. Adding the descriptor to the bundle and setting the <code>Service-Component</code> manifest header accordingly is a different task. However, if you're using the <code>org.apache.felix:maven-bundle-plugin</code> to construct the bundle and its manifest, then the <code>maven-scr-plugin</code> will add the following settings automatically for the <code>org.apache.felix:maven-bundle-plugin</code> (given default <code>maven-scr-plugin</code> configuration), so you don't have to configure this yourself: </p>
+<p>Currently the <code>maven-scr-plugin</code> only creates the component descriptor files. Adding the descriptor to the bundle and setting the <code>Service-Component</code> manifest header accordingly is a different task. However, if you're using the <code>org.apache.felix:maven-bundle-plugin</code> to construct the bundle and its manifest, then the <code>maven-scr-plugin</code> will add the following settings automatically for the <code>org.apache.felix:maven-bundle-plugin</code> (given default <code>maven-scr-plugin</code> configuration), so you don't have to configure this yourself: </p>
<div class="codehilite"><pre>...
<span class="nt"><Include-Resource></span>
src/main/resources,
@@ -183,7 +161,7 @@ the generated classes directory is scann
...
</pre></div>
<div class="timestamp" style="margin-top: 30px; font-size: 80%; text-align: right;">
- Rev. 1438983 by fmeschbe on Sat, 26 Jan 2013 22:54:42 +0000
+ Rev. 1524011 by cziegeler on Tue, 17 Sep 2013 12:41:10 +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/subprojects/apache-felix-maven-scr-plugin/scr-annotations.html
==============================================================================
--- websites/staging/felix/trunk/content/documentation/subprojects/apache-felix-maven-scr-plugin/scr-annotations.html (original)
+++ websites/staging/felix/trunk/content/documentation/subprojects/apache-felix-maven-scr-plugin/scr-annotations.html Tue Sep 17 12:41:35 2013
@@ -72,7 +72,7 @@
<div class="codehilite"><pre><span class="nt"><dependency></span>
<span class="nt"><groupId></span>org.apache.felix<span class="nt"></groupId></span>
<span class="nt"><artifactId></span>org.apache.felix.scr.annotations<span class="nt"></artifactId></span>
- <span class="nt"><version></span>1.2.0<span class="nt"></version></span>
+ <span class="nt"><version></span>1.9.6<span class="nt"></version></span>
<span class="nt"></dependency></span>
</pre></div>
@@ -375,7 +375,7 @@ The name of the method to be called when
<em>SCR Descriptor</em>: <code>reference.strategy</code> <br />
The strategy used for this reference, one of <code>event</code> or <code>lookup</code>. If the reference is defined on a field with a strategy of <code>event</code> and there is no bind or unbind method, the plugin will create the necessary methods.</p>
<div class="timestamp" style="margin-top: 30px; font-size: 80%; text-align: right;">
- Rev. 1438983 by fmeschbe on Sat, 26 Jan 2013 22:54:42 +0000
+ Rev. 1524011 by cziegeler on Tue, 17 Sep 2013 12:41:10 +0000
</div>
<div class="trademarkFooter">
Apache Felix, Felix, Apache, the Apache feather logo, and the Apache Felix project