You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@felix.apache.org by pd...@apache.org on 2018/09/30 22:15:02 UTC
svn commit: r1842416 [2/5] - in
/felix/site/trunk/content/apidocs/dependencymanager.annotations/r12: ./
org/ org/apache/ org/apache/felix/ org/apache/felix/dm/
org/apache/felix/dm/annotation/ org/apache/felix/dm/annotation/api/
Added: felix/site/trunk/content/apidocs/dependencymanager.annotations/r12/org/apache/felix/dm/annotation/api/AspectService.html
URL: http://svn.apache.org/viewvc/felix/site/trunk/content/apidocs/dependencymanager.annotations/r12/org/apache/felix/dm/annotation/api/AspectService.html?rev=1842416&view=auto
==============================================================================
--- felix/site/trunk/content/apidocs/dependencymanager.annotations/r12/org/apache/felix/dm/annotation/api/AspectService.html (added)
+++ felix/site/trunk/content/apidocs/dependencymanager.annotations/r12/org/apache/felix/dm/annotation/api/AspectService.html Sun Sep 30 22:15:02 2018
@@ -0,0 +1,576 @@
+<!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_172) on Mon Oct 01 00:11:48 CEST 2018 -->
+<title>AspectService</title>
+<meta name="date" content="2018-10-01">
+<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="AspectService";
+ }
+ }
+ 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/AdapterService.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/BundleAdapterService.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/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>Field | </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>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 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="memberNameLabel">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. If you declare the original service as a member it will be injected.
+
+ <p> For "add", "change", "remove" callbacks, the following method signatures are supported:
+
+ <pre><code>
+ (Component comp, ServiceReference ref, Service service)
+ (Component comp, ServiceReference ref, Object service)
+ (Component comp, ServiceReference ref)
+ (Component comp, Service service)
+ (Component comp, Object service)
+ (Component comp)
+ (Component comp, Map properties, Service service)
+ (ServiceReference ref, Service service)
+ (ServiceReference ref, Object service)
+ (ServiceReference ref)
+ (Service service)
+ (Service service, Map propeerties)
+ (Map properties, Service, service)
+ (Service service, Dictionary properties)
+ (Dictionary properties, Service service)
+ (Object service)
+ </code></pre>
+
+ <p> For "swap" callbacks, the following method signatures are supported:
+
+ <pre><code>
+ (Service old, Service replace)
+ (Object old, Object replace)
+ (ServiceReference old, Service old, ServiceReference replace, Service replace)
+ (ServiceReference old, Object old, ServiceReference replace, Object replace)
+ (Component comp, Service old, Service replace)
+ (Component comp, Object old, Object replace)
+ (Component comp, ServiceReference old, Service old, ServiceReference replace, Service replace)
+ (Component comp, ServiceReference old, Object old, ServiceReference replace, Object replace)
+ (ServiceReference old, ServiceReference replace)
+ (Component comp, ServiceReference old, ServiceReference replace)
+ </code></pre>
+
+ <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:
+ <blockquote>
+ <pre>
+
+ @AspectService(ranking=10))
+ class AspectService implements InterceptedService {
+ // The service we are intercepting (injected by reflection)
+ volatile 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="memberSummary" 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><span class="memberNameLink"><a href="../../../../../../org/apache/felix/dm/annotation/api/AspectService.html#ranking--">ranking</a></span></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="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/AspectService.html#added--">added</a></span></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><span class="memberNameLink"><a href="../../../../../../org/apache/felix/dm/annotation/api/AspectService.html#changed--">changed</a></span></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><span class="memberNameLink"><a href="../../../../../../org/apache/felix/dm/annotation/api/AspectService.html#factoryMethod--">factoryMethod</a></span></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><span class="memberNameLink"><a href="../../../../../../org/apache/felix/dm/annotation/api/AspectService.html#field--">field</a></span></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><span class="memberNameLink"><a href="../../../../../../org/apache/felix/dm/annotation/api/AspectService.html#filter--">filter</a></span></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><span class="memberNameLink"><a href="../../../../../../org/apache/felix/dm/annotation/api/AspectService.html#properties--">properties</a></span></code>
+<div class="block"><span class="deprecatedLabel">Deprecated.</span>
+<div class="block"><span class="deprecationComment">you can apply <a href="../../../../../../org/apache/felix/dm/annotation/api/Property.html" title="annotation in org.apache.felix.dm.annotation.api"><code>Property</code></a> annotation directly on the component class.</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/AspectService.html#removed--">removed</a></span></code>
+<div class="block">The callback method to invoke when the service is lost.</div>
+</td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><code><a href="../../../../../../org/apache/felix/dm/annotation/api/ServiceScope.html" title="enum in org.apache.felix.dm.annotation.api">ServiceScope</a></code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/felix/dm/annotation/api/AspectService.html#scope--">scope</a></span></code>
+<div class="block">The service scope for the service of this Component.</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/AspectService.html#service--">service</a></span></code>
+<div class="block">Sets the service interface to apply the aspect to.</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/AspectService.html#swap--">swap</a></span></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>
+<dl>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>the aspect service rank</dd>
+</dl>
+</li>
+</ul>
+</li>
+</ul>
+<!-- ============ ANNOTATION TYPE MEMBER DETAIL =========== -->
+<ul class="blockList">
+<li class="blockList"><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><span class="returnLabel">Returns:</span></dt>
+<dd>the service aspect</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="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><span class="returnLabel">Returns:</span></dt>
+<dd>the service aspect filter</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"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">you can apply <a href="../../../../../../org/apache/felix/dm/annotation/api/Property.html" title="annotation in org.apache.felix.dm.annotation.api"><code>Property</code></a> annotation directly on the component class.</span></div>
+<div class="block">Sets Additional properties to use with the aspect service registration</div>
+<dl>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>the aspect service properties.</dd>
+</dl>
+<dl>
+<dt>Default:</dt>
+<dd>{}</dd>
+</dl>
+</li>
+</ul>
+</li>
+</ul>
+<ul class="blockList">
+<li class="blockList"><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 of the aspect implementation that are of the same type as the aspect interface.</div>
+<dl>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>the field used to inject the original service</dd>
+</dl>
+<dl>
+<dt>Default:</dt>
+<dd>""</dd>
+</dl>
+</li>
+</ul>
+</li>
+</ul>
+<ul class="blockList">
+<li class="blockList"><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><span class="returnLabel">Returns:</span></dt>
+<dd>the add callback</dd>
+</dl>
+<dl>
+<dt>Default:</dt>
+<dd>""</dd>
+</dl>
+</li>
+</ul>
+</li>
+</ul>
+<ul class="blockList">
+<li class="blockList"><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><span class="returnLabel">Returns:</span></dt>
+<dd>the changed callback</dd>
+</dl>
+<dl>
+<dt>Default:</dt>
+<dd>""</dd>
+</dl>
+</li>
+</ul>
+</li>
+</ul>
+<ul class="blockList">
+<li class="blockList"><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><span class="returnLabel">Returns:</span></dt>
+<dd>the remove callback</dd>
+</dl>
+<dl>
+<dt>Default:</dt>
+<dd>""</dd>
+</dl>
+</li>
+</ul>
+</li>
+</ul>
+<ul class="blockList">
+<li class="blockList"><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><span class="returnLabel">Returns:</span></dt>
+<dd>the swap callback</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="blockList">
+<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><span class="returnLabel">Returns:</span></dt>
+<dd>the aspect service factory method</dd>
+</dl>
+<dl>
+<dt>Default:</dt>
+<dd>""</dd>
+</dl>
+</li>
+</ul>
+</li>
+</ul>
+<ul class="blockList">
+<li class="blockList"><a name="scope--">
+<!-- -->
+</a>
+<ul class="blockListLast">
+<li class="blockList">
+<h4>scope</h4>
+<pre>public abstract <a href="../../../../../../org/apache/felix/dm/annotation/api/ServiceScope.html" title="enum in org.apache.felix.dm.annotation.api">ServiceScope</a> scope</pre>
+<div class="block">The service scope for the service of this Component.
+
+ <p>
+ If not specified, the <a href="../../../../../../org/apache/felix/dm/annotation/api/ServiceScope.html#SINGLETON"><code>singleton</code></a> service
+ scope is used.</div>
+<dl>
+<dt>Default:</dt>
+<dd>org.apache.felix.dm.annotation.api.ServiceScope.SINGLETON</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/AdapterService.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/BundleAdapterService.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/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>Field | </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>Field | </li>
+<li><a href="#annotation.type.element.detail">Element</a></li>
+</ul>
+</div>
+<a name="skip.navbar.bottom">
+<!-- -->
+</a></div>
+<!-- ======== END OF BOTTOM NAVBAR ======= -->
+</body>
+</html>
Added: felix/site/trunk/content/apidocs/dependencymanager.annotations/r12/org/apache/felix/dm/annotation/api/BundleAdapterService.html
URL: http://svn.apache.org/viewvc/felix/site/trunk/content/apidocs/dependencymanager.annotations/r12/org/apache/felix/dm/annotation/api/BundleAdapterService.html?rev=1842416&view=auto
==============================================================================
--- felix/site/trunk/content/apidocs/dependencymanager.annotations/r12/org/apache/felix/dm/annotation/api/BundleAdapterService.html (added)
+++ felix/site/trunk/content/apidocs/dependencymanager.annotations/r12/org/apache/felix/dm/annotation/api/BundleAdapterService.html Sun Sep 30 22:15:02 2018
@@ -0,0 +1,427 @@
+<!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_172) on Mon Oct 01 00:11:48 CEST 2018 -->
+<title>BundleAdapterService</title>
+<meta name="date" content="2018-10-01">
+<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="BundleAdapterService";
+ }
+ }
+ 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/AspectService.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/BundleDependency.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/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>Field | </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>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 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="memberNameLabel">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:
+
+ <blockquote>
+ <pre>
+ @BundleAdapterService(filter = "(Video-Path=*)", stateMask = Bundle.ACTIVE, propagate=true)
+ public class VideoPlayerImpl implements VideoPlayer {
+ volatile Bundle bundle; // Injected by reflection
+
+ void play() {
+ URL mpegFile = bundle.getEntry(bundle.getHeaders().get("Video-Path"));
+ // play the video provided by the bundle ...
+ }
+ }
+ </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="memberSummary" 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><span class="memberNameLink"><a href="../../../../../../org/apache/felix/dm/annotation/api/BundleAdapterService.html#filter--">filter</a></span></code>
+<div class="block">The ldap filter used to match some manifest headers of the adapted 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="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/BundleAdapterService.html#factoryMethod--">factoryMethod</a></span></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><span class="memberNameLink"><a href="../../../../../../org/apache/felix/dm/annotation/api/BundleAdapterService.html#propagate--">propagate</a></span></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><span class="memberNameLink"><a href="../../../../../../org/apache/felix/dm/annotation/api/BundleAdapterService.html#properties--">properties</a></span></code>
+<div class="block"><span class="deprecatedLabel">Deprecated.</span>
+<div class="block"><span class="deprecationComment">you can apply <a href="../../../../../../org/apache/felix/dm/annotation/api/Property.html" title="annotation in org.apache.felix.dm.annotation.api"><code>Property</code></a> annotation directly on the component class.</span></div>
+</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/BundleAdapterService.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><a href="../../../../../../org/apache/felix/dm/annotation/api/ServiceScope.html" title="enum in org.apache.felix.dm.annotation.api">ServiceScope</a></code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/felix/dm/annotation/api/BundleAdapterService.html#scope--">scope</a></span></code>
+<div class="block">The service scope for the service of this Component.</div>
+</td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><code>int</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/felix/dm/annotation/api/BundleAdapterService.html#stateMask--">stateMask</a></span></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 ldap filter used to match some manifest headers of the adapted bundle.</div>
+<dl>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>the bundle adapter filter</dd>
+</dl>
+</li>
+</ul>
+</li>
+</ul>
+<!-- ============ ANNOTATION TYPE MEMBER DETAIL =========== -->
+<ul class="blockList">
+<li class="blockList"><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><span class="returnLabel">Returns:</span></dt>
+<dd>the interface(s) to use when registering adapters</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"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">you can apply <a href="../../../../../../org/apache/felix/dm/annotation/api/Property.html" title="annotation in org.apache.felix.dm.annotation.api"><code>Property</code></a> annotation directly on the component class.</span></div>
+<div class="block">Additional properties to use with the service registration</div>
+<dl>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>the bundle adapter properties</dd>
+</dl>
+<dl>
+<dt>Default:</dt>
+<dd>{}</dd>
+</dl>
+</li>
+</ul>
+</li>
+</ul>
+<ul class="blockList">
+<li class="blockList"><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><span class="returnLabel">Returns:</span></dt>
+<dd>the bundle state mask to apply</dd>
+</dl>
+<dl>
+<dt>Default:</dt>
+<dd><error></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">Specifies if manifest headers from the bundle should be propagated to the service properties.
+ The component service properties take precedence over the propagated bundle manifest headers.</div>
+<dl>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>the propagation flag</dd>
+</dl>
+<dl>
+<dt>Default:</dt>
+<dd>true</dd>
+</dl>
+</li>
+</ul>
+</li>
+</ul>
+<ul class="blockList">
+<li class="blockList"><a name="factoryMethod--">
+<!-- -->
+</a>
+<ul class="blockList">
+<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><span class="returnLabel">Returns:</span></dt>
+<dd>the factory method</dd>
+</dl>
+<dl>
+<dt>Default:</dt>
+<dd>""</dd>
+</dl>
+</li>
+</ul>
+</li>
+</ul>
+<ul class="blockList">
+<li class="blockList"><a name="scope--">
+<!-- -->
+</a>
+<ul class="blockListLast">
+<li class="blockList">
+<h4>scope</h4>
+<pre>public abstract <a href="../../../../../../org/apache/felix/dm/annotation/api/ServiceScope.html" title="enum in org.apache.felix.dm.annotation.api">ServiceScope</a> scope</pre>
+<div class="block">The service scope for the service of this Component.
+
+ <p>
+ If not specified, the <a href="../../../../../../org/apache/felix/dm/annotation/api/ServiceScope.html#SINGLETON"><code>singleton</code></a> service
+ scope is used.</div>
+<dl>
+<dt>Default:</dt>
+<dd>org.apache.felix.dm.annotation.api.ServiceScope.SINGLETON</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/AspectService.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/BundleDependency.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/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>Field | </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>Field | </li>
+<li><a href="#annotation.type.element.detail">Element</a></li>
+</ul>
+</div>
+<a name="skip.navbar.bottom">
+<!-- -->
+</a></div>
+<!-- ======== END OF BOTTOM NAVBAR ======= -->
+</body>
+</html>
Added: felix/site/trunk/content/apidocs/dependencymanager.annotations/r12/org/apache/felix/dm/annotation/api/BundleDependency.html
URL: http://svn.apache.org/viewvc/felix/site/trunk/content/apidocs/dependencymanager.annotations/r12/org/apache/felix/dm/annotation/api/BundleDependency.html?rev=1842416&view=auto
==============================================================================
--- felix/site/trunk/content/apidocs/dependencymanager.annotations/r12/org/apache/felix/dm/annotation/api/BundleDependency.html (added)
+++ felix/site/trunk/content/apidocs/dependencymanager.annotations/r12/org/apache/felix/dm/annotation/api/BundleDependency.html Sun Sep 30 22:15:02 2018
@@ -0,0 +1,419 @@
+<!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_172) on Mon Oct 01 00:11:48 CEST 2018 -->
+<title>BundleDependency</title>
+<meta name="date" content="2018-10-01">
+<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="BundleDependency";
+ }
+ }
+ 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/BundleAdapterService.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/Component.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/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>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 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="memberNameLabel">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:
+
+ <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="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/BundleDependency.html#changed--">changed</a></span></code>
+<div class="block">Returns the callback method to be invoked when the bundle have been updated</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/BundleDependency.html#filter--">filter</a></span></code>
+<div class="block">Returns the ldap filter dependency matching some bundle manifest headers</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/BundleDependency.html#name--">name</a></span></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><span class="memberNameLink"><a href="../../../../../../org/apache/felix/dm/annotation/api/BundleDependency.html#propagate--">propagate</a></span></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><span class="memberNameLink"><a href="../../../../../../org/apache/felix/dm/annotation/api/BundleDependency.html#removed--">removed</a></span></code>
+<div class="block">Returns the callback method to invoke when the bundle is lost.</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/BundleDependency.html#required--">required</a></span></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><span class="memberNameLink"><a href="../../../../../../org/apache/felix/dm/annotation/api/BundleDependency.html#stateMask--">stateMask</a></span></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 bundle have been updated</div>
+<dl>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>the change callback</dd>
+</dl>
+<dl>
+<dt>Default:</dt>
+<dd>""</dd>
+</dl>
+</li>
+</ul>
+</li>
+</ul>
+<ul class="blockList">
+<li class="blockList"><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 bundle is lost.</div>
+<dl>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>the remove callback</dd>
+</dl>
+<dl>
+<dt>Default:</dt>
+<dd>""</dd>
+</dl>
+</li>
+</ul>
+</li>
+</ul>
+<ul class="blockList">
+<li class="blockList"><a name="required--">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>required</h4>
+<pre>public abstract boolean required</pre>
+<div class="block">Returns whether the dependency is required or not.</div>
+<dl>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>the required flag</dd>
+</dl>
+<dl>
+<dt>Default:</dt>
+<dd>true</dd>
+</dl>
+</li>
+</ul>
+</li>
+</ul>
+<ul class="blockList">
+<li class="blockList"><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 ldap filter dependency matching some bundle manifest headers</div>
+<dl>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>the filter</dd>
+</dl>
+<dl>
+<dt>Default:</dt>
+<dd>""</dd>
+</dl>
+</li>
+</ul>
+</li>
+</ul>
+<ul class="blockList">
+<li class="blockList"><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><span class="returnLabel">Returns:</span></dt>
+<dd>the state mask</dd>
+</dl>
+<dl>
+<dt>Default:</dt>
+<dd><error></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">Specifies if the manifest headers from the bundle should be propagated to the service properties.
+ The provided service properties take precedence over the propagated bundle manifest headers.
+ It means a bundle manifest header won't override a component service property having the same name.</div>
+<dl>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>the propagation flag</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="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.
+
+ <p> See <a href="../../../../../../org/apache/felix/dm/annotation/api/Init.html" title="annotation in org.apache.felix.dm.annotation.api"><code>Init</code></a> annotation for an example usage of a dependency dynamically configured from the init method.</div>
+<dl>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>the dependency name used to dynamically configure the dependency from the init callback</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/BundleAdapterService.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/Component.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/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>Field | </li>
+<li>Required | </li>
+<li><a href="#annotation.type.optional.element.summary">Optional</a></li>
+</ul>
+<ul class="subNavList">
+<li>Detail: </li>
+<li>Field | </li>
+<li><a href="#annotation.type.element.detail">Element</a></li>
+</ul>
+</div>
+<a name="skip.navbar.bottom">
+<!-- -->
+</a></div>
+<!-- ======== END OF BOTTOM NAVBAR ======= -->
+</body>
+</html>
Added: felix/site/trunk/content/apidocs/dependencymanager.annotations/r12/org/apache/felix/dm/annotation/api/Component.html
URL: http://svn.apache.org/viewvc/felix/site/trunk/content/apidocs/dependencymanager.annotations/r12/org/apache/felix/dm/annotation/api/Component.html?rev=1842416&view=auto
==============================================================================
--- felix/site/trunk/content/apidocs/dependencymanager.annotations/r12/org/apache/felix/dm/annotation/api/Component.html (added)
+++ felix/site/trunk/content/apidocs/dependencymanager.annotations/r12/org/apache/felix/dm/annotation/api/Component.html Sun Sep 30 22:15:02 2018
@@ -0,0 +1,482 @@
+<!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_172) on Mon Oct 01 00:11:48 CEST 2018 -->
+<title>Component</title>
+<meta name="date" content="2018-10-01">
+<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>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 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>factoryPid</code> attribute is set, the component is not started automatically
+ during bundle startup, and the component can then be instantiated multiple times using
+ Configuration Admin "Factory Configurations".
+
+ <h3>Usage Examples</h3>
+
+ Here is a sample showing a Hello 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 Hello implements HelloService {
+ @ConfigurationDependency(pid="my.pid")
+ 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.
+ }
+ }
+ </pre>
+ </blockquote>
+
+ Here is a sample showing how a HelloFactory component may dynamically instantiate several Hello component instances,
+ using Configuration Admin "Factory Configurations":
+ <blockquote>
+
+ <pre>
+ /**
+ * All component instances will be created/updated/removed by the "HelloFactory" component
+ */
+ @Component(factoryPid="my.factory.pid")
+ class Hello implements HelloService {
+ void updated(Dictionary conf) {
+ // Configure or reconfigure our component. The conf is provided by the factory,
+ }
+
+ @Start
+ void start() {
+ // Our component is starting and is about to be registered in the OSGi registry as a Hello service.
+ }
+ }
+
+ /**
+ * This class will instantiate some Hello component instances
+ */
+ @Component
+ class HelloFactory {
+ @ServiceDependency
+ void bind(ConfigurationAdmin cm) {
+ // instantiate a first instance of Hello component
+ Configuration c1 = cm.createFactoryConfiguration("my.factory.pid", "?");
+ Hashtable props = new Hashtable();
+ newprops.put("key", "value1");
+ c1.update(props);
+
+ // instantiate another instance of Hello component
+ Configuration c2 = cm.createFactoryConfiguration("my.factory.pid", "?");
+ props = new Hashtable();
+ newprops.put("key", "value2");
+ c2.update(props);
+
+ // destroy the two instances of X component
+ c1.delete();
+ c2.delete();
+ }
+ }
+ </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.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="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#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>boolean</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/felix/dm/annotation/api/Component.html#propagate--">propagate</a></span></code>
+<div class="block">Returns true if the factory configuration properties must be published to the service properties.</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><span class="memberNameLink"><a href="../../../../../../org/apache/felix/dm/annotation/api/Component.html#properties--">properties</a></span></code>
+<div class="block"><span class="deprecatedLabel">Deprecated.</span>
+<div class="block"><span class="deprecationComment">you can apply <a href="../../../../../../org/apache/felix/dm/annotation/api/Property.html" title="annotation in org.apache.felix.dm.annotation.api"><code>Property</code></a> annotation directly on the component class.</span></div>
+</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/Component.html#provides--">provides</a></span></code>
+<div class="block">Sets list of provided interfaces.</div>
+</td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><code><a href="../../../../../../org/apache/felix/dm/annotation/api/ServiceScope.html" title="enum in org.apache.felix.dm.annotation.api">ServiceScope</a></code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/felix/dm/annotation/api/Component.html#scope--">scope</a></span></code>
+<div class="block">The service scope for the service of this Component.</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#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">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="factoryMethod--">
+<!-- -->
+</a>
+<ul class="blockList">
+<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>
+<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. Leaving this attribute
+ unset means your component is a singleton. If you specify a factory pid, then this component will be instantiated
+ each time a corresponding factory configuration is created.</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="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.
+ Only used if the factoryPid attribute is set.
+ The updated callback supported signatures are the following:<p>
+ <ul><li>callback(Dictionary)
+ <li>callback(Component, Dictionary)
+ <li>callback(Component, Configuration ... configTypes) // type safe configuration interface(s)
+ <li>callback(Configuration ... configTypes) // type safe configuration interface(s)
+ <li>callback(Dictionary, Configuration ... configTypes) // type safe configuration interfaces(s)
+ <li>callback(Component, Dictionary, Configuration ... configTypes) // type safe configuration interfaces(s)
+ </ul></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 factory configuration properties must be published to the service properties.
+ Only used if the factoryPid attribute is set.</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="scope--">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>scope</h4>
+<pre>public abstract <a href="../../../../../../org/apache/felix/dm/annotation/api/ServiceScope.html" title="enum in org.apache.felix.dm.annotation.api">ServiceScope</a> scope</pre>
+<div class="block">The service scope for the service of this Component.
+
+ <p>
+ If not specified, the <a href="../../../../../../org/apache/felix/dm/annotation/api/ServiceScope.html#SINGLETON"><code>singleton</code></a> service
+ scope is used.</div>
+<dl>
+<dt>Default:</dt>
+<dd>org.apache.felix.dm.annotation.api.ServiceScope.SINGLETON</dd>
+</dl>
+</li>
+</ul>
+</li>
+</ul>
+<ul class="blockList">
+<li class="blockList"><a name="properties--">
+<!-- -->
+</a>
+<ul class="blockListLast">
+<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"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">you can apply <a href="../../../../../../org/apache/felix/dm/annotation/api/Property.html" title="annotation in org.apache.felix.dm.annotation.api"><code>Property</code></a> annotation directly on the component class.</span></div>
+<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>
+</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>Field | </li>
+<li>Required | </li>
+<li><a href="#annotation.type.optional.element.summary">Optional</a></li>
+</ul>
+<ul class="subNavList">
+<li>Detail: </li>
+<li>Field | </li>
+<li><a href="#annotation.type.element.detail">Element</a></li>
+</ul>
+</div>
+<a name="skip.navbar.bottom">
+<!-- -->
+</a></div>
+<!-- ======== END OF BOTTOM NAVBAR ======= -->
+</body>
+</html>
Added: felix/site/trunk/content/apidocs/dependencymanager.annotations/r12/org/apache/felix/dm/annotation/api/Composition.html
URL: http://svn.apache.org/viewvc/felix/site/trunk/content/apidocs/dependencymanager.annotations/r12/org/apache/felix/dm/annotation/api/Composition.html?rev=1842416&view=auto
==============================================================================
--- felix/site/trunk/content/apidocs/dependencymanager.annotations/r12/org/apache/felix/dm/annotation/api/Composition.html (added)
+++ felix/site/trunk/content/apidocs/dependencymanager.annotations/r12/org/apache/felix/dm/annotation/api/Composition.html Sun Sep 30 22:15:02 2018
@@ -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_172) on Mon Oct 01 00:11:48 CEST 2018 -->
+<title>Composition</title>
+<meta name="date" content="2018-10-01">
+<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>, or <a href="../../../../../../org/apache/felix/dm/annotation/api/AdapterService.html" title="annotation in org.apache.felix.dm.annotation.api"><code>AdapterService</code></a>.
+
+ <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 {
+ volatile 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>