/usr/share/doc/libosgi-compendium-java/api/org/osgi/service/dmt/Acl.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 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<title>Acl</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="Acl";
}
//-->
</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>Prev Class</li>
<li><a href="../../../../org/osgi/service/dmt/DmtAdmin.html" title="interface in org.osgi.service.dmt"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/osgi/service/dmt/Acl.html" target="_top">Frames</a></li>
<li><a href="Acl.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.dmt</div>
<h2 title="Class Acl" class="title">Class Acl</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.osgi.service.dmt.Acl</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public final class <span class="strong">Acl</span>
extends java.lang.Object</pre>
<div class="block"><code>Acl</code> is an immutable class representing structured access to DMT ACLs.
Under OMA DM the ACLs are defined as strings with an internal syntax.
<p>
The methods of this class taking a principal as parameter accept remote
server IDs (as passed to <a href="../../../../org/osgi/service/dmt/DmtAdmin.html#getSession(java.lang.String,%20java.lang.String,%20int)"><code>DmtAdmin.getSession</code></a>), as well as " <code>*</code> " indicating any
principal.
<p>
The syntax for valid remote server IDs:
<p>
<<i>server-identifier</i>> ::= All printable characters except
<code>'='</code>, <code>'&'</code>, <code>'*'</code>, <code>'+'</code> or white-space characters.</div>
</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 int</code></td>
<td class="colLast"><code><strong><a href="../../../../org/osgi/service/dmt/Acl.html#ADD">ADD</a></strong></code>
<div class="block">Principals holding this permission can issue ADD commands on the node
having this ACL.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><strong><a href="../../../../org/osgi/service/dmt/Acl.html#ALL_PERMISSION">ALL_PERMISSION</a></strong></code>
<div class="block">Principals holding this permission can issue any command on the node
having this ACL.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><strong><a href="../../../../org/osgi/service/dmt/Acl.html#DELETE">DELETE</a></strong></code>
<div class="block">Principals holding this permission can issue DELETE commands on the node
having this ACL.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><strong><a href="../../../../org/osgi/service/dmt/Acl.html#EXEC">EXEC</a></strong></code>
<div class="block">Principals holding this permission can issue EXEC commands on the node
having this ACL.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><strong><a href="../../../../org/osgi/service/dmt/Acl.html#GET">GET</a></strong></code>
<div class="block">Principals holding this permission can issue GET command on the node
having this ACL.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><strong><a href="../../../../org/osgi/service/dmt/Acl.html#REPLACE">REPLACE</a></strong></code>
<div class="block">Principals holding this permission can issue REPLACE commands on the node
having this ACL.</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/dmt/Acl.html#Acl(java.lang.String)">Acl</a></strong>(java.lang.String acl)</code>
<div class="block">Create an instance of the ACL from its canonical string representation.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><strong><a href="../../../../org/osgi/service/dmt/Acl.html#Acl(java.lang.String[],%20int[])">Acl</a></strong>(java.lang.String[] principals,
int[] permissions)</code>
<div class="block">Creates an instance with a specified list of principals and the
permissions they hold.</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><a href="../../../../org/osgi/service/dmt/Acl.html" title="class in org.osgi.service.dmt">Acl</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/osgi/service/dmt/Acl.html#addPermission(java.lang.String,%20int)">addPermission</a></strong>(java.lang.String principal,
int permissions)</code>
<div class="block">Create a new <code>Acl</code> instance from this <code>Acl</code> with the given
permission added for the given principal.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../org/osgi/service/dmt/Acl.html" title="class in org.osgi.service.dmt">Acl</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/osgi/service/dmt/Acl.html#deletePermission(java.lang.String,%20int)">deletePermission</a></strong>(java.lang.String principal,
int permissions)</code>
<div class="block">Create a new <code>Acl</code> instance from this <code>Acl</code> with the given
permission revoked from the given principal.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../org/osgi/service/dmt/Acl.html#equals(java.lang.Object)">equals</a></strong>(java.lang.Object obj)</code>
<div class="block">Checks whether the given object is equal to this <code>Acl</code> instance.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../org/osgi/service/dmt/Acl.html#getPermissions(java.lang.String)">getPermissions</a></strong>(java.lang.String principal)</code>
<div class="block">Get the permissions associated to a given principal.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.lang.String[]</code></td>
<td class="colLast"><code><strong><a href="../../../../org/osgi/service/dmt/Acl.html#getPrincipals()">getPrincipals</a></strong>()</code>
<div class="block">Get the list of principals who have any kind of permissions on this node.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../org/osgi/service/dmt/Acl.html#hashCode()">hashCode</a></strong>()</code>
<div class="block">Returns the hash code for this ACL instance.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../org/osgi/service/dmt/Acl.html#isPermitted(java.lang.String,%20int)">isPermitted</a></strong>(java.lang.String principal,
int permissions)</code>
<div class="block">Check whether the given permissions are granted to a certain principal.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../org/osgi/service/dmt/Acl.html" title="class in org.osgi.service.dmt">Acl</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/osgi/service/dmt/Acl.html#setPermission(java.lang.String,%20int)">setPermission</a></strong>(java.lang.String principal,
int permissions)</code>
<div class="block">Create a new <code>Acl</code> instance from this <code>Acl</code> where all
permissions for the given principal are overwritten with the given
permissions.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../../org/osgi/service/dmt/Acl.html#toString()">toString</a></strong>()</code>
<div class="block">Give the canonical string representation of this ACL.</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, 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="GET">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>GET</h4>
<pre>public static final int GET</pre>
<div class="block">Principals holding this permission can issue GET command on the node
having this ACL.</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#org.osgi.service.dmt.Acl.GET">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="ADD">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>ADD</h4>
<pre>public static final int ADD</pre>
<div class="block">Principals holding this permission can issue ADD commands on the node
having this ACL.</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#org.osgi.service.dmt.Acl.ADD">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="REPLACE">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>REPLACE</h4>
<pre>public static final int REPLACE</pre>
<div class="block">Principals holding this permission can issue REPLACE commands on the node
having this ACL.</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#org.osgi.service.dmt.Acl.REPLACE">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="DELETE">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>DELETE</h4>
<pre>public static final int DELETE</pre>
<div class="block">Principals holding this permission can issue DELETE commands on the node
having this ACL.</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#org.osgi.service.dmt.Acl.DELETE">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="EXEC">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>EXEC</h4>
<pre>public static final int EXEC</pre>
<div class="block">Principals holding this permission can issue EXEC commands on the node
having this ACL.</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#org.osgi.service.dmt.Acl.EXEC">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="ALL_PERMISSION">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>ALL_PERMISSION</h4>
<pre>public static final int ALL_PERMISSION</pre>
<div class="block">Principals holding this permission can issue any command on the node
having this ACL. This permission is the logical OR of <a href="../../../../org/osgi/service/dmt/Acl.html#ADD"><code>ADD</code></a>,
<a href="../../../../org/osgi/service/dmt/Acl.html#DELETE"><code>DELETE</code></a>, <a href="../../../../org/osgi/service/dmt/Acl.html#EXEC"><code>EXEC</code></a>, <a href="../../../../org/osgi/service/dmt/Acl.html#GET"><code>GET</code></a> and <a href="../../../../org/osgi/service/dmt/Acl.html#REPLACE"><code>REPLACE</code></a>
permissions.</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#org.osgi.service.dmt.Acl.ALL_PERMISSION">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="Acl(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Acl</h4>
<pre>public Acl(java.lang.String acl)</pre>
<div class="block">Create an instance of the ACL from its canonical string representation.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>acl</code> - The string representation of the ACL as defined in OMA DM. If
<code>null</code> or empty then it represents an empty list of
principals with no permissions.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.IllegalArgumentException</code> - if acl is not a valid OMA DM ACL string</dd></dl>
</li>
</ul>
<a name="Acl(java.lang.String[], int[])">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>Acl</h4>
<pre>public Acl(java.lang.String[] principals,
int[] permissions)</pre>
<div class="block">Creates an instance with a specified list of principals and the
permissions they hold. The two arrays run in parallel, that is
<code>principals[i]</code> will hold <code>permissions[i]</code> in the ACL.
<p>
A principal name may not appear multiple times in the 'principals'
argument. If the "*" principal appears in the array, the
corresponding permissions will be granted to all principals (regardless
of whether they appear in the array or not).</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>principals</code> - The array of principals</dd><dd><code>permissions</code> - The array of permissions</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.IllegalArgumentException</code> - if the length of the two arrays are not
the same, if any array element is invalid, or if a principal
appears multiple times in the <code>principals</code> array</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="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">Checks whether the given object is equal to this <code>Acl</code> instance.
Two <code>Acl</code> instances are equal if they allow the same set of
permissions for the same set of principals.</div>
<dl>
<dt><strong>Overrides:</strong></dt>
<dd><code>equals</code> in class <code>java.lang.Object</code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>obj</code> - the object to compare with this <code>Acl</code> instance</dd>
<dt><span class="strong">Returns:</span></dt><dd><code>true</code> if the parameter represents the same ACL as this
instance</dd></dl>
</li>
</ul>
<a name="hashCode()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>hashCode</h4>
<pre>public int hashCode()</pre>
<div class="block">Returns the hash code for this ACL instance. If two <code>Acl</code> instances
are equal according to the <a href="../../../../org/osgi/service/dmt/Acl.html#equals(java.lang.Object)"><code>equals(Object)</code></a> method, then calling
this method on each of them must produce the same integer result.</div>
<dl>
<dt><strong>Overrides:</strong></dt>
<dd><code>hashCode</code> in class <code>java.lang.Object</code></dd>
<dt><span class="strong">Returns:</span></dt><dd>hash code for this ACL</dd></dl>
</li>
</ul>
<a name="addPermission(java.lang.String, int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addPermission</h4>
<pre>public <a href="../../../../org/osgi/service/dmt/Acl.html" title="class in org.osgi.service.dmt">Acl</a> addPermission(java.lang.String principal,
int permissions)</pre>
<div class="block">Create a new <code>Acl</code> instance from this <code>Acl</code> with the given
permission added for the given principal. The already existing
permissions of the principal are not affected.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>principal</code> - The entity to which permissions should be granted, or
"*" to grant permissions to all principals.</dd><dd><code>permissions</code> - The permissions to be given. The parameter can be a
logical <code>or</code> of more permission constants defined in this
class.</dd>
<dt><span class="strong">Returns:</span></dt><dd>a new <code>Acl</code> instance</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.IllegalArgumentException</code> - if <code>principal</code> is not a valid
principal name or if <code>permissions</code> is not a valid
combination of the permission constants defined in this class</dd></dl>
</li>
</ul>
<a name="deletePermission(java.lang.String, int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>deletePermission</h4>
<pre>public <a href="../../../../org/osgi/service/dmt/Acl.html" title="class in org.osgi.service.dmt">Acl</a> deletePermission(java.lang.String principal,
int permissions)</pre>
<div class="block">Create a new <code>Acl</code> instance from this <code>Acl</code> with the given
permission revoked from the given principal. Other permissions of the
principal are not affected.
<p>
Note, that it is not valid to revoke a permission from a specific
principal if that permission is granted globally to all principals.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>principal</code> - The entity from which permissions should be revoked, or
"*" to revoke permissions from all principals.</dd><dd><code>permissions</code> - The permissions to be revoked. The parameter can be a
logical <code>or</code> of more permission constants defined in this
class.</dd>
<dt><span class="strong">Returns:</span></dt><dd>a new <code>Acl</code> instance</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.IllegalArgumentException</code> - if <code>principal</code> is not a valid
principal name, if <code>permissions</code> is not a valid combination
of the permission constants defined in this class, or if a
globally granted permission would have been revoked from a
specific principal</dd></dl>
</li>
</ul>
<a name="getPermissions(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPermissions</h4>
<pre>public int getPermissions(java.lang.String principal)</pre>
<div class="block">Get the permissions associated to a given principal.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>principal</code> - The entity whose permissions to query, or "*"
to query the permissions that are granted globally, to all
principals</dd>
<dt><span class="strong">Returns:</span></dt><dd>The permissions of the given principal. The returned <code>int</code>
is a bitmask of the permission constants defined in this class</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.IllegalArgumentException</code> - if <code>principal</code> is not a valid
principal name</dd></dl>
</li>
</ul>
<a name="isPermitted(java.lang.String, int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isPermitted</h4>
<pre>public boolean isPermitted(java.lang.String principal,
int permissions)</pre>
<div class="block">Check whether the given permissions are granted to a certain principal.
The requested permissions are specified as a bitfield, for example
<code>(Acl.ADD | Acl.DELETE | Acl.GET)</code>.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>principal</code> - The entity to check, or "*" to check whether
the given permissions are granted to all principals globally</dd><dd><code>permissions</code> - The permissions to check</dd>
<dt><span class="strong">Returns:</span></dt><dd><code>true</code> if the principal holds all the given permissions</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.IllegalArgumentException</code> - if <code>principal</code> is not a valid
principal name or if <code>permissions</code> is not a valid
combination of the permission constants defined in this class</dd></dl>
</li>
</ul>
<a name="setPermission(java.lang.String, int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setPermission</h4>
<pre>public <a href="../../../../org/osgi/service/dmt/Acl.html" title="class in org.osgi.service.dmt">Acl</a> setPermission(java.lang.String principal,
int permissions)</pre>
<div class="block">Create a new <code>Acl</code> instance from this <code>Acl</code> where all
permissions for the given principal are overwritten with the given
permissions.
<p>
Note, that when changing the permissions of a specific principal, it is
not allowed to specify a set of permissions stricter than the global set
of permissions (that apply to all principals).</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>principal</code> - The entity to which permissions should be granted, or
"*" to globally grant permissions to all principals.</dd><dd><code>permissions</code> - The set of permissions to be given. The parameter is a
bitmask of the permission constants defined in this class.</dd>
<dt><span class="strong">Returns:</span></dt><dd>a new <code>Acl</code> instance</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.IllegalArgumentException</code> - if <code>principal</code> is not a valid
principal name, if <code>permissions</code> is not a valid combination
of the permission constants defined in this class, or if a
globally granted permission would have been revoked from a
specific principal</dd></dl>
</li>
</ul>
<a name="getPrincipals()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPrincipals</h4>
<pre>public java.lang.String[] getPrincipals()</pre>
<div class="block">Get the list of principals who have any kind of permissions on this node.
The list only includes those principals that have been explicitly
assigned permissions (so "*" is never returned), globally set
permissions naturally apply to all other principals as well.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>The array of principals having permissions on this node.</dd></dl>
</li>
</ul>
<a name="toString()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>toString</h4>
<pre>public java.lang.String toString()</pre>
<div class="block">Give the canonical string representation of this ACL. The operations are
in the following order: {Add, Delete, Exec, Get, Replace}, principal
names are sorted alphabetically.</div>
<dl>
<dt><strong>Overrides:</strong></dt>
<dd><code>toString</code> in class <code>java.lang.Object</code></dd>
<dt><span class="strong">Returns:</span></dt><dd>The string representation as defined in OMA DM.</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>Prev Class</li>
<li><a href="../../../../org/osgi/service/dmt/DmtAdmin.html" title="interface in org.osgi.service.dmt"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/osgi/service/dmt/Acl.html" target="_top">Frames</a></li>
<li><a href="Acl.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>
|