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/05/26 23:10:54 UTC
svn commit: r952772 [7/9] - in /websites/staging/felix/trunk/content: ./
apidocs/ apidocs/dmannotations/4.0.0/ apidocs/dmannotations/4.0.1/
apidocs/dmannotations/r1/ apidocs/dmannotations/r1/org/
apidocs/dmannotations/r1/org/apache/ apidocs/dmannotatio...
Added: websites/staging/felix/trunk/content/apidocs/dmannotations/r2/org/apache/felix/dm/annotation/api/Component.html
==============================================================================
--- websites/staging/felix/trunk/content/apidocs/dmannotations/r2/org/apache/felix/dm/annotation/api/Component.html (added)
+++ websites/staging/felix/trunk/content/apidocs/dmannotations/r2/org/apache/felix/dm/annotation/api/Component.html Tue May 26 21:10:52 2015
@@ -0,0 +1,451 @@
+<!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 (version 1.7.0_67) on Tue Mar 24 21:21:23 CET 2015 -->
+<title>Component</title>
+<meta name="date" content="2015-03-24">
+<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
+</head>
+<body>
+<script type="text/javascript"><!--
+ if (location.href.indexOf('is-external=true') == -1) {
+ parent.document.title="Component";
+ }
+//-->
+</script>
+<noscript>
+<div>JavaScript is disabled on your browser.</div>
+</noscript>
+<!-- ========= START OF TOP NAVBAR ======= -->
+<div class="topNav"><a name="navbar_top">
+<!-- -->
+</a><a href="#skip-navbar_top" title="Skip navigation links"></a><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/BundleDependency.html" title="annotation in org.apache.felix.dm.annotation.api"><span class="strong">Prev Class</span></a></li>
+<li><a href="../../../../../../org/apache/felix/dm/annotation/api/Composition.html" title="annotation in org.apache.felix.dm.annotation.api"><span class="strong">Next Class</span></a></li>
+</ul>
+<ul class="navList">
+<li><a href="../../../../../../index.html?org/apache/felix/dm/annotation/api/Component.html" target="_top">Frames</a></li>
+<li><a href="Component.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>Required | </li>
+<li><a href="#annotation_type_optional_element_summary">Optional</a></li>
+</ul>
+<ul class="subNavList">
+<li>Detail: </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 Component" class="title">Annotation Type Component</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="strong">Component</span></pre>
+<div class="block">Annotates an OSGi Component class with its dependencies. Components are the main building
+ blocks for OSGi applications. They can publish themselves as a service, and/or they can have
+ dependencies. These dependencies will influence their life cycle as component will only be
+ activated when all required dependencies are available.
+ By default, all directly implemented interfaces are registered into the OSGi registry,
+ and the component is instantiated automatically, when the component bundle is started and
+ when the component dependencies are available. If you need to take control of when and how
+ much component instances must be created, then you can use the <code>factoryName</code>
+ annotation attribute.<p>
+ If a <code>factoryName</code> attribute is set, the component is not started automatically
+ during bundle startup, and a <code>org.apache.felix.dm.runtime.api.ComponentFactory</code>
+ object is registered into the OSGi registry on behalf of the component. This ComponentFactory
+ can then be used by another component in order to instantiate multiple instances of the component
+ (DM ComponentFactory are really similar to DS ComponentFactory).
+
+ <h3>Usage Examples</h3>
+
+ <p> Here is a sample showing a X component, which depends on a configuration dependency:<p>
+ <blockquote>
+
+ <pre>
+ /**
+ * This component will be activated once the bundle is started and when all required dependencies
+ * are available.
+ */
+ @Component
+ class X implements Z {
+ @ConfigurationDependency(pid="MyPid")
+ void configure(Dictionary conf) {
+ // Configure or reconfigure our component.
+ }
+
+ @Start
+ void start() {
+ // Our component is starting and is about to be registered in the OSGi registry as a Z service.
+ }
+
+ public void doService() {
+ // ...
+ }
+ }
+ </pre>
+ </blockquote>
+
+ Here is a sample showing how a Y component may dynamically instantiate several X component instances,
+ using the <a href="../../../../../../org/apache/felix/dm/annotation/api/Component.html#factoryName()"><code>factoryName()</code></a> attribute:<p>
+ <blockquote>
+
+ <pre>
+ /**
+ * All component instances will be created/updated/removed by the "Y" component
+ */
+ @Component(factoryName="MyComponentFactory", factoryConfigure="configure")
+ class X implements Z {
+ void configure(Dictionary conf) {
+ // Configure or reconfigure our component. The conf is provided by the factory,
+ // and all public properties (which don't start with a dot) are propagated with the
+ // service properties specified in the properties annotation attribute.
+ }
+
+ @ServiceDependency
+ void bindOtherService(OtherService other) {
+ // store this require dependency
+ }
+
+ @Start
+ void start() {
+ // Our component is starting and is about to be registered in the OSGi registry as a Z service.
+ }
+
+ public void doService() {
+ // ...
+ }
+ }
+
+ import import org.apache.felix.dm.runtime.api.ComponentFactory;
+
+ /**
+ * This class will instantiate some X component instances
+ */
+ @Component
+ class Y {
+ @ServiceDependency(filter="(" + Component.FACTORY_NAME + "=MyComponentFactory)")
+ ComponentFactory _XFactory;
+
+ @Start
+ void start() {
+ // Instantiate a X component instance
+ Dictionary instance1Conf = new Hashtable() {{ put("foo", "bar1"); }};
+ ComponentInstance instance1 = _XFactory.newInstance(instance1Conf);
+
+ // Instantiate another X component instance
+ Dictionary instance2Conf = new Hashtable() {{ put("foo2", "bar2"); }};
+ ComponentInstance instance2 = _XFactory.newInstance(instance2Conf);
+
+ // Update the first X component instance
+ instance1Conf = new Hashtable() {{ put("foo", "bar1 modified"); }};
+ instance1.update(instance1Conf);
+
+ // Instantiate a third X instance, by explicitly providing the implementation object
+ Dictionary instance3Conf = new Hashtable() {{ put(Component.FACTORY_INSTANCE, new X()); }};
+ ComponentInstance instance3 = _XFactory.newInstance(instance3Conf);
+
+ // Destroy x1/x2/x3 components
+ instance1.dispose();
+ instance2.dispose();
+ instance3.dispose();
+ }
+ }
+ </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="overviewSummary" 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><strong><a href="../../../../../../org/apache/felix/dm/annotation/api/Component.html#factoryConfigure()">factoryConfigure</a></strong></code>
+<div class="block">Sets "configure" callback method name to be called with the factory configuration.</div>
+</td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><code>java.lang.String</code></td>
+<td class="colLast"><code><strong><a href="../../../../../../org/apache/felix/dm/annotation/api/Component.html#factoryMethod()">factoryMethod</a></strong></code>
+<div class="block">Sets the static method used to create the components implementation instance.</div>
+</td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code>java.lang.String</code></td>
+<td class="colLast"><code><strong><a href="../../../../../../org/apache/felix/dm/annotation/api/Component.html#factoryName()">factoryName</a></strong></code>
+<div class="block">Returns the name of the <code>ComponentFactory</code> used to dynamically instantiate this component.</div>
+</td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><code>java.lang.String</code></td>
+<td class="colLast"><code><strong><a href="../../../../../../org/apache/felix/dm/annotation/api/Component.html#factorySet()">factorySet</a></strong></code>
+<div class="block"><strong>Deprecated.</strong>
+<div class="block"><i>use <a href="../../../../../../org/apache/felix/dm/annotation/api/Component.html#factoryName()"><code>factoryName()</code></a> instead of a factorySet.</i></div>
+</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><strong><a href="../../../../../../org/apache/felix/dm/annotation/api/Component.html#properties()">properties</a></strong></code>
+<div class="block">Sets list of provided service properties.</div>
+</td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><code>java.lang.Class<?>[]</code></td>
+<td class="colLast"><code><strong><a href="../../../../../../org/apache/felix/dm/annotation/api/Component.html#provides()">provides</a></strong></code>
+<div class="block">Sets list of provided interfaces.</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">Sets list of provided interfaces. By default, the directly implemented interfaces are provided.</div>
+<dl>
+<dt>Default:</dt>
+<dd>{}</dd>
+</dl>
+</li>
+</ul>
+<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">Sets list of provided service properties.</div>
+<dl>
+<dt>Default:</dt>
+<dd>{}</dd>
+</dl>
+</li>
+</ul>
+<a name="factorySet()">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>factorySet</h4>
+<pre>public abstract java.lang.String factorySet</pre>
+<div class="block"><span class="strong">Deprecated.</span> <i>use <a href="../../../../../../org/apache/felix/dm/annotation/api/Component.html#factoryName()"><code>factoryName()</code></a> instead of a factorySet.</i></div>
+<div class="block">Returns the name of the <code>Factory Set</code> used to dynamically instantiate this component.
+ When you set this attribute, a <code>java.util.Set<java.lang.Dictionary></code> OSGi Service will
+ be provided with a <code>dm.factory.name</code> service property matching your specified <code>factorySet</code> attribute.
+ This Set will be provided once the component bundle is started, even if required dependencies are not available, and the
+ Set will be unregistered from the OSGi registry once the component bundle is stopped or being updated.<p>
+ So, basically, another component may then be injected with this set in order to dynamically instantiate some component instances:
+ <ul>
+ <li> Each time a new Dictionary is added into the Set, then a new instance of the annotated component will be instantiated.</li>
+ <li> Each time an existing Dictionary is re-added into the Set, then the corresponding component instance will be updated.</li>
+ <li> Each time an existing Dictionary is removed from the Set, then the corresponding component instance will be destroyed.</li>
+ </ul>
+
+ <p>The dictionary registered in the Set will be provided to the created component instance using a callback method that you can
+ optionally specify in the <a href="../../../../../../org/apache/felix/dm/annotation/api/Component.html#factoryConfigure()"><code>factoryConfigure()</code></a> attribute. Each public properties from that dictionary
+ (which don't start with a dot) will be propagated along with the annotated component service properties.
+
+ <p>Optionally, the dictionary registered into the factory set may provide an implementation instance for the component to be created,
+ using the <a href="../../../../../../org/apache/felix/dm/annotation/api/Component.html#FACTORY_INSTANCE">"dm.factory.instance"</a> key.</div>
+<dl>
+<dt>Default:</dt>
+<dd>""</dd>
+</dl>
+</li>
+</ul>
+<a name="factoryName()">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>factoryName</h4>
+<pre>public abstract java.lang.String factoryName</pre>
+<div class="block">Returns the name of the <code>ComponentFactory</code> used to dynamically instantiate this component.
+ When you set this attribute, a <code>org.apache.felix.dm.runtime.api.ComponentFactory</code> OSGi Service will
+ be provided with a <code>dm.factory.name</code> service property matching your specified <code>factoryName</code> attribute.
+
+ The ComponentFactory will be provided once the component bundle is started, even if required dependencies are not available, and the
+ ComponentFactory will be unregistered from the OSGi registry once the component bundle is stopped or being updated.<p>
+ So, another component may then be injected with this ComponentFactory in order to dynamically instantiate some component instances:
+
+ <p>The dictionary passed to the ComponentFactory.newInstance method will be provided to the created component instance using a callback
+ method that you can optionally specify in the <a href="../../../../../../org/apache/felix/dm/annotation/api/Component.html#factoryConfigure()"><code>factoryConfigure()</code></a> attribute. Each public properties from that dictionary
+ (which don't start with a dot) will be propagated along with the annotated component service properties.
+
+ <p>Optionally, the dictionary registered into the factory set may provide an implementation instance for the component to be created,
+ using a "dm.runtime.factory.instance" key.</div>
+<dl>
+<dt>Default:</dt>
+<dd>""</dd>
+</dl>
+</li>
+</ul>
+<a name="factoryConfigure()">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>factoryConfigure</h4>
+<pre>public abstract java.lang.String factoryConfigure</pre>
+<div class="block">Sets "configure" callback method name to be called with the factory configuration. This attribute only makes sense if the
+ <a href="../../../../../../org/apache/felix/dm/annotation/api/Component.html#factoryName()"><code>factoryName()</code></a> attribute is used. If specified, then this attribute references a callback method, which is called
+ for providing the configuration supplied by the factory that instantiated this component. The current component service properties will be
+ also updated with all public properties (which don't start with a dot).</div>
+<dl>
+<dt>Default:</dt>
+<dd>""</dd>
+</dl>
+</li>
+</ul>
+<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 components implementation instance.</div>
+<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><a href="#skip-navbar_bottom" title="Skip navigation links"></a><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/BundleDependency.html" title="annotation in org.apache.felix.dm.annotation.api"><span class="strong">Prev Class</span></a></li>
+<li><a href="../../../../../../org/apache/felix/dm/annotation/api/Composition.html" title="annotation in org.apache.felix.dm.annotation.api"><span class="strong">Next Class</span></a></li>
+</ul>
+<ul class="navList">
+<li><a href="../../../../../../index.html?org/apache/felix/dm/annotation/api/Component.html" target="_top">Frames</a></li>
+<li><a href="Component.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>Required | </li>
+<li><a href="#annotation_type_optional_element_summary">Optional</a></li>
+</ul>
+<ul class="subNavList">
+<li>Detail: </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: websites/staging/felix/trunk/content/apidocs/dmannotations/r2/org/apache/felix/dm/annotation/api/Composition.html
==============================================================================
--- websites/staging/felix/trunk/content/apidocs/dmannotations/r2/org/apache/felix/dm/annotation/api/Composition.html (added)
+++ websites/staging/felix/trunk/content/apidocs/dmannotations/r2/org/apache/felix/dm/annotation/api/Composition.html Tue May 26 21:10:52 2015
@@ -0,0 +1,195 @@
+<!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 (version 1.7.0_67) on Tue Mar 24 21:21:23 CET 2015 -->
+<title>Composition</title>
+<meta name="date" content="2015-03-24">
+<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
+</head>
+<body>
+<script type="text/javascript"><!--
+ if (location.href.indexOf('is-external=true') == -1) {
+ parent.document.title="Composition";
+ }
+//-->
+</script>
+<noscript>
+<div>JavaScript is disabled on your browser.</div>
+</noscript>
+<!-- ========= START OF TOP NAVBAR ======= -->
+<div class="topNav"><a name="navbar_top">
+<!-- -->
+</a><a href="#skip-navbar_top" title="Skip navigation links"></a><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/Component.html" title="annotation in org.apache.felix.dm.annotation.api"><span class="strong">Prev Class</span></a></li>
+<li><a href="../../../../../../org/apache/felix/dm/annotation/api/ConfigurationDependency.html" title="annotation in org.apache.felix.dm.annotation.api"><span class="strong">Next Class</span></a></li>
+</ul>
+<ul class="navList">
+<li><a href="../../../../../../index.html?org/apache/felix/dm/annotation/api/Composition.html" target="_top">Frames</a></li>
+<li><a href="Composition.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>Required | </li>
+<li>Optional</li>
+</ul>
+<ul class="subNavList">
+<li>Detail: </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 Composition" class="title">Annotation Type Composition</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="strong">Composition</span></pre>
+<div class="block">Annotates a method returning the list of objects which are part of a Component implementation.
+ When implementing complex Components, you often need to use more than one object instances.
+ Moreover, several of these instances might want to have dependencies injected, as well as lifecycle
+ callbacks invoked, like the methods annotated with <a href="../../../../../../org/apache/felix/dm/annotation/api/Init.html" title="annotation in org.apache.felix.dm.annotation.api"><code>Init</code></a>, <a href="../../../../../../org/apache/felix/dm/annotation/api/Start.html" title="annotation in org.apache.felix.dm.annotation.api"><code>Start</code></a>, <a href="../../../../../../org/apache/felix/dm/annotation/api/Stop.html" title="annotation in org.apache.felix.dm.annotation.api"><code>Stop</code></a>,
+ <a href="../../../../../../org/apache/felix/dm/annotation/api/Destroy.html" title="annotation in org.apache.felix.dm.annotation.api"><code>Destroy</code></a> annotations. In such cases you can tell the dependency manager which instances to
+ consider, by annotating a method in your Component, returning a list of objects which are part
+ of the implementation.
+ <p>
+ This annotation may be applied on a method which is part of class annotated with either a <a href="../../../../../../org/apache/felix/dm/annotation/api/Component.html" title="annotation in org.apache.felix.dm.annotation.api"><code>Component</code></a>,
+ <a href="../../../../../../org/apache/felix/dm/annotation/api/AspectService.html" title="annotation in org.apache.felix.dm.annotation.api"><code>AspectService</code></a>, <a href="../../../../../../org/apache/felix/dm/annotation/api/AdapterService.html" title="annotation in org.apache.felix.dm.annotation.api"><code>AdapterService</code></a>, <a href="../../../../../../org/apache/felix/dm/annotation/api/FactoryConfigurationAdapterService.html" title="annotation in org.apache.felix.dm.annotation.api"><code>FactoryConfigurationAdapterService</code></a> or
+ <a href="../../../../../../org/apache/felix/dm/annotation/api/ResourceAdapterService.html" title="annotation in org.apache.felix.dm.annotation.api"><code>ResourceAdapterService</code></a> annotation.
+
+ <h3>Usage Examples</h3>
+
+ <p> Here, the "MyComponent" component is composed of the Helper class, which is also injected with
+ service dependencies. The lifecycle callbacks are also invoked in the Helper (if the Helper defines
+ them):<p>
+ <blockquote>
+ <pre>
+
+ class Helper {
+ LogService logService; // Injected
+ void start() {} // lifecycle callback
+ void bind(OtherService otherService) {} // injected
+ }
+
+ @Component
+ class MyComponent {
+ // Helper which will also be injected with our service dependencies
+ private Helper helper = new Helper();
+
+ @Composition
+ Object[] getComposition() {
+ return new Object[] { this, helper };
+ }
+
+ @ServiceDependency
+ private LogService logService; // Helper.logService will be also be injected, if defined.
+
+ @Start
+ void start() {} // the Helper.start() method will also be called, if defined
+
+ @ServiceDependency
+ void bind(OtherService otherService) {} // the Helper.bind() method will also be called, if defined
+ }
+ </pre>
+ </blockquote></div>
+</li>
+</ul>
+</div>
+</div>
+<!-- ========= END OF CLASS DATA ========= -->
+<!-- ======= START OF BOTTOM NAVBAR ====== -->
+<div class="bottomNav"><a name="navbar_bottom">
+<!-- -->
+</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><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/Component.html" title="annotation in org.apache.felix.dm.annotation.api"><span class="strong">Prev Class</span></a></li>
+<li><a href="../../../../../../org/apache/felix/dm/annotation/api/ConfigurationDependency.html" title="annotation in org.apache.felix.dm.annotation.api"><span class="strong">Next Class</span></a></li>
+</ul>
+<ul class="navList">
+<li><a href="../../../../../../index.html?org/apache/felix/dm/annotation/api/Composition.html" target="_top">Frames</a></li>
+<li><a href="Composition.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>Required | </li>
+<li>Optional</li>
+</ul>
+<ul class="subNavList">
+<li>Detail: </li>
+<li>Element</li>
+</ul>
+</div>
+<a name="skip-navbar_bottom">
+<!-- -->
+</a></div>
+<!-- ======== END OF BOTTOM NAVBAR ======= -->
+</body>
+</html>
Added: websites/staging/felix/trunk/content/apidocs/dmannotations/r2/org/apache/felix/dm/annotation/api/ConfigurationDependency.html
==============================================================================
--- websites/staging/felix/trunk/content/apidocs/dmannotations/r2/org/apache/felix/dm/annotation/api/ConfigurationDependency.html (added)
+++ websites/staging/felix/trunk/content/apidocs/dmannotations/r2/org/apache/felix/dm/annotation/api/ConfigurationDependency.html Tue May 26 21:10:52 2015
@@ -0,0 +1,436 @@
+<!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 (version 1.7.0_67) on Tue Mar 24 21:21:23 CET 2015 -->
+<title>ConfigurationDependency</title>
+<meta name="date" content="2015-03-24">
+<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
+</head>
+<body>
+<script type="text/javascript"><!--
+ if (location.href.indexOf('is-external=true') == -1) {
+ parent.document.title="ConfigurationDependency";
+ }
+//-->
+</script>
+<noscript>
+<div>JavaScript is disabled on your browser.</div>
+</noscript>
+<!-- ========= START OF TOP NAVBAR ======= -->
+<div class="topNav"><a name="navbar_top">
+<!-- -->
+</a><a href="#skip-navbar_top" title="Skip navigation links"></a><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="strong">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="strong">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>Required | </li>
+<li><a href="#annotation_type_optional_element_summary">Optional</a></li>
+</ul>
+<ul class="subNavList">
+<li>Detail: </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="strong">ConfigurationDependency</span></pre>
+<div class="block">Annotates a method for injecting a Configuration Dependency. A configuration dependency
+ is always required, and allows you to depend on the availability of a valid configuration
+ for your component. This dependency requires the OSGi Configuration Admin Service.
+
+ <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 ipAddress();
+
+ @AD(description = "Enter the printer address port number.")
+ int portNumber();
+ }
+ </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(pidClass = PrinterConfiguration.class) // Will use pid "sample.PrinterConfiguration"
+ void updated(Dictionary props) {
+ // load configuration from the provided dictionary, or throw an exception of any configuration error.
+ PrinterConfig cnf = Configurable.createConfigurable(PrinterConfig.class, props);
+ String ip = cnf.ipAddress();
+ int port = cnf.portNumber();
+ ...
+ }
+ }
+ </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="overviewSummary" 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><strong><a href="../../../../../../org/apache/felix/dm/annotation/api/ConfigurationDependency.html#description()">description</a></strong></code>
+<div class="block"><strong>Deprecated.</strong>
+<div class="block"><i>use standard bndtools metatype annotations instead (see http://www.aqute.biz/Bnd/MetaType)</i></div>
+</div>
+</td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><code>java.lang.String</code></td>
+<td class="colLast"><code><strong><a href="../../../../../../org/apache/felix/dm/annotation/api/ConfigurationDependency.html#heading()">heading</a></strong></code>
+<div class="block"><strong>Deprecated.</strong>
+<div class="block"><i>use standard bndtools metatype annotations instead (see http://www.aqute.biz/Bnd/MetaType)</i></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><strong><a href="../../../../../../org/apache/felix/dm/annotation/api/ConfigurationDependency.html#metadata()">metadata</a></strong></code>
+<div class="block"><strong>Deprecated.</strong>
+<div class="block"><i>use standard bndtools metatype annotations instead (see http://www.aqute.biz/Bnd/MetaType)</i></div>
+</div>
+</td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><code>java.lang.String</code></td>
+<td class="colLast"><code><strong><a href="../../../../../../org/apache/felix/dm/annotation/api/ConfigurationDependency.html#name()">name</a></strong></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><strong><a href="../../../../../../org/apache/felix/dm/annotation/api/ConfigurationDependency.html#pid()">pid</a></strong></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><strong><a href="../../../../../../org/apache/felix/dm/annotation/api/ConfigurationDependency.html#pidClass()">pidClass</a></strong></code>
+<div class="block">Returns the pid from a class name.</div>
+</td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code>boolean</code></td>
+<td class="colLast"><code><strong><a href="../../../../../../org/apache/felix/dm/annotation/api/ConfigurationDependency.html#propagate()">propagate</a></strong></code>
+<div class="block">Returns true if the configuration properties must be published along with the service.</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="strong">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>
+<a name="pidClass()">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>pidClass</h4>
+<pre>public abstract java.lang.Class<?> pidClass</pre>
+<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 annoted with standard bndtols metatype annotations.
+ (see http://www.aqute.biz/Bnd/MetaType).</div>
+<dl>
+<dt>Default:</dt>
+<dd>java.lang.Object.class</dd>
+</dl>
+</li>
+</ul>
+<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="strong">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>
+<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>Default:</dt>
+<dd>""</dd>
+</dl>
+</li>
+</ul>
+<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="strong">Deprecated.</span> <i>use standard bndtools metatype annotations instead (see http://www.aqute.biz/Bnd/MetaType)</i></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="strong">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>
+<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="strong">Deprecated.</span> <i>use standard bndtools metatype annotations instead (see http://www.aqute.biz/Bnd/MetaType)</i></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="strong">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>
+<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="strong">Deprecated.</span> <i>use standard bndtools metatype annotations instead (see http://www.aqute.biz/Bnd/MetaType)</i></div>
+<div class="block">The list of properties types used to expose properties in web console.</div>
+<dl><dt><span class="strong">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><a href="#skip-navbar_bottom" title="Skip navigation links"></a><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="strong">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="strong">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>Required | </li>
+<li><a href="#annotation_type_optional_element_summary">Optional</a></li>
+</ul>
+<ul class="subNavList">
+<li>Detail: </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: websites/staging/felix/trunk/content/apidocs/dmannotations/r2/org/apache/felix/dm/annotation/api/Destroy.html
==============================================================================
--- websites/staging/felix/trunk/content/apidocs/dmannotations/r2/org/apache/felix/dm/annotation/api/Destroy.html (added)
+++ websites/staging/felix/trunk/content/apidocs/dmannotations/r2/org/apache/felix/dm/annotation/api/Destroy.html Tue May 26 21:10:52 2015
@@ -0,0 +1,167 @@
+<!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 (version 1.7.0_67) on Tue Mar 24 21:21:23 CET 2015 -->
+<title>Destroy</title>
+<meta name="date" content="2015-03-24">
+<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
+</head>
+<body>
+<script type="text/javascript"><!--
+ if (location.href.indexOf('is-external=true') == -1) {
+ parent.document.title="Destroy";
+ }
+//-->
+</script>
+<noscript>
+<div>JavaScript is disabled on your browser.</div>
+</noscript>
+<!-- ========= START OF TOP NAVBAR ======= -->
+<div class="topNav"><a name="navbar_top">
+<!-- -->
+</a><a href="#skip-navbar_top" title="Skip navigation links"></a><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="strong">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="strong">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>Required | </li>
+<li>Optional</li>
+</ul>
+<ul class="subNavList">
+<li>Detail: </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="strong">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).
+ </ul>
+
+ <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><a href="#skip-navbar_bottom" title="Skip navigation links"></a><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="strong">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="strong">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>Required | </li>
+<li>Optional</li>
+</ul>
+<ul class="subNavList">
+<li>Detail: </li>
+<li>Element</li>
+</ul>
+</div>
+<a name="skip-navbar_bottom">
+<!-- -->
+</a></div>
+<!-- ======== END OF BOTTOM NAVBAR ======= -->
+</body>
+</html>
Added: websites/staging/felix/trunk/content/apidocs/dmannotations/r2/org/apache/felix/dm/annotation/api/FactoryConfigurationAdapterService.html
==============================================================================
--- websites/staging/felix/trunk/content/apidocs/dmannotations/r2/org/apache/felix/dm/annotation/api/FactoryConfigurationAdapterService.html (added)
+++ websites/staging/felix/trunk/content/apidocs/dmannotations/r2/org/apache/felix/dm/annotation/api/FactoryConfigurationAdapterService.html Tue May 26 21:10:52 2015
@@ -0,0 +1,455 @@
+<!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 (version 1.7.0_67) on Tue Mar 24 21:21:23 CET 2015 -->
+<title>FactoryConfigurationAdapterService</title>
+<meta name="date" content="2015-03-24">
+<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
+</head>
+<body>
+<script type="text/javascript"><!--
+ if (location.href.indexOf('is-external=true') == -1) {
+ parent.document.title="FactoryConfigurationAdapterService";
+ }
+//-->
+</script>
+<noscript>
+<div>JavaScript is disabled on your browser.</div>
+</noscript>
+<!-- ========= START OF TOP NAVBAR ======= -->
+<div class="topNav"><a name="navbar_top">
+<!-- -->
+</a><a href="#skip-navbar_top" title="Skip navigation links"></a><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="strong">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="strong">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>Required | </li>
+<li><a href="#annotation_type_optional_element_summary">Optional</a></li>
+</ul>
+<ul class="subNavList">
+<li>Detail: </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="strong">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>
+
+ <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 Dictionary service:
+
+ <blockquote>
+ <pre>
+ import java.util.List;
+ import aQute.bnd.annotation.metatype.Configurable;
+
+ @FactoryConfigurationAdapterService(factoryPidClass=DictionaryConfiguration.class)
+ public class DictionaryImpl implements DictionaryService {
+ protected void updated(Dictionary<String, ?> props) {
+ // load configuration from the provided dictionary, or throw an exception of any configuration error.
+ DictionaryConfiguration cnf = Configurable.createConfigurable(DictionaryConfiguration.class, props);
+
+ 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="overviewSummary" 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><strong><a href="../../../../../../org/apache/felix/dm/annotation/api/FactoryConfigurationAdapterService.html#description()">description</a></strong></code>
+<div class="block"><strong>Deprecated.</strong>
+<div class="block"><i>use standard bndtools metatype annotations instead (see http://www.aqute.biz/Bnd/MetaType)</i></div>
+</div>
+</td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><code>java.lang.String</code></td>
+<td class="colLast"><code><strong><a href="../../../../../../org/apache/felix/dm/annotation/api/FactoryConfigurationAdapterService.html#factoryMethod()">factoryMethod</a></strong></code>
+<div class="block">Sets the static method used to create the adapter instance.</div>
+</td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code>java.lang.String</code></td>
+<td class="colLast"><code><strong><a href="../../../../../../org/apache/felix/dm/annotation/api/FactoryConfigurationAdapterService.html#factoryPid()">factoryPid</a></strong></code>
+<div class="block">Returns the factory pid whose configurations will instantiate the annotated service class.</div>
+</td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><code>java.lang.Class<?></code></td>
+<td class="colLast"><code><strong><a href="../../../../../../org/apache/felix/dm/annotation/api/FactoryConfigurationAdapterService.html#factoryPidClass()">factoryPidClass</a></strong></code>
+<div class="block">Returns the factory pid from a class name.</div>
+</td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code>java.lang.String</code></td>
+<td class="colLast"><code><strong><a href="../../../../../../org/apache/felix/dm/annotation/api/FactoryConfigurationAdapterService.html#heading()">heading</a></strong></code>
+<div class="block"><strong>Deprecated.</strong>
+<div class="block"><i>use standard bndtools metatype annotations instead (see http://www.aqute.biz/Bnd/MetaType)</i></div>
+</div>
+</td>
+</tr>
+<tr class="rowColor">
+<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><strong><a href="../../../../../../org/apache/felix/dm/annotation/api/FactoryConfigurationAdapterService.html#metadata()">metadata</a></strong></code>
+<div class="block"><strong>Deprecated.</strong>
+<div class="block"><i>use standard bndtools metatype annotations instead (see http://www.aqute.biz/Bnd/MetaType)</i></div>
+</div>
+</td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code>boolean</code></td>
+<td class="colLast"><code><strong><a href="../../../../../../org/apache/felix/dm/annotation/api/FactoryConfigurationAdapterService.html#propagate()">propagate</a></strong></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><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><strong><a href="../../../../../../org/apache/felix/dm/annotation/api/FactoryConfigurationAdapterService.html#properties()">properties</a></strong></code>
+<div class="block">Adapter Service properties.</div>
+</td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code>java.lang.Class<?>[]</code></td>
+<td class="colLast"><code><strong><a href="../../../../../../org/apache/felix/dm/annotation/api/FactoryConfigurationAdapterService.html#provides()">provides</a></strong></code>
+<div class="block">The interface(s) to use when registering adapters.</div>
+</td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><code>java.lang.String</code></td>
+<td class="colLast"><code><strong><a href="../../../../../../org/apache/felix/dm/annotation/api/FactoryConfigurationAdapterService.html#updated()">updated</a></strong></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>Default:</dt>
+<dd>{}</dd>
+</dl>
+</li>
+</ul>
+<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>Default:</dt>
+<dd>{}</dd>
+</dl>
+</li>
+</ul>
+<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>Default:</dt>
+<dd>""</dd>
+</dl>
+</li>
+</ul>
+<a name="factoryPidClass()">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>factoryPidClass</h4>
+<pre>public abstract java.lang.Class<?> factoryPidClass</pre>
+<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>Default:</dt>
+<dd>java.lang.Object.class</dd>
+</dl>
+</li>
+</ul>
+<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>Default:</dt>
+<dd>"updated"</dd>
+</dl>
+</li>
+</ul>
+<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="strong">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>
+<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="strong">Deprecated.</span> <i>use standard bndtools metatype annotations instead (see http://www.aqute.biz/Bnd/MetaType)</i></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="strong">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>
+<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="strong">Deprecated.</span> <i>use standard bndtools metatype annotations instead (see http://www.aqute.biz/Bnd/MetaType)</i></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="strong">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>
+<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="strong">Deprecated.</span> <i>use standard bndtools metatype annotations instead (see http://www.aqute.biz/Bnd/MetaType)</i></div>
+<div class="block">The list of properties types used to expose properties in web console.</div>
+<dl><dt><span class="strong">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>
+<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>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><a href="#skip-navbar_bottom" title="Skip navigation links"></a><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="strong">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="strong">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>Required | </li>
+<li><a href="#annotation_type_optional_element_summary">Optional</a></li>
+</ul>
+<ul class="subNavList">
+<li>Detail: </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: websites/staging/felix/trunk/content/apidocs/dmannotations/r2/org/apache/felix/dm/annotation/api/Init.html
==============================================================================
--- websites/staging/felix/trunk/content/apidocs/dmannotations/r2/org/apache/felix/dm/annotation/api/Init.html (added)
+++ websites/staging/felix/trunk/content/apidocs/dmannotations/r2/org/apache/felix/dm/annotation/api/Init.html Tue May 26 21:10:52 2015
@@ -0,0 +1,203 @@
+<!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 (version 1.7.0_67) on Tue Mar 24 21:21:23 CET 2015 -->
+<title>Init</title>
+<meta name="date" content="2015-03-24">
+<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
+</head>
+<body>
+<script type="text/javascript"><!--
+ if (location.href.indexOf('is-external=true') == -1) {
+ parent.document.title="Init";
+ }
+//-->
+</script>
+<noscript>
+<div>JavaScript is disabled on your browser.</div>
+</noscript>
+<!-- ========= START OF TOP NAVBAR ======= -->
+<div class="topNav"><a name="navbar_top">
+<!-- -->
+</a><a href="#skip-navbar_top" title="Skip navigation links"></a><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="strong">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="strong">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>Required | </li>
+<li>Optional</li>
+</ul>
+<ul class="subNavList">
+<li>Detail: </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="strong">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).<p>
+
+ 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");
+ }</div>
+</li>
+</ul>
+</div>
+</div>
+<!-- ========= END OF CLASS DATA ========= -->
+<!-- ======= START OF BOTTOM NAVBAR ====== -->
+<div class="bottomNav"><a name="navbar_bottom">
+<!-- -->
+</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><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="strong">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="strong">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>Required | </li>
+<li>Optional</li>
+</ul>
+<ul class="subNavList">
+<li>Detail: </li>
+<li>Element</li>
+</ul>
+</div>
+<a name="skip-navbar_bottom">
+<!-- -->
+</a></div>
+<!-- ======== END OF BOTTOM NAVBAR ======= -->
+</body>
+</html>
Added: websites/staging/felix/trunk/content/apidocs/dmannotations/r2/org/apache/felix/dm/annotation/api/Inject.html
==============================================================================
--- websites/staging/felix/trunk/content/apidocs/dmannotations/r2/org/apache/felix/dm/annotation/api/Inject.html (added)
+++ websites/staging/felix/trunk/content/apidocs/dmannotations/r2/org/apache/felix/dm/annotation/api/Inject.html Tue May 26 21:10:52 2015
@@ -0,0 +1,194 @@
+<!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 (version 1.7.0_67) on Tue Mar 24 21:21:23 CET 2015 -->
+<title>Inject</title>
+<meta name="date" content="2015-03-24">
+<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
+</head>
+<body>
+<script type="text/javascript"><!--
+ if (location.href.indexOf('is-external=true') == -1) {
+ parent.document.title="Inject";
+ }
+//-->
+</script>
+<noscript>
+<div>JavaScript is disabled on your browser.</div>
+</noscript>
+<!-- ========= START OF TOP NAVBAR ======= -->
+<div class="topNav"><a name="navbar_top">
+<!-- -->
+</a><a href="#skip-navbar_top" title="Skip navigation links"></a><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="strong">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="strong">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>Required | </li>
+<li>Optional</li>
+</ul>
+<ul class="subNavList">
+<li>Detail: </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="strong">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>
+
+ <p>
+ <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><a href="#skip-navbar_bottom" title="Skip navigation links"></a><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="strong">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="strong">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>Required | </li>
+<li>Optional</li>
+</ul>
+<ul class="subNavList">
+<li>Detail: </li>
+<li>Element</li>
+</ul>
+</div>
+<a name="skip-navbar_bottom">
+<!-- -->
+</a></div>
+<!-- ======== END OF BOTTOM NAVBAR ======= -->
+</body>
+</html>