Added: websites/staging/felix/trunk/content/apidocs/dependencymanager.annotations/r7/org/apache/felix/dm/annotation/api/Component.html ============================================================================== --- websites/staging/felix/trunk/content/apidocs/dependencymanager.annotations/r7/org/apache/felix/dm/annotation/api/Component.html (added) +++ websites/staging/felix/trunk/content/apidocs/dependencymanager.annotations/r7/org/apache/felix/dm/annotation/api/Component.html Wed Feb 24 00:19:46 2016 @@ -0,0 +1,570 @@ +<!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_74) on Wed Feb 24 01:07:22 CET 2016 --> +<title>Component</title> +<meta name="date" content="2016-02-24"> +<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="Component"; + } + } + 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/BundleDependency.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/Composition.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/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><a href="#annotation.type.field.summary">Field</a> | </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.field.detail">Field</a> | </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="memberNameLabel">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> + + Here is a sample showing a X component, which depends on a configuration dependency: + <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: + <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 FIELD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="annotation.type.field.summary"> +<!-- --> +</a> +<h3>Field Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> +<caption><span>Fields</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Fields and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static java.lang.String</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/felix/dm/annotation/api/Component.html#FACTORY_INSTANCE">FACTORY_INSTANCE</a></span></code> +<div class="block">Key used when providing an implementation when using a Component Factory .</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static java.lang.String</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/felix/dm/annotation/api/Component.html#FACTORY_NAME">FACTORY_NAME</a></span></code> +<div class="block">Service property name used to match a given Component Factory.</div> +</td> +</tr> +</table> +</li> +</ul> +<!-- =========== 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/Component.html#factoryConfigure--">factoryConfigure</a></span></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><span class="memberNameLink"><a href="../../../../../../org/apache/felix/dm/annotation/api/Component.html#factoryMethod--">factoryMethod</a></span></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><span class="memberNameLink"><a href="../../../../../../org/apache/felix/dm/annotation/api/Component.html#factoryName--">factoryName</a></span></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><span class="memberNameLink"><a href="../../../../../../org/apache/felix/dm/annotation/api/Component.html#factorySet--">factorySet</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/Component.html#factoryName--"><code>factoryName()</code></a> instead of a factorySet.</span></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><span class="memberNameLink"><a href="../../../../../../org/apache/felix/dm/annotation/api/Component.html#properties--">properties</a></span></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><span class="memberNameLink"><a href="../../../../../../org/apache/felix/dm/annotation/api/Component.html#provides--">provides</a></span></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 FIELD DETAIL =========== --> +<ul class="blockList"> +<li class="blockList"><a name="annotation.type.field.detail"> +<!-- --> +</a> +<h3>Field Detail</h3> +<a name="FACTORY_NAME"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>FACTORY_NAME</h4> +<pre>public static final java.lang.String FACTORY_NAME</pre> +<div class="block">Service property name used to match a given Component Factory.</div> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../../../org/apache/felix/dm/annotation/api/Component.html#factoryName--"><code>for more information about factory sets.</code></a></dd> +</dl> +</li> +</ul> +</li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="FACTORY_INSTANCE"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>FACTORY_INSTANCE</h4> +<pre>public static final java.lang.String FACTORY_INSTANCE</pre> +<div class="block">Key used when providing an implementation when using a Component Factory .</div> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../../../org/apache/felix/dm/annotation/api/Component.html#factoryName--"><code>factoryName()</code></a></dd> +</dl> +</li> +</ul> +</li> +</ul> +<!-- ============ 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><span class="returnLabel">Returns:</span></dt> +<dd>the provided 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">Sets list of provided service properties. Since R7 version, Property annotation is repeatable and you can directly + apply it on top of the component class multiple times, instead of using the Component properties attribute.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the component properties.</dd> +</dl> +<dl> +<dt>Default:</dt> +<dd>{}</dd> +</dl> +</li> +</ul> +</li> +</ul> +<ul class="blockList"> +<li class="blockList"><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="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">use <a href="../../../../../../org/apache/felix/dm/annotation/api/Component.html#factoryName--"><code>factoryName()</code></a> instead of a factorySet.</span></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><span class="returnLabel">Returns:</span></dt> +<dd>the factory set name</dd> +</dl> +<dl> +<dt>Default:</dt> +<dd>""</dd> +</dl> +</li> +</ul> +</li> +</ul> +<ul class="blockList"> +<li class="blockList"><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><span class="returnLabel">Returns:</span></dt> +<dd>the factory name</dd> +</dl> +<dl> +<dt>Default:</dt> +<dd>""</dd> +</dl> +</li> +</ul> +</li> +</ul> +<ul class="blockList"> +<li class="blockList"><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><span class="returnLabel">Returns:</span></dt> +<dd>the factory configure callback name</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 components implementation instance.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the factory method used to instantiate the component</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/BundleDependency.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/Composition.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/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><a href="#annotation.type.field.summary">Field</a> | </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.field.detail">Field</a> | </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/dependencymanager.annotations/r7/org/apache/felix/dm/annotation/api/Composition.html ============================================================================== --- websites/staging/felix/trunk/content/apidocs/dependencymanager.annotations/r7/org/apache/felix/dm/annotation/api/Composition.html (added) +++ websites/staging/felix/trunk/content/apidocs/dependencymanager.annotations/r7/org/apache/felix/dm/annotation/api/Composition.html Wed Feb 24 00:19:46 2016 @@ -0,0 +1,208 @@ +<!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_74) on Wed Feb 24 01:07:22 CET 2016 --> +<title>Composition</title> +<meta name="date" content="2016-02-24"> +<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="Composition"; + } + } + 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/Component.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/ConfigurationDependency.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/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>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 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="memberNameLabel">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): + <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> +<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/Component.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/ConfigurationDependency.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/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>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: websites/staging/felix/trunk/content/apidocs/dependencymanager.annotations/r7/org/apache/felix/dm/annotation/api/ConfigurationDependency.html ============================================================================== --- websites/staging/felix/trunk/content/apidocs/dependencymanager.annotations/r7/org/apache/felix/dm/annotation/api/ConfigurationDependency.html (added) +++ websites/staging/felix/trunk/content/apidocs/dependencymanager.annotations/r7/org/apache/felix/dm/annotation/api/ConfigurationDependency.html Wed Feb 24 00:19:46 2016 @@ -0,0 +1,554 @@ +<!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_74) on Wed Feb 24 01:07:22 CET 2016 --> +<title>ConfigurationDependency</title> +<meta name="date" content="2016-02-24"> +<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 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. + + 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 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 // Will use the fqdn of the PrinterConfiguration interface as the pid. + void updated(PrinterConfiguration cnf) { + String ip = cnf.ipAddress(); + int port = cnf.portNumber(); + ... + } + } + </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> + <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> +</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="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: websites/staging/felix/trunk/content/apidocs/dependencymanager.annotations/r7/org/apache/felix/dm/annotation/api/Destroy.html ============================================================================== --- websites/staging/felix/trunk/content/apidocs/dependencymanager.annotations/r7/org/apache/felix/dm/annotation/api/Destroy.html (added) +++ websites/staging/felix/trunk/content/apidocs/dependencymanager.annotations/r7/org/apache/felix/dm/annotation/api/Destroy.html Wed Feb 24 00:19:46 2016 @@ -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_74) on Wed Feb 24 01:07:22 CET 2016 --> +<title>Destroy</title> +<meta name="date" content="2016-02-24"> +<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: websites/staging/felix/trunk/content/apidocs/dependencymanager.annotations/r7/org/apache/felix/dm/annotation/api/FactoryConfigurationAdapterService.html ============================================================================== --- websites/staging/felix/trunk/content/apidocs/dependencymanager.annotations/r7/org/apache/felix/dm/annotation/api/FactoryConfigurationAdapterService.html (added) +++ websites/staging/felix/trunk/content/apidocs/dependencymanager.annotations/r7/org/apache/felix/dm/annotation/api/FactoryConfigurationAdapterService.html Wed Feb 24 00:19:46 2016 @@ -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_74) on Wed Feb 24 01:07:22 CET 2016 --> +<title>FactoryConfigurationAdapterService</title> +<meta name="date" content="2016-02-24"> +<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>
