/usr/share/doc/libosgi-compendium-java/api/org/osgi/service/dmt/DmtAdmin.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 | <!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>DmtAdmin</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="DmtAdmin";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":6,"i2":6};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract 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><a href="../../../../org/osgi/service/dmt/Acl.html" title="class in org.osgi.service.dmt"><span class="typeNameLink">Prev Class</span></a></li>
<li><a href="../../../../org/osgi/service/dmt/DmtConstants.html" title="class in org.osgi.service.dmt"><span class="typeNameLink">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/osgi/service/dmt/DmtAdmin.html" target="_top">Frames</a></li>
<li><a href="DmtAdmin.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</div>
<h2 title="Interface DmtAdmin" class="title">Interface DmtAdmin</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public interface <span class="typeNameLabel">DmtAdmin</span></pre>
<div class="block">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 '\').
<p>
See the <a href="../../../../org/osgi/service/dmt/Uri.html#encode-java.lang.String-"><code>Uri.encode(String)</code></a> method for support on escaping invalid
characters in a URI.
<p>
It is possible to specify a lock mode when opening the session (see lock type
constants in <a href="../../../../org/osgi/service/dmt/DmtSession.html" title="interface in org.osgi.service.dmt"><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.</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="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="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract 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/DmtSession.html" title="interface in org.osgi.service.dmt">DmtSession</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/osgi/service/dmt/DmtAdmin.html#getSession-java.lang.String-">getSession</a></span>(java.lang.String subtreeUri)</code>
<div class="block">Opens a <code>DmtSession</code> for local usage on a given subtree of the DMT
with non transactional write lock.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="../../../../org/osgi/service/dmt/DmtSession.html" title="interface in org.osgi.service.dmt">DmtSession</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/osgi/service/dmt/DmtAdmin.html#getSession-java.lang.String-int-">getSession</a></span>(java.lang.String subtreeUri,
int lockMode)</code>
<div class="block">Opens a <code>DmtSession</code> for local usage on a specific DMT subtree with
a given lock mode.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="../../../../org/osgi/service/dmt/DmtSession.html" title="interface in org.osgi.service.dmt">DmtSession</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/osgi/service/dmt/DmtAdmin.html#getSession-java.lang.String-java.lang.String-int-">getSession</a></span>(java.lang.String principal,
java.lang.String subtreeUri,
int lockMode)</code>
<div class="block">Opens a <code>DmtSession</code> on a specific DMT subtree using a specific
lock mode on behalf of a remote principal.</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="getSession-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSession</h4>
<pre><a href="../../../../org/osgi/service/dmt/DmtSession.html" title="interface in org.osgi.service.dmt">DmtSession</a> getSession(java.lang.String subtreeUri)
throws <a href="../../../../org/osgi/service/dmt/DmtException.html" title="class in org.osgi.service.dmt">DmtException</a></pre>
<div class="block">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.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>subtreeUri</code> - the subtree on which DMT manipulations can be performed
within the returned session</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a <code>DmtSession</code> object for the requested subtree</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../org/osgi/service/dmt/DmtException.html" title="class in org.osgi.service.dmt">DmtException</a></code> - with the following possible error codes:
<ul>
<li><code>INVALID_URI</code> if <code>subtreeUri</code> is syntactically
invalid</li><li><code>URI_TOO_LONG</code> if <code>subtreeUri</code> is
longer than accepted by the <code>DmtAdmin</code> implementation
(especially on systems with limited resources)</li><li>
<code>NODE_NOT_FOUND</code> if <code>subtreeUri</code> specifies a
non-existing node</li><li> <code>SESSION_CREATION_TIMEOUT</code> if
the operation timed out because of another ongoing session</li>
<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</li>
</ul></dd>
<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</dd>
</dl>
</li>
</ul>
<a name="getSession-java.lang.String-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSession</h4>
<pre><a href="../../../../org/osgi/service/dmt/DmtSession.html" title="interface in org.osgi.service.dmt">DmtSession</a> getSession(java.lang.String subtreeUri,
int lockMode)
throws <a href="../../../../org/osgi/service/dmt/DmtException.html" title="class in org.osgi.service.dmt">DmtException</a></pre>
<div class="block">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.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>subtreeUri</code> - the subtree on which DMT manipulations can be performed
within the returned session</dd>
<dd><code>lockMode</code> - one of the lock modes specified in <code>DmtSession</code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a <code>DmtSession</code> object for the requested subtree</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../org/osgi/service/dmt/DmtException.html" title="class in org.osgi.service.dmt">DmtException</a></code> - with the following possible error codes:
<ul>
<li><code>INVALID_URI</code> if <code>subtreeUri</code> is syntactically
invalid</li><li><code>URI_TOO_LONG</code> if <code>subtreeUri</code> is
longer than accepted by the <code>DmtAdmin</code> implementation
(especially on systems with limited resources)</li><li>
<code>NODE_NOT_FOUND</code> if <code>subtreeUri</code> specifies a
non-existing node</li><li> <code>FEATURE_NOT_SUPPORTED</code> if
atomic sessions are not supported by the implementation and
<code>lockMode</code> requests an atomic session</li><li>
<code>SESSION_CREATION_TIMEOUT</code> if the operation timed out
because of another ongoing session</li><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</li>
</ul></dd>
<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</dd>
</dl>
</li>
</ul>
<a name="getSession-java.lang.String-java.lang.String-int-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getSession</h4>
<pre><a href="../../../../org/osgi/service/dmt/DmtSession.html" title="interface in org.osgi.service.dmt">DmtSession</a> getSession(java.lang.String principal,
java.lang.String subtreeUri,
int lockMode)
throws <a href="../../../../org/osgi/service/dmt/DmtException.html" title="class in org.osgi.service.dmt">DmtException</a></pre>
<div class="block">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.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<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>
<dd><code>subtreeUri</code> - the subtree on which DMT manipulations can be performed
within the returned session</dd>
<dd><code>lockMode</code> - one of the lock modes specified in <code>DmtSession</code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a <code>DmtSession</code> object for the requested subtree</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../org/osgi/service/dmt/DmtException.html" title="class in org.osgi.service.dmt">DmtException</a></code> - with the following possible error codes:
<ul>
<li><code>INVALID_URI</code> if <code>subtreeUri</code> is syntactically
invalid</li><li><code>URI_TOO_LONG</code> if <code>subtreeUri</code> is
longer than accepted by the <code>DmtAdmin</code> implementation
(especially on systems with limited resources)</li><li>
<code>NODE_NOT_FOUND</code> if <code>subtreeUri</code> specifies a
non-existing node</li><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><li><code>FEATURE_NOT_SUPPORTED</code> if atomic
sessions are not supported by the implementation and
<code>lockMode</code> requests an atomic session</li><li>
<code>SESSION_CREATION_TIMEOUT</code> if the operation timed out
because of another ongoing session</li><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</li>
</ul></dd>
<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</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><a href="../../../../org/osgi/service/dmt/Acl.html" title="class in org.osgi.service.dmt"><span class="typeNameLink">Prev Class</span></a></li>
<li><a href="../../../../org/osgi/service/dmt/DmtConstants.html" title="class in org.osgi.service.dmt"><span class="typeNameLink">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/osgi/service/dmt/DmtAdmin.html" target="_top">Frames</a></li>
<li><a href="DmtAdmin.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>
|