/usr/share/doc/libosgi-compendium-java/api/org/osgi/service/useradmin/User.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 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<title>User</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="User";
}
//-->
</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/useradmin/Role.html" title="interface in org.osgi.service.useradmin"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../org/osgi/service/useradmin/UserAdmin.html" title="interface in org.osgi.service.useradmin"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/osgi/service/useradmin/User.html" target="_top">Frames</a></li>
<li><a href="User.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 User" class="title">Interface User</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></dd>
</dl>
<dl>
<dt>All Known Subinterfaces:</dt>
<dd><a href="../../../../org/osgi/service/useradmin/Group.html" title="interface in org.osgi.service.useradmin">Group</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="strong">User</span>
extends <a href="../../../../org/osgi/service/useradmin/Role.html" title="interface in org.osgi.service.useradmin">Role</a></pre>
<div class="block">A <code>User</code> role managed by a User Admin service.
<p>
In this context, the term "user" is not limited to just human
beings. Instead, it refers to any entity that may have any number of
credentials associated with it that it may use to authenticate itself.
<p>
In general, <code>User</code> objects are associated with a specific User Admin
service (namely the one that created them), and cannot be used with other
User Admin services.
<p>
A <code>User</code> object may have credentials (and properties, inherited from
the <a href="../../../../org/osgi/service/useradmin/Role.html" title="interface in org.osgi.service.useradmin"><code>Role</code></a> class) associated with it. Specific
<a href="../../../../org/osgi/service/useradmin/UserAdminPermission.html" title="class in org.osgi.service.useradmin"><code>UserAdminPermission</code></a> objects are required to read or change a
<code>User</code> object's credentials.
<p>
Credentials are <code>Dictionary</code> objects and have semantics that are
similar to the properties in the <code>Role</code> class.</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="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>java.util.Dictionary</code></td>
<td class="colLast"><code><strong><a href="../../../../org/osgi/service/useradmin/User.html#getCredentials()">getCredentials</a></strong>()</code>
<div class="block">Returns a <code>Dictionary</code> of the credentials of this <code>User</code>
object.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../org/osgi/service/useradmin/User.html#hasCredential(java.lang.String,%20java.lang.Object)">hasCredential</a></strong>(java.lang.String key,
java.lang.Object value)</code>
<div class="block">Checks to see if this <code>User</code> object has a credential with the
specified <code>key</code> set to the specified <code>value</code>.</div>
</td>
</tr>
</table>
<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="getCredentials()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCredentials</h4>
<pre>java.util.Dictionary getCredentials()</pre>
<div class="block">Returns a <code>Dictionary</code> of the credentials of this <code>User</code>
object. Any changes to the returned <code>Dictionary</code> object will change
the credentials of this <code>User</code> object. This will cause a
<code>UserAdminEvent</code> object of type <a href="../../../../org/osgi/service/useradmin/UserAdminEvent.html#ROLE_CHANGED"><code>UserAdminEvent.ROLE_CHANGED</code></a>
to be broadcast to any <code>UserAdminListeners</code> objects.
<p>
Only objects of type <code>String</code> may be used as credential keys, and
only objects of type <code>String</code> or of type <code>byte[]</code> may be used
as credential values. Any other types will cause an exception of type
<code>IllegalArgumentException</code> to be raised.
<p>
In order to retrieve a credential from the returned <code>Dictionary</code>
object, a <a href="../../../../org/osgi/service/useradmin/UserAdminPermission.html" title="class in org.osgi.service.useradmin"><code>UserAdminPermission</code></a> named after the credential name (or
a prefix of it) with action <code>getCredential</code> is required.
<p>
In order to add or remove a credential from the returned
<code>Dictionary</code> object, a <a href="../../../../org/osgi/service/useradmin/UserAdminPermission.html" title="class in org.osgi.service.useradmin"><code>UserAdminPermission</code></a> named after the
credential name (or a prefix of it) with action <code>changeCredential</code>
is required.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd><code>Dictionary</code> object containing the credentials of this
<code>User</code> object.</dd></dl>
</li>
</ul>
<a name="hasCredential(java.lang.String, java.lang.Object)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>hasCredential</h4>
<pre>boolean hasCredential(java.lang.String key,
java.lang.Object value)</pre>
<div class="block">Checks to see if this <code>User</code> object has a credential with the
specified <code>key</code> set to the specified <code>value</code>.
<p>
If the specified credential <code>value</code> is not of type <code>String</code>
or <code>byte[]</code>, it is ignored, that is, <code>false</code> is returned (as
opposed to an <code>IllegalArgumentException</code> being raised).</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>key</code> - The credential <code>key</code>.</dd><dd><code>value</code> - The credential <code>value</code>.</dd>
<dt><span class="strong">Returns:</span></dt><dd><code>true</code> if this user has the specified credential;
<code>false</code> otherwise.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.SecurityException</code> - If a security manager exists and the caller
does not have the <code>UserAdminPermission</code> named after the
credential key (or a prefix of it) with action
<code>getCredential</code>.</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/useradmin/Role.html" title="interface in org.osgi.service.useradmin"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../org/osgi/service/useradmin/UserAdmin.html" title="interface in org.osgi.service.useradmin"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/osgi/service/useradmin/User.html" target="_top">Frames</a></li>
<li><a href="User.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>
|