/usr/share/doc/libosgi-compendium-java/api/org/osgi/service/resolver/ResolveContext.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 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 | <!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>ResolveContext</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="ResolveContext";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":10,"i2":10,"i3":6,"i4":6,"i5":6};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],8:["t4","Concrete 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/resolver/ResolutionException.html" title="class in org.osgi.service.resolver"><span class="typeNameLink">Prev Class</span></a></li>
<li><a href="../../../../org/osgi/service/resolver/Resolver.html" title="interface in org.osgi.service.resolver"><span class="typeNameLink">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/osgi/service/resolver/ResolveContext.html" target="_top">Frames</a></li>
<li><a href="ResolveContext.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><a href="#constructor.summary">Constr</a> | </li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li><a href="#constructor.detail">Constr</a> | </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.resolver</div>
<h2 title="Class ResolveContext" class="title">Class ResolveContext</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.osgi.service.resolver.ResolveContext</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public abstract class <span class="typeNameLabel">ResolveContext</span>
extends java.lang.Object</pre>
<div class="block">A resolve context provides resources, options and constraints to the
potential solution of a <a href="../../../../org/osgi/service/resolver/Resolver.html#resolve-org.osgi.service.resolver.ResolveContext-"><code>resolve</code></a>
operation.
<p>
Resolve Contexts:
<ul>
<li>Specify the mandatory and optional resources to resolve. The mandatory
and optional resources must be consistent and correct. For example, they must
not violate the singleton policy of the implementer.</li>
<li>Provide <code>capabilities</code> that the Resolver can use to
satisfy <code>requirements</code> via the
<a href="../../../../org/osgi/service/resolver/ResolveContext.html#findProviders-org.osgi.resource.Requirement-"><code>findProviders(Requirement)</code></a> method</li>
<li>Constrain solutions via the <a href="../../../../org/osgi/service/resolver/ResolveContext.html#getWirings--"><code>getWirings()</code></a> method. A wiring
consists of a map of existing <code>resources</code> to <code>wiring</code>.</li>
<li>Filter requirements that are part of a resolve operation via the
<a href="../../../../org/osgi/service/resolver/ResolveContext.html#isEffective-org.osgi.resource.Requirement-"><code>isEffective(Requirement)</code></a>.</li>
</ul>
<p>
A resolver may call the methods on the resolve context any number of times
during a resolve operation using any thread. Implementors should ensure that
this class is properly thread safe.
<p>
Except for <a href="../../../../org/osgi/service/resolver/ResolveContext.html#insertHostedCapability-java.util.List-org.osgi.service.resolver.HostedCapability-"><code>insertHostedCapability(List, HostedCapability)</code></a>, the
resolve context methods must be <i>idempotent</i>. This means that resources
must have constant capabilities and requirements and the resolve context must
return a consistent set of capabilities, wires and effective requirements.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/osgi/service/resolver/ResolveContext.html#ResolveContext--">ResolveContext</a></span>()</code> </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><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete 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>abstract java.util.List<org.osgi.resource.Capability></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/osgi/service/resolver/ResolveContext.html#findProviders-org.osgi.resource.Requirement-">findProviders</a></span>(org.osgi.resource.Requirement requirement)</code>
<div class="block">Find Capabilities that match the given Requirement.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>java.util.Collection<org.osgi.resource.Resource></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/osgi/service/resolver/ResolveContext.html#getMandatoryResources--">getMandatoryResources</a></span>()</code>
<div class="block">Return the resources that must be resolved for this resolve context.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>java.util.Collection<org.osgi.resource.Resource></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/osgi/service/resolver/ResolveContext.html#getOptionalResources--">getOptionalResources</a></span>()</code>
<div class="block">Return the resources that the resolver should attempt to resolve for this
resolve context.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>abstract java.util.Map<org.osgi.resource.Resource,org.osgi.resource.Wiring></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/osgi/service/resolver/ResolveContext.html#getWirings--">getWirings</a></span>()</code>
<div class="block">Returns the wirings for existing resolved resources.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>abstract int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/osgi/service/resolver/ResolveContext.html#insertHostedCapability-java.util.List-org.osgi.service.resolver.HostedCapability-">insertHostedCapability</a></span>(java.util.List<org.osgi.resource.Capability> capabilities,
<a href="../../../../org/osgi/service/resolver/HostedCapability.html" title="interface in org.osgi.service.resolver">HostedCapability</a> hostedCapability)</code>
<div class="block">Add a <a href="../../../../org/osgi/service/resolver/HostedCapability.html" title="interface in org.osgi.service.resolver"><code>HostedCapability</code></a> to the list of capabilities returned from
<a href="../../../../org/osgi/service/resolver/ResolveContext.html#findProviders-org.osgi.resource.Requirement-"><code>findProviders(Requirement)</code></a>.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>abstract boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/osgi/service/resolver/ResolveContext.html#isEffective-org.osgi.resource.Requirement-">isEffective</a></span>(org.osgi.resource.Requirement requirement)</code>
<div class="block">Test if a given requirement should be wired in the resolve operation.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="ResolveContext--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>ResolveContext</h4>
<pre>public ResolveContext()</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getMandatoryResources--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMandatoryResources</h4>
<pre>public java.util.Collection<org.osgi.resource.Resource> getMandatoryResources()</pre>
<div class="block">Return the resources that must be resolved for this resolve context.
<p>
The default implementation returns an empty collection.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The resources that must be resolved for this resolve context. May
be empty if there are no mandatory resources.</dd>
</dl>
</li>
</ul>
<a name="getOptionalResources--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getOptionalResources</h4>
<pre>public java.util.Collection<org.osgi.resource.Resource> getOptionalResources()</pre>
<div class="block">Return the resources that the resolver should attempt to resolve for this
resolve context. Inability to resolve one of the specified resources will
not result in a resolution exception.
<p>
The default implementation returns an empty collection.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The resources that the resolver should attempt to resolve for
this resolve context. May be empty if there are no mandatory
resources.</dd>
</dl>
</li>
</ul>
<a name="findProviders-org.osgi.resource.Requirement-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>findProviders</h4>
<pre>public abstract java.util.List<org.osgi.resource.Capability> findProviders(org.osgi.resource.Requirement requirement)</pre>
<div class="block">Find Capabilities that match the given Requirement.
<p>
The returned list contains <code>Capability</code> objects where the Resource
must be the declared Resource of the Capability. The Resolver can then
add additional <a href="../../../../org/osgi/service/resolver/HostedCapability.html" title="interface in org.osgi.service.resolver"><code>HostedCapability</code></a> objects with the
<a href="../../../../org/osgi/service/resolver/ResolveContext.html#insertHostedCapability-java.util.List-org.osgi.service.resolver.HostedCapability-"><code>insertHostedCapability(List, HostedCapability)</code></a> method when it,
for example, attaches fragments. Those <a href="../../../../org/osgi/service/resolver/HostedCapability.html" title="interface in org.osgi.service.resolver"><code>HostedCapability</code></a> objects
will then use the host's Resource which likely differs from the declared
Resource of the corresponding Capability.
<p>
The returned list is in priority order such that the Capabilities with a
lower index have a preference over those with a higher index. The
resolver must use the
<a href="../../../../org/osgi/service/resolver/ResolveContext.html#insertHostedCapability-java.util.List-org.osgi.service.resolver.HostedCapability-"><code>insertHostedCapability(List, HostedCapability)</code></a> method to add
additional Capabilities to maintain priority order. In general, this is
necessary when the Resolver uses Capabilities declared in a Resource but
that must originate from an attached host.
<p>
Each returned Capability must match the given Requirement. This implies
that the filter in the Requirement must match as well as any namespace
specific directives. For example, the mandatory attributes for the
<code>osgi.wiring.package</code> namespace.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>requirement</code> - The requirement that a resolver is attempting to
satisfy. Must not be <code>null</code>.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>A list of <code>Capability</code> objects that match the specified
requirement.</dd>
</dl>
</li>
</ul>
<a name="insertHostedCapability-java.util.List-org.osgi.service.resolver.HostedCapability-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>insertHostedCapability</h4>
<pre>public abstract int insertHostedCapability(java.util.List<org.osgi.resource.Capability> capabilities,
<a href="../../../../org/osgi/service/resolver/HostedCapability.html" title="interface in org.osgi.service.resolver">HostedCapability</a> hostedCapability)</pre>
<div class="block">Add a <a href="../../../../org/osgi/service/resolver/HostedCapability.html" title="interface in org.osgi.service.resolver"><code>HostedCapability</code></a> to the list of capabilities returned from
<a href="../../../../org/osgi/service/resolver/ResolveContext.html#findProviders-org.osgi.resource.Requirement-"><code>findProviders(Requirement)</code></a>.
<p>
This method is used by the <a href="../../../../org/osgi/service/resolver/Resolver.html" title="interface in org.osgi.service.resolver"><code>Resolver</code></a> to add Capabilities that are
hosted by another Resource to the list of Capabilities returned from
<a href="../../../../org/osgi/service/resolver/ResolveContext.html#findProviders-org.osgi.resource.Requirement-"><code>findProviders(Requirement)</code></a>. This function is necessary to allow
fragments to attach to hosts, thereby changing the origin of a
Capability. This method must insert the specified HostedCapability in a
place that makes the list maintain the preference order. It must return
the index in the list of the inserted <a href="../../../../org/osgi/service/resolver/HostedCapability.html" title="interface in org.osgi.service.resolver"><code>HostedCapability</code></a>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>capabilities</code> - The list returned from
<a href="../../../../org/osgi/service/resolver/ResolveContext.html#findProviders-org.osgi.resource.Requirement-"><code>findProviders(Requirement)</code></a>. Must not be <code>null</code>.</dd>
<dd><code>hostedCapability</code> - The HostedCapability to insert in the specified
list. Must not be <code>null</code>.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The index in the list of the inserted HostedCapability.</dd>
</dl>
</li>
</ul>
<a name="isEffective-org.osgi.resource.Requirement-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isEffective</h4>
<pre>public abstract boolean isEffective(org.osgi.resource.Requirement requirement)</pre>
<div class="block">Test if a given requirement should be wired in the resolve operation. If
this method returns <code>false</code>, then the resolver should ignore this
requirement during the resolve operation.
<p>
The primary use case for this is to test the <code>effective</code> directive
on the requirement, though implementations are free to use any effective
test.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>requirement</code> - The Requirement to test. Must not be <code>null</code>.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><code>true</code> if the requirement should be considered as part of
the resolve operation.</dd>
</dl>
</li>
</ul>
<a name="getWirings--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getWirings</h4>
<pre>public abstract java.util.Map<org.osgi.resource.Resource,org.osgi.resource.Wiring> getWirings()</pre>
<div class="block">Returns the wirings for existing resolved resources.
<p>
For example, if this resolve context is for an OSGi framework, then the
result would contain all the currently resolved bundles with each
bundle's current wiring.
<p>
Multiple calls to this method for this resolve context must return the
same result.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The wirings for existing resolved resources. The returned map is
unmodifiable.</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/resolver/ResolutionException.html" title="class in org.osgi.service.resolver"><span class="typeNameLink">Prev Class</span></a></li>
<li><a href="../../../../org/osgi/service/resolver/Resolver.html" title="interface in org.osgi.service.resolver"><span class="typeNameLink">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/osgi/service/resolver/ResolveContext.html" target="_top">Frames</a></li>
<li><a href="ResolveContext.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><a href="#constructor.summary">Constr</a> | </li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li><a href="#constructor.detail">Constr</a> | </li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>
|