blob: eaf0f03941e82ccca80f19dd94fa233d3813444a [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 Sat May 17 12:14:24 CEST 2014 -->
<meta http-equiv="Content-Type" content="text/html" charset="UTF-8">
<title>EventDispatcher (Apache Felix iPOJO ~ JavaDoc 1.12.0 API)</title>
<meta name="date" content="2014-05-17">
<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="EventDispatcher (Apache Felix iPOJO ~ JavaDoc 1.12.0 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/EventDispatcher.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/ErrorHandler.html" title="interface in org.apache.felix.ipojo"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../org/apache/felix/ipojo/Factory.html" title="interface in org.apache.felix.ipojo"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/felix/ipojo/EventDispatcher.html" target="_top">Frames</a></li>
<li><a href="EventDispatcher.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><a href="#field_summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor_summary">Constr</a>&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><a href="#constructor_detail">Constr</a>&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</div>
<h2 title="Class EventDispatcher" class="title">Class EventDispatcher</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li>org.apache.felix.ipojo.EventDispatcher</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public final class <a href="../../../../src-html/org/apache/felix/ipojo/EventDispatcher.html#line.40">EventDispatcher</a>
extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></pre>
<div class="block">iPOJO Internal event dispatcher.
This class provides an internal service event dispatcher in order to tackle the
event storm that can happen when starting large-scale applications.</div>
<dl><dt><span class="strong">Author:</span></dt>
<dd><a href="mailto:dev@felix.apache.org">Felix Project Team</a></dd>
<dt><span class="strong">See Also:</span></dt><dd><a href="http://www.osgi.org/javadoc/r4v43/core/org/osgi/framework/ServiceListener.html?is-external=true" title="class or interface in org.osgi.framework"><code>ServiceListener</code></a></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>
<table class="overviewSummary" 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>private static <a href="../../../../org/apache/felix/ipojo/EventDispatcher.html" title="class in org.apache.felix.ipojo">EventDispatcher</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/felix/ipojo/EventDispatcher.html#DISPATCHER">DISPATCHER</a></strong></code>
<div class="block">The internal event dispatcher.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>private BundleContext</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/felix/ipojo/EventDispatcher.html#m_context">m_context</a></strong></code>
<div class="block">The global bundle context.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>private <a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/felix/ipojo/EventDispatcher.html#m_listeners">m_listeners</a></strong></code>
<div class="block">The list of listeners.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier</th>
<th class="colLast" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>private </code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/felix/ipojo/EventDispatcher.html#EventDispatcher(BundleContext)">EventDispatcher</a></strong>(BundleContext&nbsp;bc)</code>
<div class="block">Creates the EventDispatcher.</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="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>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/felix/ipojo/EventDispatcher.html#addListener(java.lang.String, ServiceListener)">addListener</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;itf,
ServiceListener&nbsp;listener)</code>
<div class="block">Adds a new service listener to the <a href="../../../../org/apache/felix/ipojo/EventDispatcher.html#m_listeners"><code>m_listeners</code></a>
map.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/felix/ipojo/EventDispatcher.html#create(BundleContext)">create</a></strong>(BundleContext&nbsp;bc)</code>
<div class="block">Creates the internal event
dispatcher.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/felix/ipojo/EventDispatcher.html#dispose()">dispose</a></strong>()</code>
<div class="block">Stops and delete the internal event dispatcher.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="../../../../org/apache/felix/ipojo/EventDispatcher.html" title="class in org.apache.felix.ipojo">EventDispatcher</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/felix/ipojo/EventDispatcher.html#getDispatcher()">getDispatcher</a></strong>()</code>
<div class="block">Gets the iPOJO event dispatcher.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/felix/ipojo/EventDispatcher.html#removeListener(ServiceListener)">removeListener</a></strong>(ServiceListener&nbsp;listener)</code>
<div class="block">Removes a service listener.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/felix/ipojo/EventDispatcher.html#serviceChanged(ServiceEvent)">serviceChanged</a></strong>(ServiceEvent&nbsp;event)</code>
<div class="block">Method called when a <code>ServiceEvent</code> is
fired by the OSGi framework.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>private void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/felix/ipojo/EventDispatcher.html#stop()">stop</a></strong>()</code>
<div class="block">Stops the event dispatcher.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait(long, int)" title="class or interface in java.lang">wait</a></code></li>
</ul>
</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="DISPATCHER">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>DISPATCHER</h4>
<pre>private static&nbsp;<a href="../../../../org/apache/felix/ipojo/EventDispatcher.html" title="class in org.apache.felix.ipojo">EventDispatcher</a> <a href="../../../../src-html/org/apache/felix/ipojo/EventDispatcher.html#line.46">DISPATCHER</a></pre>
<div class="block">The internal event dispatcher.
This dispatcher is a singleton.</div>
</li>
</ul>
<a name="m_listeners">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>m_listeners</h4>
<pre>private&nbsp;<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a> <a href="../../../../src-html/org/apache/felix/ipojo/EventDispatcher.html#line.52">m_listeners</a></pre>
<div class="block">The list of listeners.
Service interface -> List of <code>ServiceListener</code></div>
</li>
</ul>
<a name="m_context">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>m_context</h4>
<pre>private&nbsp;BundleContext <a href="../../../../src-html/org/apache/felix/ipojo/EventDispatcher.html#line.57">m_context</a></pre>
<div class="block">The global bundle context.
This is the bundle context from iPOJO.</div>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="EventDispatcher(BundleContext)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>EventDispatcher</h4>
<pre>private&nbsp;<a href="../../../../src-html/org/apache/felix/ipojo/EventDispatcher.html#line.64">EventDispatcher</a>(BundleContext&nbsp;bc)</pre>
<div class="block">Creates the EventDispatcher.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>bc</code> - the bundle context used to register and unregister
<code>ServiceListener</code>.</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="create(BundleContext)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>create</h4>
<pre>public static&nbsp;void&nbsp;<a href="../../../../src-html/org/apache/felix/ipojo/EventDispatcher.html#line.77">create</a>(BundleContext&nbsp;bc)</pre>
<div class="block">Creates the internal event
dispatcher.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>bc</code> - the iPOJO bundle context to send to the
internal event dispatcher.</dd></dl>
</li>
</ul>
<a name="dispose()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>dispose</h4>
<pre>public static&nbsp;void&nbsp;<a href="../../../../src-html/org/apache/felix/ipojo/EventDispatcher.html#line.86">dispose</a>()</pre>
<div class="block">Stops and delete the internal event dispatcher.
This method must be call only
if iPOJO is stopping.</div>
</li>
</ul>
<a name="getDispatcher()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDispatcher</h4>
<pre>public static&nbsp;<a href="../../../../org/apache/felix/ipojo/EventDispatcher.html" title="class in org.apache.felix.ipojo">EventDispatcher</a>&nbsp;<a href="../../../../src-html/org/apache/felix/ipojo/EventDispatcher.html#line.97">getDispatcher</a>()</pre>
<div class="block">Gets the iPOJO event dispatcher.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the event dispatcher or
<code>null</code> if not created.</dd></dl>
</li>
</ul>
<a name="stop()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>stop</h4>
<pre>private&nbsp;void&nbsp;<a href="../../../../src-html/org/apache/felix/ipojo/EventDispatcher.html#line.108">stop</a>()</pre>
<div class="block">Stops the event dispatcher.
This method unregisters the <code>ServiceListener</code>.
This methods must be called only when the iPOJO bundle
stops.</div>
</li>
</ul>
<a name="serviceChanged(ServiceEvent)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>serviceChanged</h4>
<pre>public&nbsp;void&nbsp;<a href="../../../../src-html/org/apache/felix/ipojo/EventDispatcher.html#line.124">serviceChanged</a>(ServiceEvent&nbsp;event)</pre>
<div class="block">Method called when a <code>ServiceEvent</code> is
fired by the OSGi framework.
According to the event, this method dispatches
to interested registered listers from
the <a href="../../../../org/apache/felix/ipojo/EventDispatcher.html#m_listeners"><code>m_listeners</code></a> map.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>event</code> - the service event</dd><dt><span class="strong">See Also:</span></dt><dd><a href="http://www.osgi.org/javadoc/r4v43/core/org/osgi/framework/ServiceListener.html?is-external=true#serviceChanged(org.osgi.framework.ServiceEvent)" title="class or interface in org.osgi.framework"><code>ServiceListener</code></a></dd></dl>
</li>
</ul>
<a name="addListener(java.lang.String, ServiceListener)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addListener</h4>
<pre>public&nbsp;void&nbsp;<a href="../../../../src-html/org/apache/felix/ipojo/EventDispatcher.html#line.148">addListener</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;itf,
ServiceListener&nbsp;listener)</pre>
<div class="block">Adds a new service listener to the <a href="../../../../org/apache/felix/ipojo/EventDispatcher.html#m_listeners"><code>m_listeners</code></a>
map. This method specifies the listen service interface</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>itf</code> - the service interface</dd><dd><code>listener</code> - the service listener</dd></dl>
</li>
</ul>
<a name="removeListener(ServiceListener)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>removeListener</h4>
<pre>public&nbsp;boolean&nbsp;<a href="../../../../src-html/org/apache/felix/ipojo/EventDispatcher.html#line.167">removeListener</a>(ServiceListener&nbsp;listener)</pre>
<div class="block">Removes a service listener.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>listener</code> - the service listener to remove</dd>
<dt><span class="strong">Returns:</span></dt><dd><code>true</code> if the listener is
successfully removed.</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/EventDispatcher.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/ErrorHandler.html" title="interface in org.apache.felix.ipojo"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../org/apache/felix/ipojo/Factory.html" title="interface in org.apache.felix.ipojo"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/felix/ipojo/EventDispatcher.html" target="_top">Frames</a></li>
<li><a href="EventDispatcher.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><a href="#field_summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor_summary">Constr</a>&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><a href="#constructor_detail">Constr</a>&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>