/usr/share/doc/libosgi-compendium-java/api/org/osgi/service/useradmin/UserAdmin.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 | <!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>UserAdmin</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="UserAdmin";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":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/User.html" title="interface in org.osgi.service.useradmin"><span class="typeNameLink">Prev Class</span></a></li>
<li><a href="../../../../org/osgi/service/useradmin/UserAdminEvent.html" title="class 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/UserAdmin.html" target="_top">Frames</a></li>
<li><a href="UserAdmin.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 UserAdmin" class="title">Interface UserAdmin</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public interface <span class="typeNameLabel">UserAdmin</span></pre>
<div class="block">This interface is used to manage a database of named <code>Role</code> objects,
which can be used for authentication and authorization purposes.
<p>
This version of the User Admin service defines two types of <code>Role</code>
objects: "User" and "Group". Each type of role is represented by an
<code>int</code> constant and an interface. The range of positive integers is
reserved for new types of roles that may be added in the future. When
defining proprietary role types, negative constant values must be used.
<p>
Every role has a name and a type.
<p>
A <a href="../../../../org/osgi/service/useradmin/User.html" title="interface in org.osgi.service.useradmin"><code>User</code></a> object can be configured with credentials (e.g., a password)
and properties (e.g., a street address, phone number, etc.).
<p>
A <a href="../../../../org/osgi/service/useradmin/Group.html" title="interface in org.osgi.service.useradmin"><code>Group</code></a> object represents an aggregation of <a href="../../../../org/osgi/service/useradmin/User.html" title="interface in org.osgi.service.useradmin"><code>User</code></a> and
<a href="../../../../org/osgi/service/useradmin/Group.html" title="interface in org.osgi.service.useradmin"><code>Group</code></a> objects. In other words, the members of a <code>Group</code> object
are roles themselves.
<p>
Every User Admin service manages and maintains its own namespace of
<code>Role</code> objects, in which each <code>Role</code> object has a unique name.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code><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/UserAdmin.html#createRole-java.lang.String-int-">createRole</a></span>(java.lang.String name,
int type)</code>
<div class="block">Creates a <code>Role</code> object with the given name and of the given type.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="../../../../org/osgi/service/useradmin/Authorization.html" title="interface in org.osgi.service.useradmin">Authorization</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/osgi/service/useradmin/UserAdmin.html#getAuthorization-org.osgi.service.useradmin.User-">getAuthorization</a></span>(<a href="../../../../org/osgi/service/useradmin/User.html" title="interface in org.osgi.service.useradmin">User</a> user)</code>
<div class="block">Creates an <code>Authorization</code> object that encapsulates the specified
<code>User</code> object and the <code>Role</code> objects it possesses.</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/UserAdmin.html#getRole-java.lang.String-">getRole</a></span>(java.lang.String name)</code>
<div class="block">Gets the <code>Role</code> object with the given <code>name</code> from this User
Admin service.</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/UserAdmin.html#getRoles-java.lang.String-">getRoles</a></span>(java.lang.String filter)</code>
<div class="block">Gets the <code>Role</code> objects managed by this User Admin service that
have properties matching the specified LDAP filter criteria.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code><a href="../../../../org/osgi/service/useradmin/User.html" title="interface in org.osgi.service.useradmin">User</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/osgi/service/useradmin/UserAdmin.html#getUser-java.lang.String-java.lang.String-">getUser</a></span>(java.lang.String key,
java.lang.String value)</code>
<div class="block">Gets the user with the given property <code>key</code>-<code>value</code> pair from
the User Admin service database.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/osgi/service/useradmin/UserAdmin.html#removeRole-java.lang.String-">removeRole</a></span>(java.lang.String name)</code>
<div class="block">Removes the <code>Role</code> object with the given name from this User Admin
service and all groups it is a member of.</div>
</td>
</tr>
</table>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="createRole-java.lang.String-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createRole</h4>
<pre><a href="../../../../org/osgi/service/useradmin/Role.html" title="interface in org.osgi.service.useradmin">Role</a> createRole(java.lang.String name,
int type)</pre>
<div class="block">Creates a <code>Role</code> object with the given name and of the given type.
<p>
If a <code>Role</code> object was created, a <code>UserAdminEvent</code> object of
type <a href="../../../../org/osgi/service/useradmin/UserAdminEvent.html#ROLE_CREATED"><code>UserAdminEvent.ROLE_CREATED</code></a> is broadcast to any
<code>UserAdminListener</code> object.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>name</code> - The <code>name</code> of the <code>Role</code> object to create.</dd>
<dd><code>type</code> - The type of the <code>Role</code> object to create. Must be either
a <a href="../../../../org/osgi/service/useradmin/Role.html#USER"><code>Role.USER</code></a> type or <a href="../../../../org/osgi/service/useradmin/Role.html#GROUP"><code>Role.GROUP</code></a> type.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The newly created <code>Role</code> object, or <code>null</code> if a role
with the given name already exists.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.IllegalArgumentException</code> - if <code>type</code> is invalid.</dd>
<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="removeRole-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>removeRole</h4>
<pre>boolean removeRole(java.lang.String name)</pre>
<div class="block">Removes the <code>Role</code> object with the given name from this User Admin
service and all groups it is a member of.
<p>
If the <code>Role</code> object was removed, a <code>UserAdminEvent</code> object
of type <a href="../../../../org/osgi/service/useradmin/UserAdminEvent.html#ROLE_REMOVED"><code>UserAdminEvent.ROLE_REMOVED</code></a> is broadcast to any
<code>UserAdminListener</code> object.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>name</code> - The name of the <code>Role</code> object to remove.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><code>true</code> If a <code>Role</code> object with the given name is
present in this User Admin service and 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="getRole-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getRole</h4>
<pre><a href="../../../../org/osgi/service/useradmin/Role.html" title="interface in org.osgi.service.useradmin">Role</a> getRole(java.lang.String name)</pre>
<div class="block">Gets the <code>Role</code> object with the given <code>name</code> from this User
Admin service.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>name</code> - The name of the <code>Role</code> object to get.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The requested <code>Role</code> object, or <code>null</code> if this User
Admin service does not have a <code>Role</code> object with the given
<code>name</code>.</dd>
</dl>
</li>
</ul>
<a name="getRoles-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getRoles</h4>
<pre><a href="../../../../org/osgi/service/useradmin/Role.html" title="interface in org.osgi.service.useradmin">Role</a>[] getRoles(java.lang.String filter)
throws org.osgi.framework.InvalidSyntaxException</pre>
<div class="block">Gets the <code>Role</code> objects managed by this User Admin service that
have properties matching the specified LDAP filter criteria. See
<code>org.osgi.framework.Filter</code> for a description of the filter syntax.
If a <code>null</code> filter is specified, all Role objects managed by this
User Admin service are returned.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>filter</code> - The filter criteria to match.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The <code>Role</code> objects managed by this User Admin service whose
properties match the specified filter criteria, or all
<code>Role</code> objects if a <code>null</code> filter is specified. If no
roles match the filter, <code>null</code> will be returned.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>org.osgi.framework.InvalidSyntaxException</code> - If the filter is not well formed.</dd>
</dl>
</li>
</ul>
<a name="getUser-java.lang.String-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getUser</h4>
<pre><a href="../../../../org/osgi/service/useradmin/User.html" title="interface in org.osgi.service.useradmin">User</a> getUser(java.lang.String key,
java.lang.String value)</pre>
<div class="block">Gets the user with the given property <code>key</code>-<code>value</code> pair from
the User Admin service database. This is a convenience method for
retrieving a <code>User</code> object based on a property for which every
<code>User</code> object is supposed to have a unique value (within the scope
of this User Admin service), such as for example a X.500 distinguished
name.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>key</code> - The property key to look for.</dd>
<dd><code>value</code> - The property value to compare with.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>A matching user, if <em>exactly</em> one is found. If zero or
more than one matching users are found, <code>null</code> is returned.</dd>
</dl>
</li>
</ul>
<a name="getAuthorization-org.osgi.service.useradmin.User-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getAuthorization</h4>
<pre><a href="../../../../org/osgi/service/useradmin/Authorization.html" title="interface in org.osgi.service.useradmin">Authorization</a> getAuthorization(<a href="../../../../org/osgi/service/useradmin/User.html" title="interface in org.osgi.service.useradmin">User</a> user)</pre>
<div class="block">Creates an <code>Authorization</code> object that encapsulates the specified
<code>User</code> object and the <code>Role</code> objects it possesses. The
<code>null</code> user is interpreted as the anonymous user. The anonymous
user represents a user that has not been authenticated. An
<code>Authorization</code> object for an anonymous user will be unnamed, and
will only imply groups that user.anyone implies.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>user</code> - The <code>User</code> object to create an <code>Authorization</code>
object for, or <code>null</code> for the anonymous user.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the <code>Authorization</code> object for the specified <code>User</code>
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>
<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/User.html" title="interface in org.osgi.service.useradmin"><span class="typeNameLink">Prev Class</span></a></li>
<li><a href="../../../../org/osgi/service/useradmin/UserAdminEvent.html" title="class 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/UserAdmin.html" target="_top">Frames</a></li>
<li><a href="UserAdmin.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>
|