/usr/share/doc/libosgi-compendium-java/api/org/osgi/service/dmt/notification/spi/RemoteAlertSender.html is in libosgi-compendium-java-doc 5.0.0-3.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<title>RemoteAlertSender</title>
<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="RemoteAlertSender";
}
//-->
</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="package-tree.html">Tree</a></li>
<li><a href="../../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li>Prev Class</li>
<li>Next Class</li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/osgi/service/dmt/notification/spi/RemoteAlertSender.html" target="_top">Frames</a></li>
<li><a href="RemoteAlertSender.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary: </li>
<li>Nested | </li>
<li>Field | </li>
<li>Constr | </li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li>Constr | </li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.osgi.service.dmt.notification.spi</div>
<h2 title="Interface RemoteAlertSender" class="title">Interface RemoteAlertSender</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public interface <span class="strong">RemoteAlertSender</span></pre>
<div class="block">The RemoteAlertSender can be used to send notifications to (remote) entities
identified by principal names. This service is provided by Protocol Adapters,
and is used by the
<a href="../../../../../../org/osgi/service/dmt/notification/NotificationService.html" title="interface in org.osgi.service.dmt.notification"><code>NotificationService</code></a> when sending
alerts. Implementations of this interface have to be able to connect and send
alerts to one or more management servers in a protocol specific way.
<p>
The properties of the service registration should specify a list of
destinations (principals) where the service is capable of sending alerts.
This can be done by providing a <code>String</code> array of principal names in
the <code>principals</code> registration property. If this property is not
registered, the service will be treated as the default sender. The default
alert sender is only used when a more specific alert sender cannot be found.
<p>
The <code>principals</code> registration property is used when the
<a href="../../../../../../org/osgi/service/dmt/notification/NotificationService.html#sendNotification(java.lang.String,%20int,%20java.lang.String,%20org.osgi.service.dmt.notification.AlertItem[])"><code>NotificationService.sendNotification(String, int, String, AlertItem[])</code></a>
method is called, to find the proper <code>RemoteAlertSender</code> for the given
destination. If the caller does not specify a principal, the alert is only
sent if the Notification Sender finds a default alert sender, or if the
choice is unambiguous for some other reason (for example if only one alert
sender is registered).</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method_summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/osgi/service/dmt/notification/spi/RemoteAlertSender.html#sendAlert(java.lang.String,%20int,%20java.lang.String,%20org.osgi.service.dmt.notification.AlertItem[])">sendAlert</a></strong>(java.lang.String principal,
int code,
java.lang.String correlator,
<a href="../../../../../../org/osgi/service/dmt/notification/AlertItem.html" title="class in org.osgi.service.dmt.notification">AlertItem</a>[] items)</code>
<div class="block">Sends an alert to a server identified by its principal name.</div>
</td>
</tr>
</table>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="sendAlert(java.lang.String, int, java.lang.String, org.osgi.service.dmt.notification.AlertItem[])">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>sendAlert</h4>
<pre>void sendAlert(java.lang.String principal,
int code,
java.lang.String correlator,
<a href="../../../../../../org/osgi/service/dmt/notification/AlertItem.html" title="class in org.osgi.service.dmt.notification">AlertItem</a>[] items)
throws java.lang.Exception</pre>
<div class="block">Sends an alert to a server identified by its principal name. In case the
alert is sent in response to a previous
<a href="../../../../../../org/osgi/service/dmt/DmtSession.html#execute(java.lang.String,%20java.lang.String,%20java.lang.String)"><code>execute</code></a> command, a correlation identifier can be specified to provide
the association between the execute and the alert.
<p>
The <code>principal</code> parameter specifies which server the alert should
be sent to. This parameter can be <code>null</code> if the client does not
know the name of the destination. The alert should still be delivered if
possible; for example if the alert sender is only connected to one
destination.
<p>
Any exception thrown on this method will be propagated to the original
sender of the event, wrapped in a <code>DmtException</code> with the code
<code>REMOTE_ERROR</code>.
<p>
Since sending the alert and receiving acknowledgment for it is
potentially a very time-consuming operation, alerts are sent
asynchronously. This method should attempt to ensure that the alert can
be sent successfully, and should throw an exception if it detects any
problems. If the method returns without error, the alert is accepted for
sending and the implementation must make a best-effort attempt to deliver
it.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>principal</code> - the name identifying the server where the alert should
be sent, can be <code>null</code></dd><dd><code>code</code> - the alert code, can be 0 if not needed</dd><dd><code>correlator</code> - the correlation identifier of an associated EXEC
command, or <code>null</code> if there is no associated EXEC</dd><dd><code>items</code> - the data of the alert items carried in this alert, can be
empty or <code>null</code> if no alert items are needed</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.Exception</code> - if the alert can not be sent to the server</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="package-tree.html">Tree</a></li>
<li><a href="../../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li>Prev Class</li>
<li>Next Class</li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/osgi/service/dmt/notification/spi/RemoteAlertSender.html" target="_top">Frames</a></li>
<li><a href="RemoteAlertSender.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary: </li>
<li>Nested | </li>
<li>Field | </li>
<li>Constr | </li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li>Constr | </li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>
|