/usr/share/doc/libosgi-compendium-java/api/info/dmtree/DmtAdmin.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 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 | <!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 Wed Nov 09 19:45:53 UTC 2011 -->
<TITLE>
DmtAdmin
</TITLE>
<META NAME="date" CONTENT="2011-11-09">
<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="DmtAdmin";
}
}
</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">
<A HREF="../../info/dmtree/Acl.html" title="class in info.dmtree"><B>PREV CLASS</B></A>
<A HREF="../../info/dmtree/DmtData.html" title="class in info.dmtree"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../index.html?info/dmtree/DmtAdmin.html" target="_top"><B>FRAMES</B></A>
<A HREF="DmtAdmin.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 | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL: FIELD | CONSTR | <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</FONT>
<BR>
Interface DmtAdmin</H2>
<HR>
<DL>
<DT><PRE>public interface <B>DmtAdmin</B></DL>
</PRE>
<P>
An interface providing methods to open sessions and register listeners. The
implementation of <code>DmtAdmin</code> should register itself in the OSGi
service registry as a service. <code>DmtAdmin</code> is the entry point for
applications to use the DMT API.
<p>
The <code>getSession</code> methods are used to open a session on a specified
subtree of the DMT. A typical way of usage:
<pre>
serviceRef = context.getServiceReference(DmtAdmin.class.getName());
DmtAdmin admin = (DmtAdmin) context.getService(serviceRef);
DmtSession session = admin.getSession("./OSGi/Configuration");
session.createInteriorNode("./OSGi/Configuration/my.table");
</pre>
<p>
The methods for opening a session take a node URI (the session root) as a
parameter. All segments of the given URI must be within the segment length
limit of the implementation, and the special characters '/' and '\' must be
escaped (preceded by a '\'). Any string can be converted to a valid URI
segment using the <A HREF="../../info/dmtree/Uri.html#mangle(java.lang.String)"><CODE>Uri.mangle(String)</CODE></A> method.
<p>
It is possible to specify a lock mode when opening the session (see lock type
constants in <A HREF="../../info/dmtree/DmtSession.html" title="interface in info.dmtree"><CODE>DmtSession</CODE></A>). This determines whether the session can run
in parallel with other sessions, and the kinds of operations that can be
performed in the session. All Management Objects constituting the device
management tree must support read operations on their nodes, while support
for write operations depends on the Management Object. Management Objects
supporting write access may support transactional write, non-transactional
write or both. Users of <code>DmtAdmin</code> should consult the Management
Object specification and implementation for the supported update modes. If
Management Object definition permits, implementations are encouraged to
support both update modes.
<p>
This interface also contains methods for manipulating the set of
<code>DmtEventListener</code> objects that are called when the structure or
content of the tree is changed. These methods are not needed in an OSGi
environment, clients should register listeners through the Event Admin
service.
<P>
<P>
<HR>
<P>
<!-- ========== 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> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../info/dmtree/DmtAdmin.html#addEventListener(int, java.lang.String, info.dmtree.DmtEventListener)">addEventListener</A></B>(int type,
java.lang.String uri,
<A HREF="../../info/dmtree/DmtEventListener.html" title="interface in info.dmtree">DmtEventListener</A> listener)</CODE>
<BR>
Registers an event listener on behalf of a local application.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../info/dmtree/DmtAdmin.html#addEventListener(java.lang.String, int, java.lang.String, info.dmtree.DmtEventListener)">addEventListener</A></B>(java.lang.String principal,
int type,
java.lang.String uri,
<A HREF="../../info/dmtree/DmtEventListener.html" title="interface in info.dmtree">DmtEventListener</A> listener)</CODE>
<BR>
Registers an event listener on behalf of a remote principal.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../info/dmtree/DmtSession.html" title="interface in info.dmtree">DmtSession</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../info/dmtree/DmtAdmin.html#getSession(java.lang.String)">getSession</A></B>(java.lang.String subtreeUri)</CODE>
<BR>
Opens a <code>DmtSession</code> for local usage on a given subtree of
the DMT with non transactional write lock.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../info/dmtree/DmtSession.html" title="interface in info.dmtree">DmtSession</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../info/dmtree/DmtAdmin.html#getSession(java.lang.String, int)">getSession</A></B>(java.lang.String subtreeUri,
int lockMode)</CODE>
<BR>
Opens a <code>DmtSession</code> for local usage on a specific DMT
subtree with a given lock mode.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../info/dmtree/DmtSession.html" title="interface in info.dmtree">DmtSession</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../info/dmtree/DmtAdmin.html#getSession(java.lang.String, java.lang.String, int)">getSession</A></B>(java.lang.String principal,
java.lang.String subtreeUri,
int lockMode)</CODE>
<BR>
Opens a <code>DmtSession</code> on a specific DMT subtree using a
specific lock mode on behalf of a remote principal.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../info/dmtree/DmtAdmin.html#removeEventListener(info.dmtree.DmtEventListener)">removeEventListener</A></B>(<A HREF="../../info/dmtree/DmtEventListener.html" title="interface in info.dmtree">DmtEventListener</A> listener)</CODE>
<BR>
Remove a previously registered listener.</TD>
</TR>
</TABLE>
<P>
<!-- ============ 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="getSession(java.lang.String)"><!-- --></A><H3>
getSession</H3>
<PRE>
<A HREF="../../info/dmtree/DmtSession.html" title="interface in info.dmtree">DmtSession</A> <B>getSession</B>(java.lang.String subtreeUri)
throws <A HREF="../../info/dmtree/DmtException.html" title="class in info.dmtree">DmtException</A></PRE>
<DL>
<DD>Opens a <code>DmtSession</code> for local usage on a given subtree of
the DMT with non transactional write lock. This call is equivalent to the
following:
<code>getSession(null, subtreeUri, DmtSession.LOCK_TYPE_EXCLUSIVE)</code>
<p>
The <code>subtreeUri</code> parameter must contain an absolute URI. It
can also be <code>null</code>, in this case the session is opened with
the default session root, ".", that gives access to the whole
tree.
<p>
To perform this operation the caller must have <code>DmtPermission</code>
for the <code>subtreeUri</code> node with the Get action present.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>subtreeUri</CODE> - the subtree on which DMT manipulations can be performed
within the returned session
<DT><B>Returns:</B><DD>a <code>DmtSession</code> object for the requested subtree
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../info/dmtree/DmtException.html" title="class in info.dmtree">DmtException</A></CODE> - with the following possible error codes:
<ul>
<li><code>URI_TOO_LONG</code> if <code>subtreeUri</code> or
a segment of it is too long, or if it has too many segments
<li><code>INVALID_URI</code> if <code>subtreeUri</code> is
syntactically invalid
<li><code>NODE_NOT_FOUND</code> if <code>subtreeUri</code>
specifies a non-existing node
<li><code>SESSION_CREATION_TIMEOUT</code> if the operation
timed out because of another ongoing session
<li><code>COMMAND_FAILED</code> if <code>subtreeUri</code>
specifies a relative URI, or some unspecified error is
encountered while attempting to complete the command
</ul>
<DD><CODE>java.lang.SecurityException</CODE> - if the caller does not have
<code>DmtPermission</code> for the given root node with the Get
action present</DL>
</DD>
</DL>
<HR>
<A NAME="getSession(java.lang.String, int)"><!-- --></A><H3>
getSession</H3>
<PRE>
<A HREF="../../info/dmtree/DmtSession.html" title="interface in info.dmtree">DmtSession</A> <B>getSession</B>(java.lang.String subtreeUri,
int lockMode)
throws <A HREF="../../info/dmtree/DmtException.html" title="class in info.dmtree">DmtException</A></PRE>
<DL>
<DD>Opens a <code>DmtSession</code> for local usage on a specific DMT
subtree with a given lock mode. This call is equivalent to the
following: <code>getSession(null, subtreeUri, lockMode)</code>
<p>
The <code>subtreeUri</code> parameter must contain an absolute URI. It
can also be <code>null</code>, in this case the session is opened with
the default session root, ".", that gives access to the whole
tree.
<p>
To perform this operation the caller must have <code>DmtPermission</code>
for the <code>subtreeUri</code> node with the Get action present.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>subtreeUri</CODE> - the subtree on which DMT manipulations can be performed
within the returned session<DD><CODE>lockMode</CODE> - one of the lock modes specified in
<code>DmtSession</code>
<DT><B>Returns:</B><DD>a <code>DmtSession</code> object for the requested subtree
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../info/dmtree/DmtException.html" title="class in info.dmtree">DmtException</A></CODE> - with the following possible error codes:
<ul>
<li><code>URI_TOO_LONG</code> if <code>subtreeUri</code> or
a segment of it is too long, or if it has too many segments
<li><code>INVALID_URI</code> if <code>subtreeUri</code> is
syntactically invalid
<li><code>NODE_NOT_FOUND</code> if <code>subtreeUri</code>
specifies a non-existing node
<li><code>FEATURE_NOT_SUPPORTED</code> if atomic sessions are
not supported by the implementation and <code>lockMode</code>
requests an atomic session
<li><code>SESSION_CREATION_TIMEOUT</code> if the operation
timed out because of another ongoing session
<li><code>COMMAND_FAILED</code> if <code>subtreeUri</code>
specifies a relative URI, if <code>lockMode</code> is unknown,
or some unspecified error is encountered while attempting to
complete the command
</ul>
<DD><CODE>java.lang.SecurityException</CODE> - if the caller does not have
<code>DmtPermission</code> for the given root node with the Get
action present</DL>
</DD>
</DL>
<HR>
<A NAME="getSession(java.lang.String, java.lang.String, int)"><!-- --></A><H3>
getSession</H3>
<PRE>
<A HREF="../../info/dmtree/DmtSession.html" title="interface in info.dmtree">DmtSession</A> <B>getSession</B>(java.lang.String principal,
java.lang.String subtreeUri,
int lockMode)
throws <A HREF="../../info/dmtree/DmtException.html" title="class in info.dmtree">DmtException</A></PRE>
<DL>
<DD>Opens a <code>DmtSession</code> on a specific DMT subtree using a
specific lock mode on behalf of a remote principal. If local management
applications are using this method then they should provide
<code>null</code> as the first parameter. Alternatively they can use
other forms of this method without providing a principal string.
<p>
The <code>subtreeUri</code> parameter must contain an absolute URI. It
can also be <code>null</code>, in this case the session is opened with
the default session root, ".", that gives access to the whole
tree.
<p>
This method is guarded by <code>DmtPrincipalPermission</code> in case of
remote sessions. In addition, the caller must have Get access rights
(ACL in case of remote sessions, <code>DmtPermission</code> in case of
local sessions) on the <code>subtreeUri</code> node to perform this
operation.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>principal</CODE> - the identifier of the remote server on whose behalf the
data manipulation is performed, or <code>null</code> for local
sessions<DD><CODE>subtreeUri</CODE> - the subtree on which DMT manipulations can be performed
within the returned session<DD><CODE>lockMode</CODE> - one of the lock modes specified in
<code>DmtSession</code>
<DT><B>Returns:</B><DD>a <code>DmtSession</code> object for the requested subtree
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../info/dmtree/DmtException.html" title="class in info.dmtree">DmtException</A></CODE> - with the following possible error codes:
<ul>
<li><code>URI_TOO_LONG</code> if <code>subtreeUri</code> or
a segment of it is too long, or if it has too many segments
<li><code>INVALID_URI</code> if <code>subtreeUri</code> is
syntactically invalid
<li><code>NODE_NOT_FOUND</code> if <code>subtreeUri</code>
specifies a non-existing node
<li><code>PERMISSION_DENIED</code> if <code>principal</code> is
not <code>null</code> and the ACL of the node does not allow the
<code>Get</code> operation for the principal on the given root
node
<li><code>FEATURE_NOT_SUPPORTED</code> if atomic sessions are
not supported by the implementation and <code>lockMode</code>
requests an atomic session
<li><code>SESSION_CREATION_TIMEOUT</code> if the operation
timed out because of another ongoing session
<li><code>COMMAND_FAILED</code> if <code>subtreeUri</code>
specifies a relative URI, if <code>lockMode</code> is unknown,
or some unspecified error is encountered while attempting to
complete the command
</ul>
<DD><CODE>java.lang.SecurityException</CODE> - in case of remote sessions, if the caller does
not have the required <code>DmtPrincipalPermission</code> with a
target matching the <code>principal</code> parameter, or in case
of local sessions, if the caller does not have
<code>DmtPermission</code> for the given root node with the Get
action present</DL>
</DD>
</DL>
<HR>
<A NAME="addEventListener(int, java.lang.String, info.dmtree.DmtEventListener)"><!-- --></A><H3>
addEventListener</H3>
<PRE>
void <B>addEventListener</B>(int type,
java.lang.String uri,
<A HREF="../../info/dmtree/DmtEventListener.html" title="interface in info.dmtree">DmtEventListener</A> listener)</PRE>
<DL>
<DD>Registers an event listener on behalf of a local application. The given
listener will receive notification on all changes affecting the specified
subtree. The subtree is specified by its root node URI. An event is
delivered to the registered listener if at least one affected node is
within this subtree. The events can also be filtered by specifying a
bitmask of relevant event types (e.g.
<code>DmtEvent.ADDED | DmtEvent.REPLACED | DmtEvent.SESSION_CLOSED</code>).
Only event types included in the bitmask will be delivered to the
listener.
<p>
The listener will only receive the change notifications of nodes for
which the registering application has the appropriate GET
<A HREF="../../info/dmtree/security/DmtPermission.html" title="class in info.dmtree.security"><CODE>DmtPermission</CODE></A>.
<p>
If the specified <code>listener</code> was already registered, calling
this method will update the registration.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>type</CODE> - a bitmask of event types the caller is interested in<DD><CODE>uri</CODE> - the URI of the root node of a subtree, must not be
<code>null</code><DD><CODE>listener</CODE> - the listener to be registered, must not be
<code>null</code>
<DT><B>Throws:</B>
<DD><CODE>java.lang.SecurityException</CODE> - if the caller doesn't have the necessary GET
<code>DmtPermission</code> for the given URI
<DD><CODE>java.lang.NullPointerException</CODE> - if the <code>uri</code> or
<code>listener</code> parameter is <code>null</code>
<DD><CODE>java.lang.IllegalArgumentException</CODE> - if the <code>type</code> parameter
contains invalid bits (not corresponding to any event type
defined in <code>DmtEvent</code>), or if the <code>uri</code>
parameter is invalid (is not an absolute URI or is syntactically
incorrect)</DL>
</DD>
</DL>
<HR>
<A NAME="addEventListener(java.lang.String, int, java.lang.String, info.dmtree.DmtEventListener)"><!-- --></A><H3>
addEventListener</H3>
<PRE>
void <B>addEventListener</B>(java.lang.String principal,
int type,
java.lang.String uri,
<A HREF="../../info/dmtree/DmtEventListener.html" title="interface in info.dmtree">DmtEventListener</A> listener)</PRE>
<DL>
<DD>Registers an event listener on behalf of a remote principal. The given
listener will receive notification on all changes affecting the specified
subtree. The subtree is specified by its root node URI. An event is
delivered to the registered listener if at least one affected node is
within this subtree. The events can also be filtered by specifying a
bitmask of relevant event types (e.g.
<code>DmtEvent.ADDED | DmtEvent.REPLACED | DmtEvent.SESSION_CLOSED</code>).
Only event types included in the bitmask will be delivered to the
listener.
<p>
The listener will only receive the change notifications of nodes for
which the node ACL grants GET access to the specified principal.
<p>
If the specified <code>listener</code> was already registered, calling
this method will update the registration.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>principal</CODE> - the management server identity the caller is acting on
behalf of, must not be <code>null</code><DD><CODE>type</CODE> - a bitmask of event types the caller is interested in<DD><CODE>uri</CODE> - the URI of the root node of a subtree, must not be
<code>null</code><DD><CODE>listener</CODE> - the listener to be registered, must not be
<code>null</code>
<DT><B>Throws:</B>
<DD><CODE>java.lang.SecurityException</CODE> - if the caller doesn't have the necessary
<code>DmtPrincipalPermission</code> to use the specified
principal
<DD><CODE>java.lang.NullPointerException</CODE> - if the <code>principal</code>,
<code>uri</code> or <code>listener</code> parameter is
<code>null</code>
<DD><CODE>java.lang.IllegalArgumentException</CODE> - if the <code>type</code> parameter
contains invalid bits (not corresponding to any event type
defined in <code>DmtEvent</code>), or if the <code>uri</code>
parameter is invalid (is not an absolute URI or is syntactically
incorrect)</DL>
</DD>
</DL>
<HR>
<A NAME="removeEventListener(info.dmtree.DmtEventListener)"><!-- --></A><H3>
removeEventListener</H3>
<PRE>
void <B>removeEventListener</B>(<A HREF="../../info/dmtree/DmtEventListener.html" title="interface in info.dmtree">DmtEventListener</A> listener)</PRE>
<DL>
<DD>Remove a previously registered listener. After this call, the listener
will not receive change notifications.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>listener</CODE> - the listener to be unregistered, must not be
<code>null</code>
<DT><B>Throws:</B>
<DD><CODE>java.lang.NullPointerException</CODE> - if the <code>listener</code> parameter is
<code>null</code></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">
<A HREF="../../info/dmtree/Acl.html" title="class in info.dmtree"><B>PREV CLASS</B></A>
<A HREF="../../info/dmtree/DmtData.html" title="class in info.dmtree"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../index.html?info/dmtree/DmtAdmin.html" target="_top"><B>FRAMES</B></A>
<A HREF="DmtAdmin.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 | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<HR>
</BODY>
</HTML>
|