Package org.jboss.security.auth.callback

Class DatabaseCallbackHandler

java.lang.Object

org.jboss.security.auth.callback.AbstractCallbackHandler

org.jboss.security.auth.callback.DatabaseCallbackHandler

All Implemented Interfaces:

CallbackHandler

public class DatabaseCallbackHandler
extends AbstractCallbackHandler
implements CallbackHandler

A CallbackHandler that uses a DB.

Configuration: There are two ways to specify the configuration.

1. Using the #setConfiguration(Map) method, which uses String based key/value pair.
2. Using the methods #setConnectionUrl(String), #setDbDriverName(String)etc

Either you can specify the connection url, driver class name or you can provide the jndi name of the DataSource.

Since:

Oct 31, 2011

Author:

Anil Saldhana

Field Summary

Fields

Modifier and Type	Field	Description
static String	CONNECTION_URL
protected String	connectionUrl	A DB specific connection url
static String	DB_DRIVERNAME
static String	DB_USERNAME
static String	DB_USERPASS
protected String	dbDriverName	A DB Driver Class Name
static String	DS_JNDI_NAME
protected String	dsJndiName	JNDI Name of the Datasource
protected String	dsUserName	A DB username to connect
protected String	dsUserPass	A DB password to connect
static String	PRINCIPALS_QUERY
protected String	principalsQuery	The sql query to obtain the user password

Fields inherited from class org.jboss.security.auth.callback.AbstractCallbackHandler

userName

Constructor Summary

Constructors

Constructor	Description
DatabaseCallbackHandler()

Method Summary

Modifier and Type	Method	Description
String	getConnectionUrl()	Get the DB specific connection URL Eg: "jdbc:hsqldb:mem:unit_test"
String	getDbDriverName()	Get the fully qualified name of sql driver class Eg: org.hsqldb.jdbc.JDBCDriver
String	getDsJndiName()	Get the JNDI name of the SQL Datasource
String	getDsUserName()	Get the DB user name
String	getDsUserPass()	Get the DB user pass
String	getPrincipalsQuery()
String	getUserName()
void	handle(Callback[] callbacks)
protected void	handleCallBack(Callback c)	Handle a Callback
protected void	handleVerification(VerifyPasswordCallback vpc)
protected void	safeClose(Connection conn)
protected void	safeClose(ResultSet rs)
protected void	safeClose(Statement stat)
void	setConfiguration(Map<String,String> config)	Set a Map that contains keys that are strings and values that are strings
void	setConnectionUrl(String connectionUrl)
void	setDbDriverName(String dbDriverName)
void	setDsJndiName(String dsJndiName)
void	setDsUserName(String dsUserName)
void	setDsUserPass(String dsUserPass)
void	setPrincipalsQuery(String principalsQuery)
void	setUserName(String theUserName)

Methods inherited from class org.jboss.security.auth.callback.AbstractCallbackHandler

getUserName

Methods inherited from class java.lang.Object

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

Field Detail

CONNECTION_URL

public static final String CONNECTION_URL

See Also:

Constant Field Values

DS_JNDI_NAME

public static final String DS_JNDI_NAME

See Also:

Constant Field Values

DB_DRIVERNAME

public static final String DB_DRIVERNAME

See Also:

Constant Field Values

DB_USERNAME

public static final String DB_USERNAME

See Also:

Constant Field Values

DB_USERPASS

public static final String DB_USERPASS

See Also:

Constant Field Values

PRINCIPALS_QUERY

public static final String PRINCIPALS_QUERY

See Also:

Constant Field Values

connectionUrl

protected String connectionUrl

A DB specific connection url

dsJndiName

protected String dsJndiName

JNDI Name of the Datasource

dsUserName

protected String dsUserName

A DB username to connect

dsUserPass

protected String dsUserPass

A DB password to connect

dbDriverName

protected String dbDriverName

A DB Driver Class Name

principalsQuery

protected String principalsQuery

The sql query to obtain the user password

Constructor Detail

DatabaseCallbackHandler

public DatabaseCallbackHandler()

Method Detail

getConnectionUrl

public String getConnectionUrl()

Get the DB specific connection URL Eg: "jdbc:hsqldb:mem:unit_test"

Returns:

setConnectionUrl

public void setConnectionUrl(String connectionUrl)

getDsJndiName

public String getDsJndiName()

Get the JNDI name of the SQL Datasource

Returns:

setDsJndiName

public void setDsJndiName(String dsJndiName)

getDsUserName

public String getDsUserName()

Get the DB user name

Returns:

setDsUserName

public void setDsUserName(String dsUserName)

getDsUserPass

public String getDsUserPass()

Get the DB user pass

Returns:

setDsUserPass

public void setDsUserPass(String dsUserPass)

getDbDriverName

public String getDbDriverName()

Get the fully qualified name of sql driver class Eg: org.hsqldb.jdbc.JDBCDriver

Returns:

setDbDriverName

public void setDbDriverName(String dbDriverName)

getPrincipalsQuery

public String getPrincipalsQuery()

setPrincipalsQuery

public void setPrincipalsQuery(String principalsQuery)

getUserName

public String getUserName()

setUserName

public void setUserName(String theUserName)

setConfiguration

public void setConfiguration(Map<String,String> config)

Set a Map that contains keys that are strings and values that are strings

Parameters:

config -

handle

public void handle(Callback[] callbacks)
            throws IOException,
                   UnsupportedCallbackException

Specified by:

handle in interface CallbackHandler

Throws:

IOException

UnsupportedCallbackException

handleCallBack

protected void handleCallBack(Callback c)
                       throws UnsupportedCallbackException,
                              IOException

Handle a Callback

Parameters:

c - callback

Throws:

UnsupportedCallbackException - If the callback is not supported by this handler

IOException

handleVerification

protected void handleVerification(VerifyPasswordCallback vpc)
                           throws LoginException

Throws:

LoginException

safeClose

protected void safeClose(ResultSet rs)

safeClose

protected void safeClose(Connection conn)

safeClose

protected void safeClose(Statement stat)