You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@felix.apache.org by bu...@apache.org on 2013/07/22 12:05:05 UTC
svn commit: r870558 - in /websites/staging/felix/trunk/content: ./
documentation/subprojects/apache-felix-jaas.html
Author: buildbot
Date: Mon Jul 22 10:05:04 2013
New Revision: 870558
Log:
Staging update by buildbot for felix
Modified:
websites/staging/felix/trunk/content/ (props changed)
websites/staging/felix/trunk/content/documentation/subprojects/apache-felix-jaas.html
Propchange: websites/staging/felix/trunk/content/
------------------------------------------------------------------------------
--- cms:source-revision (original)
+++ cms:source-revision Mon Jul 22 10:05:04 2013
@@ -1 +1 @@
-1505644
+1505646
Modified: websites/staging/felix/trunk/content/documentation/subprojects/apache-felix-jaas.html
==============================================================================
--- websites/staging/felix/trunk/content/documentation/subprojects/apache-felix-jaas.html (original)
+++ websites/staging/felix/trunk/content/documentation/subprojects/apache-felix-jaas.html Mon Jul 22 10:05:04 2013
@@ -125,7 +125,7 @@ Work in progress as part of FELIX-3980
<h5 id="configuration">Configuration</h5>
<p>JAAS module depends on OSGi Configuration for managing the LoginModule configuration. The configuration factory PID is <code>org.apache.felix.jaas.Configuration.factory</code>.It provides the required metatype descriptor thus enabling configuration via via "Configuration" tab of Felix WebConsole</p>
-<p>!jaas-config.png!</p>
+<p><img src="jaas-config.png" /></p>
<p>Configuration properties</p>
<ul>
<li><code>jaas.classname</code> - Fully qualified name of the LoginModule class</li>
@@ -138,43 +138,42 @@ Work in progress as part of FELIX-3980
<p>Any bundle which want to provide a LoginModule implementation would need to provide a factory service which implements the <a href="http://svn.apache.org/repos/asf/felix/trunk/jaas/src/main/java/org/apache/felix/jaas/LoginModuleFactory.java">LoginModuleFactory</a> interface. The factory needs to be registeredwith following optional properties</p>
<ul>
<li><code>jaas.controlFlag</code> - LoginControlFlag to use like required, optional, requisite, sufficient. Default is set to required</li>
-<li><code>jaas.realmName</code> - JAAS Realm name. If specified then LoginModule would be registered against given realm otherwise it is bound to a 'other' realm</li>
-<li>
-<p><code>service.ranking</code> - Ranking for the LoginModule. It would be used to order the various login modules</p>
-<p>:::java</p>
-<p>/<strong>
- * A factory for creating {@link LoginModule} instances.
- */
-public interface LoginModuleFactory
-{
- /</strong>
- * Property name specifying whether or not a <code>LoginModule</code> is
- * REQUIRED, REQUISITE, SUFFICIENT or OPTIONAL. Refer to {@link javax.security.auth.login.Configuration}
- * for more details around the meaning of these flags
- <em>
- * By default the value is set to REQUIRED
- </em>/
- String JAAS_CONTROL_FLAG = "jaas.controlFlag";</p>
+<li><code>jaas.realmName</code> - JAAS Realm name. If specified then LoginModule would be registered against given realm otherwise it is bound to a 'other' realm.</li>
+<li><code>service.ranking</code> - Ranking for the LoginModule. It would be used to order the various login modules.</li>
+</ul>
+<p>Interface</p>
<div class="codehilite"><pre><span class="cm">/**</span>
-<span class="cm"> * Property name specifying the Realm name (or application name) against which the</span>
-<span class="cm"> * LoginModule would be registered.</span>
-<span class="cm"> *</span>
-<span class="cm"> * <p>If no realm name is provided then LoginModule would registered with a default realm</span>
-<span class="cm"> * as configured</span>
+<span class="cm"> * A factory for creating {@link LoginModule} instances.</span>
<span class="cm"> */</span>
-<span class="n">String</span> <span class="no">JAAS_REALM_NAME</span> <span class="o">=</span> <span class="s">"jaas.realmName"</span><span class="p">;</span>
+<span class="kd">public</span> <span class="kd">interface</span> <span class="nc">LoginModuleFactory</span>
+<span class="o">{</span>
+ <span class="cm">/**</span>
+<span class="cm"> * Property name specifying whether or not a <code>LoginModule</code> is</span>
+<span class="cm"> * REQUIRED, REQUISITE, SUFFICIENT or OPTIONAL. Refer to {@link javax.security.auth.login.Configuration}</span>
+<span class="cm"> * for more details around the meaning of these flags</span>
+<span class="cm"> *</span>
+<span class="cm"> * By default the value is set to REQUIRED</span>
+<span class="cm"> */</span>
+ <span class="n">String</span> <span class="n">JAAS_CONTROL_FLAG</span> <span class="o">=</span> <span class="s">"jaas.controlFlag"</span><span class="o">;</span>
-<span class="cm">/**</span>
-<span class="cm"> * Creates the LoginModule instance</span>
-<span class="cm"> * @return loginModule instance</span>
-<span class="cm"> */</span>
-<span class="n">LoginModule</span> <span class="n">createLoginModule</span><span class="p">();</span>
+ <span class="cm">/**</span>
+<span class="cm"> * Property name specifying the Realm name (or application name) against which the</span>
+<span class="cm"> * LoginModule would be registered.</span>
+<span class="cm"> *</span>
+<span class="cm"> * <p>If no realm name is provided then LoginModule would registered with a default realm</span>
+<span class="cm"> * as configured</span>
+<span class="cm"> */</span>
+ <span class="n">String</span> <span class="n">JAAS_REALM_NAME</span> <span class="o">=</span> <span class="s">"jaas.realmName"</span><span class="o">;</span>
+
+ <span class="cm">/**</span>
+<span class="cm"> * Creates the LoginModule instance</span>
+<span class="cm"> * @return loginModule instance</span>
+<span class="cm"> */</span>
+ <span class="n">LoginModule</span> <span class="nf">createLoginModule</span><span class="o">();</span>
+<span class="o">}</span>
</pre></div>
-<p>}</p>
-</li>
-</ul>
<p>Refer to <a href="http://svn.apache.org/repos/asf/felix/trunk/examples/jaas/lm-jdbc/src/main/java/org/apache/felix/example/jaas/jdbc/JdbcLoginModuleFactory.java">JdbcLoginModuleFactory</a> for one example of its usage. It constructs a JdbcLoginModule based on the configuration and passes on the datasource.</p>
<h2 id="resources">Resources</h2>
<ol>
@@ -182,7 +181,7 @@ public interface LoginModuleFactory
<li><a href="http://docs.oracle.com/javase/1.5.0/docs/guide/security/jaas/tutorials/LoginConfigFile.html">JAAS Login Configuration File</a></li>
</ol>
<div class="timestamp" style="margin-top: 30px; font-size: 80%; text-align: right;">
- Rev. 1464998 by chetanm on Fri, 5 Apr 2013 15:05:10 +0000
+ Rev. 1505646 by chetanm on Mon, 22 Jul 2013 10:04:56 +0000
</div>
<div class="trademarkFooter">
Apache Felix, Felix, Apache, the Apache feather logo, and the Apache Felix project