org.eclipse.jetty.security

Class HashLoginService

java.lang.Object

org.eclipse.jetty.util.component.AbstractLifeCycle

org.eclipse.jetty.security.AbstractLoginService

org.eclipse.jetty.security.HashLoginService

All Implemented Interfaces:

LoginService, LifeCycle

public class HashLoginService
extends AbstractLoginService

Properties User Realm.

An implementation of UserRealm that stores users and roles in-memory in HashMaps.

Typically these maps are populated by calling the load() method or passing a properties resource to the constructor. The format of the properties file is:

  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.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.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, RUNNING, STARTED, STARTING, STOP_ON_FAILURE, STOPPED, STOPPING

Constructor Summary

Constructors

Constructor and Description
HashLoginService()
HashLoginService(String name)
HashLoginService(String name, String config)

Method Summary

Modifier and Type	Method and Description
protected void	doStart()
protected void	doStop()
String	getConfig()
void	getConfig(String config) Deprecated. use setConfig(String) instead
Resource	getConfigResource()
boolean	isHotReload() Is hot reload enabled on this user store
protected String[]	loadRoleInfo(AbstractLoginService.UserPrincipal user)
protected AbstractLoginService.UserPrincipal	loadUserInfo(String userName)
void	setConfig(String configFile) Load realm users from properties file.
void	setHotReload(boolean enable) Enable Hot Reload of the Property 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.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

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

start, stop

Constructor Detail

HashLoginService

public HashLoginService()

HashLoginService

public HashLoginService(String name)

HashLoginService

public HashLoginService(String name,
                        String config)

Method Detail

getConfig

public String getConfig()

getConfig

@Deprecated
public void getConfig(String config)

Deprecated. use setConfig(String) instead

getConfigResource

public Resource getConfigResource()

setConfig

public void setConfig(String configFile)

Load realm users from properties file.

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

Parameters:

configFile - Filename of user 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

loadRoleInfo

protected String[] loadRoleInfo(AbstractLoginService.UserPrincipal user)

Specified by:

loadRoleInfo in class AbstractLoginService

loadUserInfo

protected AbstractLoginService.UserPrincipal loadUserInfo(String userName)

Specified by:

loadUserInfo in class AbstractLoginService

doStart

protected void doStart()
                throws Exception

Overrides:

doStart in class AbstractLifeCycle

Throws:

Exception

See Also:

AbstractLifeCycle.doStart()

doStop

protected void doStop()
               throws Exception

Overrides:

doStop in class AbstractLifeCycle

Throws:

Exception

See Also:

AbstractLifeCycle.doStop()