/usr/share/doc/libosgi-compendium-java/api/org/osgi/service/event/TopicPermission.html is in libosgi-compendium-java-doc 5.0.0-3.
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 482 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<title>TopicPermission</title>
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="TopicPermission";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!-- -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><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/event/EventProperties.html" title="class in org.osgi.service.event"><span class="strong">Prev Class</span></a></li>
<li>Next Class</li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/osgi/service/event/TopicPermission.html" target="_top">Frames</a></li>
<li><a href="TopicPermission.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><a href="#constructor_summary">Constr</a> | </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><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.event</div>
<h2 title="Class TopicPermission" class="title">Class TopicPermission</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>java.security.Permission</li>
<li>
<ul class="inheritance">
<li>org.osgi.service.event.TopicPermission</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd>java.io.Serializable, java.security.Guard</dd>
</dl>
<hr>
<br>
<pre>public final class <span class="strong">TopicPermission</span>
extends java.security.Permission</pre>
<div class="block">A bundle's authority to publish or subscribe to event on a topic.
<p>
A topic is a slash-separated string that defines a topic.
<p>
For example:
<pre>
org/osgi/service/foo/FooEvent/ACTION
</pre>
<p>
<code>TopicPermission</code> has two actions: <code>publish</code> and
<code>subscribe</code>.</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../serialized-form.html#org.osgi.service.event.TopicPermission">Serialized Form</a></dd></dl>
</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="overviewSummary" 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><strong><a href="../../../../org/osgi/service/event/TopicPermission.html#PUBLISH">PUBLISH</a></strong></code>
<div class="block">The action string <code>publish</code>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../../org/osgi/service/event/TopicPermission.html#SUBSCRIBE">SUBSCRIBE</a></strong></code>
<div class="block">The action string <code>subscribe</code>.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="overviewSummary" 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><strong><a href="../../../../org/osgi/service/event/TopicPermission.html#TopicPermission(java.lang.String,%20java.lang.String)">TopicPermission</a></strong>(java.lang.String name,
java.lang.String actions)</code>
<div class="block">Defines the authority to publich and/or subscribe to a topic within the
EventAdmin service.</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="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../org/osgi/service/event/TopicPermission.html#equals(java.lang.Object)">equals</a></strong>(java.lang.Object obj)</code>
<div class="block">Determines the equality of two <code>TopicPermission</code> objects.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../../org/osgi/service/event/TopicPermission.html#getActions()">getActions</a></strong>()</code>
<div class="block">Returns the canonical string representation of the
<code>TopicPermission</code> actions.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../org/osgi/service/event/TopicPermission.html#hashCode()">hashCode</a></strong>()</code>
<div class="block">Returns the hash code value for this object.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../org/osgi/service/event/TopicPermission.html#implies(java.security.Permission)">implies</a></strong>(java.security.Permission p)</code>
<div class="block">Determines if the specified permission is implied by this object.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.security.PermissionCollection</code></td>
<td class="colLast"><code><strong><a href="../../../../org/osgi/service/event/TopicPermission.html#newPermissionCollection()">newPermissionCollection</a></strong>()</code>
<div class="block">Returns a new <code>PermissionCollection</code> object suitable for storing
<code>TopicPermission</code> objects.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_java.security.Permission">
<!-- -->
</a>
<h3>Methods inherited from class java.security.Permission</h3>
<code>checkGuard, getName, toString</code></li>
</ul>
<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, finalize, getClass, notify, notifyAll, wait, wait, wait</code></li>
</ul>
</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="PUBLISH">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>PUBLISH</h4>
<pre>public static final java.lang.String PUBLISH</pre>
<div class="block">The action string <code>publish</code>.</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#org.osgi.service.event.TopicPermission.PUBLISH">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="SUBSCRIBE">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>SUBSCRIBE</h4>
<pre>public static final java.lang.String SUBSCRIBE</pre>
<div class="block">The action string <code>subscribe</code>.</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#org.osgi.service.event.TopicPermission.SUBSCRIBE">Constant Field Values</a></dd></dl>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="TopicPermission(java.lang.String, java.lang.String)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>TopicPermission</h4>
<pre>public TopicPermission(java.lang.String name,
java.lang.String actions)</pre>
<div class="block">Defines the authority to publich and/or subscribe to a topic within the
EventAdmin service.
<p>
The name is specified as a slash-separated string. Wildcards may be used.
For example:
<pre>
org/osgi/service/fooFooEvent/ACTION
com/isv/*
*
</pre>
<p>
A bundle that needs to publish events on a topic must have the
appropriate <code>TopicPermission</code> for that topic; similarly, a bundle
that needs to subscribe to events on a topic must have the appropriate
<code>TopicPermssion</code> for that topic.
<p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - Topic name.</dd><dd><code>actions</code> - <code>publish</code>,<code>subscribe</code> (canonical order).</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="implies(java.security.Permission)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>implies</h4>
<pre>public boolean implies(java.security.Permission p)</pre>
<div class="block">Determines if the specified permission is implied by this object.
<p>
This method checks that the topic name of the target is implied by the
topic name of this object. The list of <code>TopicPermission</code> actions
must either match or allow for the list of the target object to imply the
target <code>TopicPermission</code> action.
<pre>
x/y/*,"publish" -> x/y/z,"publish" is true
*,"subscribe" -> x/y,"subscribe" is true
*,"publish" -> x/y,"subscribe" is false
x/y,"publish" -> x/y/z,"publish" is false
</pre></div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code>implies</code> in class <code>java.security.Permission</code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>p</code> - The target permission to interrogate.</dd>
<dt><span class="strong">Returns:</span></dt><dd><code>true</code> if the specified <code>TopicPermission</code> action is
implied by this object; <code>false</code> otherwise.</dd></dl>
</li>
</ul>
<a name="getActions()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getActions</h4>
<pre>public java.lang.String getActions()</pre>
<div class="block">Returns the canonical string representation of the
<code>TopicPermission</code> actions.
<p>
Always returns present <code>TopicPermission</code> actions in the following
order: <code>publish</code>,<code>subscribe</code>.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code>getActions</code> in class <code>java.security.Permission</code></dd>
<dt><span class="strong">Returns:</span></dt><dd>Canonical string representation of the <code>TopicPermission</code>
actions.</dd></dl>
</li>
</ul>
<a name="newPermissionCollection()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>newPermissionCollection</h4>
<pre>public java.security.PermissionCollection newPermissionCollection()</pre>
<div class="block">Returns a new <code>PermissionCollection</code> object suitable for storing
<code>TopicPermission</code> objects.</div>
<dl>
<dt><strong>Overrides:</strong></dt>
<dd><code>newPermissionCollection</code> in class <code>java.security.Permission</code></dd>
<dt><span class="strong">Returns:</span></dt><dd>A new <code>PermissionCollection</code> object.</dd></dl>
</li>
</ul>
<a name="equals(java.lang.Object)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>equals</h4>
<pre>public boolean equals(java.lang.Object obj)</pre>
<div class="block">Determines the equality of two <code>TopicPermission</code> objects.
This method checks that specified <code>TopicPermission</code> has the same
topic name and actions as this <code>TopicPermission</code> object.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code>equals</code> in class <code>java.security.Permission</code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>obj</code> - The object to test for equality with this
<code>TopicPermission</code> object.</dd>
<dt><span class="strong">Returns:</span></dt><dd><code>true</code> if <code>obj</code> is a <code>TopicPermission</code>, and has
the same topic name and actions as this <code>TopicPermission</code>
object; <code>false</code> otherwise.</dd></dl>
</li>
</ul>
<a name="hashCode()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>hashCode</h4>
<pre>public int hashCode()</pre>
<div class="block">Returns the hash code value for this object.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code>hashCode</code> in class <code>java.security.Permission</code></dd>
<dt><span class="strong">Returns:</span></dt><dd>A hash code value for this object.</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><a href="#skip-navbar_bottom" title="Skip navigation links"></a><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/event/EventProperties.html" title="class in org.osgi.service.event"><span class="strong">Prev Class</span></a></li>
<li>Next Class</li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/osgi/service/event/TopicPermission.html" target="_top">Frames</a></li>
<li><a href="TopicPermission.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><a href="#constructor_summary">Constr</a> | </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><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>
|