You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@felix.apache.org by bu...@apache.org on 2015/05/26 23:10:54 UTC
svn commit: r952772 [8/9] - in /websites/staging/felix/trunk/content: ./
apidocs/ apidocs/dmannotations/4.0.0/ apidocs/dmannotations/4.0.1/
apidocs/dmannotations/r1/ apidocs/dmannotations/r1/org/
apidocs/dmannotations/r1/org/apache/ apidocs/dmannotatio...
Added: websites/staging/felix/trunk/content/apidocs/dmannotations/r2/org/apache/felix/dm/annotation/api/LifecycleController.html
==============================================================================
--- websites/staging/felix/trunk/content/apidocs/dmannotations/r2/org/apache/felix/dm/annotation/api/LifecycleController.html (added)
+++ websites/staging/felix/trunk/content/apidocs/dmannotations/r2/org/apache/felix/dm/annotation/api/LifecycleController.html Tue May 26 21:10:52 2015
@@ -0,0 +1,260 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<!-- NewPage -->
+<html lang="en">
+<head>
+<!-- Generated by javadoc (version 1.7.0_67) on Tue Mar 24 21:21:23 CET 2015 -->
+<title>LifecycleController</title>
+<meta name="date" content="2015-03-24">
+<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
+</head>
+<body>
+<script type="text/javascript"><!--
+ if (location.href.indexOf('is-external=true') == -1) {
+ parent.document.title="LifecycleController";
+ }
+//-->
+</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/Inject.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/Property.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/LifecycleController.html" target="_top">Frames</a></li>
+<li><a href="LifecycleController.html" target="_top">No Frames</a></li>
+</ul>
+<ul class="navList" id="allclasses_navbar_top">
+<li><a href="../../../../../../allclasses-noframe.html">All Classes</a></li>
+</ul>
+<div>
+<script type="text/javascript"><!--
+ allClassesLink = document.getElementById("allclasses_navbar_top");
+ if(window==top) {
+ allClassesLink.style.display = "block";
+ }
+ else {
+ allClassesLink.style.display = "none";
+ }
+ //-->
+</script>
+</div>
+<div>
+<ul class="subNavList">
+<li>Summary: </li>
+<li>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 LifecycleController" class="title">Annotation Type LifecycleController</h2>
+</div>
+<div class="contentContainer">
+<div class="description">
+<ul class="blockList">
+<li class="blockList">
+<hr>
+<br>
+<pre>@Retention(value=CLASS)
+@Target(value=FIELD)
+public @interface <span class="strong">LifecycleController</span></pre>
+<div class="block">Injects a <code>Runnable</code> object in a Service for starting/stopping it programatically.
+ By default, a Service is implicitly started when the service's bundle is started and when
+ all required dependencies are satisfied. However, it is sometimes required to programatically
+ take control of when the service is started or stopped. In this case, the injected <code>Runnable</code>
+ can be invoked in order to start/register (or stop/unregister) a Service at any time. When this annotation
+ is used, then the Service on which this annotation is applied is not activated by default, and you have to
+ call the injected Runnable yourself.
+ <p>
+ <h3>Usage Examples</h3>
+ <blockquote>
+
+ <pre>
+ /**
+ * This Service will be registered programatically into the OSGi registry, using the LifecycleController annotation.
+ */
+ @Service
+ class X implements Z {
+ @LifecycleController
+ Runnable starter
+
+ @LifecycleController(start=false)
+ Runnable stopper
+
+ @Init
+ void init() {
+ // At this point, all required dependencies are there, but we'll activate our service in 2 seconds ...
+ Thread t = new Thread() {
+ public void run() {
+ sleep(2000);
+ // start our "Z" service (our "start" method will be called, juste before service registration
+ starter.run();
+
+ sleep(2000);
+ // now, stop/unregister the "Z" service (we'll then be called in our stop() method
+ stopper.run();
+ }
+ };
+ t.start();
+ }
+
+ @Start
+ public void start() {
+ // This method will be called after we invoke our starter Runnable, and our service will be
+ // published after our method returns, as in normal case.
+ }
+
+ @Stop
+ public void stop() {
+ // This method will be called after we invoke our "stop" Runnable, and our service will be
+ // unregistered before our method is invoked, as in normal case. Notice that the service won't
+ // be destroyed here, and the "starter" runnable can be re-invoked later.
+ }
+ }
+ </pre>
+ </blockquote></div>
+</li>
+</ul>
+</div>
+<div class="summary">
+<ul class="blockList">
+<li class="blockList">
+<!-- =========== ANNOTATION TYPE OPTIONAL MEMBER SUMMARY =========== -->
+<ul class="blockList">
+<li class="blockList"><a name="annotation_type_optional_element_summary">
+<!-- -->
+</a>
+<h3>Optional Element Summary</h3>
+<table class="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>boolean</code></td>
+<td class="colLast"><code><strong><a href="../../../../../../org/apache/felix/dm/annotation/api/LifecycleController.html#start()">start</a></strong></code>
+<div class="block">Specifies the action to be performed when the Injected runnable is invoked.</div>
+</td>
+</tr>
+</table>
+</li>
+</ul>
+</li>
+</ul>
+</div>
+<div class="details">
+<ul class="blockList">
+<li class="blockList">
+<!-- ============ ANNOTATION TYPE MEMBER DETAIL =========== -->
+<ul class="blockList">
+<li class="blockList"><a name="annotation_type_element_detail">
+<!-- -->
+</a>
+<h3>Element Detail</h3>
+<a name="start()">
+<!-- -->
+</a>
+<ul class="blockListLast">
+<li class="blockList">
+<h4>start</h4>
+<pre>public abstract boolean start</pre>
+<div class="block">Specifies the action to be performed when the Injected runnable is invoked. By default, the
+ Runnable will fire a Service Component activation, when invoked. If you specify this attribute
+ to false, then the Service Component will be stopped, when the runnable is invoked.</div>
+<dl>
+<dt>Default:</dt>
+<dd>true</dd>
+</dl>
+</li>
+</ul>
+</li>
+</ul>
+</li>
+</ul>
+</div>
+</div>
+<!-- ========= END OF CLASS DATA ========= -->
+<!-- ======= START OF BOTTOM NAVBAR ====== -->
+<div class="bottomNav"><a name="navbar_bottom">
+<!-- -->
+</a><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/Inject.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/Property.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/LifecycleController.html" target="_top">Frames</a></li>
+<li><a href="LifecycleController.html" target="_top">No Frames</a></li>
+</ul>
+<ul class="navList" id="allclasses_navbar_bottom">
+<li><a href="../../../../../../allclasses-noframe.html">All Classes</a></li>
+</ul>
+<div>
+<script type="text/javascript"><!--
+ allClassesLink = document.getElementById("allclasses_navbar_bottom");
+ if(window==top) {
+ allClassesLink.style.display = "block";
+ }
+ else {
+ allClassesLink.style.display = "none";
+ }
+ //-->
+</script>
+</div>
+<div>
+<ul class="subNavList">
+<li>Summary: </li>
+<li>Required | </li>
+<li><a href="#annotation_type_optional_element_summary">Optional</a></li>
+</ul>
+<ul class="subNavList">
+<li>Detail: </li>
+<li><a href="#annotation_type_element_detail">Element</a></li>
+</ul>
+</div>
+<a name="skip-navbar_bottom">
+<!-- -->
+</a></div>
+<!-- ======== END OF BOTTOM NAVBAR ======= -->
+</body>
+</html>
Added: websites/staging/felix/trunk/content/apidocs/dmannotations/r2/org/apache/felix/dm/annotation/api/Property.html
==============================================================================
--- websites/staging/felix/trunk/content/apidocs/dmannotations/r2/org/apache/felix/dm/annotation/api/Property.html (added)
+++ websites/staging/felix/trunk/content/apidocs/dmannotations/r2/org/apache/felix/dm/annotation/api/Property.html Tue May 26 21:10:52 2015
@@ -0,0 +1,487 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<!-- NewPage -->
+<html lang="en">
+<head>
+<!-- Generated by javadoc (version 1.7.0_67) on Tue Mar 24 21:21:23 CET 2015 -->
+<title>Property</title>
+<meta name="date" content="2015-03-24">
+<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
+</head>
+<body>
+<script type="text/javascript"><!--
+ if (location.href.indexOf('is-external=true') == -1) {
+ parent.document.title="Property";
+ }
+//-->
+</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/LifecycleController.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/PropertyMetaData.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/Property.html" target="_top">Frames</a></li>
+<li><a href="Property.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 Property" class="title">Annotation Type Property</h2>
+</div>
+<div class="contentContainer">
+<div class="description">
+<ul class="blockList">
+<li class="blockList">
+<hr>
+<br>
+<pre>@Retention(value=CLASS)
+@Target(value=ANNOTATION_TYPE)
+public @interface <span class="strong">Property</span></pre>
+<div class="block">Annotation used to describe a property key-value(s) pair. It is used for example when
+ declaring <a href="../../../../../../org/apache/felix/dm/annotation/api/Component.html#properties()"><code>Component.properties()</code></a> attribute.<p>
+
+ Property value(s) type is String by default, and the type is scalar if the value is single-valued,
+ or an array if the value is multi-valued.
+
+ Eight primitive types are supported:<p>
+ <ul>
+ <li> String (default type)
+ <li> Long
+ <li> Double
+ <li> Float
+ <li> Integer
+ <li> Byte
+ <li> Boolean
+ <li> Short
+ </ul>
+
+ You can specify the type of a property either using a combination of <code>value</code> and <code>type</code> attributes,
+ or using one of the <code>longValue/doubleValue/floatValue/intValue/byteValue/charValue/booleanValue/shortValue</code> attributes.
+
+ Notice that you can also specify service properties dynamically by returning a Map from a method
+ annotated with <a href="../../../../../../org/apache/felix/dm/annotation/api/Start.html" title="annotation in org.apache.felix.dm.annotation.api"><code>Start</code></a>.
+
+ <p>
+ <h3>Usage Examples</h3>
+ <blockquote>
+
+ <pre>
+ @Component(properties={
+ @Property(name="p1", value="v")}) // String value type (scalar)
+ @Property(name="p2", value={"s1", "s2")}) // Array of Strings
+ @Property(name="service.ranking", intValue=10) // Integer value type (scalar)
+ @Property(name="p3", intValue={1,2}) // Array of Integers
+ @Property(name="p3", value={"1"), type=Long.class}) // Long value (scalar)
+ class ServiceImpl implements Service {
+ }
+ </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/Property.html#name()">name</a></strong></code>
+<div class="block">Returns the property name.</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>boolean[]</code></td>
+<td class="colLast"><code><strong><a href="../../../../../../org/apache/felix/dm/annotation/api/Property.html#booleanValue()">booleanValue</a></strong></code>
+<div class="block">A Boolean value or an array of Boolean values.</div>
+</td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><code>byte[]</code></td>
+<td class="colLast"><code><strong><a href="../../../../../../org/apache/felix/dm/annotation/api/Property.html#byteValue()">byteValue</a></strong></code>
+<div class="block">A Byte value or an array of Byte values.</div>
+</td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code>char[]</code></td>
+<td class="colLast"><code><strong><a href="../../../../../../org/apache/felix/dm/annotation/api/Property.html#charValue()">charValue</a></strong></code>
+<div class="block">A Character value or an array of Character values.</div>
+</td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><code>double[]</code></td>
+<td class="colLast"><code><strong><a href="../../../../../../org/apache/felix/dm/annotation/api/Property.html#doubleValue()">doubleValue</a></strong></code>
+<div class="block">A Double value or an array of Double values.</div>
+</td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code>float[]</code></td>
+<td class="colLast"><code><strong><a href="../../../../../../org/apache/felix/dm/annotation/api/Property.html#floatValue()">floatValue</a></strong></code>
+<div class="block">A Float value or an array of Float values.</div>
+</td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><code>int[]</code></td>
+<td class="colLast"><code><strong><a href="../../../../../../org/apache/felix/dm/annotation/api/Property.html#intValue()">intValue</a></strong></code>
+<div class="block">An Integer value or an array of Integer values.</div>
+</td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code>long[]</code></td>
+<td class="colLast"><code><strong><a href="../../../../../../org/apache/felix/dm/annotation/api/Property.html#longValue()">longValue</a></strong></code>
+<div class="block">A Long value or an array of Long values.</div>
+</td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><code>short[]</code></td>
+<td class="colLast"><code><strong><a href="../../../../../../org/apache/felix/dm/annotation/api/Property.html#shortValue()">shortValue</a></strong></code>
+<div class="block">A Short value or an array of Short values.</div>
+</td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code>java.lang.Class<?></code></td>
+<td class="colLast"><code><strong><a href="../../../../../../org/apache/felix/dm/annotation/api/Property.html#type()">type</a></strong></code>
+<div class="block">Specifies how the <a href="../../../../../../org/apache/felix/dm/annotation/api/Property.html#value()"><code>value()</code></a> or <a href="../../../../../../org/apache/felix/dm/annotation/api/Property.html#values()"><code>values()</code></a> attributes are parsed.</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/Property.html#value()">value</a></strong></code>
+<div class="block">Returns the property value(s).</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/Property.html#values()">values</a></strong></code>
+<div class="block"><strong>Deprecated.</strong>
+<div class="block"><i>use <a href="../../../../../../org/apache/felix/dm/annotation/api/Property.html#value()"><code>value()</code></a> attribute.</i></div>
+</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="name()">
+<!-- -->
+</a>
+<ul class="blockListLast">
+<li class="blockList">
+<h4>name</h4>
+<pre>public abstract java.lang.String name</pre>
+<div class="block">Returns the property name.</div>
+<dl><dt><span class="strong">Returns:</span></dt><dd>this property name</dd></dl>
+</li>
+</ul>
+<a name="value()">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>value</h4>
+<pre>public abstract java.lang.String[] value</pre>
+<div class="block">Returns the property value(s). The property value(s) is (are)
+ parsed using the <code>valueOf</code> method of the class specified in the #type attribute
+ (which is <code>String</code> by default). When the property value is single-value, then
+ the value type is scalar (not an array). If the property value is multi-valued, then the value type
+ is an array of the type specified in the <a href="../../../../../../org/apache/felix/dm/annotation/api/Property.html#type()"><code>type()</code></a> attribute (String by default).</div>
+<dl><dt><span class="strong">Returns:</span></dt><dd>this property value(s).</dd></dl>
+<dl>
+<dt>Default:</dt>
+<dd>{}</dd>
+</dl>
+</li>
+</ul>
+<a name="type()">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>type</h4>
+<pre>public abstract java.lang.Class<?> type</pre>
+<div class="block">Specifies how the <a href="../../../../../../org/apache/felix/dm/annotation/api/Property.html#value()"><code>value()</code></a> or <a href="../../../../../../org/apache/felix/dm/annotation/api/Property.html#values()"><code>values()</code></a> attributes are parsed.</div>
+<dl><dt><span class="strong">Returns:</span></dt><dd>the property value type (String by default) used to parse <a href="../../../../../../org/apache/felix/dm/annotation/api/Property.html#value()"><code>value()</code></a> or <a href="../../../../../../org/apache/felix/dm/annotation/api/Property.html#values()"><code>values()</code></a>
+ attribtues</dd></dl>
+<dl>
+<dt>Default:</dt>
+<dd>java.lang.String.class</dd>
+</dl>
+</li>
+</ul>
+<a name="longValue()">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>longValue</h4>
+<pre>public abstract long[] longValue</pre>
+<div class="block">A Long value or an array of Long values.</div>
+<dl>
+<dt>Default:</dt>
+<dd>{}</dd>
+</dl>
+</li>
+</ul>
+<a name="doubleValue()">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>doubleValue</h4>
+<pre>public abstract double[] doubleValue</pre>
+<div class="block">A Double value or an array of Double values.</div>
+<dl>
+<dt>Default:</dt>
+<dd>{}</dd>
+</dl>
+</li>
+</ul>
+<a name="floatValue()">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>floatValue</h4>
+<pre>public abstract float[] floatValue</pre>
+<div class="block">A Float value or an array of Float values.</div>
+<dl>
+<dt>Default:</dt>
+<dd>{}</dd>
+</dl>
+</li>
+</ul>
+<a name="intValue()">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>intValue</h4>
+<pre>public abstract int[] intValue</pre>
+<div class="block">An Integer value or an array of Integer values.</div>
+<dl>
+<dt>Default:</dt>
+<dd>{}</dd>
+</dl>
+</li>
+</ul>
+<a name="byteValue()">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>byteValue</h4>
+<pre>public abstract byte[] byteValue</pre>
+<div class="block">A Byte value or an array of Byte values.</div>
+<dl>
+<dt>Default:</dt>
+<dd>{}</dd>
+</dl>
+</li>
+</ul>
+<a name="charValue()">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>charValue</h4>
+<pre>public abstract char[] charValue</pre>
+<div class="block">A Character value or an array of Character values.</div>
+<dl>
+<dt>Default:</dt>
+<dd>{}</dd>
+</dl>
+</li>
+</ul>
+<a name="booleanValue()">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>booleanValue</h4>
+<pre>public abstract boolean[] booleanValue</pre>
+<div class="block">A Boolean value or an array of Boolean values.</div>
+<dl>
+<dt>Default:</dt>
+<dd>{}</dd>
+</dl>
+</li>
+</ul>
+<a name="shortValue()">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>shortValue</h4>
+<pre>public abstract short[] shortValue</pre>
+<div class="block">A Short value or an array of Short values.</div>
+<dl>
+<dt>Default:</dt>
+<dd>{}</dd>
+</dl>
+</li>
+</ul>
+<a name="values()">
+<!-- -->
+</a>
+<ul class="blockListLast">
+<li class="blockList">
+<h4>values</h4>
+<pre>public abstract java.lang.String[] values</pre>
+<div class="block"><span class="strong">Deprecated.</span> <i>use <a href="../../../../../../org/apache/felix/dm/annotation/api/Property.html#value()"><code>value()</code></a> attribute.</i></div>
+<div class="block">Returns an array of property values.
+ The property value are parsed using the <code>valueOf</code> method of the class specified in the #type attribute
+ (which is <code>String</code> by default).</div>
+<dl><dt><span class="strong">Returns:</span></dt><dd>an array of property values.</dd></dl>
+<dl>
+<dt>Default:</dt>
+<dd>{}</dd>
+</dl>
+</li>
+</ul>
+</li>
+</ul>
+</li>
+</ul>
+</div>
+</div>
+<!-- ========= END OF CLASS DATA ========= -->
+<!-- ======= START OF BOTTOM NAVBAR ====== -->
+<div class="bottomNav"><a name="navbar_bottom">
+<!-- -->
+</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
+<!-- -->
+</a>
+<ul class="navList" title="Navigation">
+<li><a href="../../../../../../org/apache/felix/dm/annotation/api/package-summary.html">Package</a></li>
+<li class="navBarCell1Rev">Class</li>
+<li><a href="package-tree.html">Tree</a></li>
+<li><a href="../../../../../../deprecated-list.html">Deprecated</a></li>
+<li><a href="../../../../../../index-all.html">Index</a></li>
+<li><a href="../../../../../../help-doc.html">Help</a></li>
+</ul>
+</div>
+<div class="subNav">
+<ul class="navList">
+<li><a href="../../../../../../org/apache/felix/dm/annotation/api/LifecycleController.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/PropertyMetaData.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/Property.html" target="_top">Frames</a></li>
+<li><a href="Property.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/dmannotations/r2/org/apache/felix/dm/annotation/api/PropertyMetaData.html
==============================================================================
--- websites/staging/felix/trunk/content/apidocs/dmannotations/r2/org/apache/felix/dm/annotation/api/PropertyMetaData.html (added)
+++ websites/staging/felix/trunk/content/apidocs/dmannotations/r2/org/apache/felix/dm/annotation/api/PropertyMetaData.html Tue May 26 21:10:52 2015
@@ -0,0 +1,408 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<!-- NewPage -->
+<html lang="en">
+<head>
+<!-- Generated by javadoc (version 1.7.0_67) on Tue Mar 24 21:21:23 CET 2015 -->
+<title>PropertyMetaData</title>
+<meta name="date" content="2015-03-24">
+<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
+</head>
+<body>
+<script type="text/javascript"><!--
+ if (location.href.indexOf('is-external=true') == -1) {
+ parent.document.title="PropertyMetaData";
+ }
+//-->
+</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/Property.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/Registered.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/PropertyMetaData.html" target="_top">Frames</a></li>
+<li><a href="PropertyMetaData.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 PropertyMetaData" class="title">Annotation Type PropertyMetaData</h2>
+</div>
+<div class="contentContainer">
+<div class="description">
+<ul class="blockList">
+<li class="blockList">
+<hr>
+<br>
+<pre>@Retention(value=CLASS)
+@Target(value=ANNOTATION_TYPE)
+public @interface <span class="strong">PropertyMetaData</span></pre>
+<div class="block">This annotation describes the data types of a configuration Property.
+ It can be used by other annotations which require meta type support.
+ For now, the following annotations are using <code>PropertyMetaData</code:
+ <ul>
+ <li><a href="../../../../../../org/apache/felix/dm/annotation/api/ConfigurationDependency.html" title="annotation in org.apache.felix.dm.annotation.api"><code>ConfigurationDependency</code></a>: This dependency allows to define a
+ dependency over a <code>Configuration Admin</code> configuration dictionaries, whose
+ metadata can be described using <code>PropertyMetaData</code> annotation.
+ <li><a href="../../../../../../org/apache/felix/dm/annotation/api/FactoryConfigurationAdapterService.html" title="annotation in org.apache.felix.dm.annotation.api"><code>FactoryConfigurationAdapterService</code></a>: This service adapter allows
+ to dynamically create Services on behalf of <code>Factory Configuration Admin</code>
+ configuration dictionaries, whose metadata can be described using this <code>PropertyMetaData</code> annotation.
+ </ul></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/PropertyMetaData.html#description()">description</a></strong></code>
+<div class="block">Returns the property description.</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/PropertyMetaData.html#heading()">heading</a></strong></code>
+<div class="block">The label used to display the property.</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/PropertyMetaData.html#id()">id</a></strong></code>
+<div class="block">The key of a ConfigurationAdmin property.</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>int</code></td>
+<td class="colLast"><code><strong><a href="../../../../../../org/apache/felix/dm/annotation/api/PropertyMetaData.html#cardinality()">cardinality</a></strong></code>
+<div class="block">Return the cardinality of this property.</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/PropertyMetaData.html#defaults()">defaults</a></strong></code>
+<div class="block">Return a default for this property.</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/PropertyMetaData.html#optionLabels()">optionLabels</a></strong></code>
+<div class="block">Return a list of valid option labels for this property.</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/PropertyMetaData.html#optionValues()">optionValues</a></strong></code>
+<div class="block">Return a list of option values that this property can take.</div>
+</td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code>boolean</code></td>
+<td class="colLast"><code><strong><a href="../../../../../../org/apache/felix/dm/annotation/api/PropertyMetaData.html#required()">required</a></strong></code>
+<div class="block">Tells if this property is required or not.</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/PropertyMetaData.html#type()">type</a></strong></code>
+<div class="block">Return the property primitive type.</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="heading()">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>heading</h4>
+<pre>public abstract java.lang.String heading</pre>
+<div class="block">The label used to display the property. Example: "Log Level".</div>
+<dl><dt><span class="strong">Returns:</span></dt><dd>The label used to display the property</dd></dl>
+</li>
+</ul>
+<a name="id()">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>id</h4>
+<pre>public abstract java.lang.String id</pre>
+<div class="block">The key of a ConfigurationAdmin property. Example: "printer.logLevel"</div>
+<dl><dt><span class="strong">Returns:</span></dt><dd>The Configuration Admin property name</dd></dl>
+</li>
+</ul>
+<a name="description()">
+<!-- -->
+</a>
+<ul class="blockListLast">
+<li class="blockList">
+<h4>description</h4>
+<pre>public abstract java.lang.String description</pre>
+<div class="block">Returns the property description. The description may be localized and must describe the semantics of this type and any
+ constraints. Example: "Select the log level for the Printer Service".</div>
+<dl><dt><span class="strong">Returns:</span></dt><dd>The localized description of the definition.</dd></dl>
+</li>
+</ul>
+<a name="type()">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>type</h4>
+<pre>public abstract java.lang.Class<?> type</pre>
+<div class="block">Return the property primitive type. If must be either one of the following types:<p>
+ <ul>
+ <li>String.class</li>
+ <li>Long.class</li>
+ <li>Integer.class</li>
+ <li>Character.class</li>
+ <li>Byte.class</li>
+ <li>Double.class</li>
+ <li>Float.class</li>
+ <li>Boolean.class</li>
+ </ul></div>
+<dl>
+<dt>Default:</dt>
+<dd>java.lang.String.class</dd>
+</dl>
+</li>
+</ul>
+<a name="defaults()">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>defaults</h4>
+<pre>public abstract java.lang.String[] defaults</pre>
+<div class="block">Return a default for this property. The object must be of the appropriate type as defined by the cardinality and getType().
+ The return type is a list of String objects that can be converted to the appropriate type. The cardinality of the return
+ array must follow the absolute cardinality of this type. E.g. if the cardinality = 0, the array must contain 1 element.
+ If the cardinality is 1, it must contain 0 or 1 elements. If it is -5, it must contain from 0 to max 5 elements. Note that
+ the special case of a 0 cardinality, meaning a single value, does not allow arrays or vectors of 0 elements.</div>
+<dl>
+<dt>Default:</dt>
+<dd>{}</dd>
+</dl>
+</li>
+</ul>
+<a name="cardinality()">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>cardinality</h4>
+<pre>public abstract int cardinality</pre>
+<div class="block">Return the cardinality of this property. The OSGi environment handles multi valued properties in arrays ([]) or in Vector objects.
+ The return value is defined as follows:<p>
+
+ <ul>
+ <li> x = Integer.MIN_VALUE no limit, but use Vector</li>
+ <li> x < 0 -x = max occurrences, store in Vector</li>
+ <li> x > 0 x = max occurrences, store in array []</li>
+ <li> x = Integer.MAX_VALUE no limit, but use array []</li>
+ <li> x = 0 1 occurrence required</li>
+ </ul></div>
+<dl>
+<dt>Default:</dt>
+<dd>0</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">Tells if this property is required or not.</div>
+<dl>
+<dt>Default:</dt>
+<dd>true</dd>
+</dl>
+</li>
+</ul>
+<a name="optionLabels()">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>optionLabels</h4>
+<pre>public abstract java.lang.String[] optionLabels</pre>
+<div class="block">Return a list of valid option labels for this property. The purpose of this method is to allow menus with localized labels.
+ It is associated with the <a href="../../../../../../org/apache/felix/dm/annotation/api/PropertyMetaData.html#optionValues()"><code>optionValues()</code></a> attribute. The labels returned here are ordered in the same way as the
+ <a href="../../../../../../org/apache/felix/dm/annotation/api/PropertyMetaData.html#optionValues()"><code>optionValues()</code></a> attribute values.</div>
+<dl><dt><span class="strong">Returns:</span></dt><dd>the list of valid option labels for this property.</dd></dl>
+<dl>
+<dt>Default:</dt>
+<dd>{}</dd>
+</dl>
+</li>
+</ul>
+<a name="optionValues()">
+<!-- -->
+</a>
+<ul class="blockListLast">
+<li class="blockList">
+<h4>optionValues</h4>
+<pre>public abstract java.lang.String[] optionValues</pre>
+<div class="block">Return a list of option values that this property can take. This list must be in the same sequence as the <a href="../../../../../../org/apache/felix/dm/annotation/api/PropertyMetaData.html#optionLabels()"><code>optionLabels()</code></a>
+ attribute.</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/Property.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/Registered.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/PropertyMetaData.html" target="_top">Frames</a></li>
+<li><a href="PropertyMetaData.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/dmannotations/r2/org/apache/felix/dm/annotation/api/Registered.html
==============================================================================
--- websites/staging/felix/trunk/content/apidocs/dmannotations/r2/org/apache/felix/dm/annotation/api/Registered.html (added)
+++ websites/staging/felix/trunk/content/apidocs/dmannotations/r2/org/apache/felix/dm/annotation/api/Registered.html Tue May 26 21:10:52 2015
@@ -0,0 +1,172 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<!-- NewPage -->
+<html lang="en">
+<head>
+<!-- Generated by javadoc (version 1.7.0_67) on Tue Mar 24 21:21:23 CET 2015 -->
+<title>Registered</title>
+<meta name="date" content="2015-03-24">
+<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
+</head>
+<body>
+<script type="text/javascript"><!--
+ if (location.href.indexOf('is-external=true') == -1) {
+ parent.document.title="Registered";
+ }
+//-->
+</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/PropertyMetaData.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/ResourceAdapterService.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/Registered.html" target="_top">Frames</a></li>
+<li><a href="Registered.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 Registered" class="title">Annotation Type Registered</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">Registered</span></pre>
+<div class="block">This annotation can be used to be notified when a component is registered. At this point, the
+ component has been registered into the OSGI registry (if it provides some services).
+ When a service is registered, the ServiceRegistration used to register the service is
+ also passed to the method (if it takes a ServiceRegistration as parameter).
+
+ <p>
+ <h3>Usage Examples</h3>
+ <blockquote>
+
+ <pre>
+ @Component
+ class X implements Z {
+ @Start
+ void start() {
+ // Our Z Service is about to be registered into the OSGi registry.
+ }
+
+ @Registered
+ void registered(ServiceRegistration sr) {
+ // At this point, our service has been registered into the registry.
+ }
+ }
+ </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/PropertyMetaData.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/ResourceAdapterService.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/Registered.html" target="_top">Frames</a></li>
+<li><a href="Registered.html" target="_top">No Frames</a></li>
+</ul>
+<ul class="navList" id="allclasses_navbar_bottom">
+<li><a href="../../../../../../allclasses-noframe.html">All Classes</a></li>
+</ul>
+<div>
+<script type="text/javascript"><!--
+ allClassesLink = document.getElementById("allclasses_navbar_bottom");
+ if(window==top) {
+ allClassesLink.style.display = "block";
+ }
+ else {
+ allClassesLink.style.display = "none";
+ }
+ //-->
+</script>
+</div>
+<div>
+<ul class="subNavList">
+<li>Summary: </li>
+<li>Required | </li>
+<li>Optional</li>
+</ul>
+<ul class="subNavList">
+<li>Detail: </li>
+<li>Element</li>
+</ul>
+</div>
+<a name="skip-navbar_bottom">
+<!-- -->
+</a></div>
+<!-- ======== END OF BOTTOM NAVBAR ======= -->
+</body>
+</html>
Added: websites/staging/felix/trunk/content/apidocs/dmannotations/r2/org/apache/felix/dm/annotation/api/ResourceAdapterService.html
==============================================================================
--- websites/staging/felix/trunk/content/apidocs/dmannotations/r2/org/apache/felix/dm/annotation/api/ResourceAdapterService.html (added)
+++ websites/staging/felix/trunk/content/apidocs/dmannotations/r2/org/apache/felix/dm/annotation/api/ResourceAdapterService.html Tue May 26 21:10:52 2015
@@ -0,0 +1,409 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<!-- NewPage -->
+<html lang="en">
+<head>
+<!-- Generated by javadoc (version 1.7.0_67) on Tue Mar 24 21:21:23 CET 2015 -->
+<title>ResourceAdapterService</title>
+<meta name="date" content="2015-03-24">
+<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
+</head>
+<body>
+<script type="text/javascript"><!--
+ if (location.href.indexOf('is-external=true') == -1) {
+ parent.document.title="ResourceAdapterService";
+ }
+//-->
+</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/Registered.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/ResourceDependency.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/ResourceAdapterService.html" target="_top">Frames</a></li>
+<li><a href="ResourceAdapterService.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 ResourceAdapterService" class="title">Annotation Type ResourceAdapterService</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">ResourceAdapterService</span></pre>
+<div class="block">Annotates a class as a Resource adapter service. Resource adapters are things that
+ adapt a resource instead of a service, and provide an adapter service on top of this resource.
+ Resources are an abstraction that is introduced by the dependency manager, represented as a URL.
+ They can be implemented to serve resources embedded in bundles, somewhere on a file system or in
+ an http content repository server, or database.<p>
+ The adapter will be applied to any resource that matches the specified filter condition, which can
+ match some part of the resource URL (with "path", "protocol", "port", or "host" filters).
+ For each matching resource an adapter will be created based on the adapter implementation class.
+ The adapter will be registered with the specified interface and with any extra service properties
+ you supply here. Moreover, the following service properties will be propagated from the resource URL:
+
+ <ul><li> "host": this property exposes the host part of the resource URL
+ <li>"path": the resource URL path
+ <li>"protocol": the resource URL protocol
+ <li>"port": the resource URL port
+ </ul>
+
+ <h3>Usage Examples</h3>
+ Here, the "VideoPlayer" service provides a video service on top of any movie resources, with service
+ properties "host"/"port"/"protocol"/"path" extracted from the resource URL:
+ <blockquote>
+ <pre>
+
+ @ResourceAdapterService(filter = "(&(path=/videos/*.mkv)(host=localhost))", propagate = true)
+ public class VideoPlayerImpl implements VideoPlayer {
+ // Injected by reflection
+ URL resource;
+
+ void play() {} // play video referenced by this.resource
+ void stop() {} // stop playing the video
+ void transcode() {} // ...
+ }
+ </pre>
+ </blockquote>
+
+ And here is an example of a VideoProvider, which provides some videos using a web URL.
+ Notice that Resource providers need to depend on the DependencyManager API:
+
+ <blockquote>
+ <pre>
+ import java.net.MalformedURLException;
+ import java.net.URL;
+ import java.util.HashMap;
+ import java.util.Map;
+
+ import org.apache.felix.dm.ResourceHandler;
+ import org.apache.felix.dm.ResourceUtil;
+ import org.apache.felix.dm.annotation.api.Component;
+ import org.apache.felix.dm.annotation.api.Init;
+ import org.apache.felix.dm.annotation.api.ServiceDependency;
+ import org.osgi.framework.BundleContext;
+ import org.osgi.framework.Filter;
+ import org.osgi.framework.InvalidSyntaxException;
+
+ @Component
+ public class VideoProvider
+ {
+ // Injected by reflection
+ private volatile BundleContext context;
+ // List of known resource handlers
+ private Map<ResourceHandler, Filter> m_handlers = new HashMap<ResourceHandler, Filter>();
+ // List of known video resources
+ private URL[] m_videos;
+
+ @Init
+ void init() throws MalformedURLException
+ {
+ m_videos = new URL[] {
+ new URL("http://localhost:8080/videos/video1.mkv"),
+ new URL("http://localhost:8080/videos/video2.mkv"),
+ };
+ }
+
+ // Track resource handlers
+ @ServiceDependency(required = false)
+ public void add(Map<String, String> serviceProperties, ResourceHandler handler) throws InvalidSyntaxException
+ {
+ String filterString = serviceProperties.get("filter");
+ filterString = (filterString != null) ? filterString : "(path=*)";
+ Filter filter = context.createFilter(filterString);
+ synchronized (this)
+ {
+ m_handlers.put(handler, filter);
+ }
+ for (URL video : m_videos)
+ {
+ if (filter.match(ResourceUtil.createProperties(video)))
+ {
+ handler.added(video);
+ }
+ }
+ }
+ }
+ </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/ResourceAdapterService.html#filter()">filter</a></strong></code>
+<div class="block">The filter condition to use with the resource.</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/ResourceAdapterService.html#changed()">changed</a></strong></code>
+<div class="block">The callback method to be invoked when the Resource has 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/ResourceAdapterService.html#factoryMethod()">factoryMethod</a></strong></code>
+<div class="block">Sets the static method used to create the AdapterService implementation instance.</div>
+</td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code>boolean</code></td>
+<td class="colLast"><code><strong><a href="../../../../../../org/apache/felix/dm/annotation/api/ResourceAdapterService.html#propagate()">propagate</a></strong></code>
+<div class="block"><code>true</code> if properties from the resource should be propagated 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><strong><a href="../../../../../../org/apache/felix/dm/annotation/api/ResourceAdapterService.html#properties()">properties</a></strong></code>
+<div class="block">Additional properties to use with the adapter service registration</div>
+</td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code>java.lang.Class<?>[]</code></td>
+<td class="colLast"><code><strong><a href="../../../../../../org/apache/felix/dm/annotation/api/ResourceAdapterService.html#provides()">provides</a></strong></code>
+<div class="block">The interface(s) to use when registering adapters</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 condition to use with the resource.</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</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 adapter service registration</div>
+<dl>
+<dt>Default:</dt>
+<dd>{}</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"><code>true</code> if properties from the resource should be propagated to the service properties.</div>
+<dl>
+<dt>Default:</dt>
+<dd>false</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 Resource has changed.</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 AdapterService 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/Registered.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/ResourceDependency.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/ResourceAdapterService.html" target="_top">Frames</a></li>
+<li><a href="ResourceAdapterService.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/dmannotations/r2/org/apache/felix/dm/annotation/api/ResourceDependency.html
==============================================================================
--- websites/staging/felix/trunk/content/apidocs/dmannotations/r2/org/apache/felix/dm/annotation/api/ResourceDependency.html (added)
+++ websites/staging/felix/trunk/content/apidocs/dmannotations/r2/org/apache/felix/dm/annotation/api/ResourceDependency.html Tue May 26 21:10:52 2015
@@ -0,0 +1,412 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<!-- NewPage -->
+<html lang="en">
+<head>
+<!-- Generated by javadoc (version 1.7.0_67) on Tue Mar 24 21:21:23 CET 2015 -->
+<title>ResourceDependency</title>
+<meta name="date" content="2015-03-24">
+<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
+</head>
+<body>
+<script type="text/javascript"><!--
+ if (location.href.indexOf('is-external=true') == -1) {
+ parent.document.title="ResourceDependency";
+ }
+//-->
+</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/ResourceAdapterService.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/ServiceDependency.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/ResourceDependency.html" target="_top">Frames</a></li>
+<li><a href="ResourceDependency.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 ResourceDependency" class="title">Annotation Type ResourceDependency</h2>
+</div>
+<div class="contentContainer">
+<div class="description">
+<ul class="blockList">
+<li class="blockList">
+<hr>
+<br>
+<pre>@Retention(value=CLASS)
+@Target(value={METHOD,FIELD})
+public @interface <span class="strong">ResourceDependency</span></pre>
+<div class="block">Annotates a method of field as a Resource Dependency. A resource dependency allows you to
+ depend on a resource. Resources are an abstraction that is introduced by the dependency manager, represented as a URL.
+ They can be implemented to serve resources embedded in bundles, somewhere on a file system or in
+ an http content repository server, or database. <p> A resource is a URL and you can use a filter condition based on
+ protocol, host, port, and path.
+
+ <h3>Usage Examples</h3>
+ Here, the "VideoPlayer" component plays any provided MKV video resources
+ <blockquote>
+ <pre>
+
+ @Component
+ public class VideoPlayer {
+ @ResourceDependency(required=false, filter="(path=/videos/*.mkv)")
+ void playResource(URL video) { ... }
+ }
+ </pre>
+ </blockquote>
+
+ And here is an example of a VideoProvider, which provides some videos using a web URL.
+ Notice that Resource providers need to depend on the DependencyManager API:
+
+ <blockquote>
+ <pre>
+ import java.net.MalformedURLException;
+ import java.net.URL;
+ import java.util.HashMap;
+ import java.util.Map;
+
+ import org.apache.felix.dm.ResourceHandler;
+ import org.apache.felix.dm.ResourceUtil;
+ import org.apache.felix.dm.annotation.api.Component;
+ import org.apache.felix.dm.annotation.api.Init;
+ import org.apache.felix.dm.annotation.api.ServiceDependency;
+ import org.osgi.framework.BundleContext;
+ import org.osgi.framework.Filter;
+ import org.osgi.framework.InvalidSyntaxException;
+
+ @Component
+ public class VideoProvider
+ {
+ // Injected by reflection
+ private volatile BundleContext context;
+ // List of known resource handlers
+ private Map<ResourceHandler, Filter> m_handlers = new HashMap<ResourceHandler, Filter>();
+ // List of known video resources
+ private URL[] m_videos;
+
+ @Init
+ void init() throws MalformedURLException
+ {
+ m_videos = new URL[] {
+ new URL("http://localhost:8080/videos/video1.mkv"),
+ new URL("http://localhost:8080/videos/video2.mkv"),
+ };
+ }
+
+ // Track resource handlers
+ @ServiceDependency(required = false)
+ public void add(Map<String, String> serviceProperties, ResourceHandler handler) throws InvalidSyntaxException
+ {
+ String filterString = serviceProperties.get("filter");
+ filterString = (filterString != null) ? filterString : "(path=*)";
+ Filter filter = context.createFilter(filterString);
+ synchronized (this)
+ {
+ m_handlers.put(handler, filter);
+ }
+ for (URL video : m_videos)
+ {
+ if (filter.match(ResourceUtil.createProperties(video)))
+ {
+ handler.added(video);
+ }
+ }
+ }
+ }
+ </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/ResourceDependency.html#added()">added</a></strong></code>
+<div class="block">Returns the callback method to be invoked when the 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/ResourceDependency.html#changed()">changed</a></strong></code>
+<div class="block">Returns the callback method to be invoked when the 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/ResourceDependency.html#filter()">filter</a></strong></code>
+<div class="block">Returns the Service dependency OSGi filter.</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/ResourceDependency.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="altColor">
+<td class="colFirst"><code>boolean</code></td>
+<td class="colLast"><code><strong><a href="../../../../../../org/apache/felix/dm/annotation/api/ResourceDependency.html#propagate()">propagate</a></strong></code>
+<div class="block">Specifies if the resource URL properties must be propagated.</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/ResourceDependency.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="altColor">
+<td class="colFirst"><code>boolean</code></td>
+<td class="colLast"><code><strong><a href="../../../../../../org/apache/felix/dm/annotation/api/ResourceDependency.html#required()">required</a></strong></code>
+<div class="block">Returns whether the Service dependency is required or not.</div>
+</td>
+</tr>
+</table>
+</li>
+</ul>
+</li>
+</ul>
+</div>
+<div class="details">
+<ul class="blockList">
+<li class="blockList">
+<!-- ============ ANNOTATION TYPE MEMBER DETAIL =========== -->
+<ul class="blockList">
+<li class="blockList"><a name="annotation_type_element_detail">
+<!-- -->
+</a>
+<h3>Element Detail</h3>
+<a name="added()">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>added</h4>
+<pre>public abstract java.lang.String added</pre>
+<div class="block">Returns the callback method to be invoked when the service is available. This attribute is only meaningful when
+ the annotation is applied on a class field.</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">Returns the callback method to be invoked when the service properties 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 Service 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 Service dependency OSGi filter.</div>
+<dl>
+<dt>Default:</dt>
+<dd>""</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 resource URL properties must be propagated. If set to true, then the URL properties
+ ("protocol"/"host"/"port"/"path") will be propagated to the service properties of the component which
+ is using this dependency.</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.
+
+ <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>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/ResourceAdapterService.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/ServiceDependency.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/ResourceDependency.html" target="_top">Frames</a></li>
+<li><a href="ResourceDependency.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>