/usr/share/doc/libosgi-compendium-java/api/org/osgi/service/deploymentadmin/DeploymentAdmin.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 | <!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>DeploymentAdmin</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="DeploymentAdmin";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":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/deploymentadmin/BundleInfo.html" title="interface in org.osgi.service.deploymentadmin"><span class="typeNameLink">Prev Class</span></a></li>
<li><a href="../../../../org/osgi/service/deploymentadmin/DeploymentAdminPermission.html" title="class in org.osgi.service.deploymentadmin"><span class="typeNameLink">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/osgi/service/deploymentadmin/DeploymentAdmin.html" target="_top">Frames</a></li>
<li><a href="DeploymentAdmin.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.deploymentadmin</div>
<h2 title="Interface DeploymentAdmin" class="title">Interface DeploymentAdmin</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public interface <span class="typeNameLabel">DeploymentAdmin</span></pre>
<div class="block">This is the interface of the Deployment Admin service.
<p>
The OSGi Service Platform provides mechanisms to manage the life cycle of
bundles, configuration objects, permission objects, etc. but the overall
consistency of the runtime configuration is the responsibility of the
management agent. In other words, the management agent decides to install,
update, or uninstall bundles, create or delete configuration or permission
objects, as well as manage other resource types, etc.
<p>
The Deployment Admin service standardizes the access to some of the
responsibilities of the management agent. The service provides functionality
to manage Deployment Packages (see <a href="../../../../org/osgi/service/deploymentadmin/DeploymentPackage.html" title="interface in org.osgi.service.deploymentadmin"><code>DeploymentPackage</code></a>). A Deployment
Package groups resources as a unit of management. A Deployment Package is
something that can be installed, updated, and uninstalled as a unit.
<p>
The Deployment Admin functionality is exposed as a standard OSGi service with
no mandatory service parameters.</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>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/osgi/service/deploymentadmin/DeploymentAdmin.html#cancel--">cancel</a></span>()</code>
<div class="block">This method cancels the currently active deployment session.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="../../../../org/osgi/service/deploymentadmin/DeploymentPackage.html" title="interface in org.osgi.service.deploymentadmin">DeploymentPackage</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/osgi/service/deploymentadmin/DeploymentAdmin.html#getDeploymentPackage-org.osgi.framework.Bundle-">getDeploymentPackage</a></span>(org.osgi.framework.Bundle bundle)</code>
<div class="block">Gives back the installed <a href="../../../../org/osgi/service/deploymentadmin/DeploymentPackage.html" title="interface in org.osgi.service.deploymentadmin"><code>DeploymentPackage</code></a> that owns the bundle.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="../../../../org/osgi/service/deploymentadmin/DeploymentPackage.html" title="interface in org.osgi.service.deploymentadmin">DeploymentPackage</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/osgi/service/deploymentadmin/DeploymentAdmin.html#getDeploymentPackage-java.lang.String-">getDeploymentPackage</a></span>(java.lang.String symbName)</code>
<div class="block">Gets the currently installed <a href="../../../../org/osgi/service/deploymentadmin/DeploymentPackage.html" title="interface in org.osgi.service.deploymentadmin"><code>DeploymentPackage</code></a> instance which has
the given symbolic name.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="../../../../org/osgi/service/deploymentadmin/DeploymentPackage.html" title="interface in org.osgi.service.deploymentadmin">DeploymentPackage</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/osgi/service/deploymentadmin/DeploymentAdmin.html#installDeploymentPackage-java.io.InputStream-">installDeploymentPackage</a></span>(java.io.InputStream in)</code>
<div class="block">Installs a Deployment Package from an input stream.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code><a href="../../../../org/osgi/service/deploymentadmin/DeploymentPackage.html" title="interface in org.osgi.service.deploymentadmin">DeploymentPackage</a>[]</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/osgi/service/deploymentadmin/DeploymentAdmin.html#listDeploymentPackages--">listDeploymentPackages</a></span>()</code>
<div class="block">Lists the Deployment Packages currently installed on the platform.</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="installDeploymentPackage-java.io.InputStream-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>installDeploymentPackage</h4>
<pre><a href="../../../../org/osgi/service/deploymentadmin/DeploymentPackage.html" title="interface in org.osgi.service.deploymentadmin">DeploymentPackage</a> installDeploymentPackage(java.io.InputStream in)
throws <a href="../../../../org/osgi/service/deploymentadmin/DeploymentException.html" title="class in org.osgi.service.deploymentadmin">DeploymentException</a></pre>
<div class="block">Installs a Deployment Package from an input stream. If a version of that
Deployment Package is already installed and the versions are different,
the installed version is updated with this new version even if it is
older (downgrade). If the two versions are the same, then this method
simply returns with the old (target) Deployment Package without any
action.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>in</code> - the input stream the Deployment Package can be read from. It
mustn't be <code>null</code>.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>A DeploymentPackage object representing the newly
installed/updated Deployment Package. It is never <code>null</code>.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.IllegalArgumentException</code> - if the got InputStream parameter is
<code>null</code></dd>
<dd><code><a href="../../../../org/osgi/service/deploymentadmin/DeploymentException.html" title="class in org.osgi.service.deploymentadmin">DeploymentException</a></code> - if the installation was not successful. For
detailed error code description see <a href="../../../../org/osgi/service/deploymentadmin/DeploymentException.html" title="class in org.osgi.service.deploymentadmin"><code>DeploymentException</code></a>.</dd>
<dd><code>java.lang.SecurityException</code> - if the caller doesn't have the appropriate
<a href="../../../../org/osgi/service/deploymentadmin/DeploymentAdminPermission.html" title="class in org.osgi.service.deploymentadmin"><code>DeploymentAdminPermission</code></a>("<filter>", "install")
permission.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../org/osgi/service/deploymentadmin/DeploymentAdminPermission.html" title="class in org.osgi.service.deploymentadmin"><code>DeploymentAdminPermission</code></a>,
<a href="../../../../org/osgi/service/deploymentadmin/DeploymentPackage.html" title="interface in org.osgi.service.deploymentadmin"><code>DeploymentPackage</code></a>,
<a href="../../../../org/osgi/service/deploymentadmin/DeploymentPackage.html" title="interface in org.osgi.service.deploymentadmin"><code>DeploymentPackage</code></a></dd>
</dl>
</li>
</ul>
<a name="listDeploymentPackages--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>listDeploymentPackages</h4>
<pre><a href="../../../../org/osgi/service/deploymentadmin/DeploymentPackage.html" title="interface in org.osgi.service.deploymentadmin">DeploymentPackage</a>[] listDeploymentPackages()</pre>
<div class="block">Lists the Deployment Packages currently installed on the platform.
<p>
<a href="../../../../org/osgi/service/deploymentadmin/DeploymentAdminPermission.html" title="class in org.osgi.service.deploymentadmin"><code>DeploymentAdminPermission</code></a>("<filter>", "list") is needed for
this operation to the effect that only those packages are listed in the
array to which the caller has appropriate DeploymentAdminPermission. It
has the consequence that the method never throws SecurityException only
doesn't put certain Deployment Packages into the array.
<p>
During an installation of an existing package (update) or during an
uninstallation, the target must remain in this list until the
installation (uninstallation) process is completed, after which the
source (or <code>null</code> in case of uninstall) replaces the target.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the array of <code>DeploymentPackage</code> objects representing all
the installed Deployment Packages. The return value cannot be
<code>null</code>. In case of missing permissions it may give back an
empty array.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../org/osgi/service/deploymentadmin/DeploymentPackage.html" title="interface in org.osgi.service.deploymentadmin"><code>DeploymentPackage</code></a>,
<a href="../../../../org/osgi/service/deploymentadmin/DeploymentAdminPermission.html" title="class in org.osgi.service.deploymentadmin"><code>DeploymentAdminPermission</code></a></dd>
</dl>
</li>
</ul>
<a name="getDeploymentPackage-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDeploymentPackage</h4>
<pre><a href="../../../../org/osgi/service/deploymentadmin/DeploymentPackage.html" title="interface in org.osgi.service.deploymentadmin">DeploymentPackage</a> getDeploymentPackage(java.lang.String symbName)</pre>
<div class="block">Gets the currently installed <a href="../../../../org/osgi/service/deploymentadmin/DeploymentPackage.html" title="interface in org.osgi.service.deploymentadmin"><code>DeploymentPackage</code></a> instance which has
the given symbolic name.
<p>
During an installation of an existing package (update) or during an
uninstallation, the target Deployment Package must remain the return
value until the installation (uninstallation) process is completed, after
which the source (or <code>null</code> in case of uninstall) is the return
value.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>symbName</code> - the symbolic name of the Deployment Package to be
retrieved. It mustn't be <code>null</code>.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The <code>DeploymentPackage</code> for the given symbolic name. If
there is no Deployment Package with that symbolic name currently
installed, <code>null</code> is returned.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.IllegalArgumentException</code> - if the given <code>symbName</code> is
<code>null</code></dd>
<dd><code>java.lang.SecurityException</code> - if the caller doesn't have the appropriate
<a href="../../../../org/osgi/service/deploymentadmin/DeploymentAdminPermission.html" title="class in org.osgi.service.deploymentadmin"><code>DeploymentAdminPermission</code></a>("<filter>", "list")
permission.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../org/osgi/service/deploymentadmin/DeploymentPackage.html" title="interface in org.osgi.service.deploymentadmin"><code>DeploymentPackage</code></a>,
<a href="../../../../org/osgi/service/deploymentadmin/DeploymentAdminPermission.html" title="class in org.osgi.service.deploymentadmin"><code>DeploymentAdminPermission</code></a></dd>
</dl>
</li>
</ul>
<a name="getDeploymentPackage-org.osgi.framework.Bundle-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDeploymentPackage</h4>
<pre><a href="../../../../org/osgi/service/deploymentadmin/DeploymentPackage.html" title="interface in org.osgi.service.deploymentadmin">DeploymentPackage</a> getDeploymentPackage(org.osgi.framework.Bundle bundle)</pre>
<div class="block">Gives back the installed <a href="../../../../org/osgi/service/deploymentadmin/DeploymentPackage.html" title="interface in org.osgi.service.deploymentadmin"><code>DeploymentPackage</code></a> that owns the bundle.
Deployment Packages own their bundles by their Bundle Symbolic Name. It
means that if a bundle belongs to an installed Deployment Packages (and
at most to one) the Deployment Admin assigns the bundle to its owner
Deployment Package by the Symbolic Name of the bundle.
<p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>bundle</code> - the bundle whose owner is queried</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the Deployment Package Object that owns the bundle or
<code>null</code> if the bundle doesn't belong to any Deployment
Packages (standalone bundles)</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.IllegalArgumentException</code> - if the given <code>bundle</code> is
<code>null</code></dd>
<dd><code>java.lang.SecurityException</code> - if the caller doesn't have the appropriate
<a href="../../../../org/osgi/service/deploymentadmin/DeploymentAdminPermission.html" title="class in org.osgi.service.deploymentadmin"><code>DeploymentAdminPermission</code></a>("<filter>", "list")
permission.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../org/osgi/service/deploymentadmin/DeploymentPackage.html" title="interface in org.osgi.service.deploymentadmin"><code>DeploymentPackage</code></a>,
<a href="../../../../org/osgi/service/deploymentadmin/DeploymentAdminPermission.html" title="class in org.osgi.service.deploymentadmin"><code>DeploymentAdminPermission</code></a></dd>
</dl>
</li>
</ul>
<a name="cancel--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>cancel</h4>
<pre>boolean cancel()</pre>
<div class="block">This method cancels the currently active deployment session. This method
addresses the need to cancel the processing of excessively long running,
or resource consuming install, update or uninstall operations.
<p></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if there was an active session and it was successfully
canceled.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.SecurityException</code> - if the caller doesn't have the appropriate
<a href="../../../../org/osgi/service/deploymentadmin/DeploymentAdminPermission.html" title="class in org.osgi.service.deploymentadmin"><code>DeploymentAdminPermission</code></a>("<filter>", "cancel")
permission.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../org/osgi/service/deploymentadmin/DeploymentAdminPermission.html" title="class in org.osgi.service.deploymentadmin"><code>DeploymentAdminPermission</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/deploymentadmin/BundleInfo.html" title="interface in org.osgi.service.deploymentadmin"><span class="typeNameLink">Prev Class</span></a></li>
<li><a href="../../../../org/osgi/service/deploymentadmin/DeploymentAdminPermission.html" title="class in org.osgi.service.deploymentadmin"><span class="typeNameLink">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/osgi/service/deploymentadmin/DeploymentAdmin.html" target="_top">Frames</a></li>
<li><a href="DeploymentAdmin.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>
|