You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@felix.apache.org by pd...@apache.org on 2017/02/14 07:07:39 UTC
svn commit: r1782915 [3/6] - in
/felix/site/trunk/content/apidocs/dependencymanager.annotations/r9: ./ org/
org/apache/ org/apache/felix/ org/apache/felix/dm/
org/apache/felix/dm/annotation/ org/apache/felix/dm/annotation/api/
Added: felix/site/trunk/content/apidocs/dependencymanager.annotations/r9/org/apache/felix/dm/annotation/api/ConfigurationDependency.html
URL: http://svn.apache.org/viewvc/felix/site/trunk/content/apidocs/dependencymanager.annotations/r9/org/apache/felix/dm/annotation/api/ConfigurationDependency.html?rev=1782915&view=auto
==============================================================================
--- felix/site/trunk/content/apidocs/dependencymanager.annotations/r9/org/apache/felix/dm/annotation/api/ConfigurationDependency.html (added)
+++ felix/site/trunk/content/apidocs/dependencymanager.annotations/r9/org/apache/felix/dm/annotation/api/ConfigurationDependency.html Tue Feb 14 07:07:38 2017
@@ -0,0 +1,594 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<!-- NewPage -->
+<html lang="en">
+<head>
+<!-- Generated by javadoc (1.8.0_102) on Tue Feb 14 08:05:47 CET 2017 -->
+<title>ConfigurationDependency</title>
+<meta name="date" content="2017-02-14">
+<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
+<script type="text/javascript" src="../../../../../../script.js"></script>
+</head>
+<body>
+<script type="text/javascript"><!--
+ try {
+ if (location.href.indexOf('is-external=true') == -1) {
+ parent.document.title="ConfigurationDependency";
+ }
+ }
+ catch(err) {
+ }
+//-->
+</script>
+<noscript>
+<div>JavaScript is disabled on your browser.</div>
+</noscript>
+<!-- ========= START OF TOP NAVBAR ======= -->
+<div class="topNav"><a name="navbar.top">
+<!-- -->
+</a>
+<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
+<a name="navbar.top.firstrow">
+<!-- -->
+</a>
+<ul class="navList" title="Navigation">
+<li><a href="../../../../../../org/apache/felix/dm/annotation/api/package-summary.html">Package</a></li>
+<li class="navBarCell1Rev">Class</li>
+<li><a href="package-tree.html">Tree</a></li>
+<li><a href="../../../../../../deprecated-list.html">Deprecated</a></li>
+<li><a href="../../../../../../index-all.html">Index</a></li>
+<li><a href="../../../../../../help-doc.html">Help</a></li>
+</ul>
+</div>
+<div class="subNav">
+<ul class="navList">
+<li><a href="../../../../../../org/apache/felix/dm/annotation/api/Composition.html" title="annotation in org.apache.felix.dm.annotation.api"><span class="typeNameLink">Prev Class</span></a></li>
+<li><a href="../../../../../../org/apache/felix/dm/annotation/api/Destroy.html" title="annotation in org.apache.felix.dm.annotation.api"><span class="typeNameLink">Next Class</span></a></li>
+</ul>
+<ul class="navList">
+<li><a href="../../../../../../index.html?org/apache/felix/dm/annotation/api/ConfigurationDependency.html" target="_top">Frames</a></li>
+<li><a href="ConfigurationDependency.html" target="_top">No Frames</a></li>
+</ul>
+<ul class="navList" id="allclasses_navbar_top">
+<li><a href="../../../../../../allclasses-noframe.html">All Classes</a></li>
+</ul>
+<div>
+<script type="text/javascript"><!--
+ allClassesLink = document.getElementById("allclasses_navbar_top");
+ if(window==top) {
+ allClassesLink.style.display = "block";
+ }
+ else {
+ allClassesLink.style.display = "none";
+ }
+ //-->
+</script>
+</div>
+<div>
+<ul class="subNavList">
+<li>Summary: </li>
+<li>Field | </li>
+<li>Required | </li>
+<li><a href="#annotation.type.optional.element.summary">Optional</a></li>
+</ul>
+<ul class="subNavList">
+<li>Detail: </li>
+<li>Field | </li>
+<li><a href="#annotation.type.element.detail">Element</a></li>
+</ul>
+</div>
+<a name="skip.navbar.top">
+<!-- -->
+</a></div>
+<!-- ========= END OF TOP NAVBAR ========= -->
+<!-- ======== START OF CLASS DATA ======== -->
+<div class="header">
+<div class="subTitle">org.apache.felix.dm.annotation.api</div>
+<h2 title="Annotation Type ConfigurationDependency" class="title">Annotation Type ConfigurationDependency</h2>
+</div>
+<div class="contentContainer">
+<div class="description">
+<ul class="blockList">
+<li class="blockList">
+<hr>
+<br>
+<pre>@Retention(value=CLASS)
+ @Target(value=METHOD)
+public @interface <span class="memberNameLabel">ConfigurationDependency</span></pre>
+<div class="block">Annotates a method for injecting a Configuration Dependency. A configuration dependency
+ is required by default, and allows you to depend on the availability of a valid configuration
+ for your component. This dependency requires the OSGi Configuration Admin Service.
+
+ The annotation can be applied on a callback method which accepts the following parameters:
+
+ <p><ul>
+ <li>callback(Dictionary)
+ <li>callback(Component, Dictionary)
+ <li>callback(Configuration interface) // type safe configuration
+ <li>callback(Component, Configuration interface) // type safe configuration
+ </ul>
+
+ <h3>Usage Examples</h3>
+
+ <p> In the following example, the "Printer" component depends on a configuration
+ whose PID name is "sample.PrinterConfiguration". This service will initialize
+ its ip/port number from the provided configuration.
+
+ <p> First, we define the configuration metadata, using standard bndtools metatatype annotations
+ (see http://www.aqute.biz/Bnd/MetaType):
+
+ <blockquote>
+ <pre>
+ package sample;
+ import aQute.bnd.annotation.metatype.Meta.AD;
+ import aQute.bnd.annotation.metatype.Meta.OCD;
+
+ @OCD(description = "Declare here the Printer Configuration.")
+ public interface PrinterConfiguration {
+ @AD(description = "Enter the printer ip address")
+ String getAddress();
+
+ @AD(description = "Enter the printer address port number.")
+ default int getPort() { return 8080; }
+ }
+ </pre>
+ </blockquote>
+
+ Next, we define our Printer service which depends on the PrinterConfiguration:
+
+ <blockquote>
+ <pre>
+ package sample;
+ import aQute.bnd.annotation.metatype.*;
+
+ @Component
+ public class Printer {
+ @ConfigurationDependency // Will use the fqdn of the PrinterConfiguration interface as the pid.
+ void updated(PrinterConfiguration cnf) {
+ String ip = cnf.getAddress();
+ int port = cnf.getPort();
+ ...
+ }
+ }
+ </pre>
+ </blockquote>
+
+ In the above example, the updated callback accepts a type-safe configuration type (and its fqdn is used as the pid).
+ <p> Configuration type is a new feature that allows you to specify an interface that is implemented
+ by DM and such interface is then injected to your callback instead of the actual Dictionary.
+ Using such configuration interface provides a way for creating type-safe configurations from a actual <code>Dictionary</code> that is
+ normally injected by Dependency Manager.
+ The callback accepts in argument an interface that you have to provide, and DM will inject a proxy that converts
+ method calls from your configuration-type to lookups in the actual map or dictionary. The results of these lookups are then
+ converted to the expected return type of the invoked configuration method.<br>
+ As proxies are injected, no implementations of the desired configuration-type are necessary!
+ </p>
+ <p>
+ The lookups performed are based on the name of the method called on the configuration type. The method names are
+ "mangled" to the following form: <tt>[lower case letter] [any valid character]*</tt>. Method names starting with
+ <tt>get</tt> or <tt>is</tt> (JavaBean convention) are stripped from these prefixes. For example: given a dictionary
+ with the key <tt>"foo"</tt> can be accessed from a configuration-type using the following method names:
+ <tt>foo()</tt>, <tt>getFoo()</tt> and <tt>isFoo()</tt>.<p>
+ If the property contains a dot (which is invalid in java method names), then dots (".") can be converted using the following conventions:
+ <ul>
+
+ <li> if the method name follows the javabean convention and/or kamel casing convention, then each capital letter is assumed to map to a "dot",
+ followed by the same letter in lower case. This means only lower case properties are
+ supported in this case. Example: getFooBar() or fooBar() will map to "foo.bar" property.
+
+ <li> else, if the method name follows the standard OSGi metatype specification, then dots
+ are encoded as "_"; and "_" is encoded as "__". (see OSGi r6 compendium, chapter 105.9.2).
+ Example: "foo_BAR()" is mapped to "foo.BAR" property; "foo__BAR_zoo()" is mapped to "foo_BAR.zoo" property.
+ </ul>
+ <p>
+ The return values supported are: primitive types (or their object wrappers), strings, enums, arrays of
+ primitives/strings, <code>Collection</code> types, <code>Map</code> types, <code>Class</code>es and interfaces. When an interface is
+ returned, it is treated equally to a configuration type, that is, it is returned as a proxy.
+ </p>
+ <p>
+ Arrays can be represented either as comma-separated values, optionally enclosed in square brackets. For example:
+ <tt>[ a, b, c ]</tt> and <tt>a, b,c</tt> are both considered an array of length 3 with the values "a", "b" and "c".
+ Alternatively, you can append the array index to the key in the dictionary to obtain the same: a dictionary with
+ "arr.0" => "a", "arr.1" => "b", "arr.2" => "c" would result in the same array as the earlier examples.
+ </p>
+ <p>
+ Maps can be represented as single string values similarly as arrays, each value consisting of both the key and value
+ separated by a dot. Optionally, the value can be enclosed in curly brackets. Similar to array, you can use the same
+ dot notation using the keys. For example, a dictionary with
+
+ <pre><code> "map" => "{key1.value1, key2.value2}"</code></pre>
+
+ and a dictionary with <p>
+
+ <pre><code> "map.key1" => "value1", "map2.key2" => "value2"</code></pre>
+
+ result in the same map being returned.
+ Instead of a map, you could also define an interface with the methods <tt>getKey1()</tt> and <tt>getKey2</tt> and use
+ that interface as return type instead of a <code>Map</code>.
+ </p>
+ <p>
+ In case a lookup does not yield a value from the underlying map or dictionary, the following rules are applied:
+ <ol>
+ <li>primitive types yield their default value, as defined by the Java Specification;
+ <li>string, <code>Class</code>es and enum values yield <code>null</code>;
+ <li>for arrays, collections and maps, an empty array/collection/map is returned;
+ <li>for other interface types that are treated as configuration type a null-object is returned.
+ </ol>
+ </p></div>
+</li>
+</ul>
+</div>
+<div class="summary">
+<ul class="blockList">
+<li class="blockList">
+<!-- =========== ANNOTATION TYPE OPTIONAL MEMBER SUMMARY =========== -->
+<ul class="blockList">
+<li class="blockList"><a name="annotation.type.optional.element.summary">
+<!-- -->
+</a>
+<h3>Optional Element Summary</h3>
+<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Optional Element Summary table, listing optional elements, and an explanation">
+<caption><span>Optional Elements</span><span class="tabEnd"> </span></caption>
+<tr>
+<th class="colFirst" scope="col">Modifier and Type</th>
+<th class="colLast" scope="col">Optional Element and Description</th>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code>java.lang.String</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/felix/dm/annotation/api/ConfigurationDependency.html#description--">description</a></span></code>
+<div class="block"><span class="deprecatedLabel">Deprecated.</span>
+<div class="block"><span class="deprecationComment">use standard bndtools metatype annotations instead (see http://www.aqute.biz/Bnd/MetaType)</span></div>
+</div>
+</td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><code>java.lang.String</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/felix/dm/annotation/api/ConfigurationDependency.html#heading--">heading</a></span></code>
+<div class="block"><span class="deprecatedLabel">Deprecated.</span>
+<div class="block"><span class="deprecationComment">use standard bndtools metatype annotations instead (see http://www.aqute.biz/Bnd/MetaType)</span></div>
+</div>
+</td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code><a href="../../../../../../org/apache/felix/dm/annotation/api/PropertyMetaData.html" title="annotation in org.apache.felix.dm.annotation.api">PropertyMetaData</a>[]</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/felix/dm/annotation/api/ConfigurationDependency.html#metadata--">metadata</a></span></code>
+<div class="block"><span class="deprecatedLabel">Deprecated.</span>
+<div class="block"><span class="deprecationComment">use standard bndtools metatype annotations instead (see http://www.aqute.biz/Bnd/MetaType)</span></div>
+</div>
+</td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><code>java.lang.String</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/felix/dm/annotation/api/ConfigurationDependency.html#name--">name</a></span></code>
+<div class="block">The name for this configuration dependency.</div>
+</td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code>java.lang.String</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/felix/dm/annotation/api/ConfigurationDependency.html#pid--">pid</a></span></code>
+<div class="block">Returns the pid for a given service (by default, the pid is the service class name).</div>
+</td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><code>java.lang.Class<?></code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/felix/dm/annotation/api/ConfigurationDependency.html#pidClass--">pidClass</a></span></code>
+<div class="block"><span class="deprecatedLabel">Deprecated.</span>
+<div class="block"><span class="deprecationComment">just define an updated callback which accepts as argument a configuration type.</span></div>
+</div>
+</td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code>boolean</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/felix/dm/annotation/api/ConfigurationDependency.html#propagate--">propagate</a></span></code>
+<div class="block">Returns true if the configuration properties must be published along with the service.</div>
+</td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><code>boolean</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/felix/dm/annotation/api/ConfigurationDependency.html#required--">required</a></span></code>
+<div class="block">Sets the required flag which determines if this configuration dependency is required or not.</div>
+</td>
+</tr>
+</table>
+</li>
+</ul>
+</li>
+</ul>
+</div>
+<div class="details">
+<ul class="blockList">
+<li class="blockList">
+<!-- ============ ANNOTATION TYPE MEMBER DETAIL =========== -->
+<ul class="blockList">
+<li class="blockList"><a name="annotation.type.element.detail">
+<!-- -->
+</a>
+<h3>Element Detail</h3>
+<a name="pid--">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>pid</h4>
+<pre>public abstract java.lang.String pid</pre>
+<div class="block">Returns the pid for a given service (by default, the pid is the service class name).</div>
+<dl>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>the pid for a given service (default = Service class name)</dd>
+</dl>
+<dl>
+<dt>Default:</dt>
+<dd>""</dd>
+</dl>
+</li>
+</ul>
+</li>
+</ul>
+<ul class="blockList">
+<li class="blockList"><a name="pidClass--">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>pidClass</h4>
+<pre>public abstract java.lang.Class<?> pidClass</pre>
+<div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">just define an updated callback which accepts as argument a configuration type.</span></div>
+<div class="block">Returns the pid from a class name. The full class name will be used as the configuration PID.
+ You can use this method when you use an interface annotated with standard bndtols metatype annotations.
+ (see http://www.aqute.biz/Bnd/MetaType).</div>
+<dl>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>the pid class</dd>
+</dl>
+<dl>
+<dt>Default:</dt>
+<dd>java.lang.Object.class</dd>
+</dl>
+</li>
+</ul>
+</li>
+</ul>
+<ul class="blockList">
+<li class="blockList"><a name="propagate--">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>propagate</h4>
+<pre>public abstract boolean propagate</pre>
+<div class="block">Returns true if the configuration properties must be published along with the service.
+ Any additional service properties specified directly are merged with these.</div>
+<dl>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>true if configuration must be published along with the service, false if not.</dd>
+</dl>
+<dl>
+<dt>Default:</dt>
+<dd>false</dd>
+</dl>
+</li>
+</ul>
+</li>
+</ul>
+<ul class="blockList">
+<li class="blockList"><a name="name--">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>name</h4>
+<pre>public abstract java.lang.String name</pre>
+<div class="block">The name for this configuration dependency. When you give a name a dependency, it won't be evaluated
+ immediately, but after the component's init method has been called, and from the init method, you can then return
+ a map in order to dynamically configure the configuration dependency (the map has to contain a "pid" and/or "propagate"
+ flag, prefixed with the dependency name). Then the dependency will be evaluated after the component init method, and will
+ be injected before the start method.
+
+ <p> Usage example of a Configuration dependency whose pid and propagate flag is configured dynamically from init method:
+
+ <blockquote><pre>
+ /**
+ * A Service that dynamically defines an extra dynamic configuration dependency from its init method.
+ */
+ @Component
+ class X {
+ private Dictionary m_config;
+
+ // Inject initial Configuration (injected before any other required dependencies)
+ @ConfigurationDependency
+ void componentConfiguration(Dictionary config) {
+ // you must throw an exception if the configuration is not valid
+ m_config = config;
+ }
+
+ /**
+ * All unnamed dependencies are injected: we can now configure our dynamic configuration whose dependency name is "global".
+ */
+ @Init
+ Map init() {
+ return new HashMap() {{
+ put("global.pid", m_config.get("globalConfig.pid"));
+ put("global.propagate", m_config.get("globalConfig.propagate"));
+ }};
+ }
+
+ // Injected after init, and dynamically configured by the init method.
+ @ConfigurationDependency(name="global")
+ void globalConfiguration(Dictionary globalConfig) {
+ // you must throw an exception if the configuration is not valid
+ }
+
+ /**
+ * All dependencies are injected and our service is now ready to be published.
+ */
+ @Start
+ void start() {
+ }
+ }
+ </pre></blockquote></div>
+<dl>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>the dependency name used to configure the dependency dynamically from init callback</dd>
+</dl>
+<dl>
+<dt>Default:</dt>
+<dd>""</dd>
+</dl>
+</li>
+</ul>
+</li>
+</ul>
+<ul class="blockList">
+<li class="blockList"><a name="required--">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>required</h4>
+<pre>public abstract boolean required</pre>
+<div class="block">Sets the required flag which determines if this configuration dependency is required or not.
+ A configuration dependency is required by default.</div>
+<dl>
+<dt><span class="paramLabel">Parameters:</span></dt>
+<dd><code>required</code> - the required flag</dd>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>this service dependency</dd>
+</dl>
+<dl>
+<dt>Default:</dt>
+<dd>true</dd>
+</dl>
+</li>
+</ul>
+</li>
+</ul>
+<ul class="blockList">
+<li class="blockList"><a name="heading--">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>heading</h4>
+<pre>public abstract java.lang.String heading</pre>
+<div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">use standard bndtools metatype annotations instead (see http://www.aqute.biz/Bnd/MetaType)</span></div>
+<div class="block">The label used to display the tab name (or section) where the properties are displayed. Example: "Printer Service".</div>
+<dl>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>The label used to display the tab name where the properties are displayed.</dd>
+</dl>
+<dl>
+<dt>Default:</dt>
+<dd>""</dd>
+</dl>
+</li>
+</ul>
+</li>
+</ul>
+<ul class="blockList">
+<li class="blockList"><a name="description--">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>description</h4>
+<pre>public abstract java.lang.String description</pre>
+<div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">use standard bndtools metatype annotations instead (see http://www.aqute.biz/Bnd/MetaType)</span></div>
+<div class="block">A human readable description of the PID this annotation is associated with. Example: "Configuration for the PrinterService bundle".</div>
+<dl>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>A human readable description of the PID this annotation is associated with.</dd>
+</dl>
+<dl>
+<dt>Default:</dt>
+<dd>""</dd>
+</dl>
+</li>
+</ul>
+</li>
+</ul>
+<ul class="blockList">
+<li class="blockList"><a name="metadata--">
+<!-- -->
+</a>
+<ul class="blockListLast">
+<li class="blockList">
+<h4>metadata</h4>
+<pre>public abstract <a href="../../../../../../org/apache/felix/dm/annotation/api/PropertyMetaData.html" title="annotation in org.apache.felix.dm.annotation.api">PropertyMetaData</a>[] metadata</pre>
+<div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">use standard bndtools metatype annotations instead (see http://www.aqute.biz/Bnd/MetaType)</span></div>
+<div class="block">The list of properties types used to expose properties in web console.</div>
+<dl>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>The list of properties types used to expose properties in web console.</dd>
+</dl>
+<dl>
+<dt>Default:</dt>
+<dd>{}</dd>
+</dl>
+</li>
+</ul>
+</li>
+</ul>
+</li>
+</ul>
+</div>
+</div>
+<!-- ========= END OF CLASS DATA ========= -->
+<!-- ======= START OF BOTTOM NAVBAR ====== -->
+<div class="bottomNav"><a name="navbar.bottom">
+<!-- -->
+</a>
+<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
+<a name="navbar.bottom.firstrow">
+<!-- -->
+</a>
+<ul class="navList" title="Navigation">
+<li><a href="../../../../../../org/apache/felix/dm/annotation/api/package-summary.html">Package</a></li>
+<li class="navBarCell1Rev">Class</li>
+<li><a href="package-tree.html">Tree</a></li>
+<li><a href="../../../../../../deprecated-list.html">Deprecated</a></li>
+<li><a href="../../../../../../index-all.html">Index</a></li>
+<li><a href="../../../../../../help-doc.html">Help</a></li>
+</ul>
+</div>
+<div class="subNav">
+<ul class="navList">
+<li><a href="../../../../../../org/apache/felix/dm/annotation/api/Composition.html" title="annotation in org.apache.felix.dm.annotation.api"><span class="typeNameLink">Prev Class</span></a></li>
+<li><a href="../../../../../../org/apache/felix/dm/annotation/api/Destroy.html" title="annotation in org.apache.felix.dm.annotation.api"><span class="typeNameLink">Next Class</span></a></li>
+</ul>
+<ul class="navList">
+<li><a href="../../../../../../index.html?org/apache/felix/dm/annotation/api/ConfigurationDependency.html" target="_top">Frames</a></li>
+<li><a href="ConfigurationDependency.html" target="_top">No Frames</a></li>
+</ul>
+<ul class="navList" id="allclasses_navbar_bottom">
+<li><a href="../../../../../../allclasses-noframe.html">All Classes</a></li>
+</ul>
+<div>
+<script type="text/javascript"><!--
+ allClassesLink = document.getElementById("allclasses_navbar_bottom");
+ if(window==top) {
+ allClassesLink.style.display = "block";
+ }
+ else {
+ allClassesLink.style.display = "none";
+ }
+ //-->
+</script>
+</div>
+<div>
+<ul class="subNavList">
+<li>Summary: </li>
+<li>Field | </li>
+<li>Required | </li>
+<li><a href="#annotation.type.optional.element.summary">Optional</a></li>
+</ul>
+<ul class="subNavList">
+<li>Detail: </li>
+<li>Field | </li>
+<li><a href="#annotation.type.element.detail">Element</a></li>
+</ul>
+</div>
+<a name="skip.navbar.bottom">
+<!-- -->
+</a></div>
+<!-- ======== END OF BOTTOM NAVBAR ======= -->
+</body>
+</html>
Added: felix/site/trunk/content/apidocs/dependencymanager.annotations/r9/org/apache/felix/dm/annotation/api/Destroy.html
URL: http://svn.apache.org/viewvc/felix/site/trunk/content/apidocs/dependencymanager.annotations/r9/org/apache/felix/dm/annotation/api/Destroy.html?rev=1782915&view=auto
==============================================================================
--- felix/site/trunk/content/apidocs/dependencymanager.annotations/r9/org/apache/felix/dm/annotation/api/Destroy.html (added)
+++ felix/site/trunk/content/apidocs/dependencymanager.annotations/r9/org/apache/felix/dm/annotation/api/Destroy.html Tue Feb 14 07:07:38 2017
@@ -0,0 +1,180 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<!-- NewPage -->
+<html lang="en">
+<head>
+<!-- Generated by javadoc (1.8.0_102) on Tue Feb 14 08:05:47 CET 2017 -->
+<title>Destroy</title>
+<meta name="date" content="2017-02-14">
+<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
+<script type="text/javascript" src="../../../../../../script.js"></script>
+</head>
+<body>
+<script type="text/javascript"><!--
+ try {
+ if (location.href.indexOf('is-external=true') == -1) {
+ parent.document.title="Destroy";
+ }
+ }
+ catch(err) {
+ }
+//-->
+</script>
+<noscript>
+<div>JavaScript is disabled on your browser.</div>
+</noscript>
+<!-- ========= START OF TOP NAVBAR ======= -->
+<div class="topNav"><a name="navbar.top">
+<!-- -->
+</a>
+<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
+<a name="navbar.top.firstrow">
+<!-- -->
+</a>
+<ul class="navList" title="Navigation">
+<li><a href="../../../../../../org/apache/felix/dm/annotation/api/package-summary.html">Package</a></li>
+<li class="navBarCell1Rev">Class</li>
+<li><a href="package-tree.html">Tree</a></li>
+<li><a href="../../../../../../deprecated-list.html">Deprecated</a></li>
+<li><a href="../../../../../../index-all.html">Index</a></li>
+<li><a href="../../../../../../help-doc.html">Help</a></li>
+</ul>
+</div>
+<div class="subNav">
+<ul class="navList">
+<li><a href="../../../../../../org/apache/felix/dm/annotation/api/ConfigurationDependency.html" title="annotation in org.apache.felix.dm.annotation.api"><span class="typeNameLink">Prev Class</span></a></li>
+<li><a href="../../../../../../org/apache/felix/dm/annotation/api/FactoryConfigurationAdapterService.html" title="annotation in org.apache.felix.dm.annotation.api"><span class="typeNameLink">Next Class</span></a></li>
+</ul>
+<ul class="navList">
+<li><a href="../../../../../../index.html?org/apache/felix/dm/annotation/api/Destroy.html" target="_top">Frames</a></li>
+<li><a href="Destroy.html" target="_top">No Frames</a></li>
+</ul>
+<ul class="navList" id="allclasses_navbar_top">
+<li><a href="../../../../../../allclasses-noframe.html">All Classes</a></li>
+</ul>
+<div>
+<script type="text/javascript"><!--
+ allClassesLink = document.getElementById("allclasses_navbar_top");
+ if(window==top) {
+ allClassesLink.style.display = "block";
+ }
+ else {
+ allClassesLink.style.display = "none";
+ }
+ //-->
+</script>
+</div>
+<div>
+<ul class="subNavList">
+<li>Summary: </li>
+<li>Field | </li>
+<li>Required | </li>
+<li>Optional</li>
+</ul>
+<ul class="subNavList">
+<li>Detail: </li>
+<li>Field | </li>
+<li>Element</li>
+</ul>
+</div>
+<a name="skip.navbar.top">
+<!-- -->
+</a></div>
+<!-- ========= END OF TOP NAVBAR ========= -->
+<!-- ======== START OF CLASS DATA ======== -->
+<div class="header">
+<div class="subTitle">org.apache.felix.dm.annotation.api</div>
+<h2 title="Annotation Type Destroy" class="title">Annotation Type Destroy</h2>
+</div>
+<div class="contentContainer">
+<div class="description">
+<ul class="blockList">
+<li class="blockList">
+<hr>
+<br>
+<pre>@Retention(value=CLASS)
+ @Target(value=METHOD)
+public @interface <span class="memberNameLabel">Destroy</span></pre>
+<div class="block">Annotates a method which is invoked when the component is destroyed.
+ The method is called when the component's bundle is stopped, or when one of its
+ required dependency is lost (unless the dependency has been defined as an "instance bound"
+ dependency using the Dependency Manager API).
+
+
+ <h3>Usage Examples</h3>
+ <blockquote>
+ <pre>
+ @Component
+ class MyComponent {
+ @ServiceDependency
+ private LogService logService; // Required dependency over the log service.
+
+ @Destroy
+ void destroyed() {} // called if bundle is stopped or if we have lost some required dependencies.
+ }
+ </pre>
+ </blockquote></div>
+</li>
+</ul>
+</div>
+</div>
+<!-- ========= END OF CLASS DATA ========= -->
+<!-- ======= START OF BOTTOM NAVBAR ====== -->
+<div class="bottomNav"><a name="navbar.bottom">
+<!-- -->
+</a>
+<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
+<a name="navbar.bottom.firstrow">
+<!-- -->
+</a>
+<ul class="navList" title="Navigation">
+<li><a href="../../../../../../org/apache/felix/dm/annotation/api/package-summary.html">Package</a></li>
+<li class="navBarCell1Rev">Class</li>
+<li><a href="package-tree.html">Tree</a></li>
+<li><a href="../../../../../../deprecated-list.html">Deprecated</a></li>
+<li><a href="../../../../../../index-all.html">Index</a></li>
+<li><a href="../../../../../../help-doc.html">Help</a></li>
+</ul>
+</div>
+<div class="subNav">
+<ul class="navList">
+<li><a href="../../../../../../org/apache/felix/dm/annotation/api/ConfigurationDependency.html" title="annotation in org.apache.felix.dm.annotation.api"><span class="typeNameLink">Prev Class</span></a></li>
+<li><a href="../../../../../../org/apache/felix/dm/annotation/api/FactoryConfigurationAdapterService.html" title="annotation in org.apache.felix.dm.annotation.api"><span class="typeNameLink">Next Class</span></a></li>
+</ul>
+<ul class="navList">
+<li><a href="../../../../../../index.html?org/apache/felix/dm/annotation/api/Destroy.html" target="_top">Frames</a></li>
+<li><a href="Destroy.html" target="_top">No Frames</a></li>
+</ul>
+<ul class="navList" id="allclasses_navbar_bottom">
+<li><a href="../../../../../../allclasses-noframe.html">All Classes</a></li>
+</ul>
+<div>
+<script type="text/javascript"><!--
+ allClassesLink = document.getElementById("allclasses_navbar_bottom");
+ if(window==top) {
+ allClassesLink.style.display = "block";
+ }
+ else {
+ allClassesLink.style.display = "none";
+ }
+ //-->
+</script>
+</div>
+<div>
+<ul class="subNavList">
+<li>Summary: </li>
+<li>Field | </li>
+<li>Required | </li>
+<li>Optional</li>
+</ul>
+<ul class="subNavList">
+<li>Detail: </li>
+<li>Field | </li>
+<li>Element</li>
+</ul>
+</div>
+<a name="skip.navbar.bottom">
+<!-- -->
+</a></div>
+<!-- ======== END OF BOTTOM NAVBAR ======= -->
+</body>
+</html>
Added: felix/site/trunk/content/apidocs/dependencymanager.annotations/r9/org/apache/felix/dm/annotation/api/FactoryConfigurationAdapterService.html
URL: http://svn.apache.org/viewvc/felix/site/trunk/content/apidocs/dependencymanager.annotations/r9/org/apache/felix/dm/annotation/api/FactoryConfigurationAdapterService.html?rev=1782915&view=auto
==============================================================================
--- felix/site/trunk/content/apidocs/dependencymanager.annotations/r9/org/apache/felix/dm/annotation/api/FactoryConfigurationAdapterService.html (added)
+++ felix/site/trunk/content/apidocs/dependencymanager.annotations/r9/org/apache/felix/dm/annotation/api/FactoryConfigurationAdapterService.html Tue Feb 14 07:07:38 2017
@@ -0,0 +1,571 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<!-- NewPage -->
+<html lang="en">
+<head>
+<!-- Generated by javadoc (1.8.0_102) on Tue Feb 14 08:05:47 CET 2017 -->
+<title>FactoryConfigurationAdapterService</title>
+<meta name="date" content="2017-02-14">
+<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
+<script type="text/javascript" src="../../../../../../script.js"></script>
+</head>
+<body>
+<script type="text/javascript"><!--
+ try {
+ if (location.href.indexOf('is-external=true') == -1) {
+ parent.document.title="FactoryConfigurationAdapterService";
+ }
+ }
+ catch(err) {
+ }
+//-->
+</script>
+<noscript>
+<div>JavaScript is disabled on your browser.</div>
+</noscript>
+<!-- ========= START OF TOP NAVBAR ======= -->
+<div class="topNav"><a name="navbar.top">
+<!-- -->
+</a>
+<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
+<a name="navbar.top.firstrow">
+<!-- -->
+</a>
+<ul class="navList" title="Navigation">
+<li><a href="../../../../../../org/apache/felix/dm/annotation/api/package-summary.html">Package</a></li>
+<li class="navBarCell1Rev">Class</li>
+<li><a href="package-tree.html">Tree</a></li>
+<li><a href="../../../../../../deprecated-list.html">Deprecated</a></li>
+<li><a href="../../../../../../index-all.html">Index</a></li>
+<li><a href="../../../../../../help-doc.html">Help</a></li>
+</ul>
+</div>
+<div class="subNav">
+<ul class="navList">
+<li><a href="../../../../../../org/apache/felix/dm/annotation/api/Destroy.html" title="annotation in org.apache.felix.dm.annotation.api"><span class="typeNameLink">Prev Class</span></a></li>
+<li><a href="../../../../../../org/apache/felix/dm/annotation/api/Init.html" title="annotation in org.apache.felix.dm.annotation.api"><span class="typeNameLink">Next Class</span></a></li>
+</ul>
+<ul class="navList">
+<li><a href="../../../../../../index.html?org/apache/felix/dm/annotation/api/FactoryConfigurationAdapterService.html" target="_top">Frames</a></li>
+<li><a href="FactoryConfigurationAdapterService.html" target="_top">No Frames</a></li>
+</ul>
+<ul class="navList" id="allclasses_navbar_top">
+<li><a href="../../../../../../allclasses-noframe.html">All Classes</a></li>
+</ul>
+<div>
+<script type="text/javascript"><!--
+ allClassesLink = document.getElementById("allclasses_navbar_top");
+ if(window==top) {
+ allClassesLink.style.display = "block";
+ }
+ else {
+ allClassesLink.style.display = "none";
+ }
+ //-->
+</script>
+</div>
+<div>
+<ul class="subNavList">
+<li>Summary: </li>
+<li>Field | </li>
+<li>Required | </li>
+<li><a href="#annotation.type.optional.element.summary">Optional</a></li>
+</ul>
+<ul class="subNavList">
+<li>Detail: </li>
+<li>Field | </li>
+<li><a href="#annotation.type.element.detail">Element</a></li>
+</ul>
+</div>
+<a name="skip.navbar.top">
+<!-- -->
+</a></div>
+<!-- ========= END OF TOP NAVBAR ========= -->
+<!-- ======== START OF CLASS DATA ======== -->
+<div class="header">
+<div class="subTitle">org.apache.felix.dm.annotation.api</div>
+<h2 title="Annotation Type FactoryConfigurationAdapterService" class="title">Annotation Type FactoryConfigurationAdapterService</h2>
+</div>
+<div class="contentContainer">
+<div class="description">
+<ul class="blockList">
+<li class="blockList">
+<hr>
+<br>
+<pre>@Retention(value=CLASS)
+ @Target(value=TYPE)
+public @interface <span class="memberNameLabel">FactoryConfigurationAdapterService</span></pre>
+<div class="block">Annotates a class that acts as a Factory Configuration Adapter Service. For each new <code>Config Admin</code>
+ factory configuration matching the specified factoryPid, an instance of this service will be created.
+ The adapter will be registered with the specified interface, and with the specified adapter service properties.
+ Depending on the <code>propagate</code> parameter, every public factory configuration properties
+ (which don't start with ".") will be propagated along with the adapter service properties.
+
+ <p> If you specify a configuration type, then the fqdn of the configuration interface is used as the factory pid,
+ else you can specify the factory pid explicitly using the factoryPid attribute.
+ If no configuration type is used and no factoryPid attribute is specified, then the factory pid will be set to the fqdn of
+ the class on which this annotation is applied.
+
+ <p> (see javadoc from <a href="../../../../../../org/apache/felix/dm/annotation/api/ConfigurationDependency.html" title="annotation in org.apache.felix.dm.annotation.api"><code>ConfigurationDependency</code></a> for more informations about configuration types).
+
+ <h3>Usage Examples</h3>
+ Here, a "Dictionary" service instance is created for each existing "sample.DictionaryConfiguration" factory pids.
+
+ First, we declare our factory configuration metadata using standard bndtools metatatype annotations
+ (see http://www.aqute.biz/Bnd/MetaType):
+
+ <blockquote>
+ <pre>
+ package sample;
+ import java.util.List;
+ import aQute.bnd.annotation.metatype.Meta.AD;
+ import aQute.bnd.annotation.metatype.Meta.OCD;
+
+ @OCD(factory = true, description = "Declare here some Dictionary instances.")
+ public interface DictionaryConfiguration {
+ @AD(description = "Describes the dictionary language.", deflt = "en")
+ String lang();
+
+ @AD(description = "Declare here the list of words supported by this dictionary.")
+ List<String> words();
+ }
+ </pre>
+ </blockquote>
+
+ And here is the factory pid adapter service, which is instantiated for each instance of the "sample.DictionaryConfiguration" factory pid:
+
+ <blockquote>
+ <pre>
+ import java.util.List;
+ import aQute.bnd.annotation.metatype.Configurable;
+
+ @FactoryConfigurationAdapterService(configType=DictionaryConfiguration.class)
+ public class DictionaryImpl implements DictionaryService {
+ protected void updated(DictionaryConfiguration config) {
+ m_lang = config.lang();
+ m_words.clear();
+ for (String word : conf.words()) {
+ m_words.add(word);
+ }
+ }
+ ...
+ }
+ </pre>
+ </blockquote></div>
+</li>
+</ul>
+</div>
+<div class="summary">
+<ul class="blockList">
+<li class="blockList">
+<!-- =========== ANNOTATION TYPE OPTIONAL MEMBER SUMMARY =========== -->
+<ul class="blockList">
+<li class="blockList"><a name="annotation.type.optional.element.summary">
+<!-- -->
+</a>
+<h3>Optional Element Summary</h3>
+<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Optional Element Summary table, listing optional elements, and an explanation">
+<caption><span>Optional Elements</span><span class="tabEnd"> </span></caption>
+<tr>
+<th class="colFirst" scope="col">Modifier and Type</th>
+<th class="colLast" scope="col">Optional Element and Description</th>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code>java.lang.Class<?></code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/felix/dm/annotation/api/FactoryConfigurationAdapterService.html#configType--">configType</a></span></code>
+<div class="block">Returns the type safe configuration class which will be injected in the updated callback.</div>
+</td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><code>java.lang.String</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/felix/dm/annotation/api/FactoryConfigurationAdapterService.html#description--">description</a></span></code>
+<div class="block"><span class="deprecatedLabel">Deprecated.</span>
+<div class="block"><span class="deprecationComment">use standard bndtools metatype annotations instead (see http://www.aqute.biz/Bnd/MetaType)</span></div>
+</div>
+</td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code>java.lang.String</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/felix/dm/annotation/api/FactoryConfigurationAdapterService.html#factoryMethod--">factoryMethod</a></span></code>
+<div class="block">Sets the static method used to create the adapter instance.</div>
+</td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><code>java.lang.String</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/felix/dm/annotation/api/FactoryConfigurationAdapterService.html#factoryPid--">factoryPid</a></span></code>
+<div class="block">Returns the factory pid whose configurations will instantiate the annotated service class.</div>
+</td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code>java.lang.Class<?></code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/felix/dm/annotation/api/FactoryConfigurationAdapterService.html#factoryPidClass--">factoryPidClass</a></span></code>
+<div class="block"><span class="deprecatedLabel">Deprecated.</span>
+<div class="block"><span class="deprecationComment">use <a href="../../../../../../org/apache/felix/dm/annotation/api/FactoryConfigurationAdapterService.html#configType--"><code>configType()</code></a> and accept a configuration type parameter from your updated callback. The pid
+ is then assumed to match the fqdn of the configuration type.</span></div>
+</div>
+</td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><code>java.lang.String</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/felix/dm/annotation/api/FactoryConfigurationAdapterService.html#heading--">heading</a></span></code>
+<div class="block"><span class="deprecatedLabel">Deprecated.</span>
+<div class="block"><span class="deprecationComment">use standard bndtools metatype annotations instead (see http://www.aqute.biz/Bnd/MetaType)</span></div>
+</div>
+</td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code><a href="../../../../../../org/apache/felix/dm/annotation/api/PropertyMetaData.html" title="annotation in org.apache.felix.dm.annotation.api">PropertyMetaData</a>[]</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/felix/dm/annotation/api/FactoryConfigurationAdapterService.html#metadata--">metadata</a></span></code>
+<div class="block"><span class="deprecatedLabel">Deprecated.</span>
+<div class="block"><span class="deprecationComment">use standard bndtools metatype annotations instead (see http://www.aqute.biz/Bnd/MetaType)</span></div>
+</div>
+</td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><code>boolean</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/felix/dm/annotation/api/FactoryConfigurationAdapterService.html#propagate--">propagate</a></span></code>
+<div class="block">Returns true if the configuration properties must be published along with the service.</div>
+</td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code><a href="../../../../../../org/apache/felix/dm/annotation/api/Property.html" title="annotation in org.apache.felix.dm.annotation.api">Property</a>[]</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/felix/dm/annotation/api/FactoryConfigurationAdapterService.html#properties--">properties</a></span></code>
+<div class="block">Adapter Service properties.</div>
+</td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><code>java.lang.Class<?>[]</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/felix/dm/annotation/api/FactoryConfigurationAdapterService.html#provides--">provides</a></span></code>
+<div class="block">The interface(s) to use when registering adapters.</div>
+</td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code>java.lang.String</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/felix/dm/annotation/api/FactoryConfigurationAdapterService.html#updated--">updated</a></span></code>
+<div class="block">The Update method to invoke (defaulting to "updated"), when a factory configuration is created or updated</div>
+</td>
+</tr>
+</table>
+</li>
+</ul>
+</li>
+</ul>
+</div>
+<div class="details">
+<ul class="blockList">
+<li class="blockList">
+<!-- ============ ANNOTATION TYPE MEMBER DETAIL =========== -->
+<ul class="blockList">
+<li class="blockList"><a name="annotation.type.element.detail">
+<!-- -->
+</a>
+<h3>Element Detail</h3>
+<a name="provides--">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>provides</h4>
+<pre>public abstract java.lang.Class<?>[] provides</pre>
+<div class="block">The interface(s) to use when registering adapters. By default, directly implemented
+ interfaces will be registered in the OSGi registry.</div>
+<dl>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>the registered service interfaces</dd>
+</dl>
+<dl>
+<dt>Default:</dt>
+<dd>{}</dd>
+</dl>
+</li>
+</ul>
+</li>
+</ul>
+<ul class="blockList">
+<li class="blockList"><a name="properties--">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>properties</h4>
+<pre>public abstract <a href="../../../../../../org/apache/felix/dm/annotation/api/Property.html" title="annotation in org.apache.felix.dm.annotation.api">Property</a>[] properties</pre>
+<div class="block">Adapter Service properties. Notice that public factory configuration is also registered in service properties,
+ (only if propagate is true). Public factory configuration properties are those which don't starts with a dot (".").</div>
+<dl>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>the adapter service properties</dd>
+</dl>
+<dl>
+<dt>Default:</dt>
+<dd>{}</dd>
+</dl>
+</li>
+</ul>
+</li>
+</ul>
+<ul class="blockList">
+<li class="blockList"><a name="configType--">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>configType</h4>
+<pre>public abstract java.lang.Class<?> configType</pre>
+<div class="block">Returns the type safe configuration class which will be injected in the updated callback.
+ By default, the factory pid is assumed to match the fqdn of the configuration type.
+ see javadoc from <a href="../../../../../../org/apache/felix/dm/annotation/api/ConfigurationDependency.html" title="annotation in org.apache.felix.dm.annotation.api"><code>ConfigurationDependency</code></a> for more informations about configuration types.</div>
+<dl>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>the configuration type to pass in the "updated" callback argument.</dd>
+<dt><span class="seeLabel">See Also:</span></dt>
+<dd><a href="../../../../../../org/apache/felix/dm/annotation/api/ConfigurationDependency.html" title="annotation in org.apache.felix.dm.annotation.api"><code>ConfigurationDependency</code></a></dd>
+</dl>
+<dl>
+<dt>Default:</dt>
+<dd>java.lang.Object.class</dd>
+</dl>
+</li>
+</ul>
+</li>
+</ul>
+<ul class="blockList">
+<li class="blockList"><a name="factoryPid--">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>factoryPid</h4>
+<pre>public abstract java.lang.String factoryPid</pre>
+<div class="block">Returns the factory pid whose configurations will instantiate the annotated service class. (By default, the pid is the
+ service class name).</div>
+<dl>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>the factory pid</dd>
+</dl>
+<dl>
+<dt>Default:</dt>
+<dd>""</dd>
+</dl>
+</li>
+</ul>
+</li>
+</ul>
+<ul class="blockList">
+<li class="blockList"><a name="factoryPidClass--">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>factoryPidClass</h4>
+<pre>public abstract java.lang.Class<?> factoryPidClass</pre>
+<div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">use <a href="../../../../../../org/apache/felix/dm/annotation/api/FactoryConfigurationAdapterService.html#configType--"><code>configType()</code></a> and accept a configuration type parameter from your updated callback. The pid
+ is then assumed to match the fqdn of the configuration type.</span></div>
+<div class="block">Returns the factory pid from a class name. The full class name will be used as the configuration PID.
+ You can use this method when you use an interface annoted with standard bndtols metatype annotations.
+ (see http://www.aqute.biz/Bnd/MetaType).</div>
+<dl>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>the factory pid class</dd>
+</dl>
+<dl>
+<dt>Default:</dt>
+<dd>java.lang.Object.class</dd>
+</dl>
+</li>
+</ul>
+</li>
+</ul>
+<ul class="blockList">
+<li class="blockList"><a name="updated--">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>updated</h4>
+<pre>public abstract java.lang.String updated</pre>
+<div class="block">The Update method to invoke (defaulting to "updated"), when a factory configuration is created or updated</div>
+<dl>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>the updated callback</dd>
+</dl>
+<dl>
+<dt>Default:</dt>
+<dd>"updated"</dd>
+</dl>
+</li>
+</ul>
+</li>
+</ul>
+<ul class="blockList">
+<li class="blockList"><a name="propagate--">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>propagate</h4>
+<pre>public abstract boolean propagate</pre>
+<div class="block">Returns true if the configuration properties must be published along with the service.
+ Any additional service properties specified directly are merged with these.</div>
+<dl>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>true if configuration must be published along with the service, false if not.</dd>
+</dl>
+<dl>
+<dt>Default:</dt>
+<dd>false</dd>
+</dl>
+</li>
+</ul>
+</li>
+</ul>
+<ul class="blockList">
+<li class="blockList"><a name="heading--">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>heading</h4>
+<pre>public abstract java.lang.String heading</pre>
+<div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">use standard bndtools metatype annotations instead (see http://www.aqute.biz/Bnd/MetaType)</span></div>
+<div class="block">The label used to display the tab name (or section) where the properties are displayed. Example: "Printer Service".</div>
+<dl>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>The label used to display the tab name where the properties are displayed.</dd>
+</dl>
+<dl>
+<dt>Default:</dt>
+<dd>""</dd>
+</dl>
+</li>
+</ul>
+</li>
+</ul>
+<ul class="blockList">
+<li class="blockList"><a name="description--">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>description</h4>
+<pre>public abstract java.lang.String description</pre>
+<div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">use standard bndtools metatype annotations instead (see http://www.aqute.biz/Bnd/MetaType)</span></div>
+<div class="block">A human readable description of the PID this annotation is associated with. Example: "Configuration for the PrinterService bundle".</div>
+<dl>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>A human readable description of the PID this annotation is associated with.</dd>
+</dl>
+<dl>
+<dt>Default:</dt>
+<dd>""</dd>
+</dl>
+</li>
+</ul>
+</li>
+</ul>
+<ul class="blockList">
+<li class="blockList"><a name="metadata--">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>metadata</h4>
+<pre>public abstract <a href="../../../../../../org/apache/felix/dm/annotation/api/PropertyMetaData.html" title="annotation in org.apache.felix.dm.annotation.api">PropertyMetaData</a>[] metadata</pre>
+<div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">use standard bndtools metatype annotations instead (see http://www.aqute.biz/Bnd/MetaType)</span></div>
+<div class="block">The list of properties types used to expose properties in web console.</div>
+<dl>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>The list of properties types used to expose properties in web console.</dd>
+</dl>
+<dl>
+<dt>Default:</dt>
+<dd>{}</dd>
+</dl>
+</li>
+</ul>
+</li>
+</ul>
+<ul class="blockList">
+<li class="blockList"><a name="factoryMethod--">
+<!-- -->
+</a>
+<ul class="blockListLast">
+<li class="blockList">
+<h4>factoryMethod</h4>
+<pre>public abstract java.lang.String factoryMethod</pre>
+<div class="block">Sets the static method used to create the adapter instance.</div>
+<dl>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>the factory method</dd>
+</dl>
+<dl>
+<dt>Default:</dt>
+<dd>""</dd>
+</dl>
+</li>
+</ul>
+</li>
+</ul>
+</li>
+</ul>
+</div>
+</div>
+<!-- ========= END OF CLASS DATA ========= -->
+<!-- ======= START OF BOTTOM NAVBAR ====== -->
+<div class="bottomNav"><a name="navbar.bottom">
+<!-- -->
+</a>
+<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
+<a name="navbar.bottom.firstrow">
+<!-- -->
+</a>
+<ul class="navList" title="Navigation">
+<li><a href="../../../../../../org/apache/felix/dm/annotation/api/package-summary.html">Package</a></li>
+<li class="navBarCell1Rev">Class</li>
+<li><a href="package-tree.html">Tree</a></li>
+<li><a href="../../../../../../deprecated-list.html">Deprecated</a></li>
+<li><a href="../../../../../../index-all.html">Index</a></li>
+<li><a href="../../../../../../help-doc.html">Help</a></li>
+</ul>
+</div>
+<div class="subNav">
+<ul class="navList">
+<li><a href="../../../../../../org/apache/felix/dm/annotation/api/Destroy.html" title="annotation in org.apache.felix.dm.annotation.api"><span class="typeNameLink">Prev Class</span></a></li>
+<li><a href="../../../../../../org/apache/felix/dm/annotation/api/Init.html" title="annotation in org.apache.felix.dm.annotation.api"><span class="typeNameLink">Next Class</span></a></li>
+</ul>
+<ul class="navList">
+<li><a href="../../../../../../index.html?org/apache/felix/dm/annotation/api/FactoryConfigurationAdapterService.html" target="_top">Frames</a></li>
+<li><a href="FactoryConfigurationAdapterService.html" target="_top">No Frames</a></li>
+</ul>
+<ul class="navList" id="allclasses_navbar_bottom">
+<li><a href="../../../../../../allclasses-noframe.html">All Classes</a></li>
+</ul>
+<div>
+<script type="text/javascript"><!--
+ allClassesLink = document.getElementById("allclasses_navbar_bottom");
+ if(window==top) {
+ allClassesLink.style.display = "block";
+ }
+ else {
+ allClassesLink.style.display = "none";
+ }
+ //-->
+</script>
+</div>
+<div>
+<ul class="subNavList">
+<li>Summary: </li>
+<li>Field | </li>
+<li>Required | </li>
+<li><a href="#annotation.type.optional.element.summary">Optional</a></li>
+</ul>
+<ul class="subNavList">
+<li>Detail: </li>
+<li>Field | </li>
+<li><a href="#annotation.type.element.detail">Element</a></li>
+</ul>
+</div>
+<a name="skip.navbar.bottom">
+<!-- -->
+</a></div>
+<!-- ======== END OF BOTTOM NAVBAR ======= -->
+</body>
+</html>
Added: felix/site/trunk/content/apidocs/dependencymanager.annotations/r9/org/apache/felix/dm/annotation/api/Init.html
URL: http://svn.apache.org/viewvc/felix/site/trunk/content/apidocs/dependencymanager.annotations/r9/org/apache/felix/dm/annotation/api/Init.html?rev=1782915&view=auto
==============================================================================
--- felix/site/trunk/content/apidocs/dependencymanager.annotations/r9/org/apache/felix/dm/annotation/api/Init.html (added)
+++ felix/site/trunk/content/apidocs/dependencymanager.annotations/r9/org/apache/felix/dm/annotation/api/Init.html Tue Feb 14 07:07:38 2017
@@ -0,0 +1,224 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<!-- NewPage -->
+<html lang="en">
+<head>
+<!-- Generated by javadoc (1.8.0_102) on Tue Feb 14 08:05:47 CET 2017 -->
+<title>Init</title>
+<meta name="date" content="2017-02-14">
+<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
+<script type="text/javascript" src="../../../../../../script.js"></script>
+</head>
+<body>
+<script type="text/javascript"><!--
+ try {
+ if (location.href.indexOf('is-external=true') == -1) {
+ parent.document.title="Init";
+ }
+ }
+ catch(err) {
+ }
+//-->
+</script>
+<noscript>
+<div>JavaScript is disabled on your browser.</div>
+</noscript>
+<!-- ========= START OF TOP NAVBAR ======= -->
+<div class="topNav"><a name="navbar.top">
+<!-- -->
+</a>
+<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
+<a name="navbar.top.firstrow">
+<!-- -->
+</a>
+<ul class="navList" title="Navigation">
+<li><a href="../../../../../../org/apache/felix/dm/annotation/api/package-summary.html">Package</a></li>
+<li class="navBarCell1Rev">Class</li>
+<li><a href="package-tree.html">Tree</a></li>
+<li><a href="../../../../../../deprecated-list.html">Deprecated</a></li>
+<li><a href="../../../../../../index-all.html">Index</a></li>
+<li><a href="../../../../../../help-doc.html">Help</a></li>
+</ul>
+</div>
+<div class="subNav">
+<ul class="navList">
+<li><a href="../../../../../../org/apache/felix/dm/annotation/api/FactoryConfigurationAdapterService.html" title="annotation in org.apache.felix.dm.annotation.api"><span class="typeNameLink">Prev Class</span></a></li>
+<li><a href="../../../../../../org/apache/felix/dm/annotation/api/Inject.html" title="annotation in org.apache.felix.dm.annotation.api"><span class="typeNameLink">Next Class</span></a></li>
+</ul>
+<ul class="navList">
+<li><a href="../../../../../../index.html?org/apache/felix/dm/annotation/api/Init.html" target="_top">Frames</a></li>
+<li><a href="Init.html" target="_top">No Frames</a></li>
+</ul>
+<ul class="navList" id="allclasses_navbar_top">
+<li><a href="../../../../../../allclasses-noframe.html">All Classes</a></li>
+</ul>
+<div>
+<script type="text/javascript"><!--
+ allClassesLink = document.getElementById("allclasses_navbar_top");
+ if(window==top) {
+ allClassesLink.style.display = "block";
+ }
+ else {
+ allClassesLink.style.display = "none";
+ }
+ //-->
+</script>
+</div>
+<div>
+<ul class="subNavList">
+<li>Summary: </li>
+<li>Field | </li>
+<li>Required | </li>
+<li>Optional</li>
+</ul>
+<ul class="subNavList">
+<li>Detail: </li>
+<li>Field | </li>
+<li>Element</li>
+</ul>
+</div>
+<a name="skip.navbar.top">
+<!-- -->
+</a></div>
+<!-- ========= END OF TOP NAVBAR ========= -->
+<!-- ======== START OF CLASS DATA ======== -->
+<div class="header">
+<div class="subTitle">org.apache.felix.dm.annotation.api</div>
+<h2 title="Annotation Type Init" class="title">Annotation Type Init</h2>
+</div>
+<div class="contentContainer">
+<div class="description">
+<ul class="blockList">
+<li class="blockList">
+<hr>
+<br>
+<pre>@Retention(value=CLASS)
+ @Target(value=METHOD)
+public @interface <span class="memberNameLabel">Init</span></pre>
+<div class="block">Annotates a method used to configure dynamic dependencies.
+ When this method is invoked, all required dependencies (except the ones declared with a <code>name</code>
+ attribute) are already injected, and optional dependencies on class fields
+ are also already injected (possibly with NullObjects).
+
+ The purpose of the @Init method is to either declare more dynamic dependencies using the DM API, or to
+ return a Map used to dynamically configure dependencies that are annotated using a <code>name</code> attribute.
+
+ After the init method returns, the added or configured dependencies are then tracked, and when all dynamic
+ dependencies are injected, then the start method (annotated with @Start) is then invoked.
+
+ <h3>Usage Examples</h3>
+ In this sample, the "PersistenceImpl" component dynamically configures the "storage" dependency from the "init" method.
+ The dependency "required" flag and filter string are derived from an xml configuration that is already injected before the init
+ method.
+
+ <blockquote>
+ <pre>
+
+ @Component
+ public class PersistenceImpl implements Persistence {
+ // Injected before init.
+ @ServiceDependency
+ LogService log;
+
+ // Injected before init.
+ @ConfigurationDependency
+ void updated(Dictionary conf) {
+ if (conf != null) {
+ _xmlConfiguration = parseXmlConfiguration(conf.get("xmlConfiguration"));
+ }
+ }
+
+ // Parsed xml configuration, where we'll get our storage service filter and required dependency flag.
+ XmlConfiguration _xmlConfiguration;
+
+ // Injected after init (dependency filter is defined dynamically from our init method).
+ @ServiceDependency(name="storage")
+ Storage storage;
+
+ // Dynamically configure the dependency declared with a "storage" name.
+ @Init
+ Map<String, String> init() {
+ log.log(LogService.LOG_WARNING, "init: storage type=" + storageType + ", storageRequired=" + storageRequired);
+ Map<String, String> props = new HashMap<>();
+ props.put("storage.required", Boolean.toString(_xmlConfiguration.isStorageRequired()))
+ props.put("storage.filter", "(type=" + _xmlConfiguration.getStorageType() + ")");
+ return props;
+ }
+
+ // All dependencies injected, including dynamic dependencies defined from init method.
+ @Start
+ void start() {
+ log.log(LogService.LOG_WARNING, "start");
+ }
+
+ @Override
+ void store(String key, String value) {
+ storage.store(key, value);
+ }
+ }
+ </pre>
+ </blockquote></div>
+</li>
+</ul>
+</div>
+</div>
+<!-- ========= END OF CLASS DATA ========= -->
+<!-- ======= START OF BOTTOM NAVBAR ====== -->
+<div class="bottomNav"><a name="navbar.bottom">
+<!-- -->
+</a>
+<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
+<a name="navbar.bottom.firstrow">
+<!-- -->
+</a>
+<ul class="navList" title="Navigation">
+<li><a href="../../../../../../org/apache/felix/dm/annotation/api/package-summary.html">Package</a></li>
+<li class="navBarCell1Rev">Class</li>
+<li><a href="package-tree.html">Tree</a></li>
+<li><a href="../../../../../../deprecated-list.html">Deprecated</a></li>
+<li><a href="../../../../../../index-all.html">Index</a></li>
+<li><a href="../../../../../../help-doc.html">Help</a></li>
+</ul>
+</div>
+<div class="subNav">
+<ul class="navList">
+<li><a href="../../../../../../org/apache/felix/dm/annotation/api/FactoryConfigurationAdapterService.html" title="annotation in org.apache.felix.dm.annotation.api"><span class="typeNameLink">Prev Class</span></a></li>
+<li><a href="../../../../../../org/apache/felix/dm/annotation/api/Inject.html" title="annotation in org.apache.felix.dm.annotation.api"><span class="typeNameLink">Next Class</span></a></li>
+</ul>
+<ul class="navList">
+<li><a href="../../../../../../index.html?org/apache/felix/dm/annotation/api/Init.html" target="_top">Frames</a></li>
+<li><a href="Init.html" target="_top">No Frames</a></li>
+</ul>
+<ul class="navList" id="allclasses_navbar_bottom">
+<li><a href="../../../../../../allclasses-noframe.html">All Classes</a></li>
+</ul>
+<div>
+<script type="text/javascript"><!--
+ allClassesLink = document.getElementById("allclasses_navbar_bottom");
+ if(window==top) {
+ allClassesLink.style.display = "block";
+ }
+ else {
+ allClassesLink.style.display = "none";
+ }
+ //-->
+</script>
+</div>
+<div>
+<ul class="subNavList">
+<li>Summary: </li>
+<li>Field | </li>
+<li>Required | </li>
+<li>Optional</li>
+</ul>
+<ul class="subNavList">
+<li>Detail: </li>
+<li>Field | </li>
+<li>Element</li>
+</ul>
+</div>
+<a name="skip.navbar.bottom">
+<!-- -->
+</a></div>
+<!-- ======== END OF BOTTOM NAVBAR ======= -->
+</body>
+</html>
Added: felix/site/trunk/content/apidocs/dependencymanager.annotations/r9/org/apache/felix/dm/annotation/api/Inject.html
URL: http://svn.apache.org/viewvc/felix/site/trunk/content/apidocs/dependencymanager.annotations/r9/org/apache/felix/dm/annotation/api/Inject.html?rev=1782915&view=auto
==============================================================================
--- felix/site/trunk/content/apidocs/dependencymanager.annotations/r9/org/apache/felix/dm/annotation/api/Inject.html (added)
+++ felix/site/trunk/content/apidocs/dependencymanager.annotations/r9/org/apache/felix/dm/annotation/api/Inject.html Tue Feb 14 07:07:38 2017
@@ -0,0 +1,206 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<!-- NewPage -->
+<html lang="en">
+<head>
+<!-- Generated by javadoc (1.8.0_102) on Tue Feb 14 08:05:47 CET 2017 -->
+<title>Inject</title>
+<meta name="date" content="2017-02-14">
+<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
+<script type="text/javascript" src="../../../../../../script.js"></script>
+</head>
+<body>
+<script type="text/javascript"><!--
+ try {
+ if (location.href.indexOf('is-external=true') == -1) {
+ parent.document.title="Inject";
+ }
+ }
+ catch(err) {
+ }
+//-->
+</script>
+<noscript>
+<div>JavaScript is disabled on your browser.</div>
+</noscript>
+<!-- ========= START OF TOP NAVBAR ======= -->
+<div class="topNav"><a name="navbar.top">
+<!-- -->
+</a>
+<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
+<a name="navbar.top.firstrow">
+<!-- -->
+</a>
+<ul class="navList" title="Navigation">
+<li><a href="../../../../../../org/apache/felix/dm/annotation/api/package-summary.html">Package</a></li>
+<li class="navBarCell1Rev">Class</li>
+<li><a href="package-tree.html">Tree</a></li>
+<li><a href="../../../../../../deprecated-list.html">Deprecated</a></li>
+<li><a href="../../../../../../index-all.html">Index</a></li>
+<li><a href="../../../../../../help-doc.html">Help</a></li>
+</ul>
+</div>
+<div class="subNav">
+<ul class="navList">
+<li><a href="../../../../../../org/apache/felix/dm/annotation/api/Init.html" title="annotation in org.apache.felix.dm.annotation.api"><span class="typeNameLink">Prev Class</span></a></li>
+<li><a href="../../../../../../org/apache/felix/dm/annotation/api/LifecycleController.html" title="annotation in org.apache.felix.dm.annotation.api"><span class="typeNameLink">Next Class</span></a></li>
+</ul>
+<ul class="navList">
+<li><a href="../../../../../../index.html?org/apache/felix/dm/annotation/api/Inject.html" target="_top">Frames</a></li>
+<li><a href="Inject.html" target="_top">No Frames</a></li>
+</ul>
+<ul class="navList" id="allclasses_navbar_top">
+<li><a href="../../../../../../allclasses-noframe.html">All Classes</a></li>
+</ul>
+<div>
+<script type="text/javascript"><!--
+ allClassesLink = document.getElementById("allclasses_navbar_top");
+ if(window==top) {
+ allClassesLink.style.display = "block";
+ }
+ else {
+ allClassesLink.style.display = "none";
+ }
+ //-->
+</script>
+</div>
+<div>
+<ul class="subNavList">
+<li>Summary: </li>
+<li>Field | </li>
+<li>Required | </li>
+<li>Optional</li>
+</ul>
+<ul class="subNavList">
+<li>Detail: </li>
+<li>Field | </li>
+<li>Element</li>
+</ul>
+</div>
+<a name="skip.navbar.top">
+<!-- -->
+</a></div>
+<!-- ========= END OF TOP NAVBAR ========= -->
+<!-- ======== START OF CLASS DATA ======== -->
+<div class="header">
+<div class="subTitle">org.apache.felix.dm.annotation.api</div>
+<h2 title="Annotation Type Inject" class="title">Annotation Type Inject</h2>
+</div>
+<div class="contentContainer">
+<div class="description">
+<ul class="blockList">
+<li class="blockList">
+<hr>
+<br>
+<pre>@Retention(value=CLASS)
+ @Target(value=FIELD)
+public @interface <span class="memberNameLabel">Inject</span></pre>
+<div class="block">Inject classes in a component instance field.
+ The following injections are currently performed, depending on the type of the
+ field this annotation is applied on:
+ <ul>
+ <li>BundleContext: the bundle context of the bundle
+ <li>DependencyManager: the dependency manager instance
+ <li>Component: the component instance of the dependency manager
+ </ul>
+
+ <h3>Usage Examples</h3>
+ <blockquote>
+
+ <pre>
+ @Component
+ class X implements Z {
+ @Inject
+ BundleContext bundleContext;
+
+ @Inject
+ Component component;
+
+ @Inject
+ DependencyManager manager;
+
+ OtherService otherService;
+
+ @Init
+ void init() {
+ System.out.println("Bundle Context: " + bundleContext);
+ System.out.println("Manager: " + manager);
+
+ // Use DM API for defining an extra service dependency
+ componnent.add(manager.createServiceDependency()
+ .setService(OtherService.class)
+ .setRequired(true)
+ .setInstanceBound(true));
+ }
+
+ @Start
+ void start() {
+ System.out.println("OtherService: " + otherService);
+ }
+ }
+ </pre>
+ </blockquote></div>
+</li>
+</ul>
+</div>
+</div>
+<!-- ========= END OF CLASS DATA ========= -->
+<!-- ======= START OF BOTTOM NAVBAR ====== -->
+<div class="bottomNav"><a name="navbar.bottom">
+<!-- -->
+</a>
+<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
+<a name="navbar.bottom.firstrow">
+<!-- -->
+</a>
+<ul class="navList" title="Navigation">
+<li><a href="../../../../../../org/apache/felix/dm/annotation/api/package-summary.html">Package</a></li>
+<li class="navBarCell1Rev">Class</li>
+<li><a href="package-tree.html">Tree</a></li>
+<li><a href="../../../../../../deprecated-list.html">Deprecated</a></li>
+<li><a href="../../../../../../index-all.html">Index</a></li>
+<li><a href="../../../../../../help-doc.html">Help</a></li>
+</ul>
+</div>
+<div class="subNav">
+<ul class="navList">
+<li><a href="../../../../../../org/apache/felix/dm/annotation/api/Init.html" title="annotation in org.apache.felix.dm.annotation.api"><span class="typeNameLink">Prev Class</span></a></li>
+<li><a href="../../../../../../org/apache/felix/dm/annotation/api/LifecycleController.html" title="annotation in org.apache.felix.dm.annotation.api"><span class="typeNameLink">Next Class</span></a></li>
+</ul>
+<ul class="navList">
+<li><a href="../../../../../../index.html?org/apache/felix/dm/annotation/api/Inject.html" target="_top">Frames</a></li>
+<li><a href="Inject.html" target="_top">No Frames</a></li>
+</ul>
+<ul class="navList" id="allclasses_navbar_bottom">
+<li><a href="../../../../../../allclasses-noframe.html">All Classes</a></li>
+</ul>
+<div>
+<script type="text/javascript"><!--
+ allClassesLink = document.getElementById("allclasses_navbar_bottom");
+ if(window==top) {
+ allClassesLink.style.display = "block";
+ }
+ else {
+ allClassesLink.style.display = "none";
+ }
+ //-->
+</script>
+</div>
+<div>
+<ul class="subNavList">
+<li>Summary: </li>
+<li>Field | </li>
+<li>Required | </li>
+<li>Optional</li>
+</ul>
+<ul class="subNavList">
+<li>Detail: </li>
+<li>Field | </li>
+<li>Element</li>
+</ul>
+</div>
+<a name="skip.navbar.bottom">
+<!-- -->
+</a></div>
+<!-- ======== END OF BOTTOM NAVBAR ======= -->
+</body>
+</html>
Added: felix/site/trunk/content/apidocs/dependencymanager.annotations/r9/org/apache/felix/dm/annotation/api/LifecycleController.html
URL: http://svn.apache.org/viewvc/felix/site/trunk/content/apidocs/dependencymanager.annotations/r9/org/apache/felix/dm/annotation/api/LifecycleController.html?rev=1782915&view=auto
==============================================================================
--- felix/site/trunk/content/apidocs/dependencymanager.annotations/r9/org/apache/felix/dm/annotation/api/LifecycleController.html (added)
+++ felix/site/trunk/content/apidocs/dependencymanager.annotations/r9/org/apache/felix/dm/annotation/api/LifecycleController.html Tue Feb 14 07:07:38 2017
@@ -0,0 +1,278 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<!-- NewPage -->
+<html lang="en">
+<head>
+<!-- Generated by javadoc (1.8.0_102) on Tue Feb 14 08:05:47 CET 2017 -->
+<title>LifecycleController</title>
+<meta name="date" content="2017-02-14">
+<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
+<script type="text/javascript" src="../../../../../../script.js"></script>
+</head>
+<body>
+<script type="text/javascript"><!--
+ try {
+ if (location.href.indexOf('is-external=true') == -1) {
+ parent.document.title="LifecycleController";
+ }
+ }
+ catch(err) {
+ }
+//-->
+</script>
+<noscript>
+<div>JavaScript is disabled on your browser.</div>
+</noscript>
+<!-- ========= START OF TOP NAVBAR ======= -->
+<div class="topNav"><a name="navbar.top">
+<!-- -->
+</a>
+<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
+<a name="navbar.top.firstrow">
+<!-- -->
+</a>
+<ul class="navList" title="Navigation">
+<li><a href="../../../../../../org/apache/felix/dm/annotation/api/package-summary.html">Package</a></li>
+<li class="navBarCell1Rev">Class</li>
+<li><a href="package-tree.html">Tree</a></li>
+<li><a href="../../../../../../deprecated-list.html">Deprecated</a></li>
+<li><a href="../../../../../../index-all.html">Index</a></li>
+<li><a href="../../../../../../help-doc.html">Help</a></li>
+</ul>
+</div>
+<div class="subNav">
+<ul class="navList">
+<li><a href="../../../../../../org/apache/felix/dm/annotation/api/Inject.html" title="annotation in org.apache.felix.dm.annotation.api"><span class="typeNameLink">Prev Class</span></a></li>
+<li><a href="../../../../../../org/apache/felix/dm/annotation/api/Property.html" title="annotation in org.apache.felix.dm.annotation.api"><span class="typeNameLink">Next Class</span></a></li>
+</ul>
+<ul class="navList">
+<li><a href="../../../../../../index.html?org/apache/felix/dm/annotation/api/LifecycleController.html" target="_top">Frames</a></li>
+<li><a href="LifecycleController.html" target="_top">No Frames</a></li>
+</ul>
+<ul class="navList" id="allclasses_navbar_top">
+<li><a href="../../../../../../allclasses-noframe.html">All Classes</a></li>
+</ul>
+<div>
+<script type="text/javascript"><!--
+ allClassesLink = document.getElementById("allclasses_navbar_top");
+ if(window==top) {
+ allClassesLink.style.display = "block";
+ }
+ else {
+ allClassesLink.style.display = "none";
+ }
+ //-->
+</script>
+</div>
+<div>
+<ul class="subNavList">
+<li>Summary: </li>
+<li>Field | </li>
+<li>Required | </li>
+<li><a href="#annotation.type.optional.element.summary">Optional</a></li>
+</ul>
+<ul class="subNavList">
+<li>Detail: </li>
+<li>Field | </li>
+<li><a href="#annotation.type.element.detail">Element</a></li>
+</ul>
+</div>
+<a name="skip.navbar.top">
+<!-- -->
+</a></div>
+<!-- ========= END OF TOP NAVBAR ========= -->
+<!-- ======== START OF CLASS DATA ======== -->
+<div class="header">
+<div class="subTitle">org.apache.felix.dm.annotation.api</div>
+<h2 title="Annotation Type LifecycleController" class="title">Annotation Type LifecycleController</h2>
+</div>
+<div class="contentContainer">
+<div class="description">
+<ul class="blockList">
+<li class="blockList">
+<hr>
+<br>
+<pre>@Retention(value=CLASS)
+ @Target(value=FIELD)
+public @interface <span class="memberNameLabel">LifecycleController</span></pre>
+<div class="block">Injects a <code>Runnable</code> object in a Service for starting/stopping it programatically.
+ By default, a Service is implicitly started when the service's bundle is started and when
+ all required dependencies are satisfied. However, it is sometimes required to programatically
+ take control of when the service is started or stopped. In this case, the injected <code>Runnable</code>
+ can be invoked in order to start/register (or stop/unregister) a Service at any time. When this annotation
+ is used, then the Service on which this annotation is applied is not activated by default, and you have to
+ call the injected Runnable yourself.
+
+ <h3>Usage Examples</h3>
+ <blockquote>
+
+ <pre>
+ /**
+ * This Service will be registered programmatically into the OSGi registry, using the LifecycleController annotation.
+ */
+ @Component
+ class X implements Z {
+ @LifecycleController
+ Runnable starter
+
+ @LifecycleController(start=false)
+ Runnable stopper
+
+ @Init
+ void init() {
+ // At this point, all required dependencies are there, but we'll activate our service in 2 seconds ...
+ Thread t = new Thread() {
+ public void run() {
+ sleep(2000);
+ // start our "Z" service (our "start" method will be called, juste before service registration
+ starter.run();
+
+ sleep(2000);
+ // now, stop/unregister the "Z" service (we'll then be called in our stop() method
+ stopper.run();
+ }
+ };
+ t.start();
+ }
+
+ @Start
+ public void start() {
+ // This method will be called after we invoke our starter Runnable, and our service will be
+ // published after our method returns, as in normal case.
+ }
+
+ @Stop
+ public void stop() {
+ // This method will be called after we invoke our "stop" Runnable, and our service will be
+ // unregistered before our method is invoked, as in normal case. Notice that the service won't
+ // be destroyed here, and the "starter" runnable can be re-invoked later.
+ }
+ }
+ </pre>
+ </blockquote></div>
+</li>
+</ul>
+</div>
+<div class="summary">
+<ul class="blockList">
+<li class="blockList">
+<!-- =========== ANNOTATION TYPE OPTIONAL MEMBER SUMMARY =========== -->
+<ul class="blockList">
+<li class="blockList"><a name="annotation.type.optional.element.summary">
+<!-- -->
+</a>
+<h3>Optional Element Summary</h3>
+<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Optional Element Summary table, listing optional elements, and an explanation">
+<caption><span>Optional Elements</span><span class="tabEnd"> </span></caption>
+<tr>
+<th class="colFirst" scope="col">Modifier and Type</th>
+<th class="colLast" scope="col">Optional Element and Description</th>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code>boolean</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/felix/dm/annotation/api/LifecycleController.html#start--">start</a></span></code>
+<div class="block">Specifies the action to be performed when the injected runnable is invoked.</div>
+</td>
+</tr>
+</table>
+</li>
+</ul>
+</li>
+</ul>
+</div>
+<div class="details">
+<ul class="blockList">
+<li class="blockList">
+<!-- ============ ANNOTATION TYPE MEMBER DETAIL =========== -->
+<ul class="blockList">
+<li class="blockList"><a name="annotation.type.element.detail">
+<!-- -->
+</a>
+<h3>Element Detail</h3>
+<a name="start--">
+<!-- -->
+</a>
+<ul class="blockListLast">
+<li class="blockList">
+<h4>start</h4>
+<pre>public abstract boolean start</pre>
+<div class="block">Specifies the action to be performed when the injected runnable is invoked. By default, the
+ Runnable will fire a Service Component activation, when invoked. If you specify this attribute
+ to false, then the Service Component will be stopped, when the runnable is invoked.</div>
+<dl>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>true if the component must be started when you invoke the injected runnable, or false if
+ the component must stopped when invoking the runnable.</dd>
+</dl>
+<dl>
+<dt>Default:</dt>
+<dd>true</dd>
+</dl>
+</li>
+</ul>
+</li>
+</ul>
+</li>
+</ul>
+</div>
+</div>
+<!-- ========= END OF CLASS DATA ========= -->
+<!-- ======= START OF BOTTOM NAVBAR ====== -->
+<div class="bottomNav"><a name="navbar.bottom">
+<!-- -->
+</a>
+<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
+<a name="navbar.bottom.firstrow">
+<!-- -->
+</a>
+<ul class="navList" title="Navigation">
+<li><a href="../../../../../../org/apache/felix/dm/annotation/api/package-summary.html">Package</a></li>
+<li class="navBarCell1Rev">Class</li>
+<li><a href="package-tree.html">Tree</a></li>
+<li><a href="../../../../../../deprecated-list.html">Deprecated</a></li>
+<li><a href="../../../../../../index-all.html">Index</a></li>
+<li><a href="../../../../../../help-doc.html">Help</a></li>
+</ul>
+</div>
+<div class="subNav">
+<ul class="navList">
+<li><a href="../../../../../../org/apache/felix/dm/annotation/api/Inject.html" title="annotation in org.apache.felix.dm.annotation.api"><span class="typeNameLink">Prev Class</span></a></li>
+<li><a href="../../../../../../org/apache/felix/dm/annotation/api/Property.html" title="annotation in org.apache.felix.dm.annotation.api"><span class="typeNameLink">Next Class</span></a></li>
+</ul>
+<ul class="navList">
+<li><a href="../../../../../../index.html?org/apache/felix/dm/annotation/api/LifecycleController.html" target="_top">Frames</a></li>
+<li><a href="LifecycleController.html" target="_top">No Frames</a></li>
+</ul>
+<ul class="navList" id="allclasses_navbar_bottom">
+<li><a href="../../../../../../allclasses-noframe.html">All Classes</a></li>
+</ul>
+<div>
+<script type="text/javascript"><!--
+ allClassesLink = document.getElementById("allclasses_navbar_bottom");
+ if(window==top) {
+ allClassesLink.style.display = "block";
+ }
+ else {
+ allClassesLink.style.display = "none";
+ }
+ //-->
+</script>
+</div>
+<div>
+<ul class="subNavList">
+<li>Summary: </li>
+<li>Field | </li>
+<li>Required | </li>
+<li><a href="#annotation.type.optional.element.summary">Optional</a></li>
+</ul>
+<ul class="subNavList">
+<li>Detail: </li>
+<li>Field | </li>
+<li><a href="#annotation.type.element.detail">Element</a></li>
+</ul>
+</div>
+<a name="skip.navbar.bottom">
+<!-- -->
+</a></div>
+<!-- ======== END OF BOTTOM NAVBAR ======= -->
+</body>
+</html>