| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (14.0.1) on Tue Jun 15 20:48:08 PDT 2021 --> |
| <title>DistributedEventAdmin (Eclipse Communication Framework (ECF) 3.14.22 API)</title> |
| <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> |
| <meta name="dc.created" content="2021-06-15"> |
| <meta name="description" content="declaration: package: org.eclipse.ecf.remoteservice.eventadmin, class: DistributedEventAdmin"> |
| <meta name="generator" content="javadoc/ClassWriterImpl"> |
| <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.css" title="Style"> |
| <script type="text/javascript" src="../../../../../script.js"></script> |
| <script type="text/javascript" src="../../../../../script-dir/jszip/dist/jszip.min.js"></script> |
| <script type="text/javascript" src="../../../../../script-dir/jszip-utils/dist/jszip-utils.min.js"></script> |
| <!--[if IE]> |
| <script type="text/javascript" src="../../../../../script-dir/jszip-utils/dist/jszip-utils-ie.min.js"></script> |
| <![endif]--> |
| <script type="text/javascript" src="../../../../../script-dir/jquery-3.4.1.js"></script> |
| <script type="text/javascript" src="../../../../../script-dir/jquery-ui.js"></script> |
| </head> |
| <body class="class-declaration"> |
| <script type="text/javascript">var data = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10,"i17":10,"i18":10,"i19":10,"i20":10,"i21":10,"i22":10,"i23":10}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| var pathtoroot = "../../../../../"; |
| loadScripts(document, 'script');</script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <div class="flexBox"> |
| <header role="banner" class="flexHeader"> |
| <nav role="navigation"> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a id="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a id="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/DistributedEventAdmin.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-files/index-1.html">Index</a></li> |
| <li><a href="../../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li><a href="#field.summary">Field</a> | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field.detail">Field</a> | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <div class="navListSearch"><label for="search">SEARCH:</label> |
| <input type="text" id="search" value="search" disabled="disabled"> |
| <input type="reset" id="reset" value="reset" disabled="disabled"> |
| </div> |
| </div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <div class="skipNav"><a id="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| </nav> |
| </header> |
| <div class="flexContent"> |
| <main role="main"> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle"><span class="packageLabelInType">Package</span> <a href="package-summary.html">org.eclipse.ecf.remoteservice.eventadmin</a></div> |
| <h1 title="Class DistributedEventAdmin" class="title">Class DistributedEventAdmin</h1> |
| </div> |
| <div class="contentContainer"> |
| <div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">java.lang.Object</a> |
| <div class="inheritance"><a href="../../core/sharedobject/BaseSharedObject.html" title="class in org.eclipse.ecf.core.sharedobject">org.eclipse.ecf.core.sharedobject.BaseSharedObject</a> |
| <div class="inheritance">org.eclipse.ecf.remoteservice.eventadmin.DistributedEventAdmin</div> |
| </div> |
| </div> |
| <section class="description"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><code>org.eclipse.core.runtime.IAdaptable</code>, <code><a href="../../core/identity/IIdentifiable.html" title="interface in org.eclipse.ecf.core.identity">IIdentifiable</a></code>, <code><a href="../../core/sharedobject/ISharedObject.html" title="interface in org.eclipse.ecf.core.sharedobject">ISharedObject</a></code>, <code>org.osgi.service.event.EventAdmin</code></dd> |
| </dl> |
| <hr> |
| <pre>public class <span class="typeNameLabel">DistributedEventAdmin</span> |
| extends <a href="../../core/sharedobject/BaseSharedObject.html" title="class in org.eclipse.ecf.core.sharedobject">BaseSharedObject</a> |
| implements org.osgi.service.event.EventAdmin</pre> |
| </section> |
| <section class="summary"> |
| <ul class="blockList"> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <li class="blockList"> |
| <section class="fieldSummary"><a id="field.summary"> |
| <!-- --> |
| </a> |
| <h2>Field Summary</h2> |
| <div class="memberSummary"> |
| <table> |
| <caption><span>Fields</span><span class="tabEnd"> </span></caption> |
| <thead> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colSecond" scope="col">Field</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected <a href="https://docs.osgi.org/javadoc/osgi.core/7.0.0/org/osgi/framework/BundleContext.html?is-external=true" title="class or interface in org.osgi.framework" class="externalLink">BundleContext</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#context">context</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected org.eclipse.ecf.internal.remoteservice.eventadmin.EventHandlerTracker</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#eventHandlerTracker">eventHandlerTracker</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected static boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#ignoreSerializationExceptions">ignoreSerializationExceptions</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <div class="inheritedList"> |
| <h3>Fields inherited from class org.eclipse.ecf.core.sharedobject.<a href="../../core/sharedobject/BaseSharedObject.html" title="class in org.eclipse.ecf.core.sharedobject">BaseSharedObject</a></h3> |
| <a id="fields.inherited.from.class.org.eclipse.ecf.core.sharedobject.BaseSharedObject"> |
| <!-- --> |
| </a><code><a href="../../core/sharedobject/BaseSharedObject.html#DESTROYREMOTE_CODE">DESTROYREMOTE_CODE</a>, <a href="../../core/sharedobject/BaseSharedObject.html#DESTROYSELFLOCAL_CODE">DESTROYSELFLOCAL_CODE</a></code></div> |
| </section> |
| </li> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <li class="blockList"> |
| <section class="constructorSummary"><a id="constructor.summary"> |
| <!-- --> |
| </a> |
| <h2>Constructor Summary</h2> |
| <div class="memberSummary"> |
| <table> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <thead> |
| <tr> |
| <th class="colFirst" scope="col">Modifier</th> |
| <th class="colSecond" scope="col">Constructor</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected </code></td> |
| <th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E()">DistributedEventAdmin</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code> </code></td> |
| <th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(org.osgi.framework.BundleContext)">DistributedEventAdmin</a></span>​(<a href="https://docs.osgi.org/javadoc/osgi.core/7.0.0/org/osgi/framework/BundleContext.html?is-external=true" title="class or interface in org.osgi.framework" class="externalLink">BundleContext</a> context)</code></th> |
| <td class="colLast"> |
| <div class="block">Create a Distributed EventAdmin implementation.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code> </code></td> |
| <th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(org.osgi.framework.BundleContext,org.osgi.service.log.LogService)">DistributedEventAdmin</a></span>​(<a href="https://docs.osgi.org/javadoc/osgi.core/7.0.0/org/osgi/framework/BundleContext.html?is-external=true" title="class or interface in org.osgi.framework" class="externalLink">BundleContext</a> context, |
| org.osgi.service.log.LogService log)</code></th> |
| <td class="colLast"> |
| <div class="block">Create a Distributed EventAdmin implementation.</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </section> |
| </li> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <li class="blockList"> |
| <section class="methodSummary"><a id="method.summary"> |
| <!-- --> |
| </a> |
| <h2>Method Summary</h2> |
| <div class="memberSummary"> |
| <div role="tablist" aria-orientation="horizontal"><button role="tab" aria-selected="true" aria-controls="memberSummary_tabpanel" tabindex="0" onkeydown="switchTab(event)" id="t0" class="activeTableTab">All Methods</button><button role="tab" aria-selected="false" aria-controls="memberSummary_tabpanel" tabindex="-1" onkeydown="switchTab(event)" id="t2" class="tableTab" onclick="show(2);">Instance Methods</button><button role="tab" aria-selected="false" aria-controls="memberSummary_tabpanel" tabindex="-1" onkeydown="switchTab(event)" id="t4" class="tableTab" onclick="show(8);">Concrete Methods</button></div> |
| <div id="memberSummary_tabpanel" role="tabpanel"> |
| <table aria-labelledby="t0"> |
| <thead> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colSecond" scope="col">Method</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr class="altColor" id="i0"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#addEventTopicFilters(java.lang.String%5B%5D)">addEventTopicFilters</a></span>​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>[] filters)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor" id="i1"> |
| <td class="colFirst"><code>protected org.osgi.service.event.Event</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#createEventFromMessageData(org.eclipse.ecf.core.identity.ID,java.lang.Object%5B%5D)">createEventFromMessageData</a></span>​(<a href="../../core/identity/ID.html" title="interface in org.eclipse.ecf.core.identity">ID</a> fromID, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>[] messageData)</code></th> |
| <td class="colLast"> |
| <div class="block">Create a local <code>Event</code> from deserialized messageData.</div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i2"> |
| <td class="colFirst"><code>protected <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>[]</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#createMessageDataFromEvent(org.eclipse.ecf.core.identity.ID,org.osgi.service.event.Event)">createMessageDataFromEvent</a></span>​(<a href="../../core/identity/ID.html" title="interface in org.eclipse.ecf.core.identity">ID</a> target, |
| org.osgi.service.event.Event eventToSend)</code></th> |
| <td class="colLast"> |
| <div class="block">Create message data for deliver to a target (which could be |
| <code>null</code> to designate multiple target receivers), The resulting |
| Object[] must be Serializable and in a form that receivers can |
| deserialize via <a href="#createEventFromMessageData(org.eclipse.ecf.core.identity.ID,java.lang.Object%5B%5D)"><code>createEventFromMessageData(ID, Object[])</code></a> on the |
| receiver.</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i3"> |
| <td class="colFirst"><code>protected org.osgi.service.event.Event</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getEventToSend(org.osgi.service.event.Event)">getEventToSend</a></span>​(org.osgi.service.event.Event event)</code></th> |
| <td class="colLast"> |
| <div class="block">Get the actual event to pass to <a href="#sendMessage(org.osgi.service.event.Event)"><code>sendMessage(Event)</code></a>.</div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i4"> |
| <td class="colFirst"><code>protected <a href="serialization/SerializationHandler.html" title="class in org.eclipse.ecf.remoteservice.eventadmin.serialization">SerializationHandler</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getSerializationHandler(java.lang.String)">getSerializationHandler</a></span>​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> topic)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor" id="i5"> |
| <td class="colFirst"><code>protected <a href="../../core/identity/ID.html" title="interface in org.eclipse.ecf.core.identity">ID</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getTarget(org.osgi.service.event.Event)">getTarget</a></span>​(org.osgi.service.event.Event eventToSend)</code></th> |
| <td class="colLast"> |
| <div class="block">Get the target receiver for the eventToSend.</div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i6"> |
| <td class="colFirst"><code>protected void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#handleSendMessageException(java.lang.String,org.osgi.service.event.Event,java.lang.Object%5B%5D,java.io.IOException)">handleSendMessageException</a></span>​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> message, |
| org.osgi.service.event.Event eventToSend, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>[] messageParams, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/IOException.html?is-external=true" title="class or interface in java.io" class="externalLink">IOException</a> exception)</code></th> |
| <td class="colLast"> |
| <div class="block">Handle any exceptions occuring as part of Event serialization or message |
| send.</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i7"> |
| <td class="colFirst"><code>protected boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#handleSharedObjectMsg(org.eclipse.ecf.core.identity.ID,org.eclipse.ecf.core.sharedobject.SharedObjectMsg)">handleSharedObjectMsg</a></span>​(<a href="../../core/identity/ID.html" title="interface in org.eclipse.ecf.core.identity">ID</a> fromID, |
| <a href="../../core/sharedobject/SharedObjectMsg.html" title="class in org.eclipse.ecf.core.sharedobject">SharedObjectMsg</a> msg)</code></th> |
| <td class="colLast"> |
| <div class="block">Handle the shared object message.</div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i8"> |
| <td class="colFirst"><code>protected boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#handleSharedObjectMsgEvent(org.eclipse.ecf.core.sharedobject.events.ISharedObjectMessageEvent)">handleSharedObjectMsgEvent</a></span>​(<a href="../../core/sharedobject/events/ISharedObjectMessageEvent.html" title="interface in org.eclipse.ecf.core.sharedobject.events">ISharedObjectMessageEvent</a> event)</code></th> |
| <td class="colLast"> |
| <div class="block">Override of BaseSharedObject.handleSharedObjectMsgEvent.</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i9"> |
| <td class="colFirst"><code>protected void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#localDispatch(org.osgi.service.event.Event,boolean)">localDispatch</a></span>​(org.osgi.service.event.Event dispatchedEvent, |
| boolean isAsync)</code></th> |
| <td class="colLast"> |
| <div class="block">Locally dispatch an Event.</div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i10"> |
| <td class="colFirst"><code>protected void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#logError(java.lang.String)">logError</a></span>​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> message)</code></th> |
| <td class="colLast"> |
| <div class="block">Log an error.</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i11"> |
| <td class="colFirst"><code>protected void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#logError(java.lang.String,java.lang.Throwable)">logError</a></span>​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> message, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Throwable.html?is-external=true" title="class or interface in java.lang" class="externalLink">Throwable</a> exception)</code></th> |
| <td class="colLast"> |
| <div class="block">Log an error.</div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i12"> |
| <td class="colFirst"><code>protected void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#logWarning(java.lang.String)">logWarning</a></span>​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> message)</code></th> |
| <td class="colLast"> |
| <div class="block">Log a warning.</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i13"> |
| <td class="colFirst"><code>protected void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#logWarning(java.lang.String,java.lang.Throwable)">logWarning</a></span>​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> message, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Throwable.html?is-external=true" title="class or interface in java.lang" class="externalLink">Throwable</a> exception)</code></th> |
| <td class="colLast"> |
| <div class="block">Log a warning.</div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i14"> |
| <td class="colFirst"><code>protected void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#notifyPostLocalDispatch(org.osgi.service.event.Event)">notifyPostLocalDispatch</a></span>​(org.osgi.service.event.Event event)</code></th> |
| <td class="colLast"> |
| <div class="block">Notification called after local dispatch has been done.</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i15"> |
| <td class="colFirst"><code>protected void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#notifyPostSendMessage(org.osgi.service.event.Event)">notifyPostSendMessage</a></span>​(org.osgi.service.event.Event eventSent)</code></th> |
| <td class="colLast"> |
| <div class="block">Method called after <a href="#sendMessage(org.osgi.service.event.Event)"><code>sendMessage(Event)</code></a> is called (typically from |
| within <a href="#postEvent(org.osgi.service.event.Event)"><code>postEvent(Event)</code></a>), but prior to local dispatch.</div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i16"> |
| <td class="colFirst"><code>protected org.osgi.service.event.Event</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#notifyPreLocalDispatch(org.osgi.service.event.Event)">notifyPreLocalDispatch</a></span>​(org.osgi.service.event.Event event)</code></th> |
| <td class="colLast"> |
| <div class="block">Method called from within <a href="#localDispatch(org.osgi.service.event.Event,boolean)"><code>localDispatch(Event, boolean)</code></a> prior to |
| actual deliver to matching <code>EventHandler</code>s.</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i17"> |
| <td class="colFirst"><code>protected void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#notifyReceivedEvent(org.eclipse.ecf.core.identity.ID,org.osgi.service.event.Event)">notifyReceivedEvent</a></span>​(<a href="../../core/identity/ID.html" title="interface in org.eclipse.ecf.core.identity">ID</a> fromID, |
| org.osgi.service.event.Event receivedEvent)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="altColor" id="i18"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#postEvent(org.osgi.service.event.Event)">postEvent</a></span>​(org.osgi.service.event.Event event)</code></th> |
| <td class="colLast"> |
| <div class="block">Post an event for asynchronous delivery via this distributed event admin.</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i19"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#removeEventTopicFilters(java.lang.String%5B%5D)">removeEventTopicFilters</a></span>​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>[] filters)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="altColor" id="i20"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#sendEvent(org.osgi.service.event.Event)">sendEvent</a></span>​(org.osgi.service.event.Event event)</code></th> |
| <td class="colLast"> |
| <div class="block">Send the given event synchronously.</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i21"> |
| <td class="colFirst"><code>protected void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#sendMessage(org.osgi.service.event.Event)">sendMessage</a></span>​(org.osgi.service.event.Event eventToSend)</code></th> |
| <td class="colLast"> |
| <div class="block">Send the event as a shared object message.</div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i22"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#start()">start</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Start this distributed event admin instance.</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i23"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#stop()">stop</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Stop this distributed event admin instance.</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </div> |
| <div class="inheritedList"> |
| <h3>Methods inherited from class org.eclipse.ecf.core.sharedobject.<a href="../../core/sharedobject/BaseSharedObject.html" title="class in org.eclipse.ecf.core.sharedobject">BaseSharedObject</a></h3> |
| <a id="methods.inherited.from.class.org.eclipse.ecf.core.sharedobject.BaseSharedObject"> |
| <!-- --> |
| </a><code><a href="../../core/sharedobject/BaseSharedObject.html#addEventProcessor(org.eclipse.ecf.core.util.IEventProcessor)">addEventProcessor</a>, <a href="../../core/sharedobject/BaseSharedObject.html#clearEventProcessors()">clearEventProcessors</a>, <a href="../../core/sharedobject/BaseSharedObject.html#creationCompleted()">creationCompleted</a>, <a href="../../core/sharedobject/BaseSharedObject.html#destroyRemote(org.eclipse.ecf.core.identity.ID)">destroyRemote</a>, <a href="../../core/sharedobject/BaseSharedObject.html#destroySelf()">destroySelf</a>, <a href="../../core/sharedobject/BaseSharedObject.html#destroySelfLocal()">destroySelfLocal</a>, <a href="../../core/sharedobject/BaseSharedObject.html#dispose(org.eclipse.ecf.core.identity.ID)">dispose</a>, <a href="../../core/sharedobject/BaseSharedObject.html#fireEventProcessors(org.eclipse.ecf.core.util.Event)">fireEventProcessors</a>, <a href="../../core/sharedobject/BaseSharedObject.html#getAdapter(java.lang.Class)">getAdapter</a>, <a href="../../core/sharedobject/BaseSharedObject.html#getConfig()">getConfig</a>, <a href="../../core/sharedobject/BaseSharedObject.html#getConnectedID()">getConnectedID</a>, <a href="../../core/sharedobject/BaseSharedObject.html#getContext()">getContext</a>, <a href="../../core/sharedobject/BaseSharedObject.html#getGroupMemberIDs()">getGroupMemberIDs</a>, <a href="../../core/sharedobject/BaseSharedObject.html#getHomeContainerID()">getHomeContainerID</a>, <a href="../../core/sharedobject/BaseSharedObject.html#getID()">getID</a>, <a href="../../core/sharedobject/BaseSharedObject.html#getLocalContainerID()">getLocalContainerID</a>, <a href="../../core/sharedobject/BaseSharedObject.html#getProperties()">getProperties</a>, <a href="../../core/sharedobject/BaseSharedObject.html#getReplicaDescription(org.eclipse.ecf.core.identity.ID)">getReplicaDescription</a>, <a href="../../core/sharedobject/BaseSharedObject.html#getReplicaDescriptions(org.eclipse.ecf.core.identity.ID%5B%5D)">getReplicaDescriptions</a>, <a href="../../core/sharedobject/BaseSharedObject.html#getSharedObjectMsgFromEvent(org.eclipse.ecf.core.sharedobject.events.ISharedObjectMessageEvent)">getSharedObjectMsgFromEvent</a>, <a href="../../core/sharedobject/BaseSharedObject.html#handleEvent(org.eclipse.ecf.core.util.Event)">handleEvent</a>, <a href="../../core/sharedobject/BaseSharedObject.html#handleEvents(org.eclipse.ecf.core.util.Event%5B%5D)">handleEvents</a>, <a href="../../core/sharedobject/BaseSharedObject.html#handleSharedObjectCreateResponseEvent(org.eclipse.ecf.core.sharedobject.events.ISharedObjectCreateResponseEvent)">handleSharedObjectCreateResponseEvent</a>, <a href="../../core/sharedobject/BaseSharedObject.html#handleSharedObjectMsg(org.eclipse.ecf.core.sharedobject.SharedObjectMsg)">handleSharedObjectMsg</a>, <a href="../../core/sharedobject/BaseSharedObject.html#handleUnhandledEvent(org.eclipse.ecf.core.util.Event)">handleUnhandledEvent</a>, <a href="../../core/sharedobject/BaseSharedObject.html#init(org.eclipse.ecf.core.sharedobject.ISharedObjectConfig)">init</a>, <a href="../../core/sharedobject/BaseSharedObject.html#initialize()">initialize</a>, <a href="../../core/sharedobject/BaseSharedObject.html#isConnected()">isConnected</a>, <a href="../../core/sharedobject/BaseSharedObject.html#isPrimary()">isPrimary</a>, <a href="../../core/sharedobject/BaseSharedObject.html#log(int,java.lang.String,java.lang.Throwable)">log</a>, <a href="../../core/sharedobject/BaseSharedObject.html#log(java.lang.String,java.lang.Throwable)">log</a>, <a href="../../core/sharedobject/BaseSharedObject.html#removeEventProcessor(org.eclipse.ecf.core.util.IEventProcessor)">removeEventProcessor</a>, <a href="../../core/sharedobject/BaseSharedObject.html#replicateToRemoteContainers(org.eclipse.ecf.core.identity.ID%5B%5D)">replicateToRemoteContainers</a>, <a href="../../core/sharedobject/BaseSharedObject.html#sendSharedObjectMsgTo(org.eclipse.ecf.core.identity.ID,org.eclipse.ecf.core.sharedobject.SharedObjectMsg)">sendSharedObjectMsgTo</a>, <a href="../../core/sharedobject/BaseSharedObject.html#sendSharedObjectMsgToPrimary(org.eclipse.ecf.core.sharedobject.SharedObjectMsg)">sendSharedObjectMsgToPrimary</a>, <a href="../../core/sharedobject/BaseSharedObject.html#sendSharedObjectMsgToSelf(org.eclipse.ecf.core.sharedobject.SharedObjectMsg)">sendSharedObjectMsgToSelf</a>, <a href="../../core/sharedobject/BaseSharedObject.html#trace(java.lang.String,java.lang.String)">trace</a>, <a href="../../core/sharedobject/BaseSharedObject.html#traceCatching(java.lang.String,java.lang.Throwable)">traceCatching</a>, <a href="../../core/sharedobject/BaseSharedObject.html#traceEntering(java.lang.String)">traceEntering</a>, <a href="../../core/sharedobject/BaseSharedObject.html#traceEntering(java.lang.String,java.lang.Object)">traceEntering</a>, <a href="../../core/sharedobject/BaseSharedObject.html#traceEntering(java.lang.String,java.lang.Object%5B%5D)">traceEntering</a>, <a href="../../core/sharedobject/BaseSharedObject.html#traceExiting(java.lang.String)">traceExiting</a>, <a href="../../core/sharedobject/BaseSharedObject.html#traceExiting(java.lang.String,java.lang.Object)">traceExiting</a></code></div> |
| <div class="inheritedList"> |
| <h3>Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></h3> |
| <a id="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang" class="externalLink">clone</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang" class="externalLink">equals</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang" class="externalLink">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang" class="externalLink">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang" class="externalLink">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang" class="externalLink">notify</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang" class="externalLink">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang" class="externalLink">toString</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang" class="externalLink">wait</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang" class="externalLink">wait</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#wait(long,int)" title="class or interface in java.lang" class="externalLink">wait</a></code></div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <section class="details"> |
| <ul class="blockList"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <li class="blockList"> |
| <section class="fieldDetails"><a id="field.detail"> |
| <!-- --> |
| </a> |
| <h2>Field Details</h2> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="ignoreSerializationExceptions">ignoreSerializationExceptions</a></h3> |
| <div class="memberSignature"><span class="modifiers">protected static</span> <span class="returnType">boolean</span> <span class="memberName">ignoreSerializationExceptions</span></div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.2</dd> |
| <dt><span class="simpleTagLabel">Restriction:</span></dt> |
| <dd>protected non-final for unit tests only!!!</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="eventHandlerTracker">eventHandlerTracker</a></h3> |
| <div class="memberSignature"><span class="modifiers">protected</span> <span class="returnType">org.eclipse.ecf.internal.remoteservice.eventadmin.EventHandlerTracker</span> <span class="memberName">eventHandlerTracker</span></div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.2</dd> |
| <dt><span class="simpleTagLabel">Restriction:</span></dt> |
| <dd>This field is not intended to be referenced by clients.</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="context">context</a></h3> |
| <div class="memberSignature"><span class="modifiers">protected</span> <span class="returnType"><a href="https://docs.osgi.org/javadoc/osgi.core/7.0.0/org/osgi/framework/BundleContext.html?is-external=true" title="class or interface in org.osgi.framework" class="externalLink">BundleContext</a></span> <span class="memberName">context</span></div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.2</dd> |
| </dl> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <li class="blockList"> |
| <section class="constructorDetails"><a id="constructor.detail"> |
| <!-- --> |
| </a> |
| <h2>Constructor Details</h2> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="<init>()">DistributedEventAdmin</a></h3> |
| <div class="memberSignature"><span class="modifiers">protected</span> <span class="memberName">DistributedEventAdmin</span>()</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Restriction:</span></dt> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="<init>(org.osgi.framework.BundleContext,org.osgi.service.log.LogService)">DistributedEventAdmin</a></h3> |
| <div class="memberSignature"><span class="modifiers">public</span> <span class="memberName">DistributedEventAdmin</span>​(<span class="arguments"><a href="https://docs.osgi.org/javadoc/osgi.core/7.0.0/org/osgi/framework/BundleContext.html?is-external=true" title="class or interface in org.osgi.framework" class="externalLink">BundleContext</a> context, |
| org.osgi.service.log.LogService log)</span></div> |
| <div class="block">Create a Distributed EventAdmin implementation.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>context</code> - the BundleContext to be used. Must not be <code>null</code>.</dd> |
| <dd><code>log</code> - the <code>LogService</code> to use. May be <code>null</code>. If |
| <code>null</code>, then a LogTracker is created and |
| used to find and use a <code>LogService</code>.</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.1</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="<init>(org.osgi.framework.BundleContext)">DistributedEventAdmin</a></h3> |
| <div class="memberSignature"><span class="modifiers">public</span> <span class="memberName">DistributedEventAdmin</span>​(<span class="arguments"><a href="https://docs.osgi.org/javadoc/osgi.core/7.0.0/org/osgi/framework/BundleContext.html?is-external=true" title="class or interface in org.osgi.framework" class="externalLink">BundleContext</a> context)</span></div> |
| <div class="block">Create a Distributed EventAdmin implementation.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>context</code> - the BundleContext to be used. Must not be <code>null</code>.</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.1</dd> |
| </dl> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| <!-- ============ METHOD DETAIL ========== --> |
| <li class="blockList"> |
| <section class="methodDetails"><a id="method.detail"> |
| <!-- --> |
| </a> |
| <h2>Method Details</h2> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="start()">start</a></h3> |
| <div class="memberSignature"><span class="modifiers">public</span> <span class="returnType">void</span> <span class="memberName">start</span>()</div> |
| <div class="block">Start this distributed event admin instance. This method should be called |
| prior to registering this object as an <code>EventAdmin</code> implementation |
| with the OSGi service registry.</div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="stop()">stop</a></h3> |
| <div class="memberSignature"><span class="modifiers">public</span> <span class="returnType">void</span> <span class="memberName">stop</span>()</div> |
| <div class="block">Stop this distributed event admin instance. This method should be called |
| after unregistering the <a href="https://docs.osgi.org/javadoc/osgi.core/7.0.0/org/osgi/framework/ServiceRegistration.html?is-external=true" title="class or interface in org.osgi.framework" class="externalLink"><code>ServiceRegistration</code></a> created on |
| registration with the OSGi service registry.</div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="sendEvent(org.osgi.service.event.Event)">sendEvent</a></h3> |
| <div class="memberSignature"><span class="modifiers">public</span> <span class="returnType">void</span> <span class="memberName">sendEvent</span>​(<span class="arguments">org.osgi.service.event.Event event)</span></div> |
| <div class="block">Send the given event synchronously. The default implementation of this |
| method simply does a <b>local-only</b> dispatch to <code>EventHandler</code>s. |
| It does <b>not</b> attempt to distribute the given event as does |
| <a href="#postEvent(org.osgi.service.event.Event)"><code>postEvent(Event)</code></a>.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code>sendEvent</code> in interface <code>org.osgi.service.event.EventAdmin</code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>event</code> - the Event to send synchronously to local <code>EventHandler</code>s |
| (only). Must not be <code>null</code>.</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="postEvent(org.osgi.service.event.Event)">postEvent</a></h3> |
| <div class="memberSignature"><span class="modifiers">public</span> <span class="returnType">void</span> <span class="memberName">postEvent</span>​(<span class="arguments">org.osgi.service.event.Event event)</span></div> |
| <div class="block">Post an event for asynchronous delivery via this distributed event admin. |
| This is the primary entry point for the distributed event admin |
| implementation for asynchronous delivery to a set of receivers (known to |
| the this shared object and it's enclosing <a href="../../core/IContainer.html" title="interface in org.eclipse.ecf.core"><code>IContainer</code></a>. The event |
| to post must not be <code>null</code>. |
| <p> |
| This implementation goes through the following steps |
| <ol> |
| <li>Call <a href="#getEventToSend(org.osgi.service.event.Event)"><code>getEventToSend(Event)</code></a>. If the Event returned from |
| getEventToSend is <code>null</code>, then the following three method |
| calls do not occur, and postEvent returns immediately.</li> |
| <li>Call <a href="#sendMessage(org.osgi.service.event.Event)"><code>sendMessage(Event)</code></a> with the non-<code>null</code> |
| result of <a href="#getEventToSend(org.osgi.service.event.Event)"><code>getEventToSend(Event)</code></a></li> |
| <li>Call <a href="#notifyPostSendMessage(org.osgi.service.event.Event)"><code>notifyPostSendMessage(Event)</code></a></li> |
| <li>Call <a href="#localDispatch(org.osgi.service.event.Event,boolean)"><code>localDispatch(Event, boolean)</code></a></li> |
| </ol></div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code>postEvent</code> in interface <code>org.osgi.service.event.EventAdmin</code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>event</code> - the Event to send asynchronously to matching |
| <code>EventHandler</code>s. Must not be <code>null</code>.</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.1</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="sendMessage(org.osgi.service.event.Event)">sendMessage</a></h3> |
| <div class="memberSignature"><span class="modifiers">protected</span> <span class="returnType">void</span> <span class="memberName">sendMessage</span>​(<span class="arguments">org.osgi.service.event.Event eventToSend)</span></div> |
| <div class="block">Send the event as a shared object message. The given event will be |
| serialized and sent via |
| <a href="../../core/sharedobject/BaseSharedObject.html#sendSharedObjectMsgTo(org.eclipse.ecf.core.identity.ID,org.eclipse.ecf.core.sharedobject.SharedObjectMsg)"><code>BaseSharedObject.sendSharedObjectMsgTo(ID, SharedObjectMsg)</code></a>. |
| <p> |
| Prior to actual sending, the <a href="#getTarget(org.osgi.service.event.Event)"><code>getTarget(Event)</code></a> method will be |
| called, to allow subclasses to determine the target receiver. Then the |
| <a href="#createMessageDataFromEvent(org.eclipse.ecf.core.identity.ID,org.osgi.service.event.Event)"><code>createMessageDataFromEvent(ID, Event)</code></a> method is called, to |
| create an Object[] of data for sending in the message. The Object[] |
| returned from <a href="#createMessageDataFromEvent(org.eclipse.ecf.core.identity.ID,org.osgi.service.event.Event)"><code>createMessageDataFromEvent(ID, Event)</code></a> must be |
| serializable. See <a href="#createMessageDataFromEvent(org.eclipse.ecf.core.identity.ID,org.osgi.service.event.Event)"><code>createMessageDataFromEvent(ID, Event)</code></a>. |
| <p> |
| Subclasses may override this method to customize or replace this |
| sendMessage behavior. |
| <p> |
| If an exception occurs on serialization or sending, the |
| <a href="#handleSendMessageException(java.lang.String,org.osgi.service.event.Event,java.lang.Object%5B%5D,java.io.IOException)"><code>handleSendMessageException(String, Event, Object[], IOException)</code></a> |
| method will be called to handle it.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>eventToSend</code> - the event to send. Will not be <code>null</code>.</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.1</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="createMessageDataFromEvent(org.eclipse.ecf.core.identity.ID,org.osgi.service.event.Event)">createMessageDataFromEvent</a></h3> |
| <div class="memberSignature"><span class="modifiers">protected</span> <span class="returnType"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>[]</span> <span class="memberName">createMessageDataFromEvent</span>​(<span class="arguments"><a href="../../core/identity/ID.html" title="interface in org.eclipse.ecf.core.identity">ID</a> target, |
| org.osgi.service.event.Event eventToSend)</span> |
| throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/NotSerializableException.html?is-external=true" title="class or interface in java.io" class="externalLink">NotSerializableException</a></span></div> |
| <div class="block">Create message data for deliver to a target (which could be |
| <code>null</code> to designate multiple target receivers), The resulting |
| Object[] must be Serializable and in a form that receivers can |
| deserialize via <a href="#createEventFromMessageData(org.eclipse.ecf.core.identity.ID,java.lang.Object%5B%5D)"><code>createEventFromMessageData(ID, Object[])</code></a> on the |
| receiver. |
| <p> |
| The default implementation creates a single <a href="EventMessage.html" title="class in org.eclipse.ecf.remoteservice.eventadmin"><code>EventMessage</code></a> instance |
| and adds it to an Object[] of length 1. |
| <p> |
| Subclasses may override as appropriate to customize the serialization of |
| the given eventToSend. |
| <p> |
| Subclasses may override as appropriate. If this method is overridden, |
| then <a href="#createEventFromMessageData(org.eclipse.ecf.core.identity.ID,java.lang.Object%5B%5D)"><code>createEventFromMessageData(ID, Object[])</code></a> should also be |
| overridden as well on the receiver.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>target</code> - the target <a href="../../core/identity/ID.html" title="interface in org.eclipse.ecf.core.identity"><code>ID</code></a> that is the intended receiver returned |
| from <a href="#getTarget(org.osgi.service.event.Event)"><code>getTarget(Event)</code></a>.</dd> |
| <dd><code>eventToSend</code> - the event to send. Will not be <code>null</code>.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Object[] the actual message data that will be serialized (must be |
| Serializable to use in <a href="#sendMessage(org.osgi.service.event.Event)"><code>sendMessage(Event)</code></a>). The default |
| implementation creates a single <a href="EventMessage.html" title="class in org.eclipse.ecf.remoteservice.eventadmin"><code>EventMessage</code></a> instance and |
| adds it to an Object[] of length 1.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/NotSerializableException.html?is-external=true" title="class or interface in java.io" class="externalLink">NotSerializableException</a></code> - if the eventToSend cannot be serialized.</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.1</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="getSerializationHandler(java.lang.String)">getSerializationHandler</a></h3> |
| <div class="memberSignature"><span class="modifiers">protected</span> <span class="returnType"><a href="serialization/SerializationHandler.html" title="class in org.eclipse.ecf.remoteservice.eventadmin.serialization">SerializationHandler</a></span> <span class="memberName">getSerializationHandler</span>​(<span class="arguments"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> topic)</span></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>topic</code> - topic</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>SerializationHandler the serialization handler associated with topic</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.2</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="createEventFromMessageData(org.eclipse.ecf.core.identity.ID,java.lang.Object[])">createEventFromMessageData</a></h3> |
| <div class="memberSignature"><span class="modifiers">protected</span> <span class="returnType">org.osgi.service.event.Event</span> <span class="memberName">createEventFromMessageData</span>​(<span class="arguments"><a href="../../core/identity/ID.html" title="interface in org.eclipse.ecf.core.identity">ID</a> fromID, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>[] messageData)</span></div> |
| <div class="block">Create a local <code>Event</code> from deserialized messageData. The fromID |
| will be a non-<code>null</code> <a href="../../core/identity/ID.html" title="interface in org.eclipse.ecf.core.identity"><code>ID</code></a> instance that is the container |
| ID of the sender DistributedEventAdmin. The default implementation |
| assumes that a single <a href="EventMessage.html" title="class in org.eclipse.ecf.remoteservice.eventadmin"><code>EventMessage</code></a> is in the first array element |
| of the messageData, casts the messageData[0] to EventMessage, and then |
| returns eventMessage.getEvent(). |
| <p> |
| Subclasses can override as appropriate. If this method is overridden, |
| then <a href="#createMessageDataFromEvent(org.eclipse.ecf.core.identity.ID,org.osgi.service.event.Event)"><code>createMessageDataFromEvent(ID, Event)</code></a> should also be |
| overridden as well on the sender.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>fromID</code> - the ID of the message sender. Will not be <code>null</code>.</dd> |
| <dd><code>messageData</code> - Object[] received from fromID. Will be a deserialized |
| local version of the Object[] from fromID.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Event to be delivered to local <code>EventHandler</code>s. Should not |
| be <code>null</code>.</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.1</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="handleSendMessageException(java.lang.String,org.osgi.service.event.Event,java.lang.Object[],java.io.IOException)">handleSendMessageException</a></h3> |
| <div class="memberSignature"><span class="modifiers">protected</span> <span class="returnType">void</span> <span class="memberName">handleSendMessageException</span>​(<span class="arguments"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> message, |
| org.osgi.service.event.Event eventToSend, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>[] messageParams, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/IOException.html?is-external=true" title="class or interface in java.io" class="externalLink">IOException</a> exception)</span></div> |
| <div class="block">Handle any exceptions occuring as part of Event serialization or message |
| send. The default is to call <a href="#logError(java.lang.String,java.lang.Throwable)"><code>logError(String, Throwable)</code></a> with |
| the eventToSend and messageParams appended to the message parameter.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>message</code> - a message associated with the exception.</dd> |
| <dd><code>eventToSend</code> - the event that was to be sent.</dd> |
| <dd><code>messageParams</code> - the message params that were to be</dd> |
| <dd><code>exception</code> - exception</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.1</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="getTarget(org.osgi.service.event.Event)">getTarget</a></h3> |
| <div class="memberSignature"><span class="modifiers">protected</span> <span class="returnType"><a href="../../core/identity/ID.html" title="interface in org.eclipse.ecf.core.identity">ID</a></span> <span class="memberName">getTarget</span>​(<span class="arguments">org.osgi.service.event.Event eventToSend)</span></div> |
| <div class="block">Get the target receiver for the eventToSend. The returned <a href="../../core/identity/ID.html" title="interface in org.eclipse.ecf.core.identity"><code>ID</code></a> will |
| be used to send a shared object message to either a single |
| <a href="../../core/IContainer.html" title="interface in org.eclipse.ecf.core"><code>IContainer</code></a>, or a group of <a href="../../core/IContainer.html" title="interface in org.eclipse.ecf.core"><code>IContainer</code></a>s. To send to the |
| entire group, this method should return <code>null</code>. The default |
| implementation is to return <code>null</code>, meaning that the given |
| eventToSend is to be sent to all receivers connected to this shared |
| object's enclosing <a href="../../core/IContainer.html" title="interface in org.eclipse.ecf.core"><code>IContainer</code></a>.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>eventToSend</code> - the eventToSend. Will not be <code>null</code>.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>ID the ID target for <a href="#sendMessage(org.osgi.service.event.Event)"><code>sendMessage(Event)</code></a> to send to. May |
| be <code>null</code>. <code>null</code> is the default |
| implementation, meaning that the Event will be delivered to all |
| members of the group known to this shared object's |
| <a href="../../core/IContainer.html" title="interface in org.eclipse.ecf.core"><code>IContainer</code></a>.</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.1</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="getEventToSend(org.osgi.service.event.Event)">getEventToSend</a></h3> |
| <div class="memberSignature"><span class="modifiers">protected</span> <span class="returnType">org.osgi.service.event.Event</span> <span class="memberName">getEventToSend</span>​(<span class="arguments">org.osgi.service.event.Event event)</span></div> |
| <div class="block">Get the actual event to pass to <a href="#sendMessage(org.osgi.service.event.Event)"><code>sendMessage(Event)</code></a>. The default |
| implementation of this method is to simply return the event passed in as |
| the method argument. |
| <p> |
| Subclasses may override...to filter or transform the event prior to |
| calling <a href="#sendMessage(org.osgi.service.event.Event)"><code>sendMessage(Event)</code></a>.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>event</code> - the event. Will not be <code>null</code>.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Event to send. By default, the event provided as the argument is |
| returned.</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.1</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="notifyPostSendMessage(org.osgi.service.event.Event)">notifyPostSendMessage</a></h3> |
| <div class="memberSignature"><span class="modifiers">protected</span> <span class="returnType">void</span> <span class="memberName">notifyPostSendMessage</span>​(<span class="arguments">org.osgi.service.event.Event eventSent)</span></div> |
| <div class="block">Method called after <a href="#sendMessage(org.osgi.service.event.Event)"><code>sendMessage(Event)</code></a> is called (typically from |
| within <a href="#postEvent(org.osgi.service.event.Event)"><code>postEvent(Event)</code></a>), but prior to local dispatch. The |
| default implementation is to do nothing.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>eventSent</code> - the event that was sent. Will not be <code>null</code>.</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.1</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="notifyPreLocalDispatch(org.osgi.service.event.Event)">notifyPreLocalDispatch</a></h3> |
| <div class="memberSignature"><span class="modifiers">protected</span> <span class="returnType">org.osgi.service.event.Event</span> <span class="memberName">notifyPreLocalDispatch</span>​(<span class="arguments">org.osgi.service.event.Event event)</span></div> |
| <div class="block">Method called from within <a href="#localDispatch(org.osgi.service.event.Event,boolean)"><code>localDispatch(Event, boolean)</code></a> prior to |
| actual deliver to matching <code>EventHandler</code>s. The default |
| implementation returns the given event. Subclasses may override as |
| appropriate. If the returned Event is <code>null</code> then no local |
| dispatch will occur for the given Event. |
| <p> |
| Subclasses may override as appropriate.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>event</code> - the Event to dispatch. Will not be <code>null</code>.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Event the event to actually dispatch. If <code>null</code>, no |
| local dispatch is done for this event.</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.1</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="notifyPostLocalDispatch(org.osgi.service.event.Event)">notifyPostLocalDispatch</a></h3> |
| <div class="memberSignature"><span class="modifiers">protected</span> <span class="returnType">void</span> <span class="memberName">notifyPostLocalDispatch</span>​(<span class="arguments">org.osgi.service.event.Event event)</span></div> |
| <div class="block">Notification called after local dispatch has been done. The default |
| implemenation does nothing. Note that this method is called by the thread |
| that calls <a href="#localDispatch(org.osgi.service.event.Event,boolean)"><code>localDispatch(Event, boolean)</code></a>, and if the actual |
| dispatch is done by another thread (i.e. second param to localDispatch is |
| <code>true</code>), then the dispatch could occur before, after, or |
| during the actual handling via the matching <code>EventHandler</code>s. |
| <p> |
| Subclasses may override as appropriate.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>event</code> - the Event that was delivered to matching <code>EventHandler</code> |
| s. Will not be <code>null</code>.</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.1</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="localDispatch(org.osgi.service.event.Event,boolean)">localDispatch</a></h3> |
| <div class="memberSignature"><span class="modifiers">protected</span> <span class="returnType">void</span> <span class="memberName">localDispatch</span>​(<span class="arguments">org.osgi.service.event.Event dispatchedEvent, |
| boolean isAsync)</span></div> |
| <div class="block">Locally dispatch an Event. This method is used to deliver an |
| <code>Event</code> to matching <code>EventHandler</code>s that are registered in |
| the local OSGi service registry.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>dispatchedEvent</code> - the Event to dispatch. Will not be <code>null</code>.</dd> |
| <dd><code>isAsync</code> - <code>true</code> if the dispatch should be done |
| asynchronously (non-blocking), <code>false</code> if the |
| dispatch should be done synchronously.</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="handleSharedObjectMsg(org.eclipse.ecf.core.identity.ID,org.eclipse.ecf.core.sharedobject.SharedObjectMsg)">handleSharedObjectMsg</a></h3> |
| <div class="memberSignature"><span class="modifiers">protected</span> <span class="returnType">boolean</span> <span class="memberName">handleSharedObjectMsg</span>​(<span class="arguments"><a href="../../core/identity/ID.html" title="interface in org.eclipse.ecf.core.identity">ID</a> fromID, |
| <a href="../../core/sharedobject/SharedObjectMsg.html" title="class in org.eclipse.ecf.core.sharedobject">SharedObjectMsg</a> msg)</span></div> |
| <div class="block">Handle the shared object message. This method is called on receiver implementations of |
| the DistributedEventAdmin, so that they can deliver to locally registered <code>EventHandler</code>s. |
| <p> |
| This implementation does the following: |
| <ol> |
| <li>Verifies that the value <a href="../../core/sharedobject/SharedObjectMsg.html#getMethod()"><code>SharedObjectMsg.getMethod()</code></a> matches the appropriate String.</li> |
| <li>Calls #createEventFromMessageData(ID, Object[]) to convert the message data (returned from #createMessageDataFromEvent(ID, Event) |
| on the sender)</li> |
| <li>If the Event returned from #createEventFromMessageData(ID, Object[]) is non-<code>null</code>, then call |
| <ol> |
| <li>#notifyReceivedEvent(ID, Event) to allow subclasses to be notified prior to local dispatch</li> |
| <li>#localDispatch(Event, boolean) to actually do the local dispatch asynchronously</li> |
| </ol></li> |
| <li> |
| </ol></div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../../core/sharedobject/BaseSharedObject.html#handleSharedObjectMsg(org.eclipse.ecf.core.identity.ID,org.eclipse.ecf.core.sharedobject.SharedObjectMsg)">handleSharedObjectMsg</a></code> in class <code><a href="../../core/sharedobject/BaseSharedObject.html" title="class in org.eclipse.ecf.core.sharedobject">BaseSharedObject</a></code></dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.1</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="notifyReceivedEvent(org.eclipse.ecf.core.identity.ID,org.osgi.service.event.Event)">notifyReceivedEvent</a></h3> |
| <div class="memberSignature"><span class="modifiers">protected</span> <span class="returnType">void</span> <span class="memberName">notifyReceivedEvent</span>​(<span class="arguments"><a href="../../core/identity/ID.html" title="interface in org.eclipse.ecf.core.identity">ID</a> fromID, |
| org.osgi.service.event.Event receivedEvent)</span></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>fromID</code> - fromID</dd> |
| <dd><code>receivedEvent</code> - received event</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.1</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="handleSharedObjectMsgEvent(org.eclipse.ecf.core.sharedobject.events.ISharedObjectMessageEvent)">handleSharedObjectMsgEvent</a></h3> |
| <div class="memberSignature"><span class="modifiers">protected final</span> <span class="returnType">boolean</span> <span class="memberName">handleSharedObjectMsgEvent</span>​(<span class="arguments"><a href="../../core/sharedobject/events/ISharedObjectMessageEvent.html" title="interface in org.eclipse.ecf.core.sharedobject.events">ISharedObjectMessageEvent</a> event)</span></div> |
| <div class="block">Override of BaseSharedObject.handleSharedObjectMsgEvent. Subclasses must |
| not override this method.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../../core/sharedobject/BaseSharedObject.html#handleSharedObjectMsgEvent(org.eclipse.ecf.core.sharedobject.events.ISharedObjectMessageEvent)">handleSharedObjectMsgEvent</a></code> in class <code><a href="../../core/sharedobject/BaseSharedObject.html" title="class in org.eclipse.ecf.core.sharedobject">BaseSharedObject</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>event</code> - the event to handle</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true if the provided event should receive no further processing. |
| If false the provided Event should be passed to subsequent event |
| processors.</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.1</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="logWarning(java.lang.String)">logWarning</a></h3> |
| <div class="memberSignature"><span class="modifiers">protected</span> <span class="returnType">void</span> <span class="memberName">logWarning</span>​(<span class="arguments"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> message)</span></div> |
| <div class="block">Log a warning. |
| <p> |
| Subclasses may override as appropriate.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>message</code> - the message to include in the warning. Should not be |
| <code>null</code>.</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.1</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="logWarning(java.lang.String,java.lang.Throwable)">logWarning</a></h3> |
| <div class="memberSignature"><span class="modifiers">protected</span> <span class="returnType">void</span> <span class="memberName">logWarning</span>​(<span class="arguments"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> message, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Throwable.html?is-external=true" title="class or interface in java.lang" class="externalLink">Throwable</a> exception)</span></div> |
| <div class="block">Log a warning. |
| <p> |
| Subclasses may override as appropriate.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>message</code> - the message to include in the warning. Should not be |
| <code>null</code>.</dd> |
| <dd><code>exception</code> - the exception to include in the warning. May be |
| <code>null</code>. If non-<code>null</code> then exception |
| will be printed to System.out.</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.1</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="logError(java.lang.String)">logError</a></h3> |
| <div class="memberSignature"><span class="modifiers">protected</span> <span class="returnType">void</span> <span class="memberName">logError</span>​(<span class="arguments"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> message)</span></div> |
| <div class="block">Log an error. |
| <p> |
| Subclasses may override as appropriate.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>message</code> - the message to include in the error. Should not be |
| <code>null</code>.</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.1</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="logError(java.lang.String,java.lang.Throwable)">logError</a></h3> |
| <div class="memberSignature"><span class="modifiers">protected</span> <span class="returnType">void</span> <span class="memberName">logError</span>​(<span class="arguments"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> message, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Throwable.html?is-external=true" title="class or interface in java.lang" class="externalLink">Throwable</a> exception)</span></div> |
| <div class="block">Log an error. |
| <p> |
| Subclasses may override as appropriate.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>message</code> - the message to include in the error. Should not be |
| <code>null</code>.</dd> |
| <dd><code>exception</code> - the exception to include in the warning. May be |
| <code>null</code>. If non-<code>null</code> then exception |
| will be printed to System.out.</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="addEventTopicFilters(java.lang.String[])">addEventTopicFilters</a></h3> |
| <div class="memberSignature"><span class="modifiers">public</span> <span class="returnType">boolean</span> <span class="memberName">addEventTopicFilters</span>​(<span class="arguments"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>[] filters)</span></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>filters</code> - topic filters to add</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>boolean true if given filters added, false otherwise</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.2</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="removeEventTopicFilters(java.lang.String[])">removeEventTopicFilters</a></h3> |
| <div class="memberSignature"><span class="modifiers">public</span> <span class="returnType">boolean</span> <span class="memberName">removeEventTopicFilters</span>​(<span class="arguments"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>[] filters)</span></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>filters</code> - topic filters to add</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>boolean true if given filters added, false otherwise</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.2</dd> |
| </dl> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| </main> |
| <footer role="contentinfo"> |
| <nav role="navigation"> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a id="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a id="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/DistributedEventAdmin.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-files/index-1.html">Index</a></li> |
| <li><a href="../../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li><a href="#field.summary">Field</a> | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field.detail">Field</a> | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| </div> |
| <a id="skip.navbar.bottom"> |
| <!-- --> |
| </a> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </nav> |
| <p class="legalCopy"><small>Copyright © 2004–2020 <a href="https://www.eclipse.org/">Eclipse Foundation</a>. All rights reserved.</small></p> |
| </footer> |
| </div> |
| </div> |
| </body> |
| </html> |