/usr/share/doc/libosgi-compendium-java/api/org/osgi/service/deploymentadmin/spi/ResourceProcessor.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 442 443 444 445 446 447 448 449 | <!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>ResourceProcessor</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="ResourceProcessor";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":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/DeploymentSession.html" title="interface in org.osgi.service.deploymentadmin.spi"><span class="typeNameLink">Prev Class</span></a></li>
<li><a href="../../../../../org/osgi/service/deploymentadmin/spi/ResourceProcessorException.html" title="class 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/ResourceProcessor.html" target="_top">Frames</a></li>
<li><a href="ResourceProcessor.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 ResourceProcessor" class="title">Interface ResourceProcessor</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public interface <span class="typeNameLabel">ResourceProcessor</span></pre>
<div class="block">ResourceProcessor interface is implemented by processors handling resource
files in deployment packages. Resource Processors expose their services as
standard OSGi services. Bundles exporting the service may arrive in the
deployment package (customizers) or may be preregistered (they are installed
previously). Resource processors has to define the <code>service.pid</code>
standard OSGi service property which should be a unique string.
<p>
The order of the method calls on a particular Resource Processor in case of
install/update session is the following:
<p>
<ol>
<li><a href="../../../../../org/osgi/service/deploymentadmin/spi/ResourceProcessor.html#begin-org.osgi.service.deploymentadmin.spi.DeploymentSession-"><code>begin(DeploymentSession)</code></a></li>
<li><a href="../../../../../org/osgi/service/deploymentadmin/spi/ResourceProcessor.html#process-java.lang.String-java.io.InputStream-"><code>process(String, InputStream)</code></a> calls till there are resources to
process or <a href="../../../../../org/osgi/service/deploymentadmin/spi/ResourceProcessor.html#rollback--"><code>rollback()</code></a> and the further steps are ignored</li>
<li><a href="../../../../../org/osgi/service/deploymentadmin/spi/ResourceProcessor.html#dropped-java.lang.String-"><code>dropped(String)</code></a> calls till there are resources to drop</li>
<li><a href="../../../../../org/osgi/service/deploymentadmin/spi/ResourceProcessor.html#prepare--"><code>prepare()</code></a></li>
<li><a href="../../../../../org/osgi/service/deploymentadmin/spi/ResourceProcessor.html#commit--"><code>commit()</code></a> or <a href="../../../../../org/osgi/service/deploymentadmin/spi/ResourceProcessor.html#rollback--"><code>rollback()</code></a></li>
</ol>
The order of the method calls on a particular Resource Processor in case of
uninstall session is the following:
<p>
<ol>
<li><a href="../../../../../org/osgi/service/deploymentadmin/spi/ResourceProcessor.html#begin-org.osgi.service.deploymentadmin.spi.DeploymentSession-"><code>begin(DeploymentSession)</code></a></li>
<li><a href="../../../../../org/osgi/service/deploymentadmin/spi/ResourceProcessor.html#dropAllResources--"><code>dropAllResources()</code></a> or <a href="../../../../../org/osgi/service/deploymentadmin/spi/ResourceProcessor.html#rollback--"><code>rollback()</code></a> and the further steps
are ignored</li>
<li><a href="../../../../../org/osgi/service/deploymentadmin/spi/ResourceProcessor.html#prepare--"><code>prepare()</code></a></li>
<li><a href="../../../../../org/osgi/service/deploymentadmin/spi/ResourceProcessor.html#commit--"><code>commit()</code></a> or <a href="../../../../../org/osgi/service/deploymentadmin/spi/ResourceProcessor.html#rollback--"><code>rollback()</code></a></li>
</ol></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>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/osgi/service/deploymentadmin/spi/ResourceProcessor.html#begin-org.osgi.service.deploymentadmin.spi.DeploymentSession-">begin</a></span>(<a href="../../../../../org/osgi/service/deploymentadmin/spi/DeploymentSession.html" title="interface in org.osgi.service.deploymentadmin.spi">DeploymentSession</a> session)</code>
<div class="block">Called when the Deployment Admin starts a new operation on the given
deployment package, and the resource processor is associated a resource
within the package.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/osgi/service/deploymentadmin/spi/ResourceProcessor.html#cancel--">cancel</a></span>()</code>
<div class="block">Processing of a resource passed to the resource processor may take long.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/osgi/service/deploymentadmin/spi/ResourceProcessor.html#commit--">commit</a></span>()</code>
<div class="block">Called when the processing of the current deployment package is finished.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/osgi/service/deploymentadmin/spi/ResourceProcessor.html#dropAllResources--">dropAllResources</a></span>()</code>
<div class="block">This method is called during an "uninstall" deployment session.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/osgi/service/deploymentadmin/spi/ResourceProcessor.html#dropped-java.lang.String-">dropped</a></span>(java.lang.String resource)</code>
<div class="block">Called when a resource, associated with a particular resource processor,
had belonged to an earlier version of a deployment package but is not
present in the current version of the deployment package.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/osgi/service/deploymentadmin/spi/ResourceProcessor.html#prepare--">prepare</a></span>()</code>
<div class="block">This method is called on the Resource Processor immediately before
calling the <code>commit</code> method.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/osgi/service/deploymentadmin/spi/ResourceProcessor.html#process-java.lang.String-java.io.InputStream-">process</a></span>(java.lang.String name,
java.io.InputStream stream)</code>
<div class="block">Called when a resource is encountered in the deployment package for which
this resource processor has been selected to handle the processing of
that resource.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/osgi/service/deploymentadmin/spi/ResourceProcessor.html#rollback--">rollback</a></span>()</code>
<div class="block">Called when the processing of the current deployment package is finished.</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="begin-org.osgi.service.deploymentadmin.spi.DeploymentSession-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>begin</h4>
<pre>void begin(<a href="../../../../../org/osgi/service/deploymentadmin/spi/DeploymentSession.html" title="interface in org.osgi.service.deploymentadmin.spi">DeploymentSession</a> session)</pre>
<div class="block">Called when the Deployment Admin starts a new operation on the given
deployment package, and the resource processor is associated a resource
within the package. Only one deployment package can be processed at a
time.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>session</code> - object that represents the current session to the resource
processor</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../org/osgi/service/deploymentadmin/spi/DeploymentSession.html" title="interface in org.osgi.service.deploymentadmin.spi"><code>DeploymentSession</code></a></dd>
</dl>
</li>
</ul>
<a name="process-java.lang.String-java.io.InputStream-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>process</h4>
<pre>void process(java.lang.String name,
java.io.InputStream stream)
throws <a href="../../../../../org/osgi/service/deploymentadmin/spi/ResourceProcessorException.html" title="class in org.osgi.service.deploymentadmin.spi">ResourceProcessorException</a></pre>
<div class="block">Called when a resource is encountered in the deployment package for which
this resource processor has been selected to handle the processing of
that resource.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>name</code> - The name of the resource relative to the deployment package
root directory.</dd>
<dd><code>stream</code> - The stream for the resource.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../../org/osgi/service/deploymentadmin/spi/ResourceProcessorException.html" title="class in org.osgi.service.deploymentadmin.spi">ResourceProcessorException</a></code> - if the resource cannot be processed.
Only
<a href="../../../../../org/osgi/service/deploymentadmin/spi/ResourceProcessorException.html#CODE_RESOURCE_SHARING_VIOLATION"><code>ResourceProcessorException.CODE_RESOURCE_SHARING_VIOLATION</code></a>
and <a href="../../../../../org/osgi/service/deploymentadmin/spi/ResourceProcessorException.html#CODE_OTHER_ERROR"><code>ResourceProcessorException.CODE_OTHER_ERROR</code></a> error
codes are allowed.</dd>
</dl>
</li>
</ul>
<a name="dropped-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>dropped</h4>
<pre>void dropped(java.lang.String resource)
throws <a href="../../../../../org/osgi/service/deploymentadmin/spi/ResourceProcessorException.html" title="class in org.osgi.service.deploymentadmin.spi">ResourceProcessorException</a></pre>
<div class="block">Called when a resource, associated with a particular resource processor,
had belonged to an earlier version of a deployment package but is not
present in the current version of the deployment package. This provides
an opportunity for the processor to cleanup any memory and persistent
data being maintained for the particular resource. This method will only
be called during "update" deployment sessions.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>resource</code> - the name of the resource to drop (it is the same as the
value of the "Name" attribute in the deployment package's
manifest)</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../../org/osgi/service/deploymentadmin/spi/ResourceProcessorException.html" title="class in org.osgi.service.deploymentadmin.spi">ResourceProcessorException</a></code> - if the resource is not allowed to be
dropped. Only the
<a href="../../../../../org/osgi/service/deploymentadmin/spi/ResourceProcessorException.html#CODE_OTHER_ERROR"><code>ResourceProcessorException.CODE_OTHER_ERROR</code></a> error code is
allowed</dd>
</dl>
</li>
</ul>
<a name="dropAllResources--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>dropAllResources</h4>
<pre>void dropAllResources()
throws <a href="../../../../../org/osgi/service/deploymentadmin/spi/ResourceProcessorException.html" title="class in org.osgi.service.deploymentadmin.spi">ResourceProcessorException</a></pre>
<div class="block">This method is called during an "uninstall" deployment session. This
method will be called on all resource processors that are associated with
resources in the deployment package being uninstalled. This provides an
opportunity for the processor to cleanup any memory and persistent data
being maintained for the deployment package.</div>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../../org/osgi/service/deploymentadmin/spi/ResourceProcessorException.html" title="class in org.osgi.service.deploymentadmin.spi">ResourceProcessorException</a></code> - if all resources could not be dropped.
Only the <a href="../../../../../org/osgi/service/deploymentadmin/spi/ResourceProcessorException.html#CODE_OTHER_ERROR"><code>ResourceProcessorException.CODE_OTHER_ERROR</code></a> is
allowed.</dd>
</dl>
</li>
</ul>
<a name="prepare--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>prepare</h4>
<pre>void prepare()
throws <a href="../../../../../org/osgi/service/deploymentadmin/spi/ResourceProcessorException.html" title="class in org.osgi.service.deploymentadmin.spi">ResourceProcessorException</a></pre>
<div class="block">This method is called on the Resource Processor immediately before
calling the <code>commit</code> method. The Resource Processor has to check
whether it is able to commit the operations since the last <code>begin</code>
method call. If it determines that it is not able to commit the changes,
it has to raise a <code>ResourceProcessorException</code> with the
<a href="../../../../../org/osgi/service/deploymentadmin/spi/ResourceProcessorException.html#CODE_PREPARE"><code>ResourceProcessorException.CODE_PREPARE</code></a> error code.</div>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../../org/osgi/service/deploymentadmin/spi/ResourceProcessorException.html" title="class in org.osgi.service.deploymentadmin.spi">ResourceProcessorException</a></code> - if the resource processor is able to
determine it is not able to commit. Only the
<a href="../../../../../org/osgi/service/deploymentadmin/spi/ResourceProcessorException.html#CODE_PREPARE"><code>ResourceProcessorException.CODE_PREPARE</code></a> error code is
allowed.</dd>
</dl>
</li>
</ul>
<a name="commit--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>commit</h4>
<pre>void commit()</pre>
<div class="block">Called when the processing of the current deployment package is finished.
This method is called if the processing of the current deployment package
was successful, and the changes must be made permanent.</div>
</li>
</ul>
<a name="rollback--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>rollback</h4>
<pre>void rollback()</pre>
<div class="block">Called when the processing of the current deployment package is finished.
This method is called if the processing of the current deployment package
was unsuccessful, and the changes made during the processing of the
deployment package should be removed.</div>
</li>
</ul>
<a name="cancel--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>cancel</h4>
<pre>void cancel()</pre>
<div class="block">Processing of a resource passed to the resource processor may take long.
The <code>cancel()</code> method notifies the resource processor that it
should interrupt the processing of the current resource. This method is
called by the <code>DeploymentAdmin</code> implementation after the
<code>DeploymentAdmin.cancel()</code> method is called.</div>
</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/DeploymentSession.html" title="interface in org.osgi.service.deploymentadmin.spi"><span class="typeNameLink">Prev Class</span></a></li>
<li><a href="../../../../../org/osgi/service/deploymentadmin/spi/ResourceProcessorException.html" title="class 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/ResourceProcessor.html" target="_top">Frames</a></li>
<li><a href="ResourceProcessor.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>
|