| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (1.8.0_92) on Thu Jun 07 14:26:33 EDT 2018 --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>AbstractDatabaseLoginModule (Jetty :: Project 9.3.24.v20180605 API)</title> |
| <meta name="date" content="2018-06-07"> |
| <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="AbstractDatabaseLoginModule (Jetty :: Project 9.3.24.v20180605 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":6,"i1":10,"i2":10,"i3":10}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],8:["t4","Concrete 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="class-use/AbstractDatabaseLoginModule.html">Use</a></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>Prev Class</li> |
| <li><a href="../../../../../org/eclipse/jetty/jaas/spi/AbstractDatabaseLoginModule.JDBCUserInfo.html" title="class in org.eclipse.jetty.jaas.spi"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/eclipse/jetty/jaas/spi/AbstractDatabaseLoginModule.html" target="_top">Frames</a></li> |
| <li><a href="AbstractDatabaseLoginModule.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><a href="#nested.class.summary">Nested</a> | </li> |
| <li>Field | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </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.eclipse.jetty.jaas.spi</div> |
| <h2 title="Class AbstractDatabaseLoginModule" class="title">Class AbstractDatabaseLoginModule</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li>java.lang.Object</li> |
| <li> |
| <ul class="inheritance"> |
| <li><a href="../../../../../org/eclipse/jetty/jaas/spi/AbstractLoginModule.html" title="class in org.eclipse.jetty.jaas.spi">org.eclipse.jetty.jaas.spi.AbstractLoginModule</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.eclipse.jetty.jaas.spi.AbstractDatabaseLoginModule</li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd>javax.security.auth.spi.LoginModule</dd> |
| </dl> |
| <dl> |
| <dt>Direct Known Subclasses:</dt> |
| <dd><a href="../../../../../org/eclipse/jetty/jaas/spi/DataSourceLoginModule.html" title="class in org.eclipse.jetty.jaas.spi">DataSourceLoginModule</a>, <a href="../../../../../org/eclipse/jetty/jaas/spi/JDBCLoginModule.html" title="class in org.eclipse.jetty.jaas.spi">JDBCLoginModule</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public abstract class <span class="typeNameLabel">AbstractDatabaseLoginModule</span> |
| extends <a href="../../../../../org/eclipse/jetty/jaas/spi/AbstractLoginModule.html" title="class in org.eclipse.jetty.jaas.spi">AbstractLoginModule</a></pre> |
| <div class="block">AbstractDatabaseLoginModule |
| |
| Abstract base class for LoginModules that interact with a |
| database to retrieve authentication and authorization information. |
| Used by the JDBCLoginModule and DataSourceLoginModule.</div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="nested.class.summary"> |
| <!-- --> |
| </a> |
| <h3>Nested Class Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation"> |
| <caption><span>Nested Classes</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Class and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>class </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/jetty/jaas/spi/AbstractDatabaseLoginModule.JDBCUserInfo.html" title="class in org.eclipse.jetty.jaas.spi">AbstractDatabaseLoginModule.JDBCUserInfo</a></span></code> </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="nested.classes.inherited.from.class.org.eclipse.jetty.jaas.spi.AbstractLoginModule"> |
| <!-- --> |
| </a> |
| <h3>Nested classes/interfaces inherited from class org.eclipse.jetty.jaas.spi.<a href="../../../../../org/eclipse/jetty/jaas/spi/AbstractLoginModule.html" title="class in org.eclipse.jetty.jaas.spi">AbstractLoginModule</a></h3> |
| <code><a href="../../../../../org/eclipse/jetty/jaas/spi/AbstractLoginModule.JAASUserInfo.html" title="class in org.eclipse.jetty.jaas.spi">AbstractLoginModule.JAASUserInfo</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colOne" scope="col">Constructor and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/jetty/jaas/spi/AbstractDatabaseLoginModule.html#AbstractDatabaseLoginModule--">AbstractDatabaseLoginModule</a></span>()</code> </td> |
| </tr> |
| </table> |
| </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><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete 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>abstract java.sql.Connection</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/jetty/jaas/spi/AbstractDatabaseLoginModule.html#getConnection--">getConnection</a></span>()</code> </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>java.util.List<java.lang.String></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/jetty/jaas/spi/AbstractDatabaseLoginModule.html#getRoles-java.lang.String-">getRoles</a></span>(java.lang.String userName)</code> </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/eclipse/jetty/jaas/spi/UserInfo.html" title="class in org.eclipse.jetty.jaas.spi">UserInfo</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/jetty/jaas/spi/AbstractDatabaseLoginModule.html#getUserInfo-java.lang.String-">getUserInfo</a></span>(java.lang.String userName)</code> |
| <div class="block">Load info from database</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/jetty/jaas/spi/AbstractDatabaseLoginModule.html#initialize-javax.security.auth.Subject-javax.security.auth.callback.CallbackHandler-java.util.Map-java.util.Map-">initialize</a></span>(javax.security.auth.Subject subject, |
| javax.security.auth.callback.CallbackHandler callbackHandler, |
| java.util.Map<java.lang.String,?> sharedState, |
| java.util.Map<java.lang.String,?> options)</code> </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.eclipse.jetty.jaas.spi.AbstractLoginModule"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class org.eclipse.jetty.jaas.spi.<a href="../../../../../org/eclipse/jetty/jaas/spi/AbstractLoginModule.html" title="class in org.eclipse.jetty.jaas.spi">AbstractLoginModule</a></h3> |
| <code><a href="../../../../../org/eclipse/jetty/jaas/spi/AbstractLoginModule.html#abort--">abort</a>, <a href="../../../../../org/eclipse/jetty/jaas/spi/AbstractLoginModule.html#commit--">commit</a>, <a href="../../../../../org/eclipse/jetty/jaas/spi/AbstractLoginModule.html#configureCallbacks--">configureCallbacks</a>, <a href="../../../../../org/eclipse/jetty/jaas/spi/AbstractLoginModule.html#getCallbackHandler--">getCallbackHandler</a>, <a href="../../../../../org/eclipse/jetty/jaas/spi/AbstractLoginModule.html#getCurrentUser--">getCurrentUser</a>, <a href="../../../../../org/eclipse/jetty/jaas/spi/AbstractLoginModule.html#getSubject--">getSubject</a>, <a href="../../../../../org/eclipse/jetty/jaas/spi/AbstractLoginModule.html#isAuthenticated--">isAuthenticated</a>, <a href="../../../../../org/eclipse/jetty/jaas/spi/AbstractLoginModule.html#isCommitted--">isCommitted</a>, <a href="../../../../../org/eclipse/jetty/jaas/spi/AbstractLoginModule.html#isIgnored--">isIgnored</a>, <a href="../../../../../org/eclipse/jetty/jaas/spi/AbstractLoginModule.html#login--">login</a>, <a href="../../../../../org/eclipse/jetty/jaas/spi/AbstractLoginModule.html#logout--">logout</a>, <a href="../../../../../org/eclipse/jetty/jaas/spi/AbstractLoginModule.html#setAuthenticated-boolean-">setAuthenticated</a>, <a href="../../../../../org/eclipse/jetty/jaas/spi/AbstractLoginModule.html#setCallbackHandler-javax.security.auth.callback.CallbackHandler-">setCallbackHandler</a>, <a href="../../../../../org/eclipse/jetty/jaas/spi/AbstractLoginModule.html#setCommitted-boolean-">setCommitted</a>, <a href="../../../../../org/eclipse/jetty/jaas/spi/AbstractLoginModule.html#setCurrentUser-org.eclipse.jetty.jaas.spi.AbstractLoginModule.JAASUserInfo-">setCurrentUser</a>, <a href="../../../../../org/eclipse/jetty/jaas/spi/AbstractLoginModule.html#setSubject-javax.security.auth.Subject-">setSubject</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.Object</h3> |
| <code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="AbstractDatabaseLoginModule--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>AbstractDatabaseLoginModule</h4> |
| <pre>public AbstractDatabaseLoginModule()</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="getConnection--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getConnection</h4> |
| <pre>public abstract java.sql.Connection getConnection() |
| throws java.lang.Exception</pre> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a java.sql.Connection from the database</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.lang.Exception</code> - if unable to get the connection</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getUserInfo-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getUserInfo</h4> |
| <pre>public <a href="../../../../../org/eclipse/jetty/jaas/spi/UserInfo.html" title="class in org.eclipse.jetty.jaas.spi">UserInfo</a> getUserInfo(java.lang.String userName) |
| throws java.lang.Exception</pre> |
| <div class="block">Load info from database</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/eclipse/jetty/jaas/spi/AbstractLoginModule.html#getUserInfo-java.lang.String-">getUserInfo</a></code> in class <code><a href="../../../../../org/eclipse/jetty/jaas/spi/AbstractLoginModule.html" title="class in org.eclipse.jetty.jaas.spi">AbstractLoginModule</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>userName</code> - user info to load</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.lang.Exception</code> - if unable to get the user info</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getRoles-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getRoles</h4> |
| <pre>public java.util.List<java.lang.String> getRoles(java.lang.String userName) |
| throws java.lang.Exception</pre> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.lang.Exception</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="initialize-javax.security.auth.Subject-javax.security.auth.callback.CallbackHandler-java.util.Map-java.util.Map-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>initialize</h4> |
| <pre>public void initialize(javax.security.auth.Subject subject, |
| javax.security.auth.callback.CallbackHandler callbackHandler, |
| java.util.Map<java.lang.String,?> sharedState, |
| java.util.Map<java.lang.String,?> options)</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code>initialize</code> in interface <code>javax.security.auth.spi.LoginModule</code></dd> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../../../../../org/eclipse/jetty/jaas/spi/AbstractLoginModule.html#initialize-javax.security.auth.Subject-javax.security.auth.callback.CallbackHandler-java.util.Map-java.util.Map-">initialize</a></code> in class <code><a href="../../../../../org/eclipse/jetty/jaas/spi/AbstractLoginModule.html" title="class in org.eclipse.jetty.jaas.spi">AbstractLoginModule</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>subject</code> - the subject</dd> |
| <dd><code>callbackHandler</code> - the callback handler</dd> |
| <dd><code>sharedState</code> - the shared state map</dd> |
| <dd><code>options</code> - the option map</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><code>LoginModule.initialize(javax.security.auth.Subject, javax.security.auth.callback.CallbackHandler, java.util.Map, java.util.Map)</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> |
| <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="class-use/AbstractDatabaseLoginModule.html">Use</a></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>Prev Class</li> |
| <li><a href="../../../../../org/eclipse/jetty/jaas/spi/AbstractDatabaseLoginModule.JDBCUserInfo.html" title="class in org.eclipse.jetty.jaas.spi"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/eclipse/jetty/jaas/spi/AbstractDatabaseLoginModule.html" target="_top">Frames</a></li> |
| <li><a href="AbstractDatabaseLoginModule.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><a href="#nested.class.summary">Nested</a> | </li> |
| <li>Field | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| <p class="legalCopy"><small>Copyright © 1995–2018 <a href="http://webtide.com">Webtide</a>. All rights reserved.</small></p> |
| </body> |
| </html> |
