Package org.eclipse.jetty.security

Class HashLoginService

java.lang.Object

org.eclipse.jetty.util.component.AbstractLifeCycle

org.eclipse.jetty.util.component.ContainerLifeCycle

org.eclipse.jetty.security.AbstractLoginService

org.eclipse.jetty.security.HashLoginService

All Implemented Interfaces:

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

public class HashLoginService
extends AbstractLoginService

An implementation of a LoginService that stores users and roles in-memory in HashMaps. The source of the users and roles information is a properties file formatted like so:

  username: password [,rolename ...]
 

Passwords may be clear text, obfuscated or checksummed. The class com.eclipse.Util.Password should be used to generate obfuscated passwords or password checksums.

If DIGEST Authentication is used, the password must be in a recoverable format, either plain text or OBF:.

Nested Class Summary

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 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
HashLoginService()
HashLoginService(String name)
HashLoginService(String name, String config)

Method Summary

Modifier and Type	Method	Description
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()
boolean	isHotReload()	Is hot reload enabled on this user store
protected List<RolePrincipal>	loadRoleInfo(UserPrincipal user)
protected UserPrincipal	loadUserInfo(String userName)
void	setConfig(String config)	Load users from properties file.
void	setHotReload(boolean enable)	Enable Hot Reload of the Property File
void	setUserStore(UserStore userStore)	Configure the UserStore implementation to use.

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

Constructor Details

HashLoginService

public HashLoginService()

HashLoginService

public HashLoginService(String name)

HashLoginService

public HashLoginService(String name,
 String config)

Method Details

getConfig

public String getConfig()

setConfig

public void setConfig(String config)

Load users from properties file.

The property file maps usernames to password specs followed by an optional comma separated list of role names.

Parameters:

config - uri or url or path to realm properties file

isHotReload

public boolean isHotReload()

Is hot reload enabled on this user store

Returns:

true if hot reload was enabled before startup

setHotReload

public void setHotReload(boolean enable)

Enable Hot Reload of the Property File

Parameters:

enable - true to enable, false to disable

setUserStore

public void setUserStore(UserStore userStore)

Configure the UserStore implementation to use. If none, for backward compat if none the PropertyUserStore will be used

Parameters:

userStore - the UserStore implementation to use

loadRoleInfo

protected List<RolePrincipal> loadRoleInfo(UserPrincipal user)

Specified by:

loadRoleInfo in class AbstractLoginService

loadUserInfo

protected UserPrincipal loadUserInfo(String userName)

Specified by:

loadUserInfo in class AbstractLoginService

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:

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

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