Package org.eclipse.jetty.security

Class JDBCLoginService

java.lang.Object

org.eclipse.jetty.util.component.AbstractLifeCycle

org.eclipse.jetty.util.component.ContainerLifeCycle

org.eclipse.jetty.security.AbstractLoginService

org.eclipse.jetty.security.JDBCLoginService

All Implemented Interfaces:

LoginService, Container, Destroyable, Dumpable, Dumpable.DumpableContainer, LifeCycle

public class JDBCLoginService
extends AbstractLoginService

JDBC as a source of user authentication and authorization information. Uses one database connection that is lazily initialized. Reconnect on failures.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	JDBCLoginService.JDBCUserPrincipal	A UserPrincipal with extra jdbc key info.

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

AbstractLifeCycle.AbstractLifeCycleListener, AbstractLifeCycle.StopException

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

Container.InheritedListener, Container.Listener

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

Dumpable.DumpableContainer

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

LifeCycle.Listener

Field Summary

Fields

Modifier and Type	Field	Description
protected Connection	_con
protected String	_config
protected String	_jdbcDriver
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.AbstractLoginService

_fullValidate, _identityService, _name

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

FAILED, STARTED, STARTING, STOPPED, STOPPING

Fields inherited from interface org.eclipse.jetty.util.component.Dumpable

KEY

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
Connection	connectDatabase()	Connect to database with parameters setup by loadConfig()
protected void	doStart()	Starts the managed lifecycle beans in the order they were added.
protected void	doStop()	Stops the managed lifecycle beans in the reverse order they were added.
String	getConfig()
List<RolePrincipal>	loadRoleInfo(UserPrincipal user)
UserPrincipal	loadUserInfo(String username)
void	setConfig(String config)	Load JDBC connection configuration from properties file.

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

getIdentityService, getName, isFullValidate, login, logout, setFullValidate, setIdentityService, setName, toString, validate

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

addBean, addBean, addEventListener, addManaged, contains, destroy, dump, dump, dump, dumpObjects, dumpStdErr, getBean, getBeans, getBeans, getContainedBeans, getContainedBeans, installBean, installBean, isAuto, isManaged, isUnmanaged, manage, removeBean, removeBeans, removeEventListener, setBeans, start, stop, unmanage, updateBean, updateBean, updateBeans, updateBeans

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

getEventListeners, getState, getState, isFailed, isRunning, isStarted, isStarting, isStopped, isStopping, setEventListeners, start, stop

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.eclipse.jetty.util.component.Container

getCachedBeans, getEventListeners

Methods inherited from interface org.eclipse.jetty.util.component.Dumpable

dumpSelf

Methods inherited from interface org.eclipse.jetty.util.component.Dumpable.DumpableContainer

isDumpable

Methods inherited from interface org.eclipse.jetty.security.LoginService

getUserIdentity

Field Details

_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

_userSql

protected String _userSql

_roleSql

protected String _roleSql

_con

protected Connection _con

Constructor Details

JDBCLoginService

public JDBCLoginService()

JDBCLoginService

public JDBCLoginService(String name)

JDBCLoginService

public JDBCLoginService(String name,
 String config)

JDBCLoginService

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

Method Details

doStart

protected void doStart()
                throws Exception

Description copied from class: ContainerLifeCycle

Starts the managed lifecycle beans in the order they were added.

Overrides:

doStart in class ContainerLifeCycle

Throws:

AbstractLifeCycle.StopException - If thrown, the lifecycle will immediately be stopped.

Exception - If there was a problem starting. Will cause a transition to FAILED state

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 Connection connectDatabase()
                           throws SQLException

Connect to database with parameters setup by loadConfig()

Throws:

SQLException

loadUserInfo

public UserPrincipal loadUserInfo(String username)

Specified by:

loadUserInfo in class AbstractLoginService

loadRoleInfo

public List<RolePrincipal> loadRoleInfo(UserPrincipal user)

Specified by:

loadRoleInfo in class AbstractLoginService

doStop

protected void doStop()
               throws Exception

Description copied from class: ContainerLifeCycle

Stops the managed lifecycle beans in the reverse order they were added.

Overrides:

doStop in class ContainerLifeCycle

Throws:

Exception - If there was a problem stopping. Will cause a transition to FAILED state