ipojo/handler/temporal/doc/temporal-service-dependency.html - onos-felix - Gitiles

 <!DOCTYPE HTML PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
 <html><head>


     <title>Apache Felix - Temporal Service Dependency</title>
     <link rel="stylesheet" href="temporal-service-dependency_files/site.css" type="text/css" media="all">
     <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
   </head><body>
     <div class="title"><div class="logo"><a href="http://felix.apache.org/site/index.html"><img alt="Apache Felix" src="temporal-service-dependency_files/logo.png" border="0"></a></div><div class="header"><a href="http://www.apache.org/"><img alt="Apache" src="temporal-service-dependency_files/apache.png" border="0"></a></div></div>
     <div class="menu">
 <ul>
 	<li><a href="http://felix.apache.org/site/news.html" title="news">news</a></li>
 	<li><a href="http://felix.apache.org/site/license.html" title="license">license</a></li>
 	<li><span class="nobr"><a href="http://felix.apache.org/site/downloads.cgi" title="Visit page outside Confluence" rel="nofollow">downloads<sup><img class="rendericon" src="temporal-service-dependency_files/linkext7.gif" alt="" align="absmiddle" border="0" width="7" height="7"></sup></a></span></li>
 	<li><a href="http://felix.apache.org/site/documentation.html" title="documentation">documentation</a></li>
 	<li><a href="http://felix.apache.org/site/mailinglists.html" title="mailinglists">mailing lists</a></li>
 	<li><a href="http://felix.apache.org/site/contributing.html" title="Contributing">contributing</a></li>
 	<li><span class="nobr"><a href="http://www.apache.org/" title="Visit page outside Confluence" rel="nofollow">asf<sup><img class="rendericon" src="temporal-service-dependency_files/linkext7.gif" alt="" align="absmiddle" border="0" width="7" height="7"></sup></a></span></li>
 	<li><span class="nobr"><a href="http://www.apache.org/foundation/sponsorship.html" title="Visit page outside Confluence" rel="nofollow">sponsorship<sup><img class="rendericon" src="temporal-service-dependency_files/linkext7.gif" alt="" align="absmiddle" border="0" width="7" height="7"></sup></a></span></li>
 	<li><span class="nobr"><a href="http://www.apache.org/foundation/thanks.html" title="Visit page outside Confluence" rel="nofollow">sponsors<sup><img class="rendericon" src="temporal-service-dependency_files/linkext7.gif" alt="" align="absmiddle" border="0" width="7" height="7"></sup></a></span>
 <!-- ApacheCon Ad -->
 <iframe src="temporal-service-dependency_files/button.html" style="border-width: 0pt; float: left;" scrolling="no" width="135" frameborder="0" height="135"></iframe>
 <p style="height: 100px;">
 <!-- ApacheCon Ad -->
 </p></li></ul> </div>
     <div class="main">
 <table class="sectionMacro" border="0" cellpadding="5" cellspacing="0" width="100%"><tbody><tr>
 <td class="confluenceTd" valign="top" width="80%">
 <h1><a name="TemporalServiceDependency-Thetemporaldependencyhandler"></a>The temporal dependency handler</h1>

 <p>Regular service dependencies participate to the instance lifecycle.
 Moreover, the injected service object is either available or not
 available. A temporal dependency handler is a little different and
 provides a different resolution pattern. Indeed, the temporal
 dependency does not invalidate the instance. Moreover, if not
 available, the temporal dependency waits (and so blocks the current
 thread) for a provider. Of course, the maximum waiting time can be
 specified. If a timeout occurs, the handler throws a runtime exception.<br>
 Using the handler</p>

 <p>First of all, you need to configure the component type to use the handler such as:</p>
 <div class="code"><div class="codeContent">
 <pre class="code-xml"><span class="code-tag">&lt;iPOJO <span class="code-keyword">xmlns:temporal</span>=<span class="code-quote">"org.apache.felix.ipojo.handler.temporal"</span>&gt;</span>
 &lt;component
     className=<span class="code-quote">"org.apache.felix.ipojo.example.Temporal"</span>&gt;

     <span class="code-tag"><span class="code-comment">&lt;!-- Temporal dependency configuration --&gt;</span></span>
     <span class="code-tag">&lt;temporal:requires field=<span class="code-quote">"mytemporal"</span>/&gt;</span>

     <span class="code-tag">&lt;provides/&gt;</span>

 <span class="code-tag">&lt;/component&gt;</span>
 <span class="code-tag">&lt;/iPOJO&gt;</span></pre>
 </div></div>
 <p>Notice that, this handler is an external handler. So, it uses the "org.apache.felix.ipojo.handler.temporal" namespace.<br>
 Once described, you can implement your component. The specified field
 will be mapped to the temporal dependency. As for regular field
 injection, aggregation, targeted service specification (i.e. interface)
 is discovered automatically. Filter, comparator and binding policy are
 also supported. However, the optional attribute is not supported. In
 fact, this attribute is meaningless in the case of a temporal
 dependency.<br>
 Using the field in your code will try to find a matching service
 provider. If a provider is available, the field receives the service
 object immediately. Else, the thread is stopped and waits for a
 provider. The default wait time is 3s (you can also specify this time).
 If no provider is available after this time, the thread throws a
 RuntimeException. If a provider becomes available during this time, the
 field receives immediately the value and the execution can continue.<br>
 Configuration</p>

 <p>The handler has only one mandatory attributes:</p>
 <ul>
 	<li>Field: the implementation field supporting the dependency</li>
 </ul>


 <p>The handler supports on specific optional attributes:</p>
 <ul>
 	<li>Timeout: the maximum time waited in order to find a provider
 (default: 3s). For an infinite timeout, the timeout value is either
 "infinite" or "-1".</li>
 	<li>OnTimeout: specifies the action to do
 when the timeout occurs. Four actions are supported: null, nullable,
 empty-array, default-implementation. By default, no action is
 specified, and an exception occurs when the timeout is reached.</li>
 </ul>


 <p>The attributes from "regular" dependencies are also supported (like filter).<br>
 OnTimeout actions</p>

 <p>When a timeout occurs, you can specify what the handler must do. By
 default, it throws a runtime exception. However, four others actions
 can be set in the 'onTimeout' attribute.</p>
 <ul>
 	<li>The null action (onTimeout="null") will return "null" instead of the service object.</li>
 	<li>The
 "nullable" action (onTimeout="nullable") will return a "Nullable"
 object instead of the service object. This object is a fake but can be
 used a regular service object. However, invoking actions on this object
 will do nothing. In the case of aggregate dependency, an array
 containing a "nullable" object is returned.</li>
 	<li>The empty-array
 action is only supported for aggregate dependency (the field must be an
 array). In this case, an empty-array is returned. <b>[ In the 1.1.0-SNAPSHOT version, the <tt>empty-array</tt> attribute became <tt>empty</tt>]</b></li>
 	<li>The
 default-implementation action is a little different. Instead of
 specifying the action, you need to specify the default-implementation
 (the qualified class name) that you want to use. For example
 onTimeout="o.a.f.i.MyDefaultLogServiceImpl". In this case, the handler
 will inject an instance of this object instead of a real service
 object. On aggregate dependency, an array with one
 default-implementation object is returned.</li>
 </ul>


 <div class="code"><div class="codeContent">
 <pre class="code-xml"><span class="code-tag">&lt;iPOJO <span class="code-keyword">xmlns:temporal</span>=<span class="code-quote">"org.apache.felix.ipojo.handler.temporal"</span>&gt;</span>
 &lt;component
     className=<span class="code-quote">"org.apache.felix.ipojo.example.Temporal"</span>&gt;

     <span class="code-tag"><span class="code-comment">&lt;!-- Temporal dependency configuration --&gt;</span></span>
     <span class="code-tag">&lt;temporal:requires field=<span class="code-quote">"fs"</span> timeout=<span class="code-quote">"300"</span> ontimeout=<span class="code-quote">"nullable"</span>/&gt;</span>

     <span class="code-tag">&lt;provides/&gt;</span>

 <span class="code-tag">&lt;/component&gt;</span>
 <span class="code-tag">&lt;/iPOJO&gt;</span></pre>
 </div></div>
 <h2><a name="TemporalServiceDependency-Collectionsupport\1.1.0SNAPSHOTversion\"></a>Collection support <b>[1.1.0-SNAPSHOT version ]</b></h2>
 <p>Temporal dependencies can also be injected inside Collection. To
 achieve this, the 'specification' attribute must indicates the looked
 specification, and the field must be a Collection.</p>
 <div class="code"><div class="codeContent">
 <pre class="code-xml"><span class="code-tag">&lt;iPOJO <span class="code-keyword">xmlns:temporal</span>=<span class="code-quote">"org.apache.felix.ipojo.handler.temporal"</span>&gt;</span>
 &lt;component
     className=<span class="code-quote">"org.apache.felix.ipojo.example.Temporal"</span>&gt;

     <span class="code-tag"><span class="code-comment">&lt;!-- Temporal dependency configuration --&gt;</span></span>
     <span class="code-tag">&lt;temporal:requires field=<span class="code-quote">"mycollection"</span> specification=<span class="code-quote">"my.service.specification"</span>/&gt;</span>

     <span class="code-tag">&lt;provides/&gt;</span>

 <span class="code-tag">&lt;/component&gt;</span>
 <span class="code-tag">&lt;/iPOJO&gt;</span></pre>
 </div></div>
 <h2><a name="TemporalServiceDependency-Proxysupport\1.1.0SNAPSHOTversion\"></a>Proxy support <b>[1.1.0-SNAPSHOT version ]</b></h2>
 <p>Temporal dependencies can also be injected as proxies. So it is possible to give the temporal dependency to helper object.<br>
 On 'scalar' dependencies, the service lookup is executed during an
 operation invocation. Timeout policies are also executed is the lookup
 failed.<br>
 On aggregate dependencies (necessary Collection), the service lookup is
 executed when the iterator(), and toArray(...) methods are invoked.
 Timeout policies <br>
 are also executed if the lookup failed.</p>

 <p>To set a temporal dependency as a proxy, just add the <tt>proxy</tt> attribute as follows:</p>
 <div class="code"><div class="codeContent">
 <pre class="code-xml"><span class="code-tag">&lt;iPOJO <span class="code-keyword">xmlns:temporal</span>=<span class="code-quote">"org.apache.felix.ipojo.handler.temporal"</span>&gt;</span>
 &lt;component
     className=<span class="code-quote">"org.apache.felix.ipojo.example.Temporal"</span>&gt;

     <span class="code-tag"><span class="code-comment">&lt;!-- Temporal dependencies configuration --&gt;</span></span>
     <span class="code-tag">&lt;temporal:requires proxy=<span class="code-quote">"true"</span> field=<span class="code-quote">"fs"</span>/&gt;</span>
     <span class="code-tag">&lt;temporal:requires proxy=<span class="code-quote">"true"</span> field=<span class="code-quote">"mycollection"</span> specification=<span class="code-quote">"my.service.specification"</span>/&gt;</span>


     <span class="code-tag">&lt;provides/&gt;</span>

 <span class="code-tag">&lt;/component&gt;</span>
 <span class="code-tag">&lt;/iPOJO&gt;</span></pre>
 </div></div>

 <p>By default, proxies are disabled.</p>

 <h2><a name="TemporalServiceDependency-Download"></a>Download </h2>

 <p>The handler is available on the <a href="http://felix.apache.org/site/download.html" title="Download">download</a> page.<br>
 Sources are available on the Felix trunk at the following location: <span class="nobr"><a href="http://svn.apache.org/repos/asf/felix/trunk/ipojo/handler/temporal" title="Visit page outside Confluence" rel="nofollow">http://svn.apache.org/repos/asf/felix/trunk/ipojo/handler/temporal<sup><img class="rendericon" src="temporal-service-dependency_files/linkext7.gif" alt="" align="absmiddle" border="0" width="7" height="7"></sup></a></span></p></td>
 <td class="confluenceTd" valign="top" width="20%">
 <h6><a name="TemporalServiceDependency-Overview"></a><b>Overview</b></h6>
 <ul>
 	<li><a href="http://felix.apache.org/site/apache-felix-ipojo.html" title="Apache Felix iPOJO">Home Page</a></li>
 	<li><a href="http://felix.apache.org/site/apache-felix-ipojo-feature-overview.html" title="Apache Felix iPOJO Feature Overview">iPOJO Feature Overview</a></li>
 	<li><a href="http://felix.apache.org/site/download.html" title="Download">Download &amp; Install </a></li>
 </ul>


 <h6><a name="TemporalServiceDependency-GettingStarted"></a><b>Getting Started</b></h6>
 <ul>
 	<li><a href="http://felix.apache.org/site/ipojo-in-10-minutes.html" title="iPOJO in 10 minutes">iPOJO in 10 minutes</a></li>
 	<li><a href="http://felix.apache.org/site/how-to-use-ipojo-annotations.html" title="How to use iPOJO Annotations">How to use iPOJO Annotations</a></li>
 	<li><a href="http://felix.apache.org/site/ipojo-hello-word-maven-based-tutorial.html" title="iPOJO Hello Word (Maven-Based) tutorial">iPOJO Hello Word (Maven-Based) tutorial</a></li>
 	<li><a href="http://felix.apache.org/site/ipojo-advanced-tutorial.html" title="iPOJO Advanced Tutorial">iPOJO Advanced Tutorial</a></li>
 	<li><a href="http://felix.apache.org/site/ipojo-composition-tutorial.html" title="iPOJO Composition Tutorial">iPOJO Composition Tutorial</a></li>
 </ul>


 <h6><a name="TemporalServiceDependency-UserGuide"></a><b>User Guide</b></h6>
 <ul>
 	<li><a href="http://felix.apache.org/site/describing-components.html" title="Describing components">Describing components (handler list) </a></li>
 	<li><a href="http://felix.apache.org/site/using-xml-schemas.html" title="Using XML Schemas">Using XML Schemas</a></li>
 	<li><a href="http://felix.apache.org/site/apache-felix-ipojo-testing-components.html" title="apache-felix-ipojo-testing-components">Testing components</a></li>
 	<li><a href="http://felix.apache.org/site/ipojo-advanced-topics.html" title="iPOJO Advanced Topics">Advanced Topics</a></li>
 	<li><a href="http://felix.apache.org/site/ipojo-faq.html" title="iPOJO FAQ">FAQ</a></li>
 </ul>


 <h6><a name="TemporalServiceDependency-Tools"></a><b>Tools</b></h6>
 <ul>
 	<li><a href="http://felix.apache.org/site/ipojo-eclipse-plug-in.html" title="iPOJO Eclipse Plug-in">iPOJO Eclipse Plug-in</a></li>
 	<li><a href="http://felix.apache.org/site/ipojo-ant-task.html" title="iPOJO Ant Task">iPOJO Ant Task</a></li>
 	<li><a href="http://felix.apache.org/site/ipojo-maven-plug-in.html" title="iPOJO Maven Plug-in">iPOJO Maven Plug-in</a></li>
 	<li><a href="http://felix.apache.org/site/apache-felix-ipojo-junit4osgi.html" title="apache-felix-ipojo-junit4osgi">Junit4OSGi</a></li>
 	<li><a href="http://felix.apache.org/site/ipojo-concepts-overview.html" title="iPOJO Concepts Overview">iPOJO concepts overview</a></li>
 </ul>


 <h6><a name="TemporalServiceDependency-DeveloperGuide"></a><b>Developer Guide</b></h6>
 <ul>
 	<li>API: <span class="nobr"><a href="http://people.apache.org/%7Eclement/ipojo/api/1.0/" title="Visit page outside Confluence" rel="nofollow">1.0<sup><img class="rendericon" src="temporal-service-dependency_files/linkext7.gif" alt="" align="absmiddle" border="0" width="7" height="7"></sup></a></span></li>
 	<li><a href="http://felix.apache.org/site/how-to-write-your-own-handler.html" title="How to write your own handler">How to write your own handler</a></li>
 	<li><a href="http://felix.apache.org/site/how-to-use-ipojo-manipulation-metadata.html" title="How to use iPOJO Manipulation Metadata">How to use iPOJO Manipulation Metadata</a></li>
 	<li><a href="http://felix.apache.org/site/dive-into-the-ipojo-manipulation-depths.html" title="Dive into the iPOJO Manipulation depths">Dive into the iPOJO Manipulation depths</a></li>
 </ul>


 <h6><a name="TemporalServiceDependency-Misc&amp;Contact"></a><b>Misc &amp; Contact</b></h6>
 <ul>
 	<li><a href="http://felix.apache.org/site/apache-felix-ipojo-issuestracker.html" title="apache-felix-ipojo-issuestracker">Issues Tracker</a></li>
 	<li><a href="http://felix.apache.org/site/apache-felix-ipojo-supportedvms.html" title="apache-felix-ipojo-supportedVMs">Supported JVMs</a></li>
 	<li><a href="http://felix.apache.org/site/apache-felix-ipojo-supportedosgi.html" title="apache-felix-ipojo-supportedOSGi">Supported OSGi Implementations</a></li>
 	<li><span class="nobr"><a href="http://ipojo-dark-side.blogspot.com/" title="Visit page outside Confluence" rel="nofollow">iPOJO's Dark Side Blog<sup><img class="rendericon" src="temporal-service-dependency_files/linkext7.gif" alt="" align="absmiddle" border="0" width="7" height="7"></sup></a></span></li>
 	<li><a href="http://felix.apache.org/site/future-ideas.html" title="Future Ideas">Future Ideas</a></li>
 	<li><a href="http://felix.apache.org/site/contact.html" title="Contact">Contact</a></li>
 	<li><a href="http://felix.apache.org/site/related-works.html" title="Related Works">Related Works</a></li>
 	<li><a href="http://felix.apache.org/site/article-presentations.html" title="Article &amp; Presentations">Article &amp; Presentations</a></li>
 </ul>


 <hr>
 <div class="" align="center">
 <p><span class="nobr"><a href="http://cwiki.apache.org/confluence/createrssfeed.action?types=blogpost&amp;statuses=created&amp;statuses=modified&amp;spaces=FELIX&amp;labelString=iPOJO&amp;rssType=atom&amp;maxResults=10&amp;timeSpan=5&amp;publicFeed=true&amp;title=iPOJO%20Atom%20Feed" title="Stay tuned!" rel="nofollow"><img src="temporal-service-dependency_files/feed-icon-32x32.png" align="absmiddle" border="0"><sup><img class="rendericon" src="temporal-service-dependency_files/linkext7.gif" alt="" align="absmiddle" border="0" width="7" height="7"></sup></a></span></p></div>

 <script type="text/javascript">
 var gaJsHost = (("https:" == document.location.protocol) ? "https://ssl." : "http://www.");
 document.write(unescape("%3Cscript src='" + gaJsHost + "google-analytics.com/ga.js' type='text/javascript'%3E%3C/script%3E"));
 </script><script src="temporal-service-dependency_files/ga.js" type="text/javascript"></script>
 <script type="text/javascript">
 var pageTracker = _gat._getTracker("UA-1518442-4");
 pageTracker._trackPageview();
 </script>
 </td></tr></tbody></table>
     </div>
   </body></html>
	<!DOCTYPE HTML PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
	<html><head>



	<title>Apache Felix - Temporal Service Dependency</title>
	<link rel="stylesheet" href="temporal-service-dependency_files/site.css" type="text/css" media="all">
	<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
	</head><body>
	<div class="title"><div class="logo"><a href="http://felix.apache.org/site/index.html"><img alt="Apache Felix" src="temporal-service-dependency_files/logo.png" border="0"></a></div><div class="header"><a href="http://www.apache.org/"><img alt="Apache" src="temporal-service-dependency_files/apache.png" border="0"></a></div></div>
	<div class="menu">
	<ul>
	<li><a href="http://felix.apache.org/site/news.html" title="news">news</a></li>
	<li><a href="http://felix.apache.org/site/license.html" title="license">license</a></li>
	<li><span class="nobr"><a href="http://felix.apache.org/site/downloads.cgi" title="Visit page outside Confluence" rel="nofollow">downloads<sup><img class="rendericon" src="temporal-service-dependency_files/linkext7.gif" alt="" align="absmiddle" border="0" width="7" height="7"></sup></a></span></li>
	<li><a href="http://felix.apache.org/site/documentation.html" title="documentation">documentation</a></li>
	<li><a href="http://felix.apache.org/site/mailinglists.html" title="mailinglists">mailing lists</a></li>
	<li><a href="http://felix.apache.org/site/contributing.html" title="Contributing">contributing</a></li>
	<li><span class="nobr"><a href="http://www.apache.org/" title="Visit page outside Confluence" rel="nofollow">asf<sup><img class="rendericon" src="temporal-service-dependency_files/linkext7.gif" alt="" align="absmiddle" border="0" width="7" height="7"></sup></a></span></li>
	<li><span class="nobr"><a href="http://www.apache.org/foundation/sponsorship.html" title="Visit page outside Confluence" rel="nofollow">sponsorship<sup><img class="rendericon" src="temporal-service-dependency_files/linkext7.gif" alt="" align="absmiddle" border="0" width="7" height="7"></sup></a></span></li>
	<li><span class="nobr"><a href="http://www.apache.org/foundation/thanks.html" title="Visit page outside Confluence" rel="nofollow">sponsors<sup><img class="rendericon" src="temporal-service-dependency_files/linkext7.gif" alt="" align="absmiddle" border="0" width="7" height="7"></sup></a></span>
	<!-- ApacheCon Ad -->
	<iframe src="temporal-service-dependency_files/button.html" style="border-width: 0pt; float: left;" scrolling="no" width="135" frameborder="0" height="135"></iframe>
	<p style="height: 100px;">
	<!-- ApacheCon Ad -->
	</p></li></ul> </div>
	<div class="main">
	<table class="sectionMacro" border="0" cellpadding="5" cellspacing="0" width="100%"><tbody><tr>
	<td class="confluenceTd" valign="top" width="80%">
	<h1><a name="TemporalServiceDependency-Thetemporaldependencyhandler"></a>The temporal dependency handler</h1>

	<p>Regular service dependencies participate to the instance lifecycle.
	Moreover, the injected service object is either available or not
	available. A temporal dependency handler is a little different and
	provides a different resolution pattern. Indeed, the temporal
	dependency does not invalidate the instance. Moreover, if not
	available, the temporal dependency waits (and so blocks the current
	thread) for a provider. Of course, the maximum waiting time can be
	specified. If a timeout occurs, the handler throws a runtime exception.<br>
	Using the handler</p>

	<p>First of all, you need to configure the component type to use the handler such as:</p>
	<div class="code"><div class="codeContent">
	<pre class="code-xml"><span class="code-tag"><iPOJO <span class="code-keyword">xmlns:temporal</span>=<span class="code-quote">"org.apache.felix.ipojo.handler.temporal"</span>></span>
	<component
	className=<span class="code-quote">"org.apache.felix.ipojo.example.Temporal"</span>>

	<span class="code-tag"><span class="code-comment"><!-- Temporal dependency configuration --></span></span>
	<span class="code-tag"><temporal:requires field=<span class="code-quote">"mytemporal"</span>/></span>

	<span class="code-tag"><provides/></span>

	<span class="code-tag"></component></span>
	<span class="code-tag"></iPOJO></span></pre>
	</div></div>
	<p>Notice that, this handler is an external handler. So, it uses the "org.apache.felix.ipojo.handler.temporal" namespace.<br>
	Once described, you can implement your component. The specified field
	will be mapped to the temporal dependency. As for regular field
	injection, aggregation, targeted service specification (i.e. interface)
	is discovered automatically. Filter, comparator and binding policy are
	also supported. However, the optional attribute is not supported. In
	fact, this attribute is meaningless in the case of a temporal
	dependency.<br>
	Using the field in your code will try to find a matching service
	provider. If a provider is available, the field receives the service
	object immediately. Else, the thread is stopped and waits for a
	provider. The default wait time is 3s (you can also specify this time).
	If no provider is available after this time, the thread throws a
	RuntimeException. If a provider becomes available during this time, the
	field receives immediately the value and the execution can continue.<br>
	Configuration</p>

	<p>The handler has only one mandatory attributes:</p>
	<ul>
	<li>Field: the implementation field supporting the dependency</li>
	</ul>


	<p>The handler supports on specific optional attributes:</p>
	<ul>
	<li>Timeout: the maximum time waited in order to find a provider
	(default: 3s). For an infinite timeout, the timeout value is either
	"infinite" or "-1".</li>
	<li>OnTimeout: specifies the action to do
	when the timeout occurs. Four actions are supported: null, nullable,
	empty-array, default-implementation. By default, no action is
	specified, and an exception occurs when the timeout is reached.</li>
	</ul>


	<p>The attributes from "regular" dependencies are also supported (like filter).<br>
	OnTimeout actions</p>

	<p>When a timeout occurs, you can specify what the handler must do. By
	default, it throws a runtime exception. However, four others actions
	can be set in the 'onTimeout' attribute.</p>
	<ul>
	<li>The null action (onTimeout="null") will return "null" instead of the service object.</li>
	<li>The
	"nullable" action (onTimeout="nullable") will return a "Nullable"
	object instead of the service object. This object is a fake but can be
	used a regular service object. However, invoking actions on this object
	will do nothing. In the case of aggregate dependency, an array
	containing a "nullable" object is returned.</li>
	<li>The empty-array
	action is only supported for aggregate dependency (the field must be an
	array). In this case, an empty-array is returned. <b>[ In the 1.1.0-SNAPSHOT version, the <tt>empty-array</tt> attribute became <tt>empty</tt>]</b></li>
	<li>The
	default-implementation action is a little different. Instead of
	specifying the action, you need to specify the default-implementation
	(the qualified class name) that you want to use. For example
	onTimeout="o.a.f.i.MyDefaultLogServiceImpl". In this case, the handler
	will inject an instance of this object instead of a real service
	object. On aggregate dependency, an array with one
	default-implementation object is returned.</li>
	</ul>


	<div class="code"><div class="codeContent">
	<pre class="code-xml"><span class="code-tag"><iPOJO <span class="code-keyword">xmlns:temporal</span>=<span class="code-quote">"org.apache.felix.ipojo.handler.temporal"</span>></span>
	<component
	className=<span class="code-quote">"org.apache.felix.ipojo.example.Temporal"</span>>

	<span class="code-tag"><span class="code-comment"><!-- Temporal dependency configuration --></span></span>
	<span class="code-tag"><temporal:requires field=<span class="code-quote">"fs"</span> timeout=<span class="code-quote">"300"</span> ontimeout=<span class="code-quote">"nullable"</span>/></span>

	<span class="code-tag"><provides/></span>

	<span class="code-tag"></component></span>
	<span class="code-tag"></iPOJO></span></pre>
	</div></div>
	<h2><a name="TemporalServiceDependency-Collectionsupport\1.1.0SNAPSHOTversion\"></a>Collection support <b>[1.1.0-SNAPSHOT version ]</b></h2>
	<p>Temporal dependencies can also be injected inside Collection. To
	achieve this, the 'specification' attribute must indicates the looked
	specification, and the field must be a Collection.</p>
	<div class="code"><div class="codeContent">
	<pre class="code-xml"><span class="code-tag"><iPOJO <span class="code-keyword">xmlns:temporal</span>=<span class="code-quote">"org.apache.felix.ipojo.handler.temporal"</span>></span>
	<component
	className=<span class="code-quote">"org.apache.felix.ipojo.example.Temporal"</span>>

	<span class="code-tag"><span class="code-comment"><!-- Temporal dependency configuration --></span></span>
	<span class="code-tag"><temporal:requires field=<span class="code-quote">"mycollection"</span> specification=<span class="code-quote">"my.service.specification"</span>/></span>

	<span class="code-tag"><provides/></span>

	<span class="code-tag"></component></span>
	<span class="code-tag"></iPOJO></span></pre>
	</div></div>
	<h2><a name="TemporalServiceDependency-Proxysupport\1.1.0SNAPSHOTversion\"></a>Proxy support <b>[1.1.0-SNAPSHOT version ]</b></h2>
	<p>Temporal dependencies can also be injected as proxies. So it is possible to give the temporal dependency to helper object.<br>
	On 'scalar' dependencies, the service lookup is executed during an
	operation invocation. Timeout policies are also executed is the lookup
	failed.<br>
	On aggregate dependencies (necessary Collection), the service lookup is
	executed when the iterator(), and toArray(...) methods are invoked.
	Timeout policies <br>
	are also executed if the lookup failed.</p>

	<p>To set a temporal dependency as a proxy, just add the <tt>proxy</tt> attribute as follows:</p>
	<div class="code"><div class="codeContent">
	<pre class="code-xml"><span class="code-tag"><iPOJO <span class="code-keyword">xmlns:temporal</span>=<span class="code-quote">"org.apache.felix.ipojo.handler.temporal"</span>></span>
	<component
	className=<span class="code-quote">"org.apache.felix.ipojo.example.Temporal"</span>>

	<span class="code-tag"><span class="code-comment"><!-- Temporal dependencies configuration --></span></span>
	<span class="code-tag"><temporal:requires proxy=<span class="code-quote">"true"</span> field=<span class="code-quote">"fs"</span>/></span>
	<span class="code-tag"><temporal:requires proxy=<span class="code-quote">"true"</span> field=<span class="code-quote">"mycollection"</span> specification=<span class="code-quote">"my.service.specification"</span>/></span>


	<span class="code-tag"><provides/></span>

	<span class="code-tag"></component></span>
	<span class="code-tag"></iPOJO></span></pre>
	</div></div>

	<p>By default, proxies are disabled.</p>

	<h2><a name="TemporalServiceDependency-Download"></a>Download </h2>

	<p>The handler is available on the <a href="http://felix.apache.org/site/download.html" title="Download">download</a> page.<br>
	Sources are available on the Felix trunk at the following location: <span class="nobr"><a href="http://svn.apache.org/repos/asf/felix/trunk/ipojo/handler/temporal" title="Visit page outside Confluence" rel="nofollow">http://svn.apache.org/repos/asf/felix/trunk/ipojo/handler/temporal<sup><img class="rendericon" src="temporal-service-dependency_files/linkext7.gif" alt="" align="absmiddle" border="0" width="7" height="7"></sup></a></span></p></td>
	<td class="confluenceTd" valign="top" width="20%">
	<h6><a name="TemporalServiceDependency-Overview"></a><b>Overview</b></h6>
	<ul>
	<li><a href="http://felix.apache.org/site/apache-felix-ipojo.html" title="Apache Felix iPOJO">Home Page</a></li>
	<li><a href="http://felix.apache.org/site/apache-felix-ipojo-feature-overview.html" title="Apache Felix iPOJO Feature Overview">iPOJO Feature Overview</a></li>
	<li><a href="http://felix.apache.org/site/download.html" title="Download">Download & Install </a></li>
	</ul>


	<h6><a name="TemporalServiceDependency-GettingStarted"></a><b>Getting Started</b></h6>
	<ul>
	<li><a href="http://felix.apache.org/site/ipojo-in-10-minutes.html" title="iPOJO in 10 minutes">iPOJO in 10 minutes</a></li>
	<li><a href="http://felix.apache.org/site/how-to-use-ipojo-annotations.html" title="How to use iPOJO Annotations">How to use iPOJO Annotations</a></li>
	<li><a href="http://felix.apache.org/site/ipojo-hello-word-maven-based-tutorial.html" title="iPOJO Hello Word (Maven-Based) tutorial">iPOJO Hello Word (Maven-Based) tutorial</a></li>
	<li><a href="http://felix.apache.org/site/ipojo-advanced-tutorial.html" title="iPOJO Advanced Tutorial">iPOJO Advanced Tutorial</a></li>
	<li><a href="http://felix.apache.org/site/ipojo-composition-tutorial.html" title="iPOJO Composition Tutorial">iPOJO Composition Tutorial</a></li>
	</ul>


	<h6><a name="TemporalServiceDependency-UserGuide"></a><b>User Guide</b></h6>
	<ul>
	<li><a href="http://felix.apache.org/site/describing-components.html" title="Describing components">Describing components (handler list) </a></li>
	<li><a href="http://felix.apache.org/site/using-xml-schemas.html" title="Using XML Schemas">Using XML Schemas</a></li>
	<li><a href="http://felix.apache.org/site/apache-felix-ipojo-testing-components.html" title="apache-felix-ipojo-testing-components">Testing components</a></li>
	<li><a href="http://felix.apache.org/site/ipojo-advanced-topics.html" title="iPOJO Advanced Topics">Advanced Topics</a></li>
	<li><a href="http://felix.apache.org/site/ipojo-faq.html" title="iPOJO FAQ">FAQ</a></li>
	</ul>


	<h6><a name="TemporalServiceDependency-Tools"></a><b>Tools</b></h6>
	<ul>
	<li><a href="http://felix.apache.org/site/ipojo-eclipse-plug-in.html" title="iPOJO Eclipse Plug-in">iPOJO Eclipse Plug-in</a></li>
	<li><a href="http://felix.apache.org/site/ipojo-ant-task.html" title="iPOJO Ant Task">iPOJO Ant Task</a></li>
	<li><a href="http://felix.apache.org/site/ipojo-maven-plug-in.html" title="iPOJO Maven Plug-in">iPOJO Maven Plug-in</a></li>
	<li><a href="http://felix.apache.org/site/apache-felix-ipojo-junit4osgi.html" title="apache-felix-ipojo-junit4osgi">Junit4OSGi</a></li>
	<li><a href="http://felix.apache.org/site/ipojo-concepts-overview.html" title="iPOJO Concepts Overview">iPOJO concepts overview</a></li>
	</ul>


	<h6><a name="TemporalServiceDependency-DeveloperGuide"></a><b>Developer Guide</b></h6>
	<ul>
	<li>API: <span class="nobr"><a href="http://people.apache.org/%7Eclement/ipojo/api/1.0/" title="Visit page outside Confluence" rel="nofollow">1.0<sup><img class="rendericon" src="temporal-service-dependency_files/linkext7.gif" alt="" align="absmiddle" border="0" width="7" height="7"></sup></a></span></li>
	<li><a href="http://felix.apache.org/site/how-to-write-your-own-handler.html" title="How to write your own handler">How to write your own handler</a></li>
	<li><a href="http://felix.apache.org/site/how-to-use-ipojo-manipulation-metadata.html" title="How to use iPOJO Manipulation Metadata">How to use iPOJO Manipulation Metadata</a></li>
	<li><a href="http://felix.apache.org/site/dive-into-the-ipojo-manipulation-depths.html" title="Dive into the iPOJO Manipulation depths">Dive into the iPOJO Manipulation depths</a></li>
	</ul>


	<h6><a name="TemporalServiceDependency-Misc&Contact"></a><b>Misc & Contact</b></h6>
	<ul>
	<li><a href="http://felix.apache.org/site/apache-felix-ipojo-issuestracker.html" title="apache-felix-ipojo-issuestracker">Issues Tracker</a></li>
	<li><a href="http://felix.apache.org/site/apache-felix-ipojo-supportedvms.html" title="apache-felix-ipojo-supportedVMs">Supported JVMs</a></li>
	<li><a href="http://felix.apache.org/site/apache-felix-ipojo-supportedosgi.html" title="apache-felix-ipojo-supportedOSGi">Supported OSGi Implementations</a></li>
	<li><span class="nobr"><a href="http://ipojo-dark-side.blogspot.com/" title="Visit page outside Confluence" rel="nofollow">iPOJO's Dark Side Blog<sup><img class="rendericon" src="temporal-service-dependency_files/linkext7.gif" alt="" align="absmiddle" border="0" width="7" height="7"></sup></a></span></li>
	<li><a href="http://felix.apache.org/site/future-ideas.html" title="Future Ideas">Future Ideas</a></li>
	<li><a href="http://felix.apache.org/site/contact.html" title="Contact">Contact</a></li>
	<li><a href="http://felix.apache.org/site/related-works.html" title="Related Works">Related Works</a></li>
	<li><a href="http://felix.apache.org/site/article-presentations.html" title="Article & Presentations">Article & Presentations</a></li>
	</ul>


	<hr>
	<div class="" align="center">
	<p><span class="nobr"><a href="http://cwiki.apache.org/confluence/createrssfeed.action?types=blogpost&statuses=created&statuses=modified&spaces=FELIX&labelString=iPOJO&rssType=atom&maxResults=10&timeSpan=5&publicFeed=true&title=iPOJO%20Atom%20Feed" title="Stay tuned!" rel="nofollow"><img src="temporal-service-dependency_files/feed-icon-32x32.png" align="absmiddle" border="0"><sup><img class="rendericon" src="temporal-service-dependency_files/linkext7.gif" alt="" align="absmiddle" border="0" width="7" height="7"></sup></a></span></p></div>

	<script type="text/javascript">
	var gaJsHost = (("https:" == document.location.protocol) ? "https://ssl." : "http://www.");
	document.write(unescape("%3Cscript src='" + gaJsHost + "google-analytics.com/ga.js' type='text/javascript'%3E%3C/script%3E"));
	</script><script src="temporal-service-dependency_files/ga.js" type="text/javascript"></script>
	<script type="text/javascript">
	var pageTracker = _gat._getTracker("UA-1518442-4");
	pageTracker._trackPageview();
	</script>
	</td></tr></tbody></table>
	</div>
	</body></html>