Class AbstractDatabaseLoginModule

java.lang.Object

org.eclipse.jetty.security.jaas.spi.AbstractLoginModule

org.eclipse.jetty.security.jaas.spi.AbstractDatabaseLoginModule

All Implemented Interfaces:

LoginModule

Direct Known Subclasses:

DataSourceLoginModule, JDBCLoginModule

public abstract class AbstractDatabaseLoginModule
extends AbstractLoginModule

Abstract base class for LoginModules that interact with a database to retrieve authentication and authorization information. Used by the JDBCLoginModule and DataSourceLoginModule.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	AbstractDatabaseLoginModule.JDBCUser

Nested classes/interfaces inherited from class AbstractLoginModule

AbstractLoginModule.JAASUser

Constructor Summary

Constructors

Constructor	Description
AbstractDatabaseLoginModule()

Method Summary

Modifier and Type	Method	Description
abstract Connection	getConnection()
List<String>	getRoles(String userName)
AbstractLoginModule.JAASUser	getUser(String userName)	Load info from database
void	initialize(Subject subject, CallbackHandler callbackHandler, Map<String,?> sharedState, Map<String,?> options)

Methods inherited from class AbstractLoginModule

abort, commit, configureCallbacks, getCallbackHandler, getCurrentUser, getSubject, isAuthenticated, isCommitted, isIgnored, login, logout, setAuthenticated, setCallbackHandler, setCommitted, setCurrentUser, setSubject

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

AbstractDatabaseLoginModule

public AbstractDatabaseLoginModule()

Method Details

getConnection

public abstract Connection getConnection()
                                  throws Exception

Returns:

a java.sql.Connection from the database

Throws:

Exception - if unable to get the connection

getUser

public AbstractLoginModule.JAASUser getUser(String userName)
                                     throws Exception

Load info from database

Specified by:

getUser in class AbstractLoginModule

Parameters:

userName - user info to load

Throws:

Exception - if unable to get the user info

getRoles

public List<String> getRoles(String userName)
                      throws Exception

Throws:

Exception

initialize

public void initialize(Subject subject,
 CallbackHandler callbackHandler,
 Map<String,?> sharedState,
 Map<String,?> options)

Specified by:

initialize in interface LoginModule

Overrides:

initialize in class AbstractLoginModule

Parameters:

subject - the subject

callbackHandler - the callback handler

sharedState - the shared state map

options - the option map

See Also:

• LoginModule.initialize(Subject, CallbackHandler, Map, Map)