Google Git
Sign in
apache / felix-site-pub / ce5028da261c6ed2e1928e6338c81e1f24559823 / . / ipojo / api / 1.12.1 / org / apache / felix / ipojo / dependency / interceptors / DependencyInterceptor.html
blob: faccdd82d879d8435d2d9f947f60321539abc36a [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0) on Wed Dec 24 15:58:26 CET 2014 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>DependencyInterceptor (Apache Felix iPOJO ~ JavaDoc 1.12.1 API)</title>
<meta name="date" content="2014-12-24">
<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="DependencyInterceptor (Apache Felix iPOJO ~ JavaDoc 1.12.1 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":6};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../../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/DependencyInterceptor.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/DefaultServiceTrackingInterceptor.html" title="class in org.apache.felix.ipojo.dependency.interceptors"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../org/apache/felix/ipojo/dependency/interceptors/ServiceBindingInterceptor.html" title="interface in org.apache.felix.ipojo.dependency.interceptors"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/felix/ipojo/dependency/interceptors/DependencyInterceptor.html" target="_top">Frames</a></li>
<li><a href="DependencyInterceptor.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../../allclasses-noframe.html">All&nbsp;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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</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 DependencyInterceptor" class="title">Interface DependencyInterceptor</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Known Subinterfaces:</dt>
<dd><a href="../../../../../../org/apache/felix/ipojo/dependency/interceptors/ServiceBindingInterceptor.html" title="interface in org.apache.felix.ipojo.dependency.interceptors">ServiceBindingInterceptor</a>, <a href="../../../../../../org/apache/felix/ipojo/dependency/interceptors/ServiceRankingInterceptor.html" title="interface in org.apache.felix.ipojo.dependency.interceptors">ServiceRankingInterceptor</a>, <a href="../../../../../../org/apache/felix/ipojo/dependency/interceptors/ServiceTrackingInterceptor.html" title="interface in org.apache.felix.ipojo.dependency.interceptors">ServiceTrackingInterceptor</a></dd>
</dl>
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><a href="../../../../../../org/apache/felix/ipojo/dependency/impl/ComparatorBasedServiceRankingInterceptor.html" title="class in org.apache.felix.ipojo.dependency.impl">ComparatorBasedServiceRankingInterceptor</a>, <a href="../../../../../../org/apache/felix/ipojo/dependency/interceptors/DefaultDependencyInterceptor.html" title="class in org.apache.felix.ipojo.dependency.interceptors">DefaultDependencyInterceptor</a>, <a href="../../../../../../org/apache/felix/ipojo/dependency/interceptors/DefaultServiceRankingInterceptor.html" title="class in org.apache.felix.ipojo.dependency.interceptors">DefaultServiceRankingInterceptor</a>, <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/EmptyBasedServiceRankingInterceptor.html" title="class in org.apache.felix.ipojo.dependency.impl">EmptyBasedServiceRankingInterceptor</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/DependencyInterceptor.html#line.33">DependencyInterceptor</a></pre>
<div class="block">Dependency interceptor are collaborating with the service dependency during the service resolution.
Interceptors publishes a service property (target) to select the dependencies they handle.
Notice that interceptor can invalidate the set of service used by a dependency by calling
<a href="../../../../../../org/apache/felix/ipojo/util/DependencyModel.html#invalidateMatchingServices--"><code>DependencyModel.invalidateMatchingServices()</code></a> and
<a href="../../../../../../org/apache/felix/ipojo/util/DependencyModel.html#invalidateSelectedServices--"><code>DependencyModel.invalidateSelectedServices()</code></a>.</div>
</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>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Field and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/felix/ipojo/dependency/interceptors/DependencyInterceptor.html#TARGET_PROPERTY">TARGET_PROPERTY</a></span></code>
<div class="block">A mandatory property published by provider of this service.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/felix/ipojo/dependency/interceptors/DependencyInterceptor.html#close-org.apache.felix.ipojo.util.DependencyModel-">close</a></span>(<a href="../../../../../../org/apache/felix/ipojo/util/DependencyModel.html" title="class in org.apache.felix.ipojo.util">DependencyModel</a>&nbsp;dependency)</code>
<div class="block">The interceptor won't be use anymore by the given dependency.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/felix/ipojo/dependency/interceptors/DependencyInterceptor.html#open-org.apache.felix.ipojo.util.DependencyModel-">open</a></span>(<a href="../../../../../../org/apache/felix/ipojo/util/DependencyModel.html" title="class in org.apache.felix.ipojo.util">DependencyModel</a>&nbsp;dependency)</code>
<div class="block">The interceptor is plugged to the given dependency.</div>
</td>
</tr>
</table>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a name="TARGET_PROPERTY">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>TARGET_PROPERTY</h4>
<pre>static final&nbsp;<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> <a href="../../../../../../src-html/org/apache/felix/ipojo/dependency/interceptors/DependencyInterceptor.html#line.41">TARGET_PROPERTY</a></pre>
<div class="block">A mandatory property published by provider of this service.
The value must be a LDAP filter (Filter or String). This filter will be confronted to the dependency property.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="http://www.osgi.org/javadoc/r4v43/core/org/osgi/framework/Filter.html?is-external=true" title="class or interface in org.osgi.framework"><code>Filter</code></a>,
<a href="../../../../../../constant-values.html#org.apache.felix.ipojo.dependency.interceptors.DependencyInterceptor.TARGET_PROPERTY">Constant Field Values</a></dd>
</dl>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="open-org.apache.felix.ipojo.util.DependencyModel-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>open</h4>
<pre>void&nbsp;<a href="../../../../../../src-html/org/apache/felix/ipojo/dependency/interceptors/DependencyInterceptor.html#line.48">open</a>(<a href="../../../../../../org/apache/felix/ipojo/util/DependencyModel.html" title="class in org.apache.felix.ipojo.util">DependencyModel</a>&nbsp;dependency)</pre>
<div class="block">The interceptor is plugged to the given dependency.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>dependency</code> - the dependency starting using the interceptor.</dd>
</dl>
</li>
</ul>
<a name="close-org.apache.felix.ipojo.util.DependencyModel-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>close</h4>
<pre>void&nbsp;<a href="../../../../../../src-html/org/apache/felix/ipojo/dependency/interceptors/DependencyInterceptor.html#line.55">close</a>(<a href="../../../../../../org/apache/felix/ipojo/util/DependencyModel.html" title="class in org.apache.felix.ipojo.util">DependencyModel</a>&nbsp;dependency)</pre>
<div class="block">The interceptor won't be use anymore by the given dependency.
This method is called either when the interceptor is replace or when the instance's dependency is stopping.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>dependency</code> - the dependency stopping its use of the interceptor</dd>
</dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../../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/DependencyInterceptor.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/DefaultServiceTrackingInterceptor.html" title="class in org.apache.felix.ipojo.dependency.interceptors"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../org/apache/felix/ipojo/dependency/interceptors/ServiceBindingInterceptor.html" title="interface in org.apache.felix.ipojo.dependency.interceptors"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/felix/ipojo/dependency/interceptors/DependencyInterceptor.html" target="_top">Frames</a></li>
<li><a href="DependencyInterceptor.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../../allclasses-noframe.html">All&nbsp;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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</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 &#169; 2014. All rights reserved.</small></p>
</body>
</html>