org.eclipse.jetty.security

类 PropertyUserStore

java.lang.Object

org.eclipse.jetty.util.component.AbstractLifeCycle

org.eclipse.jetty.security.PropertyUserStore

所有已实现的接口:

EventListener, org.eclipse.jetty.util.component.LifeCycle, org.eclipse.jetty.util.PathWatcher.Listener

public class PropertyUserStore
extends org.eclipse.jetty.util.component.AbstractLifeCycle
implements org.eclipse.jetty.util.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:.

嵌套类概要

嵌套类

限定符和类型	类和说明
static interface	PropertyUserStore.UserListener UserListener

从类继承的嵌套类/接口 org.eclipse.jetty.util.component.AbstractLifeCycle

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

从接口继承的嵌套类/接口 org.eclipse.jetty.util.component.LifeCycle

org.eclipse.jetty.util.component.LifeCycle.Listener

字段概要

字段

限定符和类型	字段和说明
protected Path	_configPath
protected org.eclipse.jetty.util.resource.Resource	_configResource
protected boolean	_firstLoad
protected IdentityService	_identityService
protected Map<String,org.eclipse.jetty.server.UserIdentity>	_knownUserIdentities
protected List<String>	_knownUsers
protected List<PropertyUserStore.UserListener>	_listeners
protected boolean	hotReload
protected org.eclipse.jetty.util.PathWatcher	pathWatcher

从类继承的字段 org.eclipse.jetty.util.component.AbstractLifeCycle

FAILED, RUNNING, STARTED, STARTING, STOPPED, STOPPING

构造器概要

构造器

构造器和说明
PropertyUserStore()

方法概要

限定符和类型	方法和说明
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()
String	getConfig() 已过时。 use getConfigPath() instead
Path	getConfigPath() Get the Config Path reference.
org.eclipse.jetty.util.resource.Resource	getConfigResource()
org.eclipse.jetty.server.UserIdentity	getUserIdentity(String userName)
boolean	isHotReload() Is hot reload enabled on this user store
protected void	loadUsers()
void	onPathWatchEvent(org.eclipse.jetty.util.PathWatcher.PathWatchEvent event)
void	registerUserListener(PropertyUserStore.UserListener listener) registers a listener to be notified of the contents of the property file
void	setConfig(String configFile) 已过时。 use setConfigPath(String) instead
void	setConfigPath(File configFile) Set the Config Path from a File reference
void	setConfigPath(Path configPath) Set the Config Path
void	setConfigPath(String configFile) Set the Config Path from a String reference to a file
void	setHotReload(boolean enable) Enable Hot Reload of the Property File
String	toString()

从类继承的方法 org.eclipse.jetty.util.component.AbstractLifeCycle

addLifeCycleListener, getState, getState, getStopTimeout, isFailed, isRunning, isStarted, isStarting, isStopped, isStopping, removeLifeCycleListener, setStopTimeout, start, stop

从类继承的方法 java.lang.Object

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

字段详细资料

_configPath

protected Path _configPath

_configResource

protected org.eclipse.jetty.util.resource.Resource _configResource

pathWatcher

protected org.eclipse.jetty.util.PathWatcher pathWatcher

hotReload

protected boolean hotReload

_identityService

protected IdentityService _identityService

_firstLoad

protected boolean _firstLoad

_knownUsers

protected final List<String> _knownUsers

_knownUserIdentities

protected final Map<String,org.eclipse.jetty.server.UserIdentity> _knownUserIdentities

_listeners

protected List<PropertyUserStore.UserListener> _listeners

构造器详细资料

PropertyUserStore

public PropertyUserStore()

方法详细资料

getConfig

@Deprecated
public String getConfig()

已过时。 use getConfigPath() instead

Get the config (as a string)

返回:

the config path as a string

setConfig

@Deprecated
public void setConfig(String configFile)

已过时。 use setConfigPath(String) instead

Set the Config Path from a String reference to a file

参数:

configFile - the config file

getConfigPath

public Path getConfigPath()

Get the Config Path reference.

返回:

the config path

setConfigPath

public void setConfigPath(String configFile)

Set the Config Path from a String reference to a file

参数:

configFile - the config file

setConfigPath

public void setConfigPath(File configFile)

Set the Config Path from a File reference

参数:

configFile - the config file

setConfigPath

public void setConfigPath(Path configPath)

Set the Config Path

参数:

configPath - the config path

getUserIdentity

public org.eclipse.jetty.server.UserIdentity getUserIdentity(String userName)

getConfigResource

public org.eclipse.jetty.util.resource.Resource getConfigResource()
                                                           throws IOException

返回:

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

抛出:

IOException - if unable to get the resource

isHotReload

public boolean isHotReload()

Is hot reload enabled on this user store

返回:

true if hot reload was enabled before startup

setHotReload

public void setHotReload(boolean enable)

Enable Hot Reload of the Property File

参数:

enable - true to enable, false to disable

toString

public String toString()

覆盖:

toString 在类中 Object

loadUsers

protected void loadUsers()
                  throws IOException

抛出:

IOException

doStart

protected void doStart()
                throws 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.

覆盖:

doStart 在类中 org.eclipse.jetty.util.component.AbstractLifeCycle

抛出:

Exception

另请参阅:

AbstractLifeCycle.doStart()

onPathWatchEvent

public void onPathWatchEvent(org.eclipse.jetty.util.PathWatcher.PathWatchEvent event)

指定者:

onPathWatchEvent 在接口中 org.eclipse.jetty.util.PathWatcher.Listener

doStop

protected void doStop()
               throws Exception

覆盖:

doStop 在类中 org.eclipse.jetty.util.component.AbstractLifeCycle

抛出:

Exception

另请参阅:

AbstractLifeCycle.doStop()

registerUserListener

public void registerUserListener(PropertyUserStore.UserListener listener)

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

参数:

listener - the user listener