| <!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_25) on Tue Oct 08 19:30:28 CEST 2013 --> |
| <meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> |
| <title>ServiceTrackingInterceptor (Apache Felix iPOJO ~ JavaDoc 1.10.1 API)</title> |
| <meta name="date" content="2013-10-08"> |
| <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="ServiceTrackingInterceptor (Apache Felix iPOJO ~ JavaDoc 1.10.1 API)"; |
| } |
| //--> |
| </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="../../../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/ServiceTrackingInterceptor.html">Use</a></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> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../../../org/apache/felix/ipojo/dependency/interceptors/ServiceRankingInterceptor.html" title="interface in org.apache.felix.ipojo.dependency.interceptors"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../../../../org/apache/felix/ipojo/dependency/interceptors/TransformedServiceReference.html" title="interface in org.apache.felix.ipojo.dependency.interceptors"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?org/apache/felix/ipojo/dependency/interceptors/ServiceTrackingInterceptor.html" target="_top">Frames</a></li> |
| <li><a href="ServiceTrackingInterceptor.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>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method_summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method_detail">Method</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.ipojo.dependency.interceptors</div> |
| <h2 title="Interface ServiceTrackingInterceptor" class="title">Interface ServiceTrackingInterceptor</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Superinterfaces:</dt> |
| <dd><a href="../../../../../../org/apache/felix/ipojo/dependency/interceptors/DependencyInterceptor.html" title="interface in org.apache.felix.ipojo.dependency.interceptors">DependencyInterceptor</a></dd> |
| </dl> |
| <dl> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><a href="../../../../../../org/apache/felix/ipojo/dependency/interceptors/DefaultServiceTrackingInterceptor.html" title="class in org.apache.felix.ipojo.dependency.interceptors">DefaultServiceTrackingInterceptor</a>, <a href="../../../../../../org/apache/felix/ipojo/dependency/impl/FilterBasedServiceTrackingInterceptor.html" title="class in org.apache.felix.ipojo.dependency.impl">FilterBasedServiceTrackingInterceptor</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public interface <a href="../../../../../../src-html/org/apache/felix/ipojo/dependency/interceptors/ServiceTrackingInterceptor.html#line.39">ServiceTrackingInterceptor</a> |
| extends <a href="../../../../../../org/apache/felix/ipojo/dependency/interceptors/DependencyInterceptor.html" title="interface in org.apache.felix.ipojo.dependency.interceptors">DependencyInterceptor</a></pre> |
| <div class="block">A service to influence the visibility of services within a service dependency. |
| This service is called to determine which services from the tracker (base set) is going to the matching set. |
| |
| Several tracking interceptors can be plugged to the same service dependency. In this case, |
| a chain is created where all interceptor can influence the next one. If the dependency has a filter, |
| a tracking interceptor using this filter is the last interceptor of the chain. |
| |
| Obviously an interceptor can be plugged to several dependencies. Conversely, several tracking interceptor can be |
| plugged to one dependency.</div> |
| <dl><dt><span class="strong">Since:</span></dt> |
| <dd>1.10.1</dd></dl> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field_summary"> |
| <!-- --> |
| </a> |
| <h3>Field Summary</h3> |
| <ul class="blockList"> |
| <li class="blockList"><a name="fields_inherited_from_class_org.apache.felix.ipojo.dependency.interceptors.DependencyInterceptor"> |
| <!-- --> |
| </a> |
| <h3>Fields inherited from interface org.apache.felix.ipojo.dependency.interceptors.<a href="../../../../../../org/apache/felix/ipojo/dependency/interceptors/DependencyInterceptor.html" title="interface in org.apache.felix.ipojo.dependency.interceptors">DependencyInterceptor</a></h3> |
| <code><a href="../../../../../../org/apache/felix/ipojo/dependency/interceptors/DependencyInterceptor.html#TARGET_PROPERTY">TARGET_PROPERTY</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method_summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span>Methods</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><S> <a href="../../../../../../org/apache/felix/ipojo/dependency/interceptors/TransformedServiceReference.html" title="interface in org.apache.felix.ipojo.dependency.interceptors">TransformedServiceReference</a><S></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../../org/apache/felix/ipojo/dependency/interceptors/ServiceTrackingInterceptor.html#accept(org.apache.felix.ipojo.util.DependencyModel, org.osgi.framework.BundleContext, org.apache.felix.ipojo.dependency.interceptors.TransformedServiceReference)">accept</a></strong>(<a href="../../../../../../org/apache/felix/ipojo/util/DependencyModel.html" title="class in org.apache.felix.ipojo.util">DependencyModel</a> dependency, |
| <a href="http://www.osgi.org/javadoc/r4v43/core/org/osgi/framework/BundleContext.html?is-external=true" title="class or interface in org.osgi.framework">BundleContext</a> context, |
| <a href="../../../../../../org/apache/felix/ipojo/dependency/interceptors/TransformedServiceReference.html" title="interface in org.apache.felix.ipojo.dependency.interceptors">TransformedServiceReference</a><S> ref)</code> |
| <div class="block">Does the interceptor accepts the reference of not ? |
| This methods has two goals.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods_inherited_from_class_org.apache.felix.ipojo.dependency.interceptors.DependencyInterceptor"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface org.apache.felix.ipojo.dependency.interceptors.<a href="../../../../../../org/apache/felix/ipojo/dependency/interceptors/DependencyInterceptor.html" title="interface in org.apache.felix.ipojo.dependency.interceptors">DependencyInterceptor</a></h3> |
| <code><a href="../../../../../../org/apache/felix/ipojo/dependency/interceptors/DependencyInterceptor.html#close(org.apache.felix.ipojo.util.DependencyModel)">close</a>, <a href="../../../../../../org/apache/felix/ipojo/dependency/interceptors/DependencyInterceptor.html#open(org.apache.felix.ipojo.util.DependencyModel)">open</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method_detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="accept(org.apache.felix.ipojo.util.DependencyModel, org.osgi.framework.BundleContext, org.apache.felix.ipojo.dependency.interceptors.TransformedServiceReference)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>accept</h4> |
| <pre><S> <a href="../../../../../../org/apache/felix/ipojo/dependency/interceptors/TransformedServiceReference.html" title="interface in org.apache.felix.ipojo.dependency.interceptors">TransformedServiceReference</a><S> <a href="../../../../../../src-html/org/apache/felix/ipojo/dependency/interceptors/ServiceTrackingInterceptor.html#line.61">accept</a>(<a href="../../../../../../org/apache/felix/ipojo/util/DependencyModel.html" title="class in org.apache.felix.ipojo.util">DependencyModel</a> dependency, |
| <a href="http://www.osgi.org/javadoc/r4v43/core/org/osgi/framework/BundleContext.html?is-external=true" title="class or interface in org.osgi.framework">BundleContext</a> context, |
| <a href="../../../../../../org/apache/felix/ipojo/dependency/interceptors/TransformedServiceReference.html" title="interface in org.apache.felix.ipojo.dependency.interceptors">TransformedServiceReference</a><S> ref)</pre> |
| <div class="block">Does the interceptor accepts the reference of not ? |
| This methods has two goals. It can filter out undesirable services by returning null. In addition, |
| it can <em>transform</em> the service reference to add / remove service properties. In this case, |
| it must return the <strong>same</strong> instance of <a href="../../../../../../org/apache/felix/ipojo/dependency/interceptors/TransformedServiceReference.html" title="interface in org.apache.felix.ipojo.dependency.interceptors"><code>TransformedServiceReference</code></a>, |
| but with the new set of properties. |
| |
| So to filter out the service, return null. To accept the service, |
| return the reference as it is. To transform the service update the service reference and return it. |
| |
| When several interceptors are collaborating on the same dependency, a chain is created. The received reference |
| is the reference modified by the preceding interceptor. Notice that once an interceptor returns null the chain is interrupted and the service rejected.</div> |
| <dl><dt><span class="strong">Type Parameters:</span></dt><dd><code>S</code> - the type of service</dd><dt><span class="strong">Parameters:</span></dt><dd><code>dependency</code> - the dependency</dd><dd><code>context</code> - the context of the dependency</dd><dd><code>ref</code> - the reference</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>null to filter out the service, the, optionally updated, reference to accept it.</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="../../../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/ServiceTrackingInterceptor.html">Use</a></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> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../../../org/apache/felix/ipojo/dependency/interceptors/ServiceRankingInterceptor.html" title="interface in org.apache.felix.ipojo.dependency.interceptors"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../../../../org/apache/felix/ipojo/dependency/interceptors/TransformedServiceReference.html" title="interface in org.apache.felix.ipojo.dependency.interceptors"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?org/apache/felix/ipojo/dependency/interceptors/ServiceTrackingInterceptor.html" target="_top">Frames</a></li> |
| <li><a href="ServiceTrackingInterceptor.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>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method_summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method_detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip-navbar_bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| <p class="legalCopy"><small>Copyright © 2013. All rights reserved.</small></p> |
| </body> |
| </html> |