/usr/share/doc/libosgi-compendium-java/api/org/osgi/service/dmt/spi/DataPlugin.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 | <!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>DataPlugin</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="DataPlugin";
}
}
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>Prev Class</li>
<li><a href="../../../../../org/osgi/service/dmt/spi/ExecPlugin.html" title="interface in org.osgi.service.dmt.spi"><span class="typeNameLink">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/osgi/service/dmt/spi/DataPlugin.html" target="_top">Frames</a></li>
<li><a href="DataPlugin.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><a href="#field.summary">Field</a> | </li>
<li>Constr | </li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li><a href="#field.detail">Field</a> | </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.spi</div>
<h2 title="Interface DataPlugin" class="title">Interface DataPlugin</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public interface <span class="typeNameLabel">DataPlugin</span></pre>
<div class="block">An implementation of this interface takes the responsibility of handling data
requests in a subtree of the DMT.
<p>
In an OSGi environment such implementations should be registered at the OSGi
service registry specifying the list of root node URIs in a <code>String</code>
array or in case of a single value as <code>String</code> in the
<code>dataRootURIs</code> registration parameter.
<p>
When the first reference in a session is made to a node handled by this
plugin, the DmtAdmin calls one of the <code>open...</code> methods to retrieve a
plugin session object for processing the request. The called method depends
on the lock type of the current session. In case of
<a href="../../../../../org/osgi/service/dmt/spi/DataPlugin.html#openReadWriteSession-java.lang.String:A-org.osgi.service.dmt.DmtSession-"><code>openReadWriteSession(String[], DmtSession)</code></a> and
<a href="../../../../../org/osgi/service/dmt/spi/DataPlugin.html#openAtomicSession-java.lang.String:A-org.osgi.service.dmt.DmtSession-"><code>openAtomicSession(String[], DmtSession)</code></a>, the plugin may return
<code>null</code> to indicate that the specified lock type is not supported. In
this case the DmtAdmin may call
<a href="../../../../../org/osgi/service/dmt/spi/DataPlugin.html#openReadOnlySession-java.lang.String:A-org.osgi.service.dmt.DmtSession-"><code>openReadOnlySession(String[], DmtSession)</code></a> to start a read-only
plugin session, which can be used as long as there are no write operations on
the nodes handled by this plugin.
<p>
The <code>sessionRoot</code> parameter of each method is a String array containing
the segments of the URI pointing to the root of the session. This is an
absolute path, so the first segment is always ".". Special
characters appear escaped in the segments.
<p></div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Field and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/osgi/service/dmt/spi/DataPlugin.html#DATA_ROOT_URIS">DATA_ROOT_URIS</a></span></code>
<div class="block">The string to be used as key for the ???dataRootURIs??? property when an
DataPlugin is registered.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/osgi/service/dmt/spi/DataPlugin.html#MOUNT_POINTS">MOUNT_POINTS</a></span></code>
<div class="block">The string to be used as key for the mount points property when a
DataPlugin is registered with mount points.</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="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/spi/TransactionalDataSession.html" title="interface in org.osgi.service.dmt.spi">TransactionalDataSession</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/osgi/service/dmt/spi/DataPlugin.html#openAtomicSession-java.lang.String:A-org.osgi.service.dmt.DmtSession-">openAtomicSession</a></span>(java.lang.String[] sessionRoot,
<a href="../../../../../org/osgi/service/dmt/DmtSession.html" title="interface in org.osgi.service.dmt">DmtSession</a> session)</code>
<div class="block">This method is called to signal the start of an atomic read-write session
when the first reference is made within a <code>DmtSession</code> to a node
which is handled by this plugin.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/osgi/service/dmt/spi/ReadableDataSession.html" title="interface in org.osgi.service.dmt.spi">ReadableDataSession</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/osgi/service/dmt/spi/DataPlugin.html#openReadOnlySession-java.lang.String:A-org.osgi.service.dmt.DmtSession-">openReadOnlySession</a></span>(java.lang.String[] sessionRoot,
<a href="../../../../../org/osgi/service/dmt/DmtSession.html" title="interface in org.osgi.service.dmt">DmtSession</a> session)</code>
<div class="block">This method is called to signal the start of a read-only session when the
first reference is made within a <code>DmtSession</code> to a node which is
handled by this plugin.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/osgi/service/dmt/spi/ReadWriteDataSession.html" title="interface in org.osgi.service.dmt.spi">ReadWriteDataSession</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/osgi/service/dmt/spi/DataPlugin.html#openReadWriteSession-java.lang.String:A-org.osgi.service.dmt.DmtSession-">openReadWriteSession</a></span>(java.lang.String[] sessionRoot,
<a href="../../../../../org/osgi/service/dmt/DmtSession.html" title="interface in org.osgi.service.dmt">DmtSession</a> session)</code>
<div class="block">This method is called to signal the start of a non-atomic read-write
session when the first reference is made within a <code>DmtSession</code> to a
node which is handled by this plugin.</div>
</td>
</tr>
</table>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a name="MOUNT_POINTS">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>MOUNT_POINTS</h4>
<pre>static final java.lang.String MOUNT_POINTS</pre>
<div class="block">The string to be used as key for the mount points property when a
DataPlugin is registered with mount points.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#org.osgi.service.dmt.spi.DataPlugin.MOUNT_POINTS">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="DATA_ROOT_URIS">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>DATA_ROOT_URIS</h4>
<pre>static final java.lang.String DATA_ROOT_URIS</pre>
<div class="block">The string to be used as key for the ???dataRootURIs??? property when an
DataPlugin is registered.</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>2.0</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#org.osgi.service.dmt.spi.DataPlugin.DATA_ROOT_URIS">Constant Field Values</a></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="openReadOnlySession-java.lang.String:A-org.osgi.service.dmt.DmtSession-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>openReadOnlySession</h4>
<pre><a href="../../../../../org/osgi/service/dmt/spi/ReadableDataSession.html" title="interface in org.osgi.service.dmt.spi">ReadableDataSession</a> openReadOnlySession(java.lang.String[] sessionRoot,
<a href="../../../../../org/osgi/service/dmt/DmtSession.html" title="interface in org.osgi.service.dmt">DmtSession</a> session)
throws <a href="../../../../../org/osgi/service/dmt/DmtException.html" title="class in org.osgi.service.dmt">DmtException</a></pre>
<div class="block">This method is called to signal the start of a read-only session when the
first reference is made within a <code>DmtSession</code> to a node which is
handled by this plugin. Session information is given as it is needed for
sending alerts back from the plugin.
<p>
The plugin can assume that there are no writing sessions open on any
subtree that has any overlap with the subtree of this session.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>sessionRoot</code> - the path to the subtree which is accessed in the
current session, must not be <code>null</code></dd>
<dd><code>session</code> - the session from which this plugin instance is accessed,
must not be <code>null</code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a plugin session capable of executing read operations</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>NODE_NOT_FOUND</code> if <code>sessionRoot</code> points to a
non-existing node</li><li><code>COMMAND_FAILED</code> if some
unspecified error is encountered while attempting to complete the
command</li>
</ul></dd>
<dd><code>java.lang.SecurityException</code> - if some underlying operation failed because of
lack of permissions</dd>
</dl>
</li>
</ul>
<a name="openReadWriteSession-java.lang.String:A-org.osgi.service.dmt.DmtSession-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>openReadWriteSession</h4>
<pre><a href="../../../../../org/osgi/service/dmt/spi/ReadWriteDataSession.html" title="interface in org.osgi.service.dmt.spi">ReadWriteDataSession</a> openReadWriteSession(java.lang.String[] sessionRoot,
<a href="../../../../../org/osgi/service/dmt/DmtSession.html" title="interface in org.osgi.service.dmt">DmtSession</a> session)
throws <a href="../../../../../org/osgi/service/dmt/DmtException.html" title="class in org.osgi.service.dmt">DmtException</a></pre>
<div class="block">This method is called to signal the start of a non-atomic read-write
session when the first reference is made within a <code>DmtSession</code> to a
node which is handled by this plugin. Session information is given as it
is needed for sending alerts back from the plugin.
<p>
The plugin can assume that there are no other sessions open on any
subtree that has any overlap with the subtree of this session.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>sessionRoot</code> - the path to the subtree which is locked in the current
session, must not be <code>null</code></dd>
<dd><code>session</code> - the session from which this plugin instance is accessed,
must not be <code>null</code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a plugin session capable of executing read-write operations, or
<code>null</code> if the plugin does not support non-atomic read-write
sessions</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>NODE_NOT_FOUND</code> if <code>sessionRoot</code> points to a
non-existing node</li><li><code>COMMAND_FAILED</code> if some
unspecified error is encountered while attempting to complete the
command</li>
</ul></dd>
<dd><code>java.lang.SecurityException</code> - if some underlying operation failed because of
lack of permissions</dd>
</dl>
</li>
</ul>
<a name="openAtomicSession-java.lang.String:A-org.osgi.service.dmt.DmtSession-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>openAtomicSession</h4>
<pre><a href="../../../../../org/osgi/service/dmt/spi/TransactionalDataSession.html" title="interface in org.osgi.service.dmt.spi">TransactionalDataSession</a> openAtomicSession(java.lang.String[] sessionRoot,
<a href="../../../../../org/osgi/service/dmt/DmtSession.html" title="interface in org.osgi.service.dmt">DmtSession</a> session)
throws <a href="../../../../../org/osgi/service/dmt/DmtException.html" title="class in org.osgi.service.dmt">DmtException</a></pre>
<div class="block">This method is called to signal the start of an atomic read-write session
when the first reference is made within a <code>DmtSession</code> to a node
which is handled by this plugin. Session information is given as it is
needed for sending alerts back from the plugin.
<p>
The plugin can assume that there are no other sessions open on any
subtree that has any overlap with the subtree of this session.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>sessionRoot</code> - the path to the subtree which is locked in the current
session, must not be <code>null</code></dd>
<dd><code>session</code> - the session from which this plugin instance is accessed,
must not be <code>null</code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a plugin session capable of executing read-write operations in an
atomic block, or <code>null</code> if the plugin does not support
atomic read-write sessions</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>NODE_NOT_FOUND</code> if <code>sessionRoot</code> points to a
non-existing node</li><li><code>COMMAND_FAILED</code> if some
unspecified error is encountered while attempting to complete the
command</li>
</ul></dd>
<dd><code>java.lang.SecurityException</code> - if some underlying operation failed because of
lack of permissions</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/spi/ExecPlugin.html" title="interface in org.osgi.service.dmt.spi"><span class="typeNameLink">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/osgi/service/dmt/spi/DataPlugin.html" target="_top">Frames</a></li>
<li><a href="DataPlugin.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><a href="#field.summary">Field</a> | </li>
<li>Constr | </li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li><a href="#field.detail">Field</a> | </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>
|