/usr/share/doc/libosgi-compendium-java/api/org/osgi/service/deploymentadmin/spi/DeploymentSession.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 | <!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>DeploymentSession</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="DeploymentSession";
}
}
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/deploymentadmin/spi/DeploymentCustomizerPermission.html" title="class in org.osgi.service.deploymentadmin.spi"><span class="typeNameLink">Prev Class</span></a></li>
<li><a href="../../../../../org/osgi/service/deploymentadmin/spi/ResourceProcessor.html" title="interface in org.osgi.service.deploymentadmin.spi"><span class="typeNameLink">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/osgi/service/deploymentadmin/spi/DeploymentSession.html" target="_top">Frames</a></li>
<li><a href="DeploymentSession.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.spi</div>
<h2 title="Interface DeploymentSession" class="title">Interface DeploymentSession</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public interface <span class="typeNameLabel">DeploymentSession</span></pre>
<div class="block">The session interface represents a currently running deployment session
(install/update/uninstall).
<p>
When a deployment package is installed the target package, when uninstalled
the source package is an empty deployment package. The empty deployment
package is a virtual entity it doesn't appear for the outside world. It is
only visible on the DeploymentSession interface used by Resource Processors.
Although the empty package is only visible for Resource Processors it has the
following characteristics:
<p>
<ul>
<li>has version 0.0.0</li>
<li>its name is an empty string</li>
<li>it is stale</li>
<li>it has no bundles (see <a href="../../../../../org/osgi/service/deploymentadmin/DeploymentPackage.html#getBundle-java.lang.String-"><code>DeploymentPackage.getBundle(String)</code></a>)</li>
<li>it has no resources (see <a href="../../../../../org/osgi/service/deploymentadmin/DeploymentPackage.html#getResources--"><code>DeploymentPackage.getResources()</code></a>)</li>
<li>it has no headers except
<ul>
<li><code>DeploymentPackage-SymbolicName</code> and</li>
<li><code>DeploymentPackage-Version</code></li>
</ul>
(see <a href="../../../../../org/osgi/service/deploymentadmin/DeploymentPackage.html#getHeader-java.lang.String-"><code>DeploymentPackage.getHeader(String)</code></a>)</li>
<li>it has no resource headers (see
<a href="../../../../../org/osgi/service/deploymentadmin/DeploymentPackage.html#getResourceHeader-java.lang.String-java.lang.String-"><code>DeploymentPackage.getResourceHeader(String, String)</code></a>)</li>
<li><a href="../../../../../org/osgi/service/deploymentadmin/DeploymentPackage.html#uninstall--"><code>DeploymentPackage.uninstall()</code></a> throws
<code>IllegalStateException</code></li>
<li><a href="../../../../../org/osgi/service/deploymentadmin/DeploymentPackage.html#uninstallForced--"><code>DeploymentPackage.uninstallForced()</code></a> throws
<code>IllegalStateException</code></li>
</ul></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>java.io.File</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/osgi/service/deploymentadmin/spi/DeploymentSession.html#getDataFile-org.osgi.framework.Bundle-">getDataFile</a></span>(org.osgi.framework.Bundle bundle)</code>
<div class="block">Returns the private data area of the specified bundle.</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/spi/DeploymentSession.html#getSourceDeploymentPackage--">getSourceDeploymentPackage</a></span>()</code>
<div class="block">If the deployment action is an install or an update, this call returns
the <code>DeploymentPackage</code> instance that corresponds to the deployment
package being streamed in for this session.</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/spi/DeploymentSession.html#getTargetDeploymentPackage--">getTargetDeploymentPackage</a></span>()</code>
<div class="block">If the deployment action is an update or an uninstall, this call returns
the <code>DeploymentPackage</code> instance for the installed deployment
package.</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="getTargetDeploymentPackage--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTargetDeploymentPackage</h4>
<pre><a href="../../../../../org/osgi/service/deploymentadmin/DeploymentPackage.html" title="interface in org.osgi.service.deploymentadmin">DeploymentPackage</a> getTargetDeploymentPackage()</pre>
<div class="block">If the deployment action is an update or an uninstall, this call returns
the <code>DeploymentPackage</code> instance for the installed deployment
package. If the deployment action is an install, this call returns the
empty deployment package (see <a href="../../../../../org/osgi/service/deploymentadmin/DeploymentPackage.html" title="interface in org.osgi.service.deploymentadmin"><code>DeploymentPackage</code></a>).</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the target deployment package</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></dd>
</dl>
</li>
</ul>
<a name="getSourceDeploymentPackage--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSourceDeploymentPackage</h4>
<pre><a href="../../../../../org/osgi/service/deploymentadmin/DeploymentPackage.html" title="interface in org.osgi.service.deploymentadmin">DeploymentPackage</a> getSourceDeploymentPackage()</pre>
<div class="block">If the deployment action is an install or an update, this call returns
the <code>DeploymentPackage</code> instance that corresponds to the deployment
package being streamed in for this session. If the deployment action is
an uninstall, this call returns the empty deployment package (see
<a href="../../../../../org/osgi/service/deploymentadmin/DeploymentPackage.html" title="interface in org.osgi.service.deploymentadmin"><code>DeploymentPackage</code></a>).</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the source deployment package</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></dd>
</dl>
</li>
</ul>
<a name="getDataFile-org.osgi.framework.Bundle-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getDataFile</h4>
<pre>java.io.File getDataFile(org.osgi.framework.Bundle bundle)</pre>
<div class="block">Returns the private data area of the specified bundle. The bundle must be
part of either the source or the target deployment packages. The
permission set the caller resource processor needs to manipulate the
private area of the bundle is set by the Deployment Admin on the fly when
this method is called. The permissions remain available during the
deployment action only.
<p>
The bundle and the caller Resource Processor have to be in the same
Deployment Package.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>bundle</code> - the bundle the private area belongs to</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>file representing the private area of the bundle. It cannot be
null.</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/spi/DeploymentCustomizerPermission.html" title="class in org.osgi.service.deploymentadmin.spi"><code>DeploymentCustomizerPermission</code></a>("<filter>",
"privatearea") 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/spi/DeploymentCustomizerPermission.html" title="class in org.osgi.service.deploymentadmin.spi"><code>DeploymentCustomizerPermission</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/spi/DeploymentCustomizerPermission.html" title="class in org.osgi.service.deploymentadmin.spi"><span class="typeNameLink">Prev Class</span></a></li>
<li><a href="../../../../../org/osgi/service/deploymentadmin/spi/ResourceProcessor.html" title="interface in org.osgi.service.deploymentadmin.spi"><span class="typeNameLink">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/osgi/service/deploymentadmin/spi/DeploymentSession.html" target="_top">Frames</a></li>
<li><a href="DeploymentSession.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>
|