类 SafeConfig
- 直接已知子类:
AbstractLockConfig
,AlternatorTool
,ClassTool
,ContextTool
,EscapeTool
,FieldTool
,LinkTool
,LocaleConfig
,MarkupTool
,RenderTool
,XmlTool
Implements common logic and constants for tools which automatically
locks down the public void configure(Map params)
method after
it is called once.
This keeps application or session scoped tools thread-safe in templates,
which generally have access to the tool after configuration has happened.
It also provides for a separate "safe mode" setting which tells
tools to block any functions that may pose a security threat. This,
of course, is set to true
by default.
Once "locked down", the configure(Map)
may still be called,
however it will do nothing (unless some subclass is foolish enough to
override it and not check if isConfigLocked()
before changing
configurations. The proper method for subclasses to override is
configure(ValueParser)
which will only be called by
configure(Map)
when the isConfigLocked()
is false
(i.e. the first time only).
- 从以下版本开始:
- VelocityTools 2.0
- 作者:
- Nathan Bubna
-
字段概要
字段 -
构造器概要
构造器 -
方法概要
修饰符和类型方法说明void
IfisConfigLocked()
returnstrue
, then this method does nothing; otherwise, iffalse
, this will create a newValueParser
from the specified Map of params and callconfigure(ValueParser)
with it.protected void
configure
(ValueParser values) Does the actual configuration.boolean
Returnstrue
if theconfigure(Map)
method has been locked.boolean
Returnstrue
if this tool is in "safe mode".protected void
setLockConfig
(boolean lock) Only allow subclass access to this.protected void
setSafeMode
(boolean safe)
-
字段详细资料
-
LOCK_CONFIG_KEY
The key used for specifying whether or not to prevent templates from reconfiguring this tool. The default is true.- 另请参阅:
-
OLD_LOCK_CONFIG_KEY
已过时。- 另请参阅:
-
SAFE_MODE_KEY
Many tools interested in locking configure() also have other things they wish to secure. This key controls that property. The default value is true, of course.- 另请参阅:
-
configLocked
private boolean configLocked -
safeMode
private boolean safeMode
-
-
构造器详细资料
-
SafeConfig
public SafeConfig()
-
-
方法详细资料
-
setLockConfig
protected void setLockConfig(boolean lock) Only allow subclass access to this. -
setSafeMode
protected void setSafeMode(boolean safe) -
isConfigLocked
public boolean isConfigLocked()Returnstrue
if theconfigure(Map)
method has been locked. -
isSafeMode
public boolean isSafeMode()Returnstrue
if this tool is in "safe mode". -
configure
IfisConfigLocked()
returnstrue
, then this method does nothing; otherwise, iffalse
, this will create a newValueParser
from the specified Map of params and callconfigure(ValueParser)
with it. Then this will check the parameters itself to find out whether or not the configuration for this tool should be put into safe mode or have its config locked. The safe mode value should be a boolean under the keySAFE_MODE_KEY
and the lock value should be a boolean under the keyLOCK_CONFIG_KEY
. -
configure
Does the actual configuration. This is protected, so subclasses may share the same ValueParser and call configure at any time, while preventing templates from doing so when configure(Map) is locked.
-