org.eclipse.jetty.security

Class JDBCLoginService

java.lang.Object

org.eclipse.jetty.util.component.AbstractLifeCycle

org.eclipse.jetty.security.MappedLoginService

org.eclipse.jetty.security.JDBCLoginService

All Implemented Interfaces:

LoginService, LifeCycle

public class JDBCLoginService
extends MappedLoginService

HashMapped User Realm with JDBC as data source. The login(String, Object, ServletRequest) method checks the inherited Map for the user. If the user is not found, it will fetch details from the database and populate the inherited Map. It then calls the superclass login(String, Object, ServletRequest) method to perform the actual authentication. Periodically (controlled by configuration parameter), internal hashes are cleared. Caching can be disabled by setting cache refresh interval to zero. Uses one database connection that is initialized at startup. Reconnect on failures.

An example properties file for configuration is in ${jetty.home}/etc/jdbcRealm.properties

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	JDBCLoginService.JDBCKnownUser JDBCKnownUser

Nested classes/interfaces inherited from class org.eclipse.jetty.security.MappedLoginService

MappedLoginService.Anonymous, MappedLoginService.KnownUser, MappedLoginService.RolePrincipal, MappedLoginService.UserPrincipal

Nested classes/interfaces inherited from class org.eclipse.jetty.util.component.AbstractLifeCycle

AbstractLifeCycle.AbstractLifeCycleListener

Nested classes/interfaces inherited from interface org.eclipse.jetty.util.component.LifeCycle

LifeCycle.Listener

Field Summary

Fields

Modifier and Type	Field and Description
protected int	_cacheTime
protected Connection	_con
protected String	_config
protected String	_jdbcDriver
protected long	_lastHashPurge
protected String	_password
protected String	_roleSql
protected String	_roleTableRoleField
protected String	_url
protected String	_userName
protected String	_userSql
protected String	_userTableKey
protected String	_userTablePasswordField

Fields inherited from class org.eclipse.jetty.security.MappedLoginService

_identityService, _name, _users

Fields inherited from class org.eclipse.jetty.util.component.AbstractLifeCycle

FAILED, RUNNING, STARTED, STARTING, STOPPED, STOPPING

Constructor Summary

Constructors

Constructor and Description
JDBCLoginService()
JDBCLoginService(String name)
JDBCLoginService(String name, IdentityService identityService, String config)
JDBCLoginService(String name, String config)

Method Summary

Modifier and Type	Method and Description
void	connectDatabase() (re)Connect to database with parameters setup by loadConfig()
protected void	doStart()
String	getConfig()
String[]	loadRoleInfo(MappedLoginService.KnownUser user)
protected UserIdentity	loadUser(String username) Deprecated.
MappedLoginService.KnownUser	loadUserInfo(String username)
protected void	loadUsers()
UserIdentity	login(String username, Object credentials, ServletRequest request) Login a user.
void	setConfig(String config) Load JDBC connection configuration from properties file.

Methods inherited from class org.eclipse.jetty.security.MappedLoginService

doStop, getIdentityService, getName, getUsers, logout, putUser, putUser, putUser, removeUser, setIdentityService, setName, setUsers, toString, validate

Methods inherited from class org.eclipse.jetty.util.component.AbstractLifeCycle

addLifeCycleListener, getState, getState, getStopTimeout, isFailed, isRunning, isStarted, isStarting, isStopped, isStopping, removeLifeCycleListener, setStopTimeout, start, stop

Methods inherited from class java.lang.Object

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

Field Detail

_config

protected String _config

_jdbcDriver

protected String _jdbcDriver

_url

protected String _url

_userName

protected String _userName

_password

protected String _password

_userTableKey

protected String _userTableKey

_userTablePasswordField

protected String _userTablePasswordField

_roleTableRoleField

protected String _roleTableRoleField

_cacheTime

protected int _cacheTime

_lastHashPurge

protected long _lastHashPurge

_con

protected Connection _con

_userSql

protected String _userSql

_roleSql

protected String _roleSql

Constructor Detail

JDBCLoginService

public JDBCLoginService()
                 throws IOException

Throws:

IOException

JDBCLoginService

public JDBCLoginService(String name)
                 throws IOException

Throws:

IOException

JDBCLoginService

public JDBCLoginService(String name,
                        String config)
                 throws IOException

Throws:

IOException

JDBCLoginService

public JDBCLoginService(String name,
                        IdentityService identityService,
                        String config)
                 throws IOException

Throws:

IOException

Method Detail

doStart

protected void doStart()
                throws Exception

Overrides:

doStart in class MappedLoginService

Throws:

Exception

See Also:

MappedLoginService.doStart()

getConfig

public String getConfig()

setConfig

public void setConfig(String config)

Load JDBC connection configuration from properties file.

Parameters:

config - Filename or url of user properties file.

connectDatabase

public void connectDatabase()

(re)Connect to database with parameters setup by loadConfig()

login

public UserIdentity login(String username,
                          Object credentials,
                          ServletRequest request)

Description copied from interface: LoginService

Login a user.

Specified by:

login in interface LoginService

Overrides:

login in class MappedLoginService

Parameters:

username - The user name

credentials - The users credentials

request - TODO

Returns:

A UserIdentity if the credentials matched, otherwise null

See Also:

LoginService.login(java.lang.String, java.lang.Object, ServletRequest)

loadUsers

protected void loadUsers()

Specified by:

loadUsers in class MappedLoginService

loadUser

@Deprecated
protected UserIdentity loadUser(String username)

Deprecated.

Specified by:

loadUser in class MappedLoginService

loadUserInfo

public MappedLoginService.KnownUser loadUserInfo(String username)

Specified by:

loadUserInfo in class MappedLoginService

See Also:

MappedLoginService.loadUserInfo(java.lang.String)

loadRoleInfo

public String[] loadRoleInfo(MappedLoginService.KnownUser user)

Specified by:

loadRoleInfo in class MappedLoginService

See Also:

MappedLoginService.loadRoleInfo(org.eclipse.jetty.security.MappedLoginService.KnownUser)