Package org.eclipse.jetty.security

Class PropertyUserStore

java.lang.Object
org.eclipse.jetty.util.component.AbstractLifeCycle
org.eclipse.jetty.security.UserStore
org.eclipse.jetty.security.PropertyUserStore
All Implemented Interfaces:
EventListener, LifeCycle, PathWatcher.Listener
@Deprecated(since="2021-05-27") public class PropertyUserStore extends UserStore implements PathWatcher.Listener
Deprecated.
The Eclipse Jetty and Apache Felix Http Jetty packages are no longer supported.

This class monitors a property file of the format mentioned below and notifies registered listeners of the changes to the the given file.

   username: password [,rolename ...]

Passwords may be clear text, obfuscated or checksummed. The class 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 obfuscated.

  • Constructor Details

    • PropertyUserStore

      public PropertyUserStore()
      Deprecated.

  • Method Details

    • getConfig

      public String getConfig()
      Deprecated.
      Get the config (as a string)
      Returns:
      the config path as a string

    • setConfig

      public void setConfig(String config)
      Deprecated.
      Set the Config Path from a String reference to a file
      Parameters:
      config - the config file

    • getConfigPath

      public Path getConfigPath()
      Deprecated.
      Get the Config Path reference.
      Returns:
      the config path

    • setConfigPath

      @Deprecated public void setConfigPath(String configFile)
      Deprecated.
      Set the Config Path from a String reference to a file
      Parameters:
      configFile - the config file can a be a file path or a reference to a file within a jar file jar:file:

    • setConfigPath

      @Deprecated public void setConfigPath(File configFile)
      Deprecated.
      Set the Config Path from a File reference
      Parameters:
      configFile - the config file

    • setConfigFile

      public void setConfigFile(File configFile)
      Deprecated.
      Set the Config Path from a File reference
      Parameters:
      configFile - the config file

    • setConfigPath

      public void setConfigPath(Path configPath)
      Deprecated.
      Set the Config Path
      Parameters:
      configPath - the config path

    • getConfigResource

      public Resource getConfigResource()
      Deprecated.
      Returns:
      the resource associated with the configured properties file, creating it if necessary

    • isHotReload

      public boolean isHotReload()
      Deprecated.
      Is hot reload enabled on this user store
      Returns:
      true if hot reload was enabled before startup

    • setHotReload

      public void setHotReload(boolean enable)
      Deprecated.
      Enable Hot Reload of the Property File
      Parameters:
      enable - true to enable, false to disable

    • toString

      public String toString()
      Deprecated.
      Overrides:
      toString in class AbstractLifeCycle

    • onPathWatchEvent

      public void onPathWatchEvent(PathWatcher.PathWatchEvent event)
      Deprecated.
      Specified by:
      onPathWatchEvent in interface PathWatcher.Listener

    • registerUserListener

      public void registerUserListener(PropertyUserStore.UserListener listener)
      Deprecated.
      Registers a listener to be notified of the contents of the property file
      Parameters:
      listener - the user listener