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:

java.util.EventListener, LifeCycle, PathWatcher.Listener

public class PropertyUserStore
extends UserStore
implements PathWatcher.Listener

PropertyUserStore

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

Modifier and Type	Class	Description
static interface	PropertyUserStore.UserListener	UserListener

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

Modifier and Type	Field	Description
protected java.nio.file.Path	_configPath
protected Resource	_configResource
protected boolean	_firstLoad
protected java.util.List<PropertyUserStore.UserListener>	_listeners
protected boolean	hotReload
protected PathWatcher	pathWatcher

Fields inherited from class org.eclipse.jetty.util.component.AbstractLifeCycle

FAILED, RUNNING, STARTED, STARTING, STOP_ON_FAILURE, STOPPED, STOPPING

Constructor Summary

Constructors

Constructor	Description
PropertyUserStore()

Method Summary

Modifier and Type	Method	Description
protected void	doStart()	Depending on the value of the refresh interval, this method will either start up a scanner thread that will monitor the properties file for changes after it has initially loaded it.
protected void	doStop()
java.lang.String	getConfig()	Deprecated. use getConfigPath() instead
java.nio.file.Path	getConfigPath()	Get the Config Path reference.
Resource	getConfigResource()
boolean	isHotReload()	Is hot reload enabled on this user store
protected void	loadUsers()
void	onPathWatchEvent(PathWatcher.PathWatchEvent event)
void	registerUserListener(PropertyUserStore.UserListener listener)	registers a listener to be notified of the contents of the property file
void	setConfig(java.lang.String config)	Set the Config Path from a String reference to a file
void	setConfigPath(java.io.File configFile)	Set the Config Path from a File reference
void	setConfigPath(java.lang.String configFile)	Set the Config Path from a String reference to a file
void	setConfigPath(java.nio.file.Path configPath)	Set the Config Path
void	setHotReload(boolean enable)	Enable Hot Reload of the Property File
java.lang.String	toString()

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 interface org.eclipse.jetty.util.component.LifeCycle

start, stop

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from class org.eclipse.jetty.security.UserStore

addUser, getIdentityService, getKnownUserIdentities, getUserIdentity, removeUser

Field Detail

_configPath

protected java.nio.file.Path _configPath

_configResource

protected Resource _configResource

pathWatcher

protected PathWatcher pathWatcher

hotReload

protected boolean hotReload

_firstLoad

protected boolean _firstLoad

_listeners

protected java.util.List<PropertyUserStore.UserListener> _listeners

Constructor Detail

PropertyUserStore

public PropertyUserStore()

Method Detail

getConfig

@Deprecated
public java.lang.String getConfig()

Deprecated. use getConfigPath() instead

Get the config (as a string)

Returns:

the config path as a string

setConfig

public void setConfig(java.lang.String config)

Set the Config Path from a String reference to a file

Parameters:

config - the config file

getConfigPath

public java.nio.file.Path getConfigPath()

Get the Config Path reference.

Returns:

the config path

setConfigPath

public void setConfigPath(java.lang.String configFile)

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

public void setConfigPath(java.io.File configFile)

Set the Config Path from a File reference

Parameters:

configFile - the config file

setConfigPath

public void setConfigPath(java.nio.file.Path configPath)

Set the Config Path

Parameters:

configPath - the config path

getConfigResource

public Resource getConfigResource()
                           throws java.io.IOException

Returns:

the resource associated with the configured properties file, creating it if necessary

Throws:

java.io.IOException - if unable to get the resource

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

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

loadUsers

protected void loadUsers()
                  throws java.io.IOException

Throws:

java.io.IOException

doStart

protected void doStart()
                throws java.lang.Exception

Depending on the value of the refresh interval, this method will either start up a scanner thread that will monitor the properties file for changes after it has initially loaded it. Otherwise the users will be loaded and there will be no active monitoring thread so changes will not be detected.

Overrides:

doStart in class AbstractLifeCycle

Throws:

java.lang.Exception

See Also:

AbstractLifeCycle.doStart()

onPathWatchEvent

public void onPathWatchEvent(PathWatcher.PathWatchEvent event)

Specified by:

onPathWatchEvent in interface PathWatcher.Listener

doStop

protected void doStop()
               throws java.lang.Exception

Overrides:

doStop in class AbstractLifeCycle

Throws:

java.lang.Exception

See Also:

AbstractLifeCycle.doStop()

registerUserListener

public void registerUserListener(PropertyUserStore.UserListener listener)

registers a listener to be notified of the contents of the property file

Parameters:

listener - the user listener