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, org.eclipse.jetty.util.component.Container, org.eclipse.jetty.util.component.Destroyable, org.eclipse.jetty.util.component.Dumpable, org.eclipse.jetty.util.component.Dumpable.DumpableContainer, org.eclipse.jetty.util.component.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

    org.eclipse.jetty.util.component.AbstractLifeCycle.AbstractLifeCycleListener

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

    org.eclipse.jetty.util.component.Container.InheritedListener, org.eclipse.jetty.util.component.Container.Listener

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

    org.eclipse.jetty.util.component.Dumpable.DumpableContainer

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

    org.eclipse.jetty.util.component.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, 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()
     
    protected void
    doStop()
     
    String
    getConfig()
     
    org.eclipse.jetty.util.resource.Resource
    getConfigResource()
    Deprecated.
    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 config)
    Load realm 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, 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

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

    • getConfigResource

      @Deprecated public org.eclipse.jetty.util.resource.Resource getConfigResource()
      Deprecated.

    • setConfig

      public void setConfig(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 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 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 org.eclipse.jetty.util.component.ContainerLifeCycle
      Throws:
      Exception
      See Also:
      • AbstractLifeCycle.doStart()

    • doStop

      protected void doStop() throws Exception
      Overrides:
      doStop in class org.eclipse.jetty.util.component.ContainerLifeCycle
      Throws:
      Exception
      See Also:
      • AbstractLifeCycle.doStop()