blob: da918511b2e420a8e47cbb89c4ad1b78d1697f39 [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 (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>ServiceBindingInterceptor (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="ServiceBindingInterceptor (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/ServiceBindingInterceptor.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/DependencyInterceptor.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/ServiceRankingInterceptor.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/ServiceBindingInterceptor.html" target="_top">Frames</a></li>
<li><a href="ServiceBindingInterceptor.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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&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>Field&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 ServiceBindingInterceptor" class="title">Interface ServiceBindingInterceptor</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>
<hr>
<br>
<pre>public interface <a href="../../../../../../src-html/org/apache/felix/ipojo/dependency/interceptors/ServiceBindingInterceptor.html#line.39">ServiceBindingInterceptor</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 modify / monitor the service bindings.
This service is notified every time the dependency is weaving a new service bindings on un-weaves an existing one.
Several binding interceptors can be plugged to the same service dependency. In this case,
a chain is created where all interceptor are called in a sequence.
A binding interceptor cannot modify the existing bindings.
Obviously an interceptor can be plugged to several dependencies.</div>
<dl><dt><span class="strong">Since:</span></dt>
<dd>1.11.0</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&nbsp;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">&nbsp;</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>&lt;S&gt;&nbsp;S</code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/apache/felix/ipojo/dependency/interceptors/ServiceBindingInterceptor.html#getService(org.apache.felix.ipojo.util.DependencyModel, org.osgi.framework.ServiceReference, S)">getService</a></strong>(<a href="../../../../../../org/apache/felix/ipojo/util/DependencyModel.html" title="class in org.apache.felix.ipojo.util">DependencyModel</a>&nbsp;dependency,
<a href="http://www.osgi.org/javadoc/r4v43/core/org/osgi/framework/ServiceReference.html?is-external=true" title="class or interface in org.osgi.framework">ServiceReference</a>&lt;S&gt;&nbsp;reference,
S&nbsp;service)</code>
<div class="block">Notification method when a dependency is weaving a new service binding.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>&lt;S&gt;&nbsp;void</code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/apache/felix/ipojo/dependency/interceptors/ServiceBindingInterceptor.html#ungetService(org.apache.felix.ipojo.util.DependencyModel, org.osgi.framework.ServiceReference)">ungetService</a></strong>(<a href="../../../../../../org/apache/felix/ipojo/util/DependencyModel.html" title="class in org.apache.felix.ipojo.util">DependencyModel</a>&nbsp;dependency,
<a href="http://www.osgi.org/javadoc/r4v43/core/org/osgi/framework/ServiceReference.html?is-external=true" title="class or interface in org.osgi.framework">ServiceReference</a>&lt;S&gt;&nbsp;reference)</code>
<div class="block">Notification method when a dependency is un-weaving a service binding.</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&nbsp;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="getService(org.apache.felix.ipojo.util.DependencyModel,org.osgi.framework.ServiceReference,java.lang.Object)">
<!-- -->
</a><a name="getService(org.apache.felix.ipojo.util.DependencyModel, org.osgi.framework.ServiceReference, S)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getService</h4>
<pre>&lt;S&gt;&nbsp;S&nbsp;<a href="../../../../../../src-html/org/apache/felix/ipojo/dependency/interceptors/ServiceBindingInterceptor.html#line.58">getService</a>(<a href="../../../../../../org/apache/felix/ipojo/util/DependencyModel.html" title="class in org.apache.felix.ipojo.util">DependencyModel</a>&nbsp;dependency,
<a href="http://www.osgi.org/javadoc/r4v43/core/org/osgi/framework/ServiceReference.html?is-external=true" title="class or interface in org.osgi.framework">ServiceReference</a>&lt;S&gt;&nbsp;reference,
S&nbsp;service)</pre>
<div class="block">Notification method when a dependency is weaving a new service binding.
The interceptor can modify the service object. It must <strong>never</strong> return a <code>null</code> object,
but the receive service object if it does not want to do anything with the service object.
When the interceptor <em>modifies</em> the service object, the returned object <strong>must</strong> be
compatible with the dependency specification.
The received service object may already have been <em>wrapped</em> by binding interceptors called before the
current one.</div>
<dl><dt><span class="strong">Type Parameters:</span></dt><dd><code>S</code> - the service specification</dd><dt><span class="strong">Parameters:</span></dt><dd><code>dependency</code> - the dependency</dd><dd><code>reference</code> - the service reference bound</dd><dd><code>service</code> - the service object</dd>
<dt><span class="strong">Returns:</span></dt><dd>the service object to be injected within the component. Must never be <code>null</code>.</dd></dl>
</li>
</ul>
<a name="ungetService(org.apache.felix.ipojo.util.DependencyModel, org.osgi.framework.ServiceReference)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>ungetService</h4>
<pre>&lt;S&gt;&nbsp;void&nbsp;<a href="../../../../../../src-html/org/apache/felix/ipojo/dependency/interceptors/ServiceBindingInterceptor.html#line.68">ungetService</a>(<a href="../../../../../../org/apache/felix/ipojo/util/DependencyModel.html" title="class in org.apache.felix.ipojo.util">DependencyModel</a>&nbsp;dependency,
<a href="http://www.osgi.org/javadoc/r4v43/core/org/osgi/framework/ServiceReference.html?is-external=true" title="class or interface in org.osgi.framework">ServiceReference</a>&lt;S&gt;&nbsp;reference)</pre>
<div class="block">Notification method when a dependency is un-weaving a service binding.
The interceptor must released all objects related to this service binding.</div>
<dl><dt><span class="strong">Type Parameters:</span></dt><dd><code>S</code> - the service specification</dd><dt><span class="strong">Parameters:</span></dt><dd><code>dependency</code> - the dependency</dd><dd><code>reference</code> - the unbound service reference</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/ServiceBindingInterceptor.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/DependencyInterceptor.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/ServiceRankingInterceptor.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/ServiceBindingInterceptor.html" target="_top">Frames</a></li>
<li><a href="ServiceBindingInterceptor.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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&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>Field&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; 2013. All rights reserved.</small></p>
</body>
</html>