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, LifeCycle

public class JDBCLoginService
extends AbstractLoginService

HashMapped User Realm with JDBC as data source. The AbstractLoginService.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 AbstractLoginService.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.JDBCUserPrincipal JDBCKnownUser

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

AbstractLoginService.RolePrincipal, AbstractLoginService.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.Container

Container.InheritedListener, Container.Listener

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

LifeCycle.Listener

Field Summary

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

FAILED, RUNNING, STARTED, STARTING, STOPPED, STOPPING

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

KEY

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()
String	getConfig()
String[]	loadRoleInfo(AbstractLoginService.UserPrincipal user)
AbstractLoginService.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, dump, dump, dumpObject, dumpStdErr, getBean, getBeans, getBeans, getContainedBeans, isAuto, isManaged, isUnmanaged, manage, removeBean, removeBeans, removeEventListener, setBeans, setStopTimeout, unmanage, updateBean, updateBean, updateBeans

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

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

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

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

dumpContainer, dumpIterable, dumpMapEntries, dumpObjects, dumpSelf, named

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

start, stop

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

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()

loadUserInfo

public AbstractLoginService.UserPrincipal loadUserInfo(String username)

loadRoleInfo

public String[] loadRoleInfo(AbstractLoginService.UserPrincipal user)