/usr/share/doc/libosgi-compendium-java/api/org/osgi/service/dmt/spi/ExecPlugin.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 | <!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>ExecPlugin</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="ExecPlugin";
}
}
catch(err) {
}
//-->
var methods = {"i0":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/spi/DataPlugin.html" title="interface in org.osgi.service.dmt.spi"><span class="typeNameLink">Prev Class</span></a></li>
<li><a href="../../../../../org/osgi/service/dmt/spi/MountPlugin.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/ExecPlugin.html" target="_top">Frames</a></li>
<li><a href="ExecPlugin.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 ExecPlugin" class="title">Interface ExecPlugin</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public interface <span class="typeNameLabel">ExecPlugin</span></pre>
<div class="block">An implementation of this interface takes the responsibility of handling node
execute requests 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>execRootURIs</code> registration parameter.</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/ExecPlugin.html#EXEC_ROOT_URIS">EXEC_ROOT_URIS</a></span></code>
<div class="block">The string to be used as key for the ???execRootURIs??? property when an
ExecPlugin 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/ExecPlugin.html#MOUNT_POINTS">MOUNT_POINTS</a></span></code>
<div class="block">The string to be used as key for the mount points property when an Exec
Plugin 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>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/osgi/service/dmt/spi/ExecPlugin.html#execute-org.osgi.service.dmt.DmtSession-java.lang.String:A-java.lang.String-java.lang.String-">execute</a></span>(<a href="../../../../../org/osgi/service/dmt/DmtSession.html" title="interface in org.osgi.service.dmt">DmtSession</a> session,
java.lang.String[] nodePath,
java.lang.String correlator,
java.lang.String data)</code>
<div class="block">Execute the given node with the given data.</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 an Exec
Plugin 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.ExecPlugin.MOUNT_POINTS">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="EXEC_ROOT_URIS">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>EXEC_ROOT_URIS</h4>
<pre>static final java.lang.String EXEC_ROOT_URIS</pre>
<div class="block">The string to be used as key for the ???execRootURIs??? property when an
ExecPlugin 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.ExecPlugin.EXEC_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="execute-org.osgi.service.dmt.DmtSession-java.lang.String:A-java.lang.String-java.lang.String-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>execute</h4>
<pre>void execute(<a href="../../../../../org/osgi/service/dmt/DmtSession.html" title="interface in org.osgi.service.dmt">DmtSession</a> session,
java.lang.String[] nodePath,
java.lang.String correlator,
java.lang.String data)
throws <a href="../../../../../org/osgi/service/dmt/DmtException.html" title="class in org.osgi.service.dmt">DmtException</a></pre>
<div class="block">Execute the given node with the given data. This operation corresponds to
the EXEC command in OMA DM.
<p>
The semantics of an execute operation and the data parameter it takes
depends on the definition of the managed object on which the command is
issued. Session information is given as it is needed for sending alerts
back from the plugin. If a correlation ID is specified, it should be used
as the <code>correlator</code> parameter for alerts sent in response to this
execute operation.
<p>
The <code>nodePath</code> parameter contains an array of path segments
identifying the node to be executed in the subtree of this plugin. This
is an absolute path, so the first segment is always ".".
Special characters appear escaped in the segments.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>session</code> - a reference to the session in which the operation was
issued, must not be <code>null</code></dd>
<dd><code>nodePath</code> - the absolute path of the node to be executed, must not be
<code>null</code></dd>
<dd><code>correlator</code> - an identifier to associate this operation with any
alerts sent in response to it, can be <code>null</code></dd>
<dd><code>data</code> - the parameter of the execute operation, can be <code>null</code></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 the node does not exist</li><li>
<code>METADATA_MISMATCH</code> if the command failed because of
meta-data restrictions</li><li><code>DATA_STORE_FAILURE</code> if an
error occurred while accessing the data store</li><li>
<code>COMMAND_FAILED</code> if some unspecified error is encountered
while attempting to complete the command</li>
</ul></dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../org/osgi/service/dmt/DmtSession.html#execute-java.lang.String-java.lang.String-"><code>DmtSession.execute(String, String)</code></a>,
<a href="../../../../../org/osgi/service/dmt/DmtSession.html#execute-java.lang.String-java.lang.String-java.lang.String-"><code>DmtSession.execute(String, String, String)</code></a></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/spi/DataPlugin.html" title="interface in org.osgi.service.dmt.spi"><span class="typeNameLink">Prev Class</span></a></li>
<li><a href="../../../../../org/osgi/service/dmt/spi/MountPlugin.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/ExecPlugin.html" target="_top">Frames</a></li>
<li><a href="ExecPlugin.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>
|