Added: websites/staging/felix/trunk/content/apidocs/dependencymanager.annotations/4.0.0/org/apache/felix/dm/annotation/api/AspectService.html ============================================================================== --- websites/staging/felix/trunk/content/apidocs/dependencymanager.annotations/4.0.0/org/apache/felix/dm/annotation/api/AspectService.html (added) +++ websites/staging/felix/trunk/content/apidocs/dependencymanager.annotations/4.0.0/org/apache/felix/dm/annotation/api/AspectService.html Fri Mar 6 22:25:31 2015 @@ -0,0 +1,431 @@ +<!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 Fri Mar 06 23:14:53 CET 2015 --> +<title>AspectService</title> +<meta name="date" content="2015-03-06"> +<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="AspectService"; + } +//--> +</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/AdapterService.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/BundleAdapterService.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/AspectService.html" target="_top">Frames</a></li> +<li><a href="AspectService.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_required_element_summary">Required</a> | </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 AspectService" class="title">Annotation Type AspectService</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">AspectService</span></pre> +<div class="block">Annotates an Aspect service. Aspects allow you to define an interceptor, or chain of interceptors + for a service (to add features like caching or logging, etc ...). The dependency manager intercepts + the original service, and allows you to execute some code before invoking the original service ... + The aspect will be applied to any service that matches the specified interface and filter and + will be registered with the same interface and properties as the original service, plus any + extra properties you supply here. It will also inherit all dependencies, + and if you declare the original service as a member it will be injected.<p> + + <h3>Usage Examples</h3> + + <p> Here, the AspectService is registered into the OSGI registry each time an InterceptedService + is found from the registry. The AspectService class intercepts the InterceptedService, and decorates + its "doWork()" method. This aspect uses a rank with value "10", meaning that it will intercept some + other eventual aspects with lower ranks. The Aspect also uses a service property (param=value), and + include eventual service properties found from the InterceptedService:<p> + <blockquote> + <pre> + + @AspectService(ranking=10), properties={@Property(name="param", value="value")}) + class AspectService implements InterceptedService { + // The service we are intercepting (injected by reflection) + protected InterceptedService intercepted; + + public void doWork() { + intercepted.doWork(); + } + } + </pre> + </blockquote></div> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- =========== ANNOTATION TYPE REQUIRED MEMBER SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="annotation_type_required_element_summary"> +<!-- --> +</a> +<h3>Required Element Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Required Element Summary table, listing required elements, and an explanation"> +<caption><span>Required Elements</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Required Element and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../../../org/apache/felix/dm/annotation/api/AspectService.html#ranking()">ranking</a></strong></code> +<div class="block">Sets the ranking of this aspect.</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="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/AspectService.html#added()">added</a></strong></code> +<div class="block">The callback method to be invoked when the original service is available.</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/AspectService.html#changed()">changed</a></strong></code> +<div class="block">The callback method to be invoked when the original service properties have changed.</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/AspectService.html#factoryMethod()">factoryMethod</a></strong></code> +<div class="block">Sets the static method used to create the AspectService implementation instance.</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/AspectService.html#field()">field</a></strong></code> +<div class="block">Sets the field name where to inject the original service.</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/AspectService.html#filter()">filter</a></strong></code> +<div class="block">Sets the filter condition to use with the service interface this aspect is applying to.</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/AspectService.html#properties()">properties</a></strong></code> +<div class="block">Sets Additional properties to use with the aspect service registration</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/AspectService.html#removed()">removed</a></strong></code> +<div class="block">The callback method to invoke when the service is lost.</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/AspectService.html#service()">service</a></strong></code> +<div class="block">Sets the service interface to apply the aspect to.</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/AspectService.html#swap()">swap</a></strong></code> +<div class="block">name of the callback method to invoke on swap.</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="ranking()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>ranking</h4> +<pre>public abstract int ranking</pre> +<div class="block">Sets the ranking of this aspect. Since aspects are chained, the ranking defines the order in which they are chained. + Chain ranking is implemented as a service ranking so service lookups automatically retrieve the top of the + chain.</div> +</li> +</ul> +<a name="service()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>service</h4> +<pre>public abstract java.lang.Class<?> service</pre> +<div class="block">Sets the service interface to apply the aspect to. By default, the directly implemented interface is used.</div> +<dl> +<dt>Default:</dt> +<dd>java.lang.Object.class</dd> +</dl> +</li> +</ul> +<a name="filter()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>filter</h4> +<pre>public abstract java.lang.String filter</pre> +<div class="block">Sets the filter condition to use with the service interface this aspect is applying to.</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 Additional properties to use with the aspect service registration</div> +<dl> +<dt>Default:</dt> +<dd>{}</dd> +</dl> +</li> +</ul> +<a name="field()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>field</h4> +<pre>public abstract java.lang.String field</pre> +<div class="block">Sets the field name where to inject the original service. By default, the original service is injected + in any attributes in the aspect implementation that are of the same type as the aspect interface.</div> +<dl> +<dt>Default:</dt> +<dd>""</dd> +</dl> +</li> +</ul> +<a name="added()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>added</h4> +<pre>public abstract java.lang.String added</pre> +<div class="block">The callback method to be invoked when the original service is available. This attribute can't be mixed with + the field attribute.</div> +<dl> +<dt>Default:</dt> +<dd>""</dd> +</dl> +</li> +</ul> +<a name="changed()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>changed</h4> +<pre>public abstract java.lang.String changed</pre> +<div class="block">The callback method to be invoked when the original service properties have changed. When this attribute is used, + then the added attribute must also be used.</div> +<dl> +<dt>Default:</dt> +<dd>""</dd> +</dl> +</li> +</ul> +<a name="removed()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>removed</h4> +<pre>public abstract java.lang.String removed</pre> +<div class="block">The callback method to invoke when the service is lost. When this attribute is used, then the added attribute + must also be used.</div> +<dl> +<dt>Default:</dt> +<dd>""</dd> +</dl> +</li> +</ul> +<a name="swap()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>swap</h4> +<pre>public abstract java.lang.String swap</pre> +<div class="block">name of the callback method to invoke on swap.</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 AspectService implementation instance. The + default constructor of the annotated class is used. The factoryMethod can be used to provide a specific + aspect implements, like a DynamicProxy.</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/AdapterService.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/BundleAdapterService.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/AspectService.html" target="_top">Frames</a></li> +<li><a href="AspectService.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_required_element_summary">Required</a> | </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/dependencymanager.annotations/4.0.0/org/apache/felix/dm/annotation/api/BundleAdapterService.html ============================================================================== --- websites/staging/felix/trunk/content/apidocs/dependencymanager.annotations/4.0.0/org/apache/felix/dm/annotation/api/BundleAdapterService.html (added) +++ websites/staging/felix/trunk/content/apidocs/dependencymanager.annotations/4.0.0/org/apache/felix/dm/annotation/api/BundleAdapterService.html Fri Mar 6 22:25:31 2015 @@ -0,0 +1,345 @@ +<!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 Fri Mar 06 23:14:53 CET 2015 --> +<title>BundleAdapterService</title> +<meta name="date" content="2015-03-06"> +<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="BundleAdapterService"; + } +//--> +</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/AspectService.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/BundleDependency.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/BundleAdapterService.html" target="_top">Frames</a></li> +<li><a href="BundleAdapterService.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_required_element_summary">Required</a> | </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 BundleAdapterService" class="title">Annotation Type BundleAdapterService</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">BundleAdapterService</span></pre> +<div class="block">Annotates a bundle adapter service class. Bundle adapters are similar to <a href="../../../../../../org/apache/felix/dm/annotation/api/AdapterService.html" title="annotation in org.apache.felix.dm.annotation.api"><code>AdapterService</code></a>, + but instead of adapting a service, they adapt a bundle with a certain set of states (STARTED|INSTALLED|...), + and provide a service on top of it. <p> + The bundle adapter will be applied to any bundle that matches the specified bundle state mask and + filter conditions, which may match some of the bundle OSGi manifest headers. For each matching + bundle an adapter will be created based on the adapter implementation class. The adapter will be + registered with the specified interface and with service properties found from the original bundle + OSGi manifest headers plus any extra properties you supply here. + If you declare the original bundle as a member it will be injected. + + <h3>Usage Examples</h3> + + <p> In the following example, a "VideoPlayer" Service is registered into the OSGi registry each time + an active bundle containing a "Video-Path" manifest header is detected: + <p> + <blockquote> + <pre> + @BundleAdapterService(filter = "(Video-Path=*)", stateMask = Bundle.ACTIVE, propagate=true) + public class VideoPlayerImpl implements VideoPlayer { + Bundle bundle; // Injected by reflection + + void play() { + URL mpegFile = bundle.getEntry(bundle.getHeaders().get("Video-Path")); + // play the video provided by the bundle ... + } + + void stop() {} + } + </pre> + </blockquote></div> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- =========== ANNOTATION TYPE REQUIRED MEMBER SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="annotation_type_required_element_summary"> +<!-- --> +</a> +<h3>Required Element Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Required Element Summary table, listing required elements, and an explanation"> +<caption><span>Required Elements</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Required 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/BundleAdapterService.html#filter()">filter</a></strong></code> +<div class="block">The filter used to match a given bundle.</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="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/BundleAdapterService.html#factoryMethod()">factoryMethod</a></strong></code> +<div class="block">Sets the static method used to create the BundleAdapterService implementation instance.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../../../org/apache/felix/dm/annotation/api/BundleAdapterService.html#propagate()">propagate</a></strong></code> +<div class="block">Specifies if manifest headers from the bundle should be propagated to the service properties.</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/BundleAdapterService.html#properties()">properties</a></strong></code> +<div class="block">Additional properties to use with the service registration</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/BundleAdapterService.html#provides()">provides</a></strong></code> +<div class="block">The interface(s) to use when registering adapters.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../../../org/apache/felix/dm/annotation/api/BundleAdapterService.html#stateMask()">stateMask</a></strong></code> +<div class="block">the bundle state mask to apply</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="filter()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>filter</h4> +<pre>public abstract java.lang.String filter</pre> +<div class="block">The filter used to match a given bundle.</div> +</li> +</ul> +<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, the interface(s) directly implemented + by the annotated class is (are) used.</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">Additional properties to use with the service registration</div> +<dl> +<dt>Default:</dt> +<dd>{}</dd> +</dl> +</li> +</ul> +<a name="stateMask()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>stateMask</h4> +<pre>public abstract int stateMask</pre> +<div class="block">the bundle state mask to apply</div> +<dl> +<dt>Default:</dt> +<dd>38</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">Specifies if manifest headers from the bundle should be propagated to the service properties.</div> +<dl> +<dt>Default:</dt> +<dd>true</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 BundleAdapterService 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/AspectService.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/BundleDependency.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/BundleAdapterService.html" target="_top">Frames</a></li> +<li><a href="BundleAdapterService.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_required_element_summary">Required</a> | </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/dependencymanager.annotations/4.0.0/org/apache/felix/dm/annotation/api/BundleDependency.html ============================================================================== --- websites/staging/felix/trunk/content/apidocs/dependencymanager.annotations/4.0.0/org/apache/felix/dm/annotation/api/BundleDependency.html (added) +++ websites/staging/felix/trunk/content/apidocs/dependencymanager.annotations/4.0.0/org/apache/felix/dm/annotation/api/BundleDependency.html Fri Mar 6 22:25:31 2015 @@ -0,0 +1,361 @@ +<!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 Fri Mar 06 23:14:53 CET 2015 --> +<title>BundleDependency</title> +<meta name="date" content="2015-03-06"> +<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="BundleDependency"; + } +//--> +</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/BundleAdapterService.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/Component.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/BundleDependency.html" target="_top">Frames</a></li> +<li><a href="BundleDependency.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 BundleDependency" class="title">Annotation Type BundleDependency</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">BundleDependency</span></pre> +<div class="block">Annotates a class or method for a bundle dependency. A bundle dependency allows you to + depend on a bundle in a certain set of states (INSTALLED|RESOLVED|STARTED|...), as + indicated by a state mask. You can also use a filter condition that is matched against + all manifest entries. When applied on a class field, optional unavailable dependencies + are injected with a NullObject. + + <h3>Usage Examples</h3> + + <p> In the following example, the "SCR" Component allows to track + all bundles containing a specific "Service-Component" OSGi header, in order to load + and manage all Declarative Service components specified in the SCR xml documents referenced by the header: + <p> + <blockquote> + <pre> + @Component + public class SCR { + @BundleDependency(required = false, + removed = "unloadServiceComponents", + filter = "(Service-Component=*)" + stateMask = Bundle.ACTIVE) + void loadServiceComponents(Bundle b) { + String descriptorPaths = (String) b.getHeaders().get("Service-Component"); + // load all service component specified in the XML descriptorPaths files ... + } + + void unloadServiceComponents(Bundle b) { + // unload all service component we loaded from our "loadServiceComponents" method. + } + } + </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/BundleDependency.html#changed()">changed</a></strong></code> +<div class="block">Returns the callback method to be invoked when the service have changed.</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/BundleDependency.html#filter()">filter</a></strong></code> +<div class="block">Returns the filter 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/BundleDependency.html#name()">name</a></strong></code> +<div class="block">The name used when dynamically configuring this dependency from the init method.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../../../org/apache/felix/dm/annotation/api/BundleDependency.html#propagate()">propagate</a></strong></code> +<div class="block">Specifies if the manifest headers from the bundle should be propagated to + the service properties.</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/BundleDependency.html#removed()">removed</a></strong></code> +<div class="block">Returns the callback method to invoke when the service is lost.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../../../org/apache/felix/dm/annotation/api/BundleDependency.html#required()">required</a></strong></code> +<div class="block">Returns whether the dependency is required or not.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../../../org/apache/felix/dm/annotation/api/BundleDependency.html#stateMask()">stateMask</a></strong></code> +<div class="block">Returns the bundle state mask</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="changed()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>changed</h4> +<pre>public abstract java.lang.String changed</pre> +<div class="block">Returns the callback method to be invoked when the service have changed.</div> +<dl> +<dt>Default:</dt> +<dd>""</dd> +</dl> +</li> +</ul> +<a name="removed()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>removed</h4> +<pre>public abstract java.lang.String removed</pre> +<div class="block">Returns the callback method to invoke when the service is lost.</div> +<dl> +<dt>Default:</dt> +<dd>""</dd> +</dl> +</li> +</ul> +<a name="required()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>required</h4> +<pre>public abstract boolean required</pre> +<div class="block">Returns whether the dependency is required or not.</div> +<dl> +<dt>Default:</dt> +<dd>true</dd> +</dl> +</li> +</ul> +<a name="filter()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>filter</h4> +<pre>public abstract java.lang.String filter</pre> +<div class="block">Returns the filter dependency</div> +<dl> +<dt>Default:</dt> +<dd>""</dd> +</dl> +</li> +</ul> +<a name="stateMask()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>stateMask</h4> +<pre>public abstract int stateMask</pre> +<div class="block">Returns the bundle state mask</div> +<dl> +<dt>Default:</dt> +<dd>38</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">Specifies if the manifest headers from the bundle should be propagated to + the service properties.</div> +<dl> +<dt>Default:</dt> +<dd>false</dd> +</dl> +</li> +</ul> +<a name="name()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>name</h4> +<pre>public abstract java.lang.String name</pre> +<div class="block">The name used when dynamically configuring this dependency from the init method. + Specifying this attribute allows to dynamically configure the dependency + <code>filter</code> and <code>required</code> flag from the Service's init method. + All unnamed dependencies will be injected before the init() method; so from the init() method, you can + then pick up whatever information needed from already injected (unnamed) dependencies, and configure dynamically + your named dependencies, which will then be calculated once the init() method returns.</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/BundleAdapterService.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/Component.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/BundleDependency.html" target="_top">Frames</a></li> +<li><a href="BundleDependency.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/dependencymanager.annotations/4.0.0/org/apache/felix/dm/annotation/api/Component.html ============================================================================== --- websites/staging/felix/trunk/content/apidocs/dependencymanager.annotations/4.0.0/org/apache/felix/dm/annotation/api/Component.html (added) +++ websites/staging/felix/trunk/content/apidocs/dependencymanager.annotations/4.0.0/org/apache/felix/dm/annotation/api/Component.html Fri Mar 6 22:25:31 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 Fri Mar 06 23:14:53 CET 2015 --> +<title>Component</title> +<meta name="date" content="2015-03-06"> +<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/dependencymanager.annotations/4.0.0/org/apache/felix/dm/annotation/api/Composition.html ============================================================================== --- websites/staging/felix/trunk/content/apidocs/dependencymanager.annotations/4.0.0/org/apache/felix/dm/annotation/api/Composition.html (added) +++ websites/staging/felix/trunk/content/apidocs/dependencymanager.annotations/4.0.0/org/apache/felix/dm/annotation/api/Composition.html Fri Mar 6 22:25:31 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 Fri Mar 06 23:14:53 CET 2015 --> +<title>Composition</title> +<meta name="date" content="2015-03-06"> +<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>
