org.apache.openejb.core.security.jaas

Class SQLLoginModule

java.lang.Object

org.apache.openejb.core.security.jaas.SQLLoginModule

All Implemented Interfaces:

LoginModule

public class SQLLoginModule
extends Object
implements LoginModule

A login module that loads security information from a SQL database. Expects to be run by a GenericSecurityRealm (doesn't work on its own).

This requires database connectivity information (either 1: a dataSourceName and optional dataSourceApplication or 2: a JDBC driver, URL, username, and password) and 2 SQL queries.

The userSelect query should return 2 values, the username and the password in that order. It should include one PreparedStatement parameter (a ?) which will be filled in with the username. In other words, the query should look like: SELECT user, password FROM credentials WHERE username=?

The groupSelect query should return 2 values, the username and the group name in that order (but it may return multiple rows, one per group). It should include one PreparedStatement parameter (a ?) which will be filled in with the username. In other words, the query should look like: SELECT user, role FROM user_roles WHERE username=?

This login module checks security credentials so the lifecycle methods must return true to indicate success or throw LoginException to indicate failure.

Version:

$Rev: 1607852 $ $Date: 2014-07-04 15:32:03 +0200 (Fri, 04 Jul 2014) $

Constructor Summary

Constructors

Constructor and Description
SQLLoginModule()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	abort()
boolean	commit()
void	initialize(Subject subject, CallbackHandler callbackHandler, Map sharedState, Map options)
boolean	login() This LoginModule is not to be ignored.
boolean	logout()

Methods inherited from class java.lang.Object

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

Constructor Detail

SQLLoginModule

public SQLLoginModule()

Method Detail

initialize

public void initialize(Subject subject,
              CallbackHandler callbackHandler,
              Map sharedState,
              Map options)

Specified by:

initialize in interface LoginModule

login

public boolean login()
              throws LoginException

This LoginModule is not to be ignored. So, this method should never return false.

Specified by:

login in interface LoginModule

Returns:

true if authentication succeeds, or throw a LoginException such as FailedLoginException if authentication fails

Throws:

LoginException

commit

public boolean commit()
               throws LoginException

Specified by:

commit in interface LoginModule

Returns:

true if login succeeded and commit succeeded, or false if login failed but commit succeeded.

Throws:

LoginException - if login succeeded but commit failed.

abort

public boolean abort()
              throws LoginException

Specified by:

abort in interface LoginModule

Throws:

LoginException

logout

public boolean logout()
               throws LoginException

Specified by:

logout in interface LoginModule

Throws:

LoginException