/usr/share/doc/libosgi-compendium-java/api/org/osgi/service/useradmin/Group.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 | <!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>Group</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="Group";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":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/useradmin/Authorization.html" title="interface in org.osgi.service.useradmin"><span class="typeNameLink">Prev Class</span></a></li>
<li><a href="../../../../org/osgi/service/useradmin/Role.html" title="interface in org.osgi.service.useradmin"><span class="typeNameLink">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/osgi/service/useradmin/Group.html" target="_top">Frames</a></li>
<li><a href="Group.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.useradmin</div>
<h2 title="Interface Group" class="title">Interface Group</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Superinterfaces:</dt>
<dd><a href="../../../../org/osgi/service/useradmin/Role.html" title="interface in org.osgi.service.useradmin">Role</a>, <a href="../../../../org/osgi/service/useradmin/User.html" title="interface in org.osgi.service.useradmin">User</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="typeNameLabel">Group</span>
extends <a href="../../../../org/osgi/service/useradmin/User.html" title="interface in org.osgi.service.useradmin">User</a></pre>
<div class="block">A named grouping of roles (<code>Role</code> objects).
<p>
Whether or not a given <code>Authorization</code> context implies a <code>Group</code>
object depends on the members of that <code>Group</code> object.
<p>
A <code>Group</code> object can have two kinds of members: <i>basic </i> and
<i>required </i>. A <code>Group</code> object is implied by an
<code>Authorization</code> context if all of its required members are implied and
at least one of its basic members is implied.
<p>
A <code>Group</code> object must contain at least one basic member in order to be
implied. In other words, a <code>Group</code> object without any basic member
roles is never implied by any <code>Authorization</code> context.
<p>
A <code>User</code> object always implies itself.
<p>
No loop detection is performed when adding members to <code>Group</code> objects,
which means that it is possible to create circular implications. Loop
detection is instead done when roles are checked. The semantics is that if a
role depends on itself (i.e., there is an implication loop), the role is not
implied.
<p>
The rule that a <code>Group</code> object must have at least one basic member to
be implied is motivated by the following example:
<pre>
group foo
required members: marketing
basic members: alice, bob
</pre>
Privileged operations that require membership in "foo" can be performed only
by "alice" and "bob", who are in marketing.
<p>
If "alice" and "bob" ever transfer to a different department, anybody in
marketing will be able to assume the "foo" role, which certainly must be
prevented. Requiring that "foo" (or any <code>Group</code> object for that matter)
must have at least one basic member accomplishes that.
<p>
However, this would make it impossible for a <code>Group</code> object to be
implied by just its required members. An example where this implication might
be useful is the following declaration: "Any citizen who is an adult is
allowed to vote." An intuitive configuration of "voter" would be:
<pre>
group voter
required members: citizen, adult
basic members:
</pre>
However, according to the above rule, the "voter" role could never be assumed
by anybody, since it lacks any basic members. In order to address this issue
a predefined role named "user.anyone" can be specified, which is always
implied. The desired implication of the "voter" group can then be achieved by
specifying "user.anyone" as its basic member, as follows:
<pre>
group voter
required members: citizen, adult
basic members: user.anyone
</pre></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>
<ul class="blockList">
<li class="blockList"><a name="fields.inherited.from.class.org.osgi.service.useradmin.Role">
<!-- -->
</a>
<h3>Fields inherited from interface org.osgi.service.useradmin.<a href="../../../../org/osgi/service/useradmin/Role.html" title="interface in org.osgi.service.useradmin">Role</a></h3>
<code><a href="../../../../org/osgi/service/useradmin/Role.html#GROUP">GROUP</a>, <a href="../../../../org/osgi/service/useradmin/Role.html#ROLE">ROLE</a>, <a href="../../../../org/osgi/service/useradmin/Role.html#USER">USER</a>, <a href="../../../../org/osgi/service/useradmin/Role.html#USER_ANYONE">USER_ANYONE</a></code></li>
</ul>
</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></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>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/osgi/service/useradmin/Group.html#addMember-org.osgi.service.useradmin.Role-">addMember</a></span>(<a href="../../../../org/osgi/service/useradmin/Role.html" title="interface in org.osgi.service.useradmin">Role</a> role)</code>
<div class="block">Adds the specified <code>Role</code> object as a basic member to this
<code>Group</code> object.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/osgi/service/useradmin/Group.html#addRequiredMember-org.osgi.service.useradmin.Role-">addRequiredMember</a></span>(<a href="../../../../org/osgi/service/useradmin/Role.html" title="interface in org.osgi.service.useradmin">Role</a> role)</code>
<div class="block">Adds the specified <code>Role</code> object as a required member to this
<code>Group</code> object.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="../../../../org/osgi/service/useradmin/Role.html" title="interface in org.osgi.service.useradmin">Role</a>[]</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/osgi/service/useradmin/Group.html#getMembers--">getMembers</a></span>()</code>
<div class="block">Gets the basic members of this <code>Group</code> object.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="../../../../org/osgi/service/useradmin/Role.html" title="interface in org.osgi.service.useradmin">Role</a>[]</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/osgi/service/useradmin/Group.html#getRequiredMembers--">getRequiredMembers</a></span>()</code>
<div class="block">Gets the required members of this <code>Group</code> object.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/osgi/service/useradmin/Group.html#removeMember-org.osgi.service.useradmin.Role-">removeMember</a></span>(<a href="../../../../org/osgi/service/useradmin/Role.html" title="interface in org.osgi.service.useradmin">Role</a> role)</code>
<div class="block">Removes the specified <code>Role</code> object from this <code>Group</code> object.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.osgi.service.useradmin.User">
<!-- -->
</a>
<h3>Methods inherited from interface org.osgi.service.useradmin.<a href="../../../../org/osgi/service/useradmin/User.html" title="interface in org.osgi.service.useradmin">User</a></h3>
<code><a href="../../../../org/osgi/service/useradmin/User.html#getCredentials--">getCredentials</a>, <a href="../../../../org/osgi/service/useradmin/User.html#hasCredential-java.lang.String-java.lang.Object-">hasCredential</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.osgi.service.useradmin.Role">
<!-- -->
</a>
<h3>Methods inherited from interface org.osgi.service.useradmin.<a href="../../../../org/osgi/service/useradmin/Role.html" title="interface in org.osgi.service.useradmin">Role</a></h3>
<code><a href="../../../../org/osgi/service/useradmin/Role.html#getName--">getName</a>, <a href="../../../../org/osgi/service/useradmin/Role.html#getProperties--">getProperties</a>, <a href="../../../../org/osgi/service/useradmin/Role.html#getType--">getType</a></code></li>
</ul>
</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="addMember-org.osgi.service.useradmin.Role-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addMember</h4>
<pre>boolean addMember(<a href="../../../../org/osgi/service/useradmin/Role.html" title="interface in org.osgi.service.useradmin">Role</a> role)</pre>
<div class="block">Adds the specified <code>Role</code> object as a basic member to this
<code>Group</code> object.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>role</code> - The role to add as a basic member.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><code>true</code> if the given role could be added as a basic member,
and <code>false</code> if this <code>Group</code> object already contains a
<code>Role</code> object whose name matches that of the specified
role.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.SecurityException</code> - If a security manager exists and the caller
does not have the <code>UserAdminPermission</code> with name
<code>admin</code>.</dd>
</dl>
</li>
</ul>
<a name="addRequiredMember-org.osgi.service.useradmin.Role-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addRequiredMember</h4>
<pre>boolean addRequiredMember(<a href="../../../../org/osgi/service/useradmin/Role.html" title="interface in org.osgi.service.useradmin">Role</a> role)</pre>
<div class="block">Adds the specified <code>Role</code> object as a required member to this
<code>Group</code> object.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>role</code> - The <code>Role</code> object to add as a required member.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><code>true</code> if the given <code>Role</code> object could be added as a
required member, and <code>false</code> if this <code>Group</code> object
already contains a <code>Role</code> object whose name matches that of
the specified role.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.SecurityException</code> - If a security manager exists and the caller
does not have the <code>UserAdminPermission</code> with name
<code>admin</code>.</dd>
</dl>
</li>
</ul>
<a name="removeMember-org.osgi.service.useradmin.Role-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>removeMember</h4>
<pre>boolean removeMember(<a href="../../../../org/osgi/service/useradmin/Role.html" title="interface in org.osgi.service.useradmin">Role</a> role)</pre>
<div class="block">Removes the specified <code>Role</code> object from this <code>Group</code> object.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>role</code> - The <code>Role</code> object to remove from this <code>Group</code>
object.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><code>true</code> if the <code>Role</code> object could be removed,
otherwise <code>false</code>.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.SecurityException</code> - If a security manager exists and the caller
does not have the <code>UserAdminPermission</code> with name
<code>admin</code>.</dd>
</dl>
</li>
</ul>
<a name="getMembers--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMembers</h4>
<pre><a href="../../../../org/osgi/service/useradmin/Role.html" title="interface in org.osgi.service.useradmin">Role</a>[] getMembers()</pre>
<div class="block">Gets the basic members of this <code>Group</code> object.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The basic members of this <code>Group</code> object, or <code>null</code>
if this <code>Group</code> object does not contain any basic members.</dd>
</dl>
</li>
</ul>
<a name="getRequiredMembers--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getRequiredMembers</h4>
<pre><a href="../../../../org/osgi/service/useradmin/Role.html" title="interface in org.osgi.service.useradmin">Role</a>[] getRequiredMembers()</pre>
<div class="block">Gets the required members of this <code>Group</code> object.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The required members of this <code>Group</code> object, or
<code>null</code> if this <code>Group</code> object does not contain any
required members.</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/useradmin/Authorization.html" title="interface in org.osgi.service.useradmin"><span class="typeNameLink">Prev Class</span></a></li>
<li><a href="../../../../org/osgi/service/useradmin/Role.html" title="interface in org.osgi.service.useradmin"><span class="typeNameLink">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/osgi/service/useradmin/Group.html" target="_top">Frames</a></li>
<li><a href="Group.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>
|