fathom.realm.jdbc

Class JdbcRealm

java.lang.Object

fathom.realm.StandardCredentialsRealm

fathom.realm.CachingRealm

fathom.realm.jdbc.JdbcRealm

All Implemented Interfaces:

Realm

public class JdbcRealm
extends CachingRealm

Realm that allows you to authenticate against a JDBC datasource.

Author:

James Moger

Field Summary

Fields

Modifier and Type	Field and Description
protected String	accountPermissionsQuery
protected String	accountQuery
protected String	accountRolesQuery
protected DataSource	dataSource
protected String	definedRolesQuery
protected String	emailMapping
protected com.typesafe.config.Config	hikariCPConfig
protected String	jdbcPassword
protected String	jdbcUrl
protected String	jdbcUsername
protected String	nameMapping
protected String	passwordMapping
protected String	permissionMapping
protected String	roleMapping
protected String	startScript
protected String	stopScript

Constructor Summary

Constructors

Constructor and Description
JdbcRealm()

Method Summary

Modifier and Type	Method and Description
Account	authenticate(StandardCredentials requestCredentials)
Account	authenticate(String username, String password)
protected void	executeScript(String scriptPath) Execute a script located either in the classpath or on the filesystem.
protected void	executeScript(URL scriptUrl) Execute a script.
protected Account	getAccount(Connection conn, String username)
DataSource	getDataSource() Returns the datasource that is being used to retrieve connections for this realm.
protected Map<String,Role>	getDefinedRoles(Connection conn)
protected Set<String>	getPermissionsByQuery(Connection conn, String username)
protected Set<String>	getRolesByQuery(Connection conn, String username)
void	setDataSource(DataSource dataSource) Sets the datasource that should be used to retrieve connections used by this realm.
void	setup(com.typesafe.config.Config config)
void	start()
void	stop()

Methods inherited from class fathom.realm.CachingRealm

cacheAccount, clearCache, getAccount, getRealmName, hasAccount, logCacheSettings

Methods inherited from class fathom.realm.StandardCredentialsRealm

authenticate, canAuthenticate, logSetting, toString, validatePassword

Methods inherited from class java.lang.Object

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

Field Detail

jdbcUrl

protected String jdbcUrl

jdbcUsername

protected String jdbcUsername

jdbcPassword

protected String jdbcPassword

dataSource

protected DataSource dataSource

accountQuery

protected String accountQuery

passwordMapping

protected String passwordMapping

nameMapping

protected String nameMapping

emailMapping

protected String emailMapping

roleMapping

protected String roleMapping

permissionMapping

protected String permissionMapping

accountRolesQuery

protected String accountRolesQuery

accountPermissionsQuery

protected String accountPermissionsQuery

definedRolesQuery

protected String definedRolesQuery

startScript

protected String startScript

stopScript

protected String stopScript

hikariCPConfig

protected com.typesafe.config.Config hikariCPConfig

Constructor Detail

JdbcRealm

public JdbcRealm()

Method Detail

setup

public void setup(com.typesafe.config.Config config)

Specified by:

setup in interface Realm

Overrides:

setup in class CachingRealm

start

public void start()

stop

public void stop()

getDataSource

public DataSource getDataSource()

Returns the datasource that is being used to retrieve connections for this realm.

Returns:

dataSource the SQL data source.

setDataSource

public void setDataSource(DataSource dataSource)

Sets the datasource that should be used to retrieve connections used by this realm.

Parameters:

dataSource - the SQL data source.

authenticate

public Account authenticate(StandardCredentials requestCredentials)

Overrides:

authenticate in class StandardCredentialsRealm

authenticate

public Account authenticate(String username,
                            String password)

Specified by:

authenticate in class StandardCredentialsRealm

getAccount

protected Account getAccount(Connection conn,
                             String username)
                      throws SQLException

Throws:

SQLException

getDefinedRoles

protected Map<String,Role> getDefinedRoles(Connection conn)
                                    throws SQLException

Throws:

SQLException

getRolesByQuery

protected Set<String> getRolesByQuery(Connection conn,
                                      String username)
                               throws SQLException

Throws:

SQLException

getPermissionsByQuery

protected Set<String> getPermissionsByQuery(Connection conn,
                                            String username)
                                     throws SQLException

Throws:

SQLException

executeScript

protected void executeScript(String scriptPath)

Execute a script located either in the classpath or on the filesystem.

Parameters:

scriptPath -

executeScript

protected void executeScript(URL scriptUrl)

Execute a script.

Parameters:

scriptUrl -