Skip to content

Commit a230cdc

Browse files
author
Open Identity Platform Community
committed
upload OpenAM docs after deploy 2af597267e6eb9302f75445c2c726f9b84f62966
1 parent b0ff5c4 commit a230cdc

51 files changed

Lines changed: 5155 additions & 3939 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

openam/apidocs/allclasses-index.html

Lines changed: 3553 additions & 3546 deletions
Large diffs are not rendered by default.

openam/apidocs/allclasses.html

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3873,6 +3873,7 @@ <h1 class="bar">All&nbsp;Classes</h1>
38733873
<li><a href="com/sun/identity/setup/MergeProperties.html" title="class in com.sun.identity.setup">MergeProperties</a></li>
38743874
<li><a href="com/sun/identity/liberty/ws/soapbinding/Message.html" title="class in com.sun.identity.liberty.ws.soapbinding">Message</a></li>
38753875
<li><a href="com/sun/identity/wss/security/handler/MessageAuthenticator.html" title="interface in com.sun.identity.wss.security.handler"><span class="interfaceName">MessageAuthenticator</span></a></li>
3876+
<li><a href="org/forgerock/openam/radius/common/MessageAuthenticatorAttribute.html" title="class in org.forgerock.openam.radius.common">MessageAuthenticatorAttribute</a></li>
38763877
<li><a href="com/sun/identity/wss/security/handler/MessageAuthorizer.html" title="interface in com.sun.identity.wss.security.handler"><span class="interfaceName">MessageAuthorizer</span></a></li>
38773878
<li><a href="org/forgerock/openam/services/push/dispatch/MessageDispatcher.html" title="class in org.forgerock.openam.services.push.dispatch">MessageDispatcher</a></li>
38783879
<li><a href="org/forgerock/openam/services/push/dispatch/MessageDispatcherFactory.html" title="class in org.forgerock.openam.services.push.dispatch">MessageDispatcherFactory</a></li>

openam/apidocs/com/sun/identity/authentication/modules/msisdn/MSISDN.html

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -148,8 +148,9 @@ <h2 title="Class MSISDN" class="title">Class MSISDN</h2>
148148
<code>ServletRequest</code>. If the values cannot be retrieved then
149149
callbacks to get <code>msisdn</code> number and wap gateway are sent back to
150150
the client. The WAP Gateway is validated against a list of valid gateways in
151-
the gateway list attribute. If the gateway list attribute is empty then all
152-
gateways will trusted , if it is "none" then no gateways will be trusted and
151+
the gateway list attribute. If the gateway list attribute is empty then no
152+
gateways will be trusted, if it is "none" then no gateways will be trusted,
153+
if it is "any" then all gateways will be trusted, and
153154
if specific values are specified only those gateways will be trusted. Once
154155
the gateway is validated the <code>msisdn</code> number is searched for in
155156
the repository. This module is written to lookup the <code>msisdn</code>

openam/apidocs/com/sun/identity/authentication/modules/radius/class-use/RADIUSServer.html

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -148,6 +148,19 @@ <h3>Uses of <a href="../RADIUSServer.html" title="class in com.sun.identity.auth
148148
</td>
149149
</tr>
150150
<tr class="altColor">
151+
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../client/RadiusConn.html#%3Cinit%3E(java.util.Set,java.util.Set,java.lang.String,int,byte%5B%5D,int,boolean)">RadiusConn</a></span>&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util" class="externalLink">Set</a>&lt;<a href="../RADIUSServer.html" title="class in com.sun.identity.authentication.modules.radius">RADIUSServer</a>&gt;&nbsp;primaries,
152+
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util" class="externalLink">Set</a>&lt;<a href="../RADIUSServer.html" title="class in com.sun.identity.authentication.modules.radius">RADIUSServer</a>&gt;&nbsp;secondaries,
153+
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;secret,
154+
int&nbsp;timeout,
155+
byte[]&nbsp;seed,
156+
int&nbsp;healthCheckInterval,
157+
boolean&nbsp;requireMessageAuthenticator)</code></th>
158+
<td class="colLast">
159+
<div class="block">Full-featured constructor that allows the caller to opt-in to the strict RFC 3579 /
160+
BlastRADIUS-mitigation profile.</div>
161+
</td>
162+
</tr>
163+
<tr class="rowColor">
151164
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../client/RadiusConn.html#%3Cinit%3E(java.util.Set,java.util.Set,java.lang.String,int,int)">RadiusConn</a></span>&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util" class="externalLink">Set</a>&lt;<a href="../RADIUSServer.html" title="class in com.sun.identity.authentication.modules.radius">RADIUSServer</a>&gt;&nbsp;primaries,
152165
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util" class="externalLink">Set</a>&lt;<a href="../RADIUSServer.html" title="class in com.sun.identity.authentication.modules.radius">RADIUSServer</a>&gt;&nbsp;secondaries,
153166
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;secret,

openam/apidocs/com/sun/identity/authentication/modules/radius/client/RadiusConn.html

Lines changed: 62 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -200,6 +200,19 @@ <h3>Constructor Summary</h3>
200200
</td>
201201
</tr>
202202
<tr class="altColor">
203+
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(java.util.Set,java.util.Set,java.lang.String,int,byte%5B%5D,int,boolean)">RadiusConn</a></span>&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util" class="externalLink">Set</a>&lt;<a href="../RADIUSServer.html" title="class in com.sun.identity.authentication.modules.radius">RADIUSServer</a>&gt;&nbsp;primaries,
204+
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util" class="externalLink">Set</a>&lt;<a href="../RADIUSServer.html" title="class in com.sun.identity.authentication.modules.radius">RADIUSServer</a>&gt;&nbsp;secondaries,
205+
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;secret,
206+
int&nbsp;timeout,
207+
byte[]&nbsp;seed,
208+
int&nbsp;healthCheckInterval,
209+
boolean&nbsp;requireMessageAuthenticator)</code></th>
210+
<td class="colLast">
211+
<div class="block">Full-featured constructor that allows the caller to opt-in to the strict RFC 3579 /
212+
BlastRADIUS-mitigation profile.</div>
213+
</td>
214+
</tr>
215+
<tr class="rowColor">
203216
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(java.util.Set,java.util.Set,java.lang.String,int,int)">RadiusConn</a></span>&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util" class="externalLink">Set</a>&lt;<a href="../RADIUSServer.html" title="class in com.sun.identity.authentication.modules.radius">RADIUSServer</a>&gt;&nbsp;primaries,
204217
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util" class="externalLink">Set</a>&lt;<a href="../RADIUSServer.html" title="class in com.sun.identity.authentication.modules.radius">RADIUSServer</a>&gt;&nbsp;secondaries,
205218
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;secret,
@@ -239,7 +252,8 @@ <h3>Method Summary</h3>
239252
<td class="colFirst"><code>void</code></td>
240253
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#disconnect()">disconnect</a></span>()</code></th>
241254
<td class="colLast">
242-
<div class="block">Disconnects the underlying datagram socket.</div>
255+
<div class="block">Closes the underlying datagram socket, releasing the associated file descriptor and
256+
ephemeral UDP port back to the operating system.</div>
243257
</td>
244258
</tr>
245259
<tr id="i2" class="altColor">
@@ -350,7 +364,7 @@ <h4>RadiusConn</h4>
350364
<a id="&lt;init&gt;(java.util.Set,java.util.Set,java.lang.String,int,byte[],int)">
351365
<!-- -->
352366
</a>
353-
<ul class="blockListLast">
367+
<ul class="blockList">
354368
<li class="blockList">
355369
<h4>RadiusConn</h4>
356370
<pre>public&nbsp;RadiusConn&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util" class="externalLink">Set</a>&lt;<a href="../RADIUSServer.html" title="class in com.sun.identity.authentication.modules.radius">RADIUSServer</a>&gt;&nbsp;primaries,
@@ -374,6 +388,42 @@ <h4>RadiusConn</h4>
374388
</dl>
375389
</li>
376390
</ul>
391+
<a id="&lt;init&gt;(java.util.Set,java.util.Set,java.lang.String,int,byte[],int,boolean)">
392+
<!-- -->
393+
</a>
394+
<ul class="blockListLast">
395+
<li class="blockList">
396+
<h4>RadiusConn</h4>
397+
<pre>public&nbsp;RadiusConn&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util" class="externalLink">Set</a>&lt;<a href="../RADIUSServer.html" title="class in com.sun.identity.authentication.modules.radius">RADIUSServer</a>&gt;&nbsp;primaries,
398+
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util" class="externalLink">Set</a>&lt;<a href="../RADIUSServer.html" title="class in com.sun.identity.authentication.modules.radius">RADIUSServer</a>&gt;&nbsp;secondaries,
399+
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;secret,
400+
int&nbsp;timeout,
401+
byte[]&nbsp;seed,
402+
int&nbsp;healthCheckInterval,
403+
boolean&nbsp;requireMessageAuthenticator)
404+
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/net/SocketException.html?is-external=true" title="class or interface in java.net" class="externalLink">SocketException</a></pre>
405+
<div class="block">Full-featured constructor that allows the caller to opt-in to the strict RFC 3579 /
406+
BlastRADIUS-mitigation profile.</div>
407+
<dl>
408+
<dt><span class="paramLabel">Parameters:</span></dt>
409+
<dd><code>primaries</code> - the primary servers to connect to.</dd>
410+
<dd><code>secondaries</code> - the secondary servers to connect to.</dd>
411+
<dd><code>secret</code> - the secret shared between this client and the remote servers.</dd>
412+
<dd><code>timeout</code> - the timeout value, in seconds.</dd>
413+
<dd><code>seed</code> - optional <a href="https://docs.oracle.com/javase/8/docs/api/java/security/SecureRandom.html?is-external=true" title="class or interface in java.security" class="externalLink"><code>SecureRandom</code></a> seed; <code>null</code> for default entropy.</dd>
414+
<dd><code>healthCheckInterval</code> - the health check interval, in minutes.</dd>
415+
<dd><code>requireMessageAuthenticator</code> - when <code>true</code>, every Access-Accept/Reject/Challenge
416+
received from the server MUST carry a verifiable
417+
Message-Authenticator (RFC 3579 attribute 80). This is
418+
the fully protected flow recommended by Cisco's
419+
BlastRADIUS guidance. When <code>false</code>, the client
420+
verifies MA only when the server happens to include it,
421+
remaining interoperable with legacy servers.</dd>
422+
<dt><span class="throwsLabel">Throws:</span></dt>
423+
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/net/SocketException.html?is-external=true" title="class or interface in java.net" class="externalLink">SocketException</a></code> - if a socket exception occurs.</dd>
424+
</dl>
425+
</li>
426+
</ul>
377427
</li>
378428
</ul>
379429
</section>
@@ -392,7 +442,16 @@ <h3>Method Detail</h3>
392442
<h4>disconnect</h4>
393443
<pre class="methodSignature">public&nbsp;void&nbsp;disconnect()
394444
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io" class="externalLink">IOException</a></pre>
395-
<div class="block">Disconnects the underlying datagram socket.</div>
445+
<div class="block">Closes the underlying datagram socket, releasing the associated file descriptor and
446+
ephemeral UDP port back to the operating system.
447+
448+
<p>Historically this method only invoked <a href="https://docs.oracle.com/javase/8/docs/api/java/net/DatagramSocket.html?is-external=true#disconnect--" title="class or interface in java.net" class="externalLink"><code>DatagramSocket.disconnect()</code></a>, which merely
449+
removes the peer association but keeps the socket (and therefore its file descriptor and
450+
ephemeral port) allocated until the JVM finaliser eventually reclaims it. Because
451+
<code>RADIUS.shutdown()</code> discards its <code>RadiusConn</code> reference right after calling
452+
this method, that behaviour leaked one FD / one ephemeral port per authentication attempt
453+
under load. The method is now an idempotent close, which is what every caller in the
454+
tree actually wants.</div>
396455
<dl>
397456
<dt><span class="throwsLabel">Throws:</span></dt>
398457
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io" class="externalLink">IOException</a></code> - if an io exception occurs.</dd>

openam/apidocs/com/sun/identity/authentication/spi/class-use/AuthLoginException.html

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1999,11 +1999,10 @@ <h3>Uses of <a href="../AuthLoginException.html" title="class in com.sun.identit
19991999
</tr>
20002000
<tr class="altColor">
20012001
<td class="colFirst"><code>protected void</code></td>
2002-
<th class="colSecond" scope="row"><span class="typeNameLabel">OAuth.</span><code><span class="memberNameLink"><a href="../../../../../../org/forgerock/openam/authentication/modules/oauth2/OAuth.html#updateAccount(org.forgerock.openam.authentication.modules.common.mapping.AccountProvider,java.lang.String,java.util.Map,java.lang.String,java.lang.String,org.forgerock.json.jose.jwt.JwtClaimsSet)">updateAccount</a></span>&#8203;(<a href="../../../../../../org/forgerock/openam/authentication/modules/common/mapping/AccountProvider.html" title="interface in org.forgerock.openam.authentication.modules.common.mapping">AccountProvider</a>&nbsp;accountProvider,
2002+
<th class="colSecond" scope="row"><span class="typeNameLabel">OAuth.</span><code><span class="memberNameLink"><a href="../../../../../../org/forgerock/openam/authentication/modules/oauth2/OAuth.html#updateAccount(org.forgerock.openam.authentication.modules.common.mapping.AccountProvider,java.lang.String,java.util.Map,java.lang.String,org.forgerock.json.jose.jwt.JwtClaimsSet)">updateAccount</a></span>&#8203;(<a href="../../../../../../org/forgerock/openam/authentication/modules/common/mapping/AccountProvider.html" title="interface in org.forgerock.openam.authentication.modules.common.mapping">AccountProvider</a>&nbsp;accountProvider,
20032003
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;realm,
20042004
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util" class="externalLink">Map</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>,&#8203;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util" class="externalLink">Set</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&gt;&gt;&nbsp;userNames,
20052005
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;profileSvcResponse,
2006-
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;userPassword,
20072006
org.forgerock.json.jose.jwt.JwtClaimsSet&nbsp;jwtClaims)</code></th>
20082007
<td class="colLast">&nbsp;</td>
20092008
</tr>

0 commit comments

Comments
 (0)