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
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.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
-
-
Constructor Summary
Constructors Constructor Description HashLoginService()
HashLoginService(java.lang.String name)
HashLoginService(java.lang.String name, java.lang.String config)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods 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.java.lang.String
getConfig()
Resource
getConfigResource()
Deprecated.boolean
isHotReload()
Is hot reload enabled on this user storeprotected java.lang.String[]
loadRoleInfo(AbstractLoginService.UserPrincipal user)
protected AbstractLoginService.UserPrincipal
loadUserInfo(java.lang.String userName)
void
setConfig(java.lang.String config)
Load realm users from properties file.void
setHotReload(boolean enable)
Enable Hot Reload of the Property Filevoid
setUserStore(UserStore userStore)
Configure theUserStore
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, dump, dump, dumpBeans, dumpObject, dumpObjects, dumpStdErr, dumpThis, getBean, getBeans, getBeans, getContainedBeans, getContainedBeans, isAuto, isManaged, isUnmanaged, manage, removeBean, removeBeans, removeEventListener, setBeans, setStopTimeout, start, stop, 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
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface org.eclipse.jetty.util.component.Dumpable.DumpableContainer
isDumpable
-
-
-
-
Method Detail
-
getConfig
public java.lang.String getConfig()
-
getConfigResource
@Deprecated public Resource getConfigResource()
Deprecated.
-
setConfig
public void setConfig(java.lang.String config)
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:
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 theUserStore
implementation to use. If none, for backward compat if none thePropertyUserStore
will be used- Parameters:
userStore
- theUserStore
implementation to use
-
loadRoleInfo
protected java.lang.String[] loadRoleInfo(AbstractLoginService.UserPrincipal user)
- Specified by:
loadRoleInfo
in classAbstractLoginService
-
loadUserInfo
protected AbstractLoginService.UserPrincipal loadUserInfo(java.lang.String userName)
- Specified by:
loadUserInfo
in classAbstractLoginService
-
doStart
protected void doStart() throws java.lang.Exception
Description copied from class:ContainerLifeCycle
Starts the managed lifecycle beans in the order they were added.- Overrides:
doStart
in classContainerLifeCycle
- Throws:
java.lang.Exception
- See Also:
AbstractLifeCycle.doStart()
-
doStop
protected void doStop() throws java.lang.Exception
Description copied from class:ContainerLifeCycle
Stops the managed lifecycle beans in the reverse order they were added.- Overrides:
doStop
in classContainerLifeCycle
- Throws:
java.lang.Exception
- See Also:
AbstractLifeCycle.doStop()
-
-