/usr/share/doc/libosgi-compendium-java/api/org/osgi/service/dmt/notification/AlertItem.html is in libosgi-compendium-java-doc 5.0.0-5.
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 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html>
<head>
<!-- Generated by javadoc -->
<title>AlertItem</title>
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="AlertItem";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":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";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="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><a href="../../../../../org/osgi/service/dmt/notification/NotificationService.html" title="interface in org.osgi.service.dmt.notification"><span class="typeNameLink">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/osgi/service/dmt/notification/AlertItem.html" target="_top">Frames</a></li>
<li><a href="AlertItem.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><a href="#constructor.summary">Constr</a> | </li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li><a href="#constructor.detail">Constr</a> | </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</div>
<h2 title="Class AlertItem" class="title">Class AlertItem</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.osgi.service.dmt.notification.AlertItem</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public class <span class="typeNameLabel">AlertItem</span>
extends java.lang.Object</pre>
<div class="block">Immutable data structure carried in an alert (client initiated notification).
The <code>AlertItem</code> describes details of various notifications that can be
sent by the client, for example as alerts in the OMA DM protocol. The use
cases include the client sending a session request to the server (alert
1201), the client notifying the server of completion of a software update
operation (alert 1226) or sending back results in response to an asynchronous
EXEC command.
<p>
The data syntax and semantics varies widely between various alerts, so does
the optionality of particular parameters of an alert item. If an item, such
as source or type, is not defined, the corresponding getter method returns
<code>null</code>. For example, for alert 1201 (client-initiated session) all
elements will be <code>null</code>.
<P>
The syntax used in <code>AlertItem</code> class corresponds to the OMA DM alert
format. <a href="../../../../../org/osgi/service/dmt/notification/NotificationService.html" title="interface in org.osgi.service.dmt.notification"><code>NotificationService</code></a> implementations on other management
protocols should map these constructs to the underlying protocol.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/osgi/service/dmt/notification/AlertItem.html#AlertItem-java.lang.String:A-java.lang.String-java.lang.String-org.osgi.service.dmt.DmtData-">AlertItem</a></span>(java.lang.String[] source,
java.lang.String type,
java.lang.String mark,
<a href="../../../../../org/osgi/service/dmt/DmtData.html" title="class in org.osgi.service.dmt">DmtData</a> data)</code>
<div class="block">Create an instance of the alert item, specifying the source node URI as
an array of path segments.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/osgi/service/dmt/notification/AlertItem.html#AlertItem-java.lang.String-java.lang.String-java.lang.String-org.osgi.service.dmt.DmtData-">AlertItem</a></span>(java.lang.String source,
java.lang.String type,
java.lang.String mark,
<a href="../../../../../org/osgi/service/dmt/DmtData.html" title="class in org.osgi.service.dmt">DmtData</a> data)</code>
<div class="block">Create an instance of the alert item.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/osgi/service/dmt/DmtData.html" title="class in org.osgi.service.dmt">DmtData</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/osgi/service/dmt/notification/AlertItem.html#getData--">getData</a></span>()</code>
<div class="block">Get the data associated with the alert item.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/osgi/service/dmt/notification/AlertItem.html#getMark--">getMark</a></span>()</code>
<div class="block">Get the mark parameter associated with the alert item.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/osgi/service/dmt/notification/AlertItem.html#getSource--">getSource</a></span>()</code>
<div class="block">Get the node which is the source of the alert.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/osgi/service/dmt/notification/AlertItem.html#getType--">getType</a></span>()</code>
<div class="block">Get the type associated with the alert item.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/osgi/service/dmt/notification/AlertItem.html#toString--">toString</a></span>()</code>
<div class="block">Returns the string representation of this alert item.</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 java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="AlertItem-java.lang.String-java.lang.String-java.lang.String-org.osgi.service.dmt.DmtData-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>AlertItem</h4>
<pre>public AlertItem(java.lang.String source,
java.lang.String type,
java.lang.String mark,
<a href="../../../../../org/osgi/service/dmt/DmtData.html" title="class in org.osgi.service.dmt">DmtData</a> data)</pre>
<div class="block">Create an instance of the alert item. The constructor takes all possible
data entries as parameters. Any of these parameters can be <code>null</code>.
The semantics of the parameters may be refined by the definition of a
specific alert, identified by its alert code (see
<a href="../../../../../org/osgi/service/dmt/notification/NotificationService.html#sendNotification-java.lang.String-int-java.lang.String-org.osgi.service.dmt.notification.AlertItem:A-"><code>NotificationService.sendNotification(String, int, String, AlertItem[])</code></a>
). In case of Generic Alerts for example (code 1226), the <code>mark</code>
parameter contains a severity string.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>source</code> - the URI of the node which is the source of the alert item</dd>
<dd><code>type</code> - a MIME type or a URN that identifies the type of the data in
the alert item</dd>
<dd><code>data</code> - a <code>DmtData</code> object that contains the format and value
of the data in the alert item</dd>
<dd><code>mark</code> - the mark parameter of the alert item</dd>
</dl>
</li>
</ul>
<a name="AlertItem-java.lang.String:A-java.lang.String-java.lang.String-org.osgi.service.dmt.DmtData-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>AlertItem</h4>
<pre>public AlertItem(java.lang.String[] source,
java.lang.String type,
java.lang.String mark,
<a href="../../../../../org/osgi/service/dmt/DmtData.html" title="class in org.osgi.service.dmt">DmtData</a> data)</pre>
<div class="block">Create an instance of the alert item, specifying the source node URI as
an array of path segments. The constructor takes all possible data
entries as parameters. Any of these parameters can be <code>null</code>. The
semantics of the parameters may be refined by the definition of a
specific alert, identified by its alert code (see
<a href="../../../../../org/osgi/service/dmt/notification/NotificationService.html#sendNotification-java.lang.String-int-java.lang.String-org.osgi.service.dmt.notification.AlertItem:A-"><code>NotificationService.sendNotification(String, int, String, AlertItem[])</code></a>
). In case of Generic Alerts for example (code 1226), the <code>mark</code>
parameter contains a severity string.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>source</code> - the path of the node which is the source of the alert item</dd>
<dd><code>type</code> - a MIME type or a URN that identifies the type of the data in
the alert item</dd>
<dd><code>data</code> - a <code>DmtData</code> object that contains the format and value
of the data in the alert item</dd>
<dd><code>mark</code> - the mark parameter of the alert item</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="getSource--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSource</h4>
<pre>public java.lang.String getSource()</pre>
<div class="block">Get the node which is the source of the alert. There might be no source
associated with the alert item.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the URI of the node which is the source of this alert, or
<code>null</code> if there is no source</dd>
</dl>
</li>
</ul>
<a name="getType--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getType</h4>
<pre>public java.lang.String getType()</pre>
<div class="block">Get the type associated with the alert item. The type string is a MIME
type or a URN that identifies the type of the data in the alert item
(returned by <a href="../../../../../org/osgi/service/dmt/notification/AlertItem.html#getData--"><code>getData()</code></a>). There might be no type associated with
the alert item.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the type type associated with the alert item, or <code>null</code> if
there is no type</dd>
</dl>
</li>
</ul>
<a name="getMark--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMark</h4>
<pre>public java.lang.String getMark()</pre>
<div class="block">Get the mark parameter associated with the alert item. The interpretation
of the mark parameter depends on the alert being sent, as identified by
the alert code in
<a href="../../../../../org/osgi/service/dmt/notification/NotificationService.html#sendNotification-java.lang.String-int-java.lang.String-org.osgi.service.dmt.notification.AlertItem:A-"><code>NotificationService.sendNotification(String, int, String, AlertItem[])</code></a>
. There might be no mark associated with the alert item.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the mark associated with the alert item, or <code>null</code> if there
is no mark</dd>
</dl>
</li>
</ul>
<a name="getData--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getData</h4>
<pre>public <a href="../../../../../org/osgi/service/dmt/DmtData.html" title="class in org.osgi.service.dmt">DmtData</a> getData()</pre>
<div class="block">Get the data associated with the alert item. The returned <code>DmtData</code>
object contains the format and the value of the data in the alert item.
There might be no data associated with the alert item.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the data associated with the alert item, or <code>null</code> if there
is no data</dd>
</dl>
</li>
</ul>
<a name="toString--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>toString</h4>
<pre>public java.lang.String toString()</pre>
<div class="block">Returns the string representation of this alert item. The returned string
includes all parameters of the alert item, and has the following format:
<pre>
AlertItem(<source>, <type>, <mark>, <data>)
</pre>
The last parameter is the string representation of the data value. The
format of the data is not explicitly included.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>toString</code> in class <code>java.lang.Object</code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the string representation of this alert item</dd>
</dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="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><a href="../../../../../org/osgi/service/dmt/notification/NotificationService.html" title="interface in org.osgi.service.dmt.notification"><span class="typeNameLink">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/osgi/service/dmt/notification/AlertItem.html" target="_top">Frames</a></li>
<li><a href="AlertItem.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><a href="#constructor.summary">Constr</a> | </li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li><a href="#constructor.detail">Constr</a> | </li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>
|