/usr/share/doc/libosgi-compendium-java/api/info/dmtree/notification/AlertItem.html is in libosgi-compendium-java-doc 4.3.0-1.
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 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!--NewPage-->
<HTML>
<HEAD>
<!-- Generated by javadoc (build 1.6.0_23) on Mon Nov 21 22:05:25 UTC 2011 -->
<TITLE>
AlertItem
</TITLE>
<META NAME="date" CONTENT="2011-11-21">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../stylesheet.css" TITLE="Style">
<SCRIPT type="text/javascript">
function windowTitle()
{
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="AlertItem";
}
}
</SCRIPT>
<NOSCRIPT>
</NOSCRIPT>
</HEAD>
<BODY BGCOLOR="white" onload="windowTitle();">
<HR>
<!-- ========= START OF TOP NAVBAR ======= -->
<A NAME="navbar_top"><!-- --></A>
<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_top_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
PREV CLASS
<A HREF="../../../info/dmtree/notification/NotificationService.html" title="interface in info.dmtree.notification"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../index.html?info/dmtree/notification/AlertItem.html" target="_top"><B>FRAMES</B></A>
<A HREF="AlertItem.html" target="_top"><B>NO FRAMES</B></A>
<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_top"></A>
<!-- ========= END OF TOP NAVBAR ========= -->
<HR>
<!-- ======== START OF CLASS DATA ======== -->
<H2>
<FONT SIZE="-1">
info.dmtree.notification</FONT>
<BR>
Class AlertItem</H2>
<PRE>
java.lang.Object
<IMG SRC="../../../resources/inherit.gif" ALT="extended by "><B>info.dmtree.notification.AlertItem</B>
</PRE>
<HR>
<DL>
<DT><PRE>public class <B>AlertItem</B><DT>extends java.lang.Object</DL>
</PRE>
<P>
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="../../../info/dmtree/notification/NotificationService.html" title="interface in info.dmtree.notification"><CODE>NotificationService</CODE></A> implementations on other management
protocols should map these constructs to the underlying protocol.
<P>
<P>
<HR>
<P>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<A NAME="constructor_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Constructor Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><B><A HREF="../../../info/dmtree/notification/AlertItem.html#AlertItem(java.lang.String[], java.lang.String, java.lang.String, info.dmtree.DmtData)">AlertItem</A></B>(java.lang.String[] source,
java.lang.String type,
java.lang.String mark,
<A HREF="../../../info/dmtree/DmtData.html" title="class in info.dmtree">DmtData</A> data)</CODE>
<BR>
Create an instance of the alert item, specifying the source node URI as
an array of path segments.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><B><A HREF="../../../info/dmtree/notification/AlertItem.html#AlertItem(java.lang.String, java.lang.String, java.lang.String, info.dmtree.DmtData)">AlertItem</A></B>(java.lang.String source,
java.lang.String type,
java.lang.String mark,
<A HREF="../../../info/dmtree/DmtData.html" title="class in info.dmtree">DmtData</A> data)</CODE>
<BR>
Create an instance of the alert item.</TD>
</TR>
</TABLE>
<!-- ========== METHOD SUMMARY =========== -->
<A NAME="method_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Method Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../info/dmtree/DmtData.html" title="class in info.dmtree">DmtData</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../info/dmtree/notification/AlertItem.html#getData()">getData</A></B>()</CODE>
<BR>
Get the data associated with the alert item.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../info/dmtree/notification/AlertItem.html#getMark()">getMark</A></B>()</CODE>
<BR>
Get the mark parameter associated with the alert item.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../info/dmtree/notification/AlertItem.html#getSource()">getSource</A></B>()</CODE>
<BR>
Get the node which is the source of the alert.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../info/dmtree/notification/AlertItem.html#getType()">getType</A></B>()</CODE>
<BR>
Get the type associated with the alert item.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../info/dmtree/notification/AlertItem.html#toString()">toString</A></B>()</CODE>
<BR>
Returns the string representation of this alert item.</TD>
</TR>
</TABLE>
<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</CODE></TD>
</TR>
</TABLE>
<P>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<A NAME="constructor_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Constructor Detail</B></FONT></TH>
</TR>
</TABLE>
<A NAME="AlertItem(java.lang.String, java.lang.String, java.lang.String, info.dmtree.DmtData)"><!-- --></A><H3>
AlertItem</H3>
<PRE>
public <B>AlertItem</B>(java.lang.String source,
java.lang.String type,
java.lang.String mark,
<A HREF="../../../info/dmtree/DmtData.html" title="class in info.dmtree">DmtData</A> data)</PRE>
<DL>
<DD>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="../../../info/dmtree/notification/NotificationService.html#sendNotification(java.lang.String, int, java.lang.String, info.dmtree.notification.AlertItem[])"><CODE>NotificationService.sendNotification(java.lang.String, int, java.lang.String, info.dmtree.notification.AlertItem[])</CODE></A>). In case of Generic Alerts
for example (code 1226), the <code>mark</code> parameter contains a
severity string.
<P>
<DL>
<DT><B>Parameters:</B><DD><CODE>source</CODE> - the URI of the node which is the source of the alert item<DD><CODE>type</CODE> - a MIME type or a URN that identifies the type of the data in
the alert item<DD><CODE>data</CODE> - a <code>DmtData</code> object that contains the format and
value of the data in the alert item<DD><CODE>mark</CODE> - the mark parameter of the alert item</DL>
</DL>
<HR>
<A NAME="AlertItem(java.lang.String[], java.lang.String, java.lang.String, info.dmtree.DmtData)"><!-- --></A><H3>
AlertItem</H3>
<PRE>
public <B>AlertItem</B>(java.lang.String[] source,
java.lang.String type,
java.lang.String mark,
<A HREF="../../../info/dmtree/DmtData.html" title="class in info.dmtree">DmtData</A> data)</PRE>
<DL>
<DD>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="../../../info/dmtree/notification/NotificationService.html#sendNotification(java.lang.String, int, java.lang.String, info.dmtree.notification.AlertItem[])"><CODE>NotificationService.sendNotification(java.lang.String, int, java.lang.String, info.dmtree.notification.AlertItem[])</CODE></A>). In case of Generic Alerts
for example (code 1226), the <code>mark</code> parameter contains a
severity string.
<P>
<DL>
<DT><B>Parameters:</B><DD><CODE>source</CODE> - the path of the node which is the source of the alert item<DD><CODE>type</CODE> - a MIME type or a URN that identifies the type of the data in
the alert item<DD><CODE>data</CODE> - a <code>DmtData</code> object that contains the format and
value of the data in the alert item<DD><CODE>mark</CODE> - the mark parameter of the alert item</DL>
</DL>
<!-- ============ METHOD DETAIL ========== -->
<A NAME="method_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Method Detail</B></FONT></TH>
</TR>
</TABLE>
<A NAME="getSource()"><!-- --></A><H3>
getSource</H3>
<PRE>
public java.lang.String <B>getSource</B>()</PRE>
<DL>
<DD>Get the node which is the source of the alert. There might be no source
associated with the alert item.
<P>
<DD><DL>
<DT><B>Returns:</B><DD>the URI of the node which is the source of this alert, or
<code>null</code> if there is no source</DL>
</DD>
</DL>
<HR>
<A NAME="getType()"><!-- --></A><H3>
getType</H3>
<PRE>
public java.lang.String <B>getType</B>()</PRE>
<DL>
<DD>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="../../../info/dmtree/notification/AlertItem.html#getData()"><CODE>getData()</CODE></A>). There might be no type associated with
the alert item.
<P>
<DD><DL>
<DT><B>Returns:</B><DD>the type type associated with the alert item, or
<code>null</code> if there is no type</DL>
</DD>
</DL>
<HR>
<A NAME="getMark()"><!-- --></A><H3>
getMark</H3>
<PRE>
public java.lang.String <B>getMark</B>()</PRE>
<DL>
<DD>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="../../../info/dmtree/notification/NotificationService.html#sendNotification(java.lang.String, int, java.lang.String, info.dmtree.notification.AlertItem[])"><CODE>NotificationService.sendNotification(java.lang.String, int, java.lang.String, info.dmtree.notification.AlertItem[])</CODE></A>. There
might be no mark associated with the alert item.
<P>
<DD><DL>
<DT><B>Returns:</B><DD>the mark associated with the alert item, or <code>null</code>
if there is no mark</DL>
</DD>
</DL>
<HR>
<A NAME="getData()"><!-- --></A><H3>
getData</H3>
<PRE>
public <A HREF="../../../info/dmtree/DmtData.html" title="class in info.dmtree">DmtData</A> <B>getData</B>()</PRE>
<DL>
<DD>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.
<P>
<DD><DL>
<DT><B>Returns:</B><DD>the data associated with the alert item, or <code>null</code>
if there is no data</DL>
</DD>
</DL>
<HR>
<A NAME="toString()"><!-- --></A><H3>
toString</H3>
<PRE>
public java.lang.String <B>toString</B>()</PRE>
<DL>
<DD>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.
<P>
<DD><DL>
<DT><B>Overrides:</B><DD><CODE>toString</CODE> in class <CODE>java.lang.Object</CODE></DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>the string representation of this alert item</DL>
</DD>
</DL>
<!-- ========= END OF CLASS DATA ========= -->
<HR>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<A NAME="navbar_bottom"><!-- --></A>
<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
PREV CLASS
<A HREF="../../../info/dmtree/notification/NotificationService.html" title="interface in info.dmtree.notification"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../index.html?info/dmtree/notification/AlertItem.html" target="_top"><B>FRAMES</B></A>
<A HREF="AlertItem.html" target="_top"><B>NO FRAMES</B></A>
<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<HR>
</BODY>
</HTML>
|