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/11/04 08:43:19 UTC
svn commit: r971304 [6/10] - in /websites/staging/felix/trunk/content: ./
apidocs/ documentation/ documentation/community/ documentation/development/
documentation/faqs/ documentation/subprojects/
documentation/subprojects/apache-felix-commons/ documen...
Modified: websites/staging/felix/trunk/content/documentation/subprojects/apache-felix-maven-osgi-plugin.html
==============================================================================
--- websites/staging/felix/trunk/content/documentation/subprojects/apache-felix-maven-osgi-plugin.html (original)
+++ websites/staging/felix/trunk/content/documentation/subprojects/apache-felix-maven-osgi-plugin.html Wed Nov 4 07:43:11 2015
@@ -50,17 +50,17 @@
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 />
-<a href="/mailinglists.html">mailing lists</a> <br />
-<a href="/documentation/community/contributing.html">contributing</a> <br />
-<a href="/sitemap.html">site map</a> <br />
-<a href="http://www.apache.org/">asf</a> <br />
-<a href="http://www.apache.org/security/">security</a> <br />
-<a href="http://www.apache.org/foundation/sponsorship.html">sponsorship</a> <br />
-<a href="http://www.apache.org/foundation/thanks.html">sponsors</a> </p>
+<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 />
+<a href="/mailinglists.html">Mailing Lists</a> <br />
+<a href="/documentation/community/contributing.html">Contributing</a> <br />
+<a href="/sitemap.html">Site Map</a> <br />
+<a href="http://www.apache.org/">ASF</a> <br />
+<a href="http://www.apache.org/security/">Security</a> <br />
+<a href="http://www.apache.org/foundation/sponsorship.html">Sponsorship</a> <br />
+<a href="http://www.apache.org/foundation/thanks.html">Sponsors</a> </p>
<iframe
src="http://www.apache.org/ads/button.html"
style="border-width:0; float: left"
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 Wed Nov 4 07:43:11 2015
@@ -39,17 +39,28 @@
</div>
<div class="menu">
- <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 />
-<a href="/mailinglists.html">mailing lists</a> <br />
-<a href="/documentation/community/contributing.html">contributing</a> <br />
-<a href="/sitemap.html">site map</a> <br />
-<a href="http://www.apache.org/">asf</a> <br />
-<a href="http://www.apache.org/security/">security</a> <br />
-<a href="http://www.apache.org/foundation/sponsorship.html">sponsorship</a> <br />
-<a href="http://www.apache.org/foundation/thanks.html">sponsors</a> </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><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 />
+<a href="/mailinglists.html">Mailing Lists</a> <br />
+<a href="/documentation/community/contributing.html">Contributing</a> <br />
+<a href="/sitemap.html">Site Map</a> <br />
+<a href="http://www.apache.org/">ASF</a> <br />
+<a href="http://www.apache.org/security/">Security</a> <br />
+<a href="http://www.apache.org/foundation/sponsorship.html">Sponsorship</a> <br />
+<a href="http://www.apache.org/foundation/thanks.html">Sponsors</a> </p>
<iframe
src="http://www.apache.org/ads/button.html"
style="border-width:0; float: left"
@@ -66,9 +77,20 @@
</div>
<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. Recent versions of the plugin support OSGi Declarative Services versions 1.0, 1.1, and 1.2.</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 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>
+<h2 id="introduction">Introduction<a class="headerlink" href="#introduction" title="Permanent link">¶</a></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>
<p>Usually, the functionality of a bundle - be it the packages exported or be it the services provided - is made available to the rest of the system, when the bundle is started. To give the bundle a change to take action, a bundle may declare a <code>BundleActivator</code> class in the <code>Bundle-Activato</code> manifest header of the bundle. When the bundle is started, the <code>start(BundleContext)</code> method is called, while the <code>stop(BundleContext)</code> method is called when the bundle is stopped. These methods are one place to instantiate and register services with the service registry.</p>
<p>The drawback of this method of service registration is that the services have to acquire other services whose functionality is used themselves and also have to observe the presence as services may come and go at any time. Though this observation is rather easy as basically a <code>ServiceListener</code> is to be implemented which listens for service registration and unregistration events, this is somewhat tedious and repeating for each service using other services.</p>
@@ -82,7 +104,7 @@
<li>The <em>Configuration Admin Service</em> provides functionality to provide configuration to components and services as well as to support management tools to update (and create) configuration data.</li>
<li>The <em>Metatype Service</em> provides a description suitable for management tools to manage configurations provided by the Configuration Admin Service. The descriptions of the data is provided in one or more XML files and associated languag binding files.</li>
</ol>
-<h2 id="where-to-go-from-here">Where to go from here</h2>
+<h2 id="where-to-go-from-here">Where to go from here<a class="headerlink" href="#where-to-go-from-here" title="Permanent link">¶</a></h2>
<ul>
<li><a href="/documentation/subprojects/apache-felix-maven-scr-plugin/apache-felix-maven-scr-plugin-use.html">Using the Apache Felix Maven SCR Plugin to generate Declarative Services and Metatype Service descriptors during a Maven Build</a></li>
<li><a href="/documentation/subprojects/apache-felix-maven-scr-plugin/apache-felix-scr-ant-task-use.html">Using the Apache Felix SCR Ant Task to generate Declarative Services and Metatype Service descriptors during an Ant driven Build.</a></li>
@@ -91,7 +113,7 @@
<li><a href="/documentation/subprojects/apache-felix-maven-scr-plugin/scr-javadoc-tags.html">Using JavaDoc Tags to describe the component or service.</a></li>
<li><a href="/documentation/subprojects/apache-felix-maven-scr-plugin/extending-scr-annotations.html">How add new Annotations extending the base Annotations</a></li>
</ul>
-<h2 id="differences-between-javadoc-tags-and-annotations">Differences between JavaDoc tags and annotations</h2>
+<h2 id="differences-between-javadoc-tags-and-annotations">Differences between JavaDoc tags and annotations<a class="headerlink" href="#differences-between-javadoc-tags-and-annotations" title="Permanent link">¶</a></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, support has been removed with version 1.8.0. New features
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 Wed Nov 4 07:43:11 2015
@@ -39,17 +39,28 @@
</div>
<div class="menu">
- <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 />
-<a href="/mailinglists.html">mailing lists</a> <br />
-<a href="/documentation/community/contributing.html">contributing</a> <br />
-<a href="/sitemap.html">site map</a> <br />
-<a href="http://www.apache.org/">asf</a> <br />
-<a href="http://www.apache.org/security/">security</a> <br />
-<a href="http://www.apache.org/foundation/sponsorship.html">sponsorship</a> <br />
-<a href="http://www.apache.org/foundation/thanks.html">sponsors</a> </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><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 />
+<a href="/mailinglists.html">Mailing Lists</a> <br />
+<a href="/documentation/community/contributing.html">Contributing</a> <br />
+<a href="/sitemap.html">Site Map</a> <br />
+<a href="http://www.apache.org/">ASF</a> <br />
+<a href="http://www.apache.org/security/">Security</a> <br />
+<a href="http://www.apache.org/foundation/sponsorship.html">Sponsorship</a> <br />
+<a href="http://www.apache.org/foundation/thanks.html">Sponsors</a> </p>
<iframe
src="http://www.apache.org/ads/button.html"
style="border-width:0; float: left"
@@ -66,7 +77,18 @@
</div>
<h1>Apache Felix Maven SCR Plugin Use</h1>
- <p>Support for automatic generation of the compenent and metadata descriptors is embeded in the <code>org.apache.felix:maven-scr-plugin</code> plugin. To use this plugin, it has to be declared in the project descriptor as a <code><plugin></code> element: </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>Support for automatic generation of the compenent and metadata descriptors is embeded in the <code>org.apache.felix:maven-scr-plugin</code> plugin. To use this plugin, it has to be declared in the project descriptor as a <code><plugin></code> element: </p>
<div class="codehilite"><pre><span class="nt"><project></span>
...
<span class="nt"><build></span>
@@ -184,7 +206,7 @@ Project types which this plugin supports
<hr />
<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>
+<h3 id="using-the-descriptor">Using the descriptor<a class="headerlink" href="#using-the-descriptor" title="Permanent link">¶</a></h3>
<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>
Modified: websites/staging/felix/trunk/content/documentation/subprojects/apache-felix-maven-scr-plugin/apache-felix-scr-ant-task-use.html
==============================================================================
--- websites/staging/felix/trunk/content/documentation/subprojects/apache-felix-maven-scr-plugin/apache-felix-scr-ant-task-use.html (original)
+++ websites/staging/felix/trunk/content/documentation/subprojects/apache-felix-maven-scr-plugin/apache-felix-scr-ant-task-use.html Wed Nov 4 07:43:11 2015
@@ -39,17 +39,28 @@
</div>
<div class="menu">
- <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 />
-<a href="/mailinglists.html">mailing lists</a> <br />
-<a href="/documentation/community/contributing.html">contributing</a> <br />
-<a href="/sitemap.html">site map</a> <br />
-<a href="http://www.apache.org/">asf</a> <br />
-<a href="http://www.apache.org/security/">security</a> <br />
-<a href="http://www.apache.org/foundation/sponsorship.html">sponsorship</a> <br />
-<a href="http://www.apache.org/foundation/thanks.html">sponsors</a> </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><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 />
+<a href="/mailinglists.html">Mailing Lists</a> <br />
+<a href="/documentation/community/contributing.html">Contributing</a> <br />
+<a href="/sitemap.html">Site Map</a> <br />
+<a href="http://www.apache.org/">ASF</a> <br />
+<a href="http://www.apache.org/security/">Security</a> <br />
+<a href="http://www.apache.org/foundation/sponsorship.html">Sponsorship</a> <br />
+<a href="http://www.apache.org/foundation/thanks.html">Sponsors</a> </p>
<iframe
src="http://www.apache.org/ads/button.html"
style="border-width:0; float: left"
@@ -66,7 +77,18 @@
</div>
<h1>Apache Felix SCR Ant Task Use</h1>
- <p>The SCR Ant Task is implemented in the <code>org.apache.felix.scr.ant</code> library which must be registered as an Ant Task in the build file as follows:</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 SCR Ant Task is implemented in the <code>org.apache.felix.scr.ant</code> library which must be registered as an Ant Task in the build file as follows:</p>
<div class="codehilite"><pre><span class="nt"><project</span> <span class="err">...</span><span class="nt">></span>
<span class="nt"><taskdef</span>
@@ -85,7 +107,7 @@
<li>The task requires that the source files have already been compiled</li>
</ul>
<p>The task only generates the descriptor file(s). If you want to use the Declarative Services descriptor -- by default generated in the <code>OSGI-INF/serviceComponents.xml</code> -- you must make sure to add a <code>Service-Components</code> header to your bundle manifest. Unlike Maven plugin the Ant task cannot automatically generate this header.</p>
-<h2 id="task-attributes">Task Attributes</h2>
+<h2 id="task-attributes">Task Attributes<a class="headerlink" href="#task-attributes" title="Permanent link">¶</a></h2>
<p>Like the standard <code>javac</code> Ant Task, the SCR Ant Task defines an implicit fileset which defines the source files to be scanned for Java 5 Annotations or JavaDoc Tags. In addition to the child elements available to Ant Fileset as defined for <a href="http://ant.apache.org/manual/dirtasks.html#directorybasedtasks">directory-based tasks</a> the following task attributes are supported:</p>
<hr />
<p><strong><code>scrdir</code></strong> <br />
@@ -149,12 +171,12 @@ If set to true, JavaDoc based annotation
If set to true, SCR annotations will be processed</p>
<hr />
<p>The <code>scr</code> task must be provided with the same class path as was used to compile the sources. The classes in the class path are used by the task to be able to load compiled classes (mostly for Java 5 annotation processing) and any base classes, which may be extended. The easiest way to share the class path is to define a class path property and refer to it with the <code>classpathref</code> attribute of the <code>scr</code> task.</p>
-<h2 id="using-javadoc-tags">Using JavaDoc Tags</h2>
+<h2 id="using-javadoc-tags">Using JavaDoc Tags<a class="headerlink" href="#using-javadoc-tags" title="Permanent link">¶</a></h2>
<p>JavaDoc tags are supported natively by the SCR Ant Task. No further configuration and/or libraries are needed.</p>
-<h2 id="java-5-annotations">Java 5 Annotations</h2>
+<h2 id="java-5-annotations">Java 5 Annotations<a class="headerlink" href="#java-5-annotations" title="Permanent link">¶</a></h2>
<p>To use Java 5 Annotations make sure the library defining the annotations is available on the class path for both the compilation in the <code>javac</code> task and for generating the descriptor in the <code>scr</code> task.</p>
<p>No further configuration is required as the SCR Ant Task automatically recognizes SCR Annotation definitions from libraries in the class path provided the annotations are provided in a JAR library with properly setup SPI configuration as documented in <a href="/documentation/subprojects/apache-felix-maven-scr-plugin/extending-scr-annotations.html">Extending SCR Annotations</a>.</p>
-<h2 id="example">Example</h2>
+<h2 id="example">Example<a class="headerlink" href="#example" title="Permanent link">¶</a></h2>
<p>The following is very simple example build file based on the <a href="http://svn.apache.org/repos/asf/sling/trunk/bundles/jcr/webconsole">Apache Sling JCR WebConsole</a> bundle:</p>
<div class="codehilite"><pre><span class="nt"><project</span> <span class="na">default=</span><span class="s">"scr"</span> <span class="na">basedir=</span><span class="s">"."</span><span class="nt">></span>
Modified: websites/staging/felix/trunk/content/documentation/subprojects/apache-felix-maven-scr-plugin/apache-felix-scr-bndtools-use.html
==============================================================================
--- websites/staging/felix/trunk/content/documentation/subprojects/apache-felix-maven-scr-plugin/apache-felix-scr-bndtools-use.html (original)
+++ websites/staging/felix/trunk/content/documentation/subprojects/apache-felix-maven-scr-plugin/apache-felix-scr-bndtools-use.html Wed Nov 4 07:43:11 2015
@@ -39,17 +39,28 @@
</div>
<div class="menu">
- <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 />
-<a href="/mailinglists.html">mailing lists</a> <br />
-<a href="/documentation/community/contributing.html">contributing</a> <br />
-<a href="/sitemap.html">site map</a> <br />
-<a href="http://www.apache.org/">asf</a> <br />
-<a href="http://www.apache.org/security/">security</a> <br />
-<a href="http://www.apache.org/foundation/sponsorship.html">sponsorship</a> <br />
-<a href="http://www.apache.org/foundation/thanks.html">sponsors</a> </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><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 />
+<a href="/mailinglists.html">Mailing Lists</a> <br />
+<a href="/documentation/community/contributing.html">Contributing</a> <br />
+<a href="/sitemap.html">Site Map</a> <br />
+<a href="http://www.apache.org/">ASF</a> <br />
+<a href="http://www.apache.org/security/">Security</a> <br />
+<a href="http://www.apache.org/foundation/sponsorship.html">Sponsorship</a> <br />
+<a href="http://www.apache.org/foundation/thanks.html">Sponsors</a> </p>
<iframe
src="http://www.apache.org/ads/button.html"
style="border-width:0; float: left"
@@ -66,13 +77,24 @@
</div>
<h1>Apache Felix SCR Annotations BndTools Use</h1>
- <p>The org.apache.felix.scrplugin.bnd.SCRDescriptorBndPlugin is a bnd plugin allowing to generate SCR annotations and metatype descriptors in the Eclipse BndTools environment.
+ <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 org.apache.felix.scrplugin.bnd.SCRDescriptorBndPlugin is a bnd plugin allowing to generate SCR annotations and metatype descriptors in the Eclipse BndTools environment.
This page describes how to install the plugin in BndTools and also provides a simple tutorial, which won't be very fascinating, but will make it easy
to demonstrate the use of Apache SCR annotations within BndTools.</p>
<p>If you are not yet familiar with BndTools or if you have not already installed it, you can take a look at <a href="http://bndtools.org/">BndTools homepage</a>.</p>
<p>This tutorial has been made with Eclipse Kepler and with the latest BndTools development version.
It is assumed that the eclipse workspace is currently set to ~/workspace/BNDTOOLS</p>
-<h2 id="installing-scr-bnd-plugin-in-bndtools">Installing SCR Bnd plugin in BndTools</h2>
+<h2 id="installing-scr-bnd-plugin-in-bndtools">Installing SCR Bnd plugin in BndTools<a class="headerlink" href="#installing-scr-bnd-plugin-in-bndtools" title="Permanent link">¶</a></h2>
<p><strong>Create the cnf project</strong>:</p>
<p>If the BndTools "cnf" project does not already exist in your workspace, then create it:</p>
<ul>
@@ -102,7 +124,7 @@ For example:</p>
<p>You have installed the SCR annotations bnd plugin in Eclipse BndTools, and you can now start using it (see the following Tutorial).</p>
-<h2 id="tutorial">Tutorial</h2>
+<h2 id="tutorial">Tutorial<a class="headerlink" href="#tutorial" title="Permanent link">¶</a></h2>
<p>In this tutorial, we'll create a "greeting" project, which provides a simple Greeting service with a "sayHello" method, and the
implementation will use the Apache Felix SCR annotations:</p>
<p>From the File menu, select New -> Bndtools OSGi Project for creating an empty project, and call it "greeting".</p>
@@ -152,7 +174,7 @@ Export-Package: greeting.api
<p>Create a Run descriptor (call it "run") with Apache Felix 4 With Gogo Shell.</p>
<p>In Run requirement, add the greeting project, as well as Apache Felix SCR from Bnd HUB.</p>
<p>Then Run the project: you should see in the console the "Starting Greeting Service" message displayed from the start() method.</p>
-<h2 id="plugin-options">Plugin Options</h2>
+<h2 id="plugin-options">Plugin Options<a class="headerlink" href="#plugin-options" title="Permanent link">¶</a></h2>
<p>You can possibly add some optional parameters in the plugin bnd directive (each one separated by a semicolon).
For example:</p>
<div class="codehilite"><pre><span class="o">-</span><span class="n">plugin</span><span class="p">:</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">scrplugin</span><span class="p">.</span><span class="n">bnd</span><span class="p">.</span><span class="n">SCRDescriptorBndPlugin</span><span class="p">;</span><span class="nb">log</span><span class="p">=</span><span class="n">debug</span><span class="p">;</span><span class="n">generateAccessors</span><span class="p">=</span><span class="n">false</span>
Modified: websites/staging/felix/trunk/content/documentation/subprojects/apache-felix-maven-scr-plugin/extending-scr-annotations.html
==============================================================================
--- websites/staging/felix/trunk/content/documentation/subprojects/apache-felix-maven-scr-plugin/extending-scr-annotations.html (original)
+++ websites/staging/felix/trunk/content/documentation/subprojects/apache-felix-maven-scr-plugin/extending-scr-annotations.html Wed Nov 4 07:43:11 2015
@@ -39,17 +39,28 @@
</div>
<div class="menu">
- <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 />
-<a href="/mailinglists.html">mailing lists</a> <br />
-<a href="/documentation/community/contributing.html">contributing</a> <br />
-<a href="/sitemap.html">site map</a> <br />
-<a href="http://www.apache.org/">asf</a> <br />
-<a href="http://www.apache.org/security/">security</a> <br />
-<a href="http://www.apache.org/foundation/sponsorship.html">sponsorship</a> <br />
-<a href="http://www.apache.org/foundation/thanks.html">sponsors</a> </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><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 />
+<a href="/mailinglists.html">Mailing Lists</a> <br />
+<a href="/documentation/community/contributing.html">Contributing</a> <br />
+<a href="/sitemap.html">Site Map</a> <br />
+<a href="http://www.apache.org/">ASF</a> <br />
+<a href="http://www.apache.org/security/">Security</a> <br />
+<a href="http://www.apache.org/foundation/sponsorship.html">Sponsorship</a> <br />
+<a href="http://www.apache.org/foundation/thanks.html">Sponsors</a> </p>
<iframe
src="http://www.apache.org/ads/button.html"
style="border-width:0; float: left"
@@ -66,7 +77,18 @@
</div>
<h1>Extending SCR Annotations</h1>
- <p><strong>Note:</strong> This page documents functionality available with the SCR Generator 1.0.0 release providing the declaration file generation mechanism for the Maven SCR Plugin 1.6.0 (and newer) and the SCR Ant Task 1.0.0 (and newer).</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><strong>Note:</strong> This page documents functionality available with the SCR Generator 1.0.0 release providing the declaration file generation mechanism for the Maven SCR Plugin 1.6.0 (and newer) and the SCR Ant Task 1.0.0 (and newer).</p>
<p>The SCR Annotations library has been updated in version 1.4.0 to comply
with the rules described here. As such this library may be used as basis
to learn more about providing pluggbale Java 5 annotations for the Maven
@@ -84,7 +106,7 @@ the default and Sling Java 5 tags for th
already implemented according to the rules outlined herein. This means,
that actually the SCR Generator does not have any built-in annotations but
only provides the framework to allow for the definition of Java 5 Annotations.</p>
-<h2 id="define-the-annotations">Define the Annotations</h2>
+<h2 id="define-the-annotations">Define the Annotations<a class="headerlink" href="#define-the-annotations" title="Permanent link">¶</a></h2>
<p>To start with you will define Java 5 Annotations to suit your application needs. The <a href="http://svn.apache.org/repos/asf/felix/trunk/scrplugin/annotations/src/main/java/org/apache/felix/scr/annotations/sling"><code>org.apache.felix.scr.annotations.sling</code></a> package provides three sample annotations:</p>
<ul>
<li><a href="http://svn.apache.org/repos/asf/felix/trunk/scrplugin/annotations/src/main/java/org/apache/felix/scr/annotations/sling/SlingServlet.java"><code>SlingServlet</code></a> -- used to declare a <code>javax.servlet.Servlet</code> service
@@ -100,11 +122,11 @@ annotation.</li>
<p>These annotations will be used to annotate classes for use with Declarative Services.</p>
<p>It is suggested to maintain the annotations in a separate package or even
in a separate module that your projects may depend upon.</p>
-<h2 id="define-an-annotationprocessor">Define an <code>AnnotationProcessor</code></h2>
+<h2 id="define-an-annotationprocessor">Define an <code>AnnotationProcessor</code><a class="headerlink" href="#define-an-annotationprocessor" title="Permanent link">¶</a></h2>
<p>The <a href="http://svn.apache.org/repos/asf/felix/trunk/scrplugin/generator/src/main/java/org/apache/felix/scrplugin/annotations/AnnotationProcessor.java"><code>AnnotationProcessor</code></a> interface defines the interface of a helper class which is used to convert Java 5 Annotation data into internal data structures to be then used as the basis for the generation of the descriptor files.</p>
<p>Implementations of this interface are provided with the <a href="http://svn.apache.org/repos/asf/felix/trunk/scrplugin/generator/src/main/java/org/apache/felix/scrplugin/annotations/ScannedClass.java"><code>ScannedClass</code></a> instances and are expected to augment the provided <a href="http://svn.apache.org/repos/asf/felix/trunk/scrplugin/generator/src/main/java/org/apache/felix/scrplugin/description/ClassDescription.java">ClassDescription</a>.</p>
<p>The <a href="http://svn.apache.org/repos/asf/felix/trunk/scrplugin/annotations/src/main/java/org/apache/felix/scrplugin/processing/SlingAnnotationProcessor.java"><code>SlingAnnotationProcessor</code></a> class implements the <code>AnnotationProcessor</code>to handle the Sling annotations described above.</p>
-<h2 id="register-the-annotationprocessor">Register the <code>AnnotationProcessor</code></h2>
+<h2 id="register-the-annotationprocessor">Register the <code>AnnotationProcessor</code><a class="headerlink" href="#register-the-annotationprocessor" title="Permanent link">¶</a></h2>
<p>To finally make the <code>AnnotationProcessor</code> implementations available to the SCR Generator (and thus the Maven SCR Plugin and/or SCR Ant Task) the fully qualified class names of these implementations must be listed in an <a href="http://svn.apache.org/repos/asf/felix/trunk/scrplugin/annotations/src/main/resources/META-INF/services/org.apache.felix.scrplugin.annotations.AnnotationProcessor"><code>META-INF/services/org.apache.felix.scrplugin.annotations.AnnotationProcessor</code></a> file
in the library providing the annotations.</p>
<p>The classes listed in this file will automatically be picked up by the SCR Generator from the library placed on the build class path and thus enable support for the respective annotations.</p>
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 Wed Nov 4 07:43:11 2015
@@ -39,17 +39,28 @@
</div>
<div class="menu">
- <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 />
-<a href="/mailinglists.html">mailing lists</a> <br />
-<a href="/documentation/community/contributing.html">contributing</a> <br />
-<a href="/sitemap.html">site map</a> <br />
-<a href="http://www.apache.org/">asf</a> <br />
-<a href="http://www.apache.org/security/">security</a> <br />
-<a href="http://www.apache.org/foundation/sponsorship.html">sponsorship</a> <br />
-<a href="http://www.apache.org/foundation/thanks.html">sponsors</a> </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><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 />
+<a href="/mailinglists.html">Mailing Lists</a> <br />
+<a href="/documentation/community/contributing.html">Contributing</a> <br />
+<a href="/sitemap.html">Site Map</a> <br />
+<a href="http://www.apache.org/">ASF</a> <br />
+<a href="http://www.apache.org/security/">Security</a> <br />
+<a href="http://www.apache.org/foundation/sponsorship.html">Sponsorship</a> <br />
+<a href="http://www.apache.org/foundation/thanks.html">Sponsors</a> </p>
<iframe
src="http://www.apache.org/ads/button.html"
style="border-width:0; float: left"
@@ -66,7 +77,18 @@
</div>
<h1>SCR Annotations</h1>
- <p>The <code>maven-scr-plugin</code> uses the <code>SCR</code> annotations from the corresponding subproject at Apache Felix. All annotations are in the <code>org.apache.felix.scr.annotations</code> package. If you want to use the annotations in your project, you have to use a <code>maven-scr-plugin</code> version >= 1.2.0 and make sure that you add a dependency to the annotations to your <code>POM</code>:</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 <code>maven-scr-plugin</code> uses the <code>SCR</code> annotations from the corresponding subproject at Apache Felix. All annotations are in the <code>org.apache.felix.scr.annotations</code> package. If you want to use the annotations in your project, you have to use a <code>maven-scr-plugin</code> version >= 1.2.0 and make sure that you add a dependency to the annotations to your <code>POM</code>:</p>
<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>
@@ -83,7 +105,7 @@
<li><a href="#property">@Property</a></li>
<li><a href="#reference">@Reference</a></li>
</ul>
-<h2 id="component">@Component</h2>
+<h2 id="component">@Component<a class="headerlink" href="#component" title="Permanent link">¶</a></h2>
<p>The <code>@Component</code> annotation is the only required annotation. If this annotation is not declared for a Java class, the class is not declared as a component.</p>
<p>This annotation is used to declare the <code><component></code> element of the component declaration. See section 112.4.3, Component Element, in the OSGi Service Platform Service Compendium Specification for more information. The required <code><implementation></code> element is automatically generated with the fully qualified name of the class containing the <code>@Component</code> annotation.</p>
<p>Supported attributes:</p>
@@ -171,13 +193,13 @@ This is generally used as a description
<em>SCR Descriptor</em>: -- <br />
<em>Metatype Descriptor</em>: <code>Designate.factoryPid</code> <br />
Is this a configuration factory? (since 1.4.0)</p>
-<h3 id="abstract-service-descriptions">Abstract Service Descriptions</h3>
+<h3 id="abstract-service-descriptions">Abstract Service Descriptions<a class="headerlink" href="#abstract-service-descriptions" title="Permanent link">¶</a></h3>
<p>If the <code>@Component</code> annotations contains the attribute <code>componentAbstract</code> with a value of true, the containing class is regarded as an abstract class. It is not added to the service descriptor and the tags are not validated. The information about this class is added to the bundle. Classes from other bundles (or the same) can extends this abstract class and do not need to specify the references of the abstract class if they set the <code>inherit</code> parameter on the <code>scr.component</code> tag to true.</p>
<p>This allows to create abstract classes which already provide some valuable functionality without having to deal with the details like reference definitions in each and every subclass.</p>
-<h2 id="activate-deactivate-and-modified">@Activate, @Deactivate, and @Modified</h2>
+<h2 id="activate-deactivate-and-modified">@Activate, @Deactivate, and @Modified<a class="headerlink" href="#activate-deactivate-and-modified" title="Permanent link">¶</a></h2>
<p>The Declarative Service version 1.1 allows to specify the name for the activate, deactivate and modified method (see the spec for more information). The <code>@Activate</code>, <code>@Deactivate</code>, and <code>@Modified</code> annotation can be used to mark a method to be used for the specified purpose. However, as the DS specifies a method search algorithm, there are rare cases where the marked method is not used (if there is another method with the same name, but a different signature this might happen).</p>
<p>These annoations have no attribues.</p>
-<h2 id="service">@Service</h2>
+<h2 id="service">@Service<a class="headerlink" href="#service" title="Permanent link">¶</a></h2>
<p>The <code>@Service</code> annotation defines whether and which service interfaces are provided by the component. This is a class annotation.</p>
<p>This annotation is used to declare <code><service></code> and <code><provide></code> elements of the component declaration. See section 112.4.6, Service Elements, in the OSGi Service Platform Service Compendium Specification for more information.</p>
<p>Supported attributes:</p>
@@ -192,7 +214,7 @@ The name of the service interface provid
<em>SCR Descriptor</em>: <code>service.servicefactory</code> <br />
Whether the component is registered as a <code>ServiceFactory</code> or not</p>
<p>Omitting the <code>Service</code> annotation will just define (and activate if required) the component but not register it as a service. Multiple <code>Service</code> annotations may be declared each with its own <code>value</code>. These annotations need to be wrapped into a <code>Services</code> anotation. The component is registered as a <code>ServiceFactory</code> if at least on <code>Service</code> annotations declares the <code>serviceFactory</code> attribute as <code>true</code>.</p>
-<h2 id="property">@Property</h2>
+<h2 id="property">@Property<a class="headerlink" href="#property" title="Permanent link">¶</a></h2>
<p>The <code>@Property</code> annotation defines properties which are made available to the component through the <code>ComponentContext.getProperties()</code> method. These tags are not strictly required but may be used by components to defined initial configuration. Additionally properties may be set here to identify the component if it is registered as a service, for example the <code>service.description</code> and <code>service.vendor</code> properties.</p>
<p>This annotation can be applied on the component class level or on a field defining a constant with the name of the property.</p>
<p>This annotation is used to declare <code><property></code> elements of the component declaration. See section 112.4.5, Properties and Property Elements, in the OSGi Service Platform Service Compendium Specification for more information.</p>
@@ -296,7 +318,7 @@ See below for a description of the <code
</pre></div>
-<h4 id="naming-the-property">Naming the Property</h4>
+<h4 id="naming-the-property">Naming the Property<a class="headerlink" href="#naming-the-property" title="Permanent link">¶</a></h4>
<p>It is important to carefully define the name of properties. By using a constant of the form</p>
<div class="codehilite"><pre><span class="nd">@Property</span><span class="o">(</span><span class="n">value</span><span class="o">=</span><span class="s">"default value"</span><span class="o">)</span>
<span class="kd">static</span> <span class="kd">final</span> <span class="n">String</span> <span class="n">CONSTANT_NAME</span> <span class="o">=</span> <span class="s">"property.name"</span><span class="o">;</span>
@@ -304,7 +326,7 @@ See below for a description of the <code
<p>and defining the <code>@Property</code> annotation on this constant, the name of the property is taken from the constant value. Thus it may easily be ensured, that both the property in the descriptor files and the property used by the implementation are actually the same. In addition the value attribute can refer to another constant.</p>
-<h3 id="the-options-attribute">The <code>options</code> Attribute</h3>
+<h3 id="the-options-attribute">The <code>options</code> Attribute<a class="headerlink" href="#the-options-attribute" title="Permanent link">¶</a></h3>
<p>Some properties may only be set to a set of possible values. To support user interfaces which provide a selection list of values or a list of checkboxes the option values and labels may be defined as parameters to the <code>@Property</code> annotation.</p>
<p>The value of the <code>options</code> attribute is a list of <code>@PropertyOption</code>s annotations:</p>
<div class="codehilite"><pre><span class="nd">@Property</span><span class="o">(</span><span class="n">name</span> <span class="o">=</span> <span class="s">"sample"</span><span class="o">,</span>
@@ -323,11 +345,11 @@ a <code>%</code> sign to localize the st
inside the <code>AD</code> element defining the property. The name of the parameter
will be used for the <code>Option.value</code> attribute while the value of the
parameter defines the <code>Option.label</code> attribute.</p>
-<h3 id="multivalue-properties">Multivalue Properties</h3>
+<h3 id="multivalue-properties">Multivalue Properties<a class="headerlink" href="#multivalue-properties" title="Permanent link">¶</a></h3>
<p>Generally the value of a property is scalar, that is a property has a single value such as <code>true</code>, <code>5</code> or <code>"This is a String"</code>. Such scalar values are defined with the different <code>value</code> attributes of the <code>Property</code> annotation. In the case of a scalar property value, the <code>cardinality</code> parameter value is assumed to be <code>0</code> (zero) unless of course set otherwise.</p>
<p>There may be properties, which have a list of values, such as a list of possible URL mappings for an URL Mapper. Such multiple values are defined just by comma separate as the value of the annotation parameter.</p>
<p>If the cardinality of the property is not explicilty set with the <code>cardinality</code> property, it defaults to <code>Integer.MAX_INT</code>, i.e. unbound array, if multiple values are defined. Otherwise the <code>cardinality</code> parameter may be set for example to a negative value to store the values in a <code>java.util.Vector</code> instead.</p>
-<h2 id="reference">@Reference</h2>
+<h2 id="reference">@Reference<a class="headerlink" href="#reference" title="Permanent link">¶</a></h2>
<p>The <code>@Reference</code> annotation defines references to other services made available to the component by the Service Component Runtime.</p>
<p>This annotation may be declared on a Class level or any Java field to which it might apply. Depending on where the annotation is declared, the parameters may have different default values.</p>
<p>This annotation is used to declare <code><reference></code> elements of the component declaration. See section 112.4.7, Reference Element, in the OSGi Service Platform Service Compendium Specification for more information.</p>
Modified: websites/staging/felix/trunk/content/documentation/subprojects/apache-felix-maven-scr-plugin/scr-javadoc-tags.html
==============================================================================
--- websites/staging/felix/trunk/content/documentation/subprojects/apache-felix-maven-scr-plugin/scr-javadoc-tags.html (original)
+++ websites/staging/felix/trunk/content/documentation/subprojects/apache-felix-maven-scr-plugin/scr-javadoc-tags.html Wed Nov 4 07:43:11 2015
@@ -39,17 +39,28 @@
</div>
<div class="menu">
- <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 />
-<a href="/mailinglists.html">mailing lists</a> <br />
-<a href="/documentation/community/contributing.html">contributing</a> <br />
-<a href="/sitemap.html">site map</a> <br />
-<a href="http://www.apache.org/">asf</a> <br />
-<a href="http://www.apache.org/security/">security</a> <br />
-<a href="http://www.apache.org/foundation/sponsorship.html">sponsorship</a> <br />
-<a href="http://www.apache.org/foundation/thanks.html">sponsors</a> </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><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 />
+<a href="/mailinglists.html">Mailing Lists</a> <br />
+<a href="/documentation/community/contributing.html">Contributing</a> <br />
+<a href="/sitemap.html">Site Map</a> <br />
+<a href="http://www.apache.org/">ASF</a> <br />
+<a href="http://www.apache.org/security/">Security</a> <br />
+<a href="http://www.apache.org/foundation/sponsorship.html">Sponsorship</a> <br />
+<a href="http://www.apache.org/foundation/thanks.html">Sponsors</a> </p>
<iframe
src="http://www.apache.org/ads/button.html"
style="border-width:0; float: left"
@@ -66,7 +77,18 @@
</div>
<h1>SCR JavaDoc Tags</h1>
- <div class="note">
+ <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>
+<div class="note">
JavaDoc tags are not supported since the Maven SCR Plugin 1.8.0 because
annotations are a much more powerful instrument allowing
for type safety or supporting JVM based languages such as Groovy and Scala.
@@ -81,11 +103,11 @@ Plugin version 1.7.4.
<li><a href="#scrservice">scr.service</a></li>
<li><a href="#scrreference">scr.reference</a></li>
</ul>
-<h2 id="scrcomponent">scr.component</h2>
+<h2 id="scrcomponent">scr.component<a class="headerlink" href="#scrcomponent" title="Permanent link">¶</a></h2>
<p>The <code>scr.component</code> tag is the only required tag. If this tag is not declared in the Java class comment, the class is not declared as a component.</p>
<p>This tag is used to declare the <code><component></code> element of the component declaration. See section 112.4.3, Component Element, in the OSGi Service Platform Service Compendium Specification for more information. The required <code><implementation></code> element is automatically generated with the fully qualified name of the class containing the <code>scr.component</code> tag.</p>
<p>Supported parameters:</p>
-<table>
+<table class="table">
<thead>
<tr>
<th><em>Name</em></th>
@@ -196,7 +218,7 @@ Plugin version 1.7.4.
</tbody>
</table>
<p>The following attributes are supported since version 1.4.0 of the plugin and required a Declarative Service implementation 1.1:</p>
-<table>
+<table class="table">
<thead>
<tr>
<th><em>Name</em></th>
@@ -242,15 +264,15 @@ Plugin version 1.7.4.
</tr>
</tbody>
</table>
-<h3 id="abstract-service-descriptions">Abstract Service Descriptions</h3>
+<h3 id="abstract-service-descriptions">Abstract Service Descriptions<a class="headerlink" href="#abstract-service-descriptions" title="Permanent link">¶</a></h3>
<p>If the <code>scr.component</code> tag contains the parameter <code>abstract</code> with a value of true, the containing class is regarded as an abstract class. It is not added to the service descriptor and the tags are not validated. The information about this class is added to the bundle. Classes from other bundles (or the same) can extends this abstract class and do not need to specify the references of the abstract class if they set the <code>inherit</code> parameter on the <code>scr.component</code> tag to true.</p>
<p>This allows to create abstract classes which already provide some valuable functionality without having to deal with the details like reference definitions in each and every subclass.</p>
-<h2 id="scrproperty">scr.property</h2>
+<h2 id="scrproperty">scr.property<a class="headerlink" href="#scrproperty" title="Permanent link">¶</a></h2>
<p>The <code>scr.property</code> tag defines properties which are made available to the component through the <code>ComponentContext.getProperties()</code> method. These tags are not strictly required but may be used by components to defined initial configuration. Additionally properties may be set here to identify the component if it is registered as a service, for example the <code>service.description</code> and <code>service.vendor</code> properties.</p>
<p>This tag may be defined in the Java Class comment of the component or in a coment to a field defining a constant with the name of the property.</p>
<p>This tag is used to declare <code><property></code> elements of the component declaration. See section 112.4.5, Properties and Property Elements, in the OSGi Service Platform Service Compendium Specification for more information.</p>
<p>Supported parameters:</p>
-<table>
+<table class="table">
<thead>
<tr>
<th><em>Name</em></th>
@@ -356,7 +378,7 @@ Plugin version 1.7.4.
<ul>
<li>Generating <code><properties></code> elements referring to bundle entries is not currently supported.</li>
</ul>
-<h3 id="naming-the-property">Naming the property</h3>
+<h3 id="naming-the-property">Naming the property<a class="headerlink" href="#naming-the-property" title="Permanent link">¶</a></h3>
<p>It is important to carefully define the name of properties. By using a constant of the form</p>
<div class="codehilite"><pre><span class="cm">/** @scr.property value="default value" */</span>
<span class="kd">static</span> <span class="kd">final</span> <span class="n">String</span> <span class="n">CONSTANT_NAME</span> <span class="o">=</span> <span class="s">"property.name"</span><span class="o">;</span>
@@ -364,20 +386,20 @@ Plugin version 1.7.4.
<p>and defining the <code>scr.property</code> tag on this constant, the name of the property is taken from the constant value. Thus it may easily be ensured, that both the property in the descriptor files and the property used by the implementation are actually the same.</p>
-<h3 id="the-options-parameter">The <code>options</code> parameter</h3>
+<h3 id="the-options-parameter">The <code>options</code> parameter<a class="headerlink" href="#the-options-parameter" title="Permanent link">¶</a></h3>
<p>Some properties may only be set to a set of possible values. To support user interfaces which provide a selection list of values or a list of checkboxes the option values and labels may be defined as parameters to the <code>scr.property</code> tag. All parameters in the form of name-value pairs occurring <em>after</em> the <code>options</code> parameter are used to build the list of available value options. The parameter name is used as the value while the parameter value is used as the label in the user interface. This label may be prepended with a <code>%</code> sign to localize the string.</p>
<p>The options are written to the <code>metatype.xml</code> file as <code>Option</code> elements inside the <code>AD</code> element defining the property. The name of the parameter will be used for the <code>Option.value</code> attribute while the value of the parameter defines the <code>Option.label</code> attribute.</p>
<p>Please note, that all parameters of the <code>scr.property</code> tag occurring <em>after</em> the <code>options</code> parameter are used to build the options list. Hence no non-option value parameters should actually follow the <code>options</code> parameter.</p>
-<h3 id="multivalue-properties">Multivalue properties</h3>
+<h3 id="multivalue-properties">Multivalue properties<a class="headerlink" href="#multivalue-properties" title="Permanent link">¶</a></h3>
<p>Generally the value of a property is scalar, that is a property has a single value such as <code>true</code>, <code>5</code> or <code>"This is a String"</code>. Such scalar values are defined with the <code>value</code> parameter of the <code>scr.property</code> tag. In the case of a scalar property value, the <code>cardinality</code> parameter value is assumed to be <code>0</code> (zero) unless of course set otherwise.</p>
<p>There may be properties, which have a list of values, such as a list of possible URL mappings for an URL Mapper. Such multiple values are defined in one more parameters whose name starts with <code>values</code>. Each parameter must of course have a unique name which is not in any except to differentiate the parameters.</p>
<p>If the cardinality of the property is not explicilty set with the <code>cardinality</code> property, it defaults to <code>Integer.MAX_INT</code>, i.e. unbound array, if multiple values with a series of <code>values</code> parameters are defined. Otherwise the <code>cardinality</code> parameter may be set for example to a negative value to store the values in a <code>java.util.Vector</code> instead.</p>
-<h2 id="scrservice">scr.service</h2>
+<h2 id="scrservice">scr.service<a class="headerlink" href="#scrservice" title="Permanent link">¶</a></h2>
<p>The <code>scr.service</code> tag defines whether and which service interfaces are provided by the component.</p>
<p>This tag is expected in the Java Class comment of the component.</p>
<p>This tag is used to declare <code><service></code> and <code><provide></code> elements of the component declaration. See section 112.4.6, Service Elements, in the OSGi Service Platform Service Compendium Specification for more information.</p>
<p>Supported parameters:</p>
-<table>
+<table class="table">
<thead>
<tr>
<th><em>Name</em></th>
@@ -405,12 +427,12 @@ Plugin version 1.7.4.
</tbody>
</table>
<p>Omitting the <code>scr.service</code> tag will just define (and activate if required) the component but not register it as a service. Multiple <code>scr.service</code> tags may be declared each with its own <code>interface</code>. The component is registered as a <code>ServiceFactory</code> if at least on <code>scr.service</code> tag declares the <code>servicefactory</code> parameter as <code>true</code>.</p>
-<h2 id="scrreference">scr.reference</h2>
+<h2 id="scrreference">scr.reference<a class="headerlink" href="#scrreference" title="Permanent link">¶</a></h2>
<p>The <code>scr.reference</code> tag defines references to other services made available to the component by the Service Component Runtime.</p>
<p>This tag may be declared in the java Class comment or any Java Field to which it might apply. Depending on where the tag is declared, the parameters may have different default values.</p>
<p>This tag is used to declare <code><reference></code> elements of the component declaration. See section 112.4.7, Reference Element, in the OSGi Service Platform Service Compendium Specification for more information.</p>
<p>Supported parameters:</p>
-<table>
+<table class="table">
<thead>
<tr>
<th><em>Name</em></th>
Modified: websites/staging/felix/trunk/content/documentation/subprojects/apache-felix-metatype-service.html
==============================================================================
--- websites/staging/felix/trunk/content/documentation/subprojects/apache-felix-metatype-service.html (original)
+++ websites/staging/felix/trunk/content/documentation/subprojects/apache-felix-metatype-service.html Wed Nov 4 07:43:11 2015
@@ -50,17 +50,17 @@
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 />
-<a href="/mailinglists.html">mailing lists</a> <br />
-<a href="/documentation/community/contributing.html">contributing</a> <br />
-<a href="/sitemap.html">site map</a> <br />
-<a href="http://www.apache.org/">asf</a> <br />
-<a href="http://www.apache.org/security/">security</a> <br />
-<a href="http://www.apache.org/foundation/sponsorship.html">sponsorship</a> <br />
-<a href="http://www.apache.org/foundation/thanks.html">sponsors</a> </p>
+<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 />
+<a href="/mailinglists.html">Mailing Lists</a> <br />
+<a href="/documentation/community/contributing.html">Contributing</a> <br />
+<a href="/sitemap.html">Site Map</a> <br />
+<a href="http://www.apache.org/">ASF</a> <br />
+<a href="http://www.apache.org/security/">Security</a> <br />
+<a href="http://www.apache.org/foundation/sponsorship.html">Sponsorship</a> <br />
+<a href="http://www.apache.org/foundation/thanks.html">Sponsors</a> </p>
<iframe
src="http://www.apache.org/ads/button.html"
style="border-width:0; float: left"
Modified: websites/staging/felix/trunk/content/documentation/subprojects/apache-felix-osgi-bundle-repository.html
==============================================================================
--- websites/staging/felix/trunk/content/documentation/subprojects/apache-felix-osgi-bundle-repository.html (original)
+++ websites/staging/felix/trunk/content/documentation/subprojects/apache-felix-osgi-bundle-repository.html Wed Nov 4 07:43:11 2015
@@ -50,17 +50,17 @@
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 />
-<a href="/mailinglists.html">mailing lists</a> <br />
-<a href="/documentation/community/contributing.html">contributing</a> <br />
-<a href="/sitemap.html">site map</a> <br />
-<a href="http://www.apache.org/">asf</a> <br />
-<a href="http://www.apache.org/security/">security</a> <br />
-<a href="http://www.apache.org/foundation/sponsorship.html">sponsorship</a> <br />
-<a href="http://www.apache.org/foundation/thanks.html">sponsors</a> </p>
+<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 />
+<a href="/mailinglists.html">Mailing Lists</a> <br />
+<a href="/documentation/community/contributing.html">Contributing</a> <br />
+<a href="/sitemap.html">Site Map</a> <br />
+<a href="http://www.apache.org/">ASF</a> <br />
+<a href="http://www.apache.org/security/">Security</a> <br />
+<a href="http://www.apache.org/foundation/sponsorship.html">Sponsorship</a> <br />
+<a href="http://www.apache.org/foundation/thanks.html">Sponsors</a> </p>
<iframe
src="http://www.apache.org/ads/button.html"
style="border-width:0; float: left"
Modified: websites/staging/felix/trunk/content/documentation/subprojects/apache-felix-osgi-core.html
==============================================================================
--- websites/staging/felix/trunk/content/documentation/subprojects/apache-felix-osgi-core.html (original)
+++ websites/staging/felix/trunk/content/documentation/subprojects/apache-felix-osgi-core.html Wed Nov 4 07:43:11 2015
@@ -50,17 +50,17 @@
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 />
-<a href="/mailinglists.html">mailing lists</a> <br />
-<a href="/documentation/community/contributing.html">contributing</a> <br />
-<a href="/sitemap.html">site map</a> <br />
-<a href="http://www.apache.org/">asf</a> <br />
-<a href="http://www.apache.org/security/">security</a> <br />
-<a href="http://www.apache.org/foundation/sponsorship.html">sponsorship</a> <br />
-<a href="http://www.apache.org/foundation/thanks.html">sponsors</a> </p>
+<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 />
+<a href="/mailinglists.html">Mailing Lists</a> <br />
+<a href="/documentation/community/contributing.html">Contributing</a> <br />
+<a href="/sitemap.html">Site Map</a> <br />
+<a href="http://www.apache.org/">ASF</a> <br />
+<a href="http://www.apache.org/security/">Security</a> <br />
+<a href="http://www.apache.org/foundation/sponsorship.html">Sponsorship</a> <br />
+<a href="http://www.apache.org/foundation/thanks.html">Sponsors</a> </p>
<iframe
src="http://www.apache.org/ads/button.html"
style="border-width:0; float: left"
Modified: websites/staging/felix/trunk/content/documentation/subprojects/apache-felix-preferences-service.html
==============================================================================
--- websites/staging/felix/trunk/content/documentation/subprojects/apache-felix-preferences-service.html (original)
+++ websites/staging/felix/trunk/content/documentation/subprojects/apache-felix-preferences-service.html Wed Nov 4 07:43:11 2015
@@ -50,17 +50,17 @@
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 />
-<a href="/mailinglists.html">mailing lists</a> <br />
-<a href="/documentation/community/contributing.html">contributing</a> <br />
-<a href="/sitemap.html">site map</a> <br />
-<a href="http://www.apache.org/">asf</a> <br />
-<a href="http://www.apache.org/security/">security</a> <br />
-<a href="http://www.apache.org/foundation/sponsorship.html">sponsorship</a> <br />
-<a href="http://www.apache.org/foundation/thanks.html">sponsors</a> </p>
+<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 />
+<a href="/mailinglists.html">Mailing Lists</a> <br />
+<a href="/documentation/community/contributing.html">Contributing</a> <br />
+<a href="/sitemap.html">Site Map</a> <br />
+<a href="http://www.apache.org/">ASF</a> <br />
+<a href="http://www.apache.org/security/">Security</a> <br />
+<a href="http://www.apache.org/foundation/sponsorship.html">Sponsorship</a> <br />
+<a href="http://www.apache.org/foundation/thanks.html">Sponsors</a> </p>
<iframe
src="http://www.apache.org/ads/button.html"
style="border-width:0; float: left"
Modified: websites/staging/felix/trunk/content/documentation/subprojects/apache-felix-remote-shell.html
==============================================================================
--- websites/staging/felix/trunk/content/documentation/subprojects/apache-felix-remote-shell.html (original)
+++ websites/staging/felix/trunk/content/documentation/subprojects/apache-felix-remote-shell.html Wed Nov 4 07:43:11 2015
@@ -50,17 +50,17 @@
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 />
-<a href="/mailinglists.html">mailing lists</a> <br />
-<a href="/documentation/community/contributing.html">contributing</a> <br />
-<a href="/sitemap.html">site map</a> <br />
-<a href="http://www.apache.org/">asf</a> <br />
-<a href="http://www.apache.org/security/">security</a> <br />
-<a href="http://www.apache.org/foundation/sponsorship.html">sponsorship</a> <br />
-<a href="http://www.apache.org/foundation/thanks.html">sponsors</a> </p>
+<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 />
+<a href="/mailinglists.html">Mailing Lists</a> <br />
+<a href="/documentation/community/contributing.html">Contributing</a> <br />
+<a href="/sitemap.html">Site Map</a> <br />
+<a href="http://www.apache.org/">ASF</a> <br />
+<a href="http://www.apache.org/security/">Security</a> <br />
+<a href="http://www.apache.org/foundation/sponsorship.html">Sponsorship</a> <br />
+<a href="http://www.apache.org/foundation/thanks.html">Sponsors</a> </p>
<iframe
src="http://www.apache.org/ads/button.html"
style="border-width:0; float: left"
Modified: websites/staging/felix/trunk/content/documentation/subprojects/apache-felix-script-console-plugin.html
==============================================================================
--- websites/staging/felix/trunk/content/documentation/subprojects/apache-felix-script-console-plugin.html (original)
+++ websites/staging/felix/trunk/content/documentation/subprojects/apache-felix-script-console-plugin.html Wed Nov 4 07:43:11 2015
@@ -39,17 +39,28 @@
</div>
<div class="menu">
- <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 />
-<a href="/mailinglists.html">mailing lists</a> <br />
-<a href="/documentation/community/contributing.html">contributing</a> <br />
-<a href="/sitemap.html">site map</a> <br />
-<a href="http://www.apache.org/">asf</a> <br />
-<a href="http://www.apache.org/security/">security</a> <br />
-<a href="http://www.apache.org/foundation/sponsorship.html">sponsorship</a> <br />
-<a href="http://www.apache.org/foundation/thanks.html">sponsors</a> </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><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 />
+<a href="/mailinglists.html">Mailing Lists</a> <br />
+<a href="/documentation/community/contributing.html">Contributing</a> <br />
+<a href="/sitemap.html">Site Map</a> <br />
+<a href="http://www.apache.org/">ASF</a> <br />
+<a href="http://www.apache.org/security/">Security</a> <br />
+<a href="http://www.apache.org/foundation/sponsorship.html">Sponsorship</a> <br />
+<a href="http://www.apache.org/foundation/thanks.html">Sponsors</a> </p>
<iframe
src="http://www.apache.org/ads/button.html"
style="border-width:0; float: left"
@@ -67,6 +78,17 @@
<h1>Apache Felix Script Console Plugin</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>
+<style type="text/css">
img {
width:auto;
}
@@ -80,9 +102,9 @@ features</p>
<li>Hot key support</li>
<li>Execute remote testcase via evaluating test scripts</li>
</ul>
-<h3 id="installation">Installation</h3>
+<h3 id="installation">Installation<a class="headerlink" href="#installation" title="Permanent link">¶</a></h3>
<p>To make use of this plugin you need to</p>
-<h4 id="a-install-the-script-console-plugin-bundle">A - Install the Script Console Plugin bundle</h4>
+<h4 id="a-install-the-script-console-plugin-bundle">A - Install the Script Console Plugin bundle<a class="headerlink" href="#a-install-the-script-console-plugin-bundle" title="Permanent link">¶</a></h4>
<p>Refer to <a href="http://felix.apache.org/downloads.cgi">downloads</a> for getting the bundle.</p>
<p>For Maven use following coordinates</p>
<div class="codehilite"><pre><span class="nt"><dependency></span>
@@ -101,13 +123,13 @@ $<span class="n">mvn</span> <span class=
</pre></div>
-<h4 id="b-install-the-language-specific-bundle">B- Install the language specific bundle</h4>
+<h4 id="b-install-the-language-specific-bundle">B- Install the language specific bundle<a class="headerlink" href="#b-install-the-language-specific-bundle" title="Permanent link">¶</a></h4>
<p>Install bundles for the Script Language you want to use</p>
<ul>
<li><a href="http://repo1.maven.org/maven2/org/codehaus/groovy/groovy-all/2.1.6/groovy-all-2.1.6.jar">Groovy</a></li>
<li><a href="http://repo1.maven.org/maven2/org/jruby/jruby/1.7.4/jruby-1.7.4.jar">JRuby</a></li>
</ul>
-<h3 id="usage">Usage</h3>
+<h3 id="usage">Usage<a class="headerlink" href="#usage" title="Permanent link">¶</a></h3>
<p>After installing it you would see a new tab "Script Console" in Felix Web Console.
The plugin screen provides a textarea to author script code. One can select the language via the given dropdown. The generated
output is shown in pane below.</p>
@@ -141,7 +163,7 @@ output is shown in pane below.</p>
<li>Ctrl+F9 - Execute the script</li>
<li>Ctrl+q - Clear the output</li>
</ul>
-<h3 id="http-api">HTTP API</h3>
+<h3 id="http-api">HTTP API<a class="headerlink" href="#http-api" title="Permanent link">¶</a></h3>
<p>The plugin can also be invoked by making POST request. It supports following parameters</p>
<ul>
<li><code>code</code>- Script content. Can be norm form data or a multi part content</li>
@@ -152,7 +174,7 @@ output is shown in pane below.</p>
</li>
</ul>
<p>If any exception occurs while evaluating the script then it would return the exception message with status set to 500. Scripts can control what output they want to emit.</p>
-<h3 id="sample-scripts">Sample Scripts</h3>
+<h3 id="sample-scripts">Sample Scripts<a class="headerlink" href="#sample-scripts" title="Permanent link">¶</a></h3>
<p>Following are some sample scripts in Groovy. Note the scripts might be depending on implementation details to access the
relevant data structures</p>
<ol>
@@ -224,7 +246,7 @@ access some private class to see the run
</li>
</ol>
-<h3 id="screenshots">Screenshots</h3>
+<h3 id="screenshots">Screenshots<a class="headerlink" href="#screenshots" title="Permanent link">¶</a></h3>
<p><img src="script-console-1.png" align="center"></p>
<div class="timestamp" style="margin-top: 30px; font-size: 80%; text-align: right;">
Rev. 1508319 by chetanm on Tue, 30 Jul 2013 06:53:12 +0000
Modified: websites/staging/felix/trunk/content/documentation/subprojects/apache-felix-serialization-framework.html
==============================================================================
--- websites/staging/felix/trunk/content/documentation/subprojects/apache-felix-serialization-framework.html (original)
+++ websites/staging/felix/trunk/content/documentation/subprojects/apache-felix-serialization-framework.html Wed Nov 4 07:43:11 2015
@@ -50,17 +50,17 @@
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 />
-<a href="/mailinglists.html">mailing lists</a> <br />
-<a href="/documentation/community/contributing.html">contributing</a> <br />
-<a href="/sitemap.html">site map</a> <br />
-<a href="http://www.apache.org/">asf</a> <br />
-<a href="http://www.apache.org/security/">security</a> <br />
-<a href="http://www.apache.org/foundation/sponsorship.html">sponsorship</a> <br />
-<a href="http://www.apache.org/foundation/thanks.html">sponsors</a> </p>
+<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 />
+<a href="/mailinglists.html">Mailing Lists</a> <br />
+<a href="/documentation/community/contributing.html">Contributing</a> <br />
+<a href="/sitemap.html">Site Map</a> <br />
+<a href="http://www.apache.org/">ASF</a> <br />
+<a href="http://www.apache.org/security/">Security</a> <br />
+<a href="http://www.apache.org/foundation/sponsorship.html">Sponsorship</a> <br />
+<a href="http://www.apache.org/foundation/thanks.html">Sponsors</a> </p>
<iframe
src="http://www.apache.org/ads/button.html"
style="border-width:0; float: left"