org.pac4j.sql.credentials.authenticator

Class DbAuthenticator

java.lang.Object

org.pac4j.core.util.InitializableWebObject

org.pac4j.core.credentials.authenticator.AbstractUsernamePasswordAuthenticator

org.pac4j.sql.credentials.authenticator.DbAuthenticator

All Implemented Interfaces:

Authenticator<UsernamePasswordCredentials>

public class DbAuthenticator
extends AbstractUsernamePasswordAuthenticator

Authenticator for users stored in relational database, based on the JDBI library. It creates the user profile and stores it in the credentials for the AuthenticatorProfileCreator.

Since:

1.8.0

Author:

Jerome Leleu

Field Summary

Fields

Modifier and Type	Field and Description
protected String	attributes This must a list of attribute names separated by commas.
protected DataSource	dataSource
protected org.skife.jdbi.v2.DBI	dbi
protected String	endQuery
protected org.slf4j.Logger	logger
protected String	startQuery

Constructor Summary

Constructors

Constructor and Description
DbAuthenticator()
DbAuthenticator(DataSource dataSource)
DbAuthenticator(DataSource dataSource, String attributes)
DbAuthenticator(DataSource dataSource, String attributes, PasswordEncoder passwordEncoder)

Method Summary

Modifier and Type	Method and Description
protected DbProfile	createProfile(String username, String[] attributes, Map<String,Object> result)
String	getAttributes()
DataSource	getDataSource()
String	getEndQuery()
String	getStartQuery()
protected void	internalInit(WebContext context)
void	setAttributes(String attributes)
void	setDataSource(DataSource dataSource)
void	setEndQuery(String endQuery)
void	setStartQuery(String startQuery)
void	validate(UsernamePasswordCredentials credentials, WebContext context)

Methods inherited from class org.pac4j.core.credentials.authenticator.AbstractUsernamePasswordAuthenticator

getPasswordEncoder, setPasswordEncoder

Methods inherited from class org.pac4j.core.util.InitializableWebObject

init, reinit

Methods inherited from class java.lang.Object

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

Field Detail

logger

protected final org.slf4j.Logger logger

dbi

protected org.skife.jdbi.v2.DBI dbi

dataSource

protected DataSource dataSource

attributes

protected String attributes

This must a list of attribute names separated by commas. No aliasing (AS).

startQuery

protected String startQuery

endQuery

protected String endQuery

Constructor Detail

DbAuthenticator

public DbAuthenticator()

DbAuthenticator

public DbAuthenticator(DataSource dataSource)

DbAuthenticator

public DbAuthenticator(DataSource dataSource,
                       String attributes)

DbAuthenticator

public DbAuthenticator(DataSource dataSource,
                       String attributes,
                       PasswordEncoder passwordEncoder)

Method Detail

internalInit

protected void internalInit(WebContext context)

Overrides:

internalInit in class AbstractUsernamePasswordAuthenticator

validate

public void validate(UsernamePasswordCredentials credentials,
                     WebContext context)
              throws HttpAction

Throws:

HttpAction

createProfile

protected DbProfile createProfile(String username,
                                  String[] attributes,
                                  Map<String,Object> result)

getDataSource

public DataSource getDataSource()

setDataSource

public void setDataSource(DataSource dataSource)

getAttributes

public String getAttributes()

setAttributes

public void setAttributes(String attributes)

getStartQuery

public String getStartQuery()

setStartQuery

public void setStartQuery(String startQuery)

getEndQuery

public String getEndQuery()

setEndQuery

public void setEndQuery(String endQuery)