org.eclipse.jetty.jaas.spi

Class AbstractDatabaseLoginModule

java.lang.Object

org.eclipse.jetty.jaas.spi.AbstractLoginModule

org.eclipse.jetty.jaas.spi.AbstractDatabaseLoginModule

All Implemented Interfaces:

javax.security.auth.spi.LoginModule

Direct Known Subclasses:

DataSourceLoginModule, JDBCLoginModule

public abstract class AbstractDatabaseLoginModule
extends AbstractLoginModule

AbstractDatabaseLoginModule 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 and Description
class	AbstractDatabaseLoginModule.JDBCUserInfo

Nested classes/interfaces inherited from class org.eclipse.jetty.jaas.spi.AbstractLoginModule

AbstractLoginModule.JAASUserInfo

Field Summary

Fields

Modifier and Type	Field and Description
private java.lang.String	dbUserRoleTable
private java.lang.String	dbUserRoleTableRoleField
private java.lang.String	dbUserRoleTableUserField
private java.lang.String	dbUserTable
private java.lang.String	dbUserTableCredentialField
private java.lang.String	dbUserTableUserField
private static Logger	LOG
private java.lang.String	rolesQuery
private java.lang.String	userQuery

Constructor Summary

Constructors

Constructor and Description
AbstractDatabaseLoginModule()

Method Summary

Modifier and Type	Method and Description
abstract java.sql.Connection	getConnection()
java.util.List<java.lang.String>	getRoles(java.lang.String userName)
UserInfo	getUserInfo(java.lang.String userName) Load info from database
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)

Methods inherited from class org.eclipse.jetty.jaas.spi.AbstractLoginModule

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

Methods inherited from class java.lang.Object

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

Field Detail

LOG

private static final Logger LOG

userQuery

private java.lang.String userQuery

rolesQuery

private java.lang.String rolesQuery

dbUserTable

private java.lang.String dbUserTable

dbUserTableUserField

private java.lang.String dbUserTableUserField

dbUserTableCredentialField

private java.lang.String dbUserTableCredentialField

dbUserRoleTable

private java.lang.String dbUserRoleTable

dbUserRoleTableUserField

private java.lang.String dbUserRoleTableUserField

dbUserRoleTableRoleField

private java.lang.String dbUserRoleTableRoleField

Constructor Detail

AbstractDatabaseLoginModule

public AbstractDatabaseLoginModule()

Method Detail

getConnection

public abstract java.sql.Connection getConnection()
                                           throws java.lang.Exception

Returns:

a java.sql.Connection from the database

Throws:

java.lang.Exception - if unable to get the connection

getUserInfo

public UserInfo getUserInfo(java.lang.String userName)
                     throws java.lang.Exception

Load info from database

Specified by:

getUserInfo in class AbstractLoginModule

Parameters:

userName - user info to load

Throws:

java.lang.Exception - if unable to get the user info

getRoles

public java.util.List<java.lang.String> getRoles(java.lang.String userName)
                                          throws java.lang.Exception

Throws:

java.lang.Exception

initialize

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)

Specified by:

initialize in interface javax.security.auth.spi.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(javax.security.auth.Subject, javax.security.auth.callback.CallbackHandler, java.util.Map, java.util.Map)