bboss.org.apache.velocity.app.event.implement

类 EscapeReference

java.lang.Object

bboss.org.apache.velocity.app.event.implement.EscapeReference

所有已实现的接口:

EventHandler, ReferenceInsertionEventHandler, RuntimeServicesAware

直接已知子类:

EscapeHtmlReference, EscapeJavaScriptReference, EscapeSqlReference, EscapeXmlReference

public abstract class EscapeReference
extends java.lang.Object
implements ReferenceInsertionEventHandler, RuntimeServicesAware

Base class for escaping references. To use it, override the following methods:

String escape(String text)

escape the provided text

String getMatchAttribute()

retrieve the configuration attribute used to match references (see below)

By default, all references are escaped. However, by setting the match attribute in the configuration file to a regular expression, users can specify which references to escape. For example the following configuration property tells the EscapeSqlReference event handler to only escape references that start with "sql". (e.g. $sql, $sql.toString(),, etc).

 eventhandler.escape.sql.match = /sql.*/
 
 

Regular expressions should follow the "Perl5" format used by the ORO regular expression library. More info is at http://jakarta.apache.org/oro/api/org/apache/oro/text/perl/package-summary.html.

从以下版本开始:

1.5

嵌套类概要

从接口继承的嵌套类/接口 bboss.org.apache.velocity.app.event.ReferenceInsertionEventHandler

ReferenceInsertionEventHandler.referenceInsertExecutor

构造器概要

构造器

构造器和说明
EscapeReference()

方法概要

限定符和类型	方法和说明
protected abstract java.lang.String	escape(java.lang.Object text) Escape the given text.
protected abstract java.lang.String	getMatchAttribute() Specify the configuration attribute that specifies the regular expression.
protected RuntimeServices	getRuntimeServices() Retrieve a reference to RuntimeServices.
java.lang.Object	referenceInsert(java.lang.String reference, java.lang.Object value) Escape the provided text if it matches the configured regular expression.
void	setRuntimeServices(RuntimeServices rs) Called automatically when event cartridge is initialized.

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

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

构造器详细资料

EscapeReference

public EscapeReference()

方法详细资料

escape

protected abstract java.lang.String escape(java.lang.Object text)

Escape the given text. Override this in a subclass to do the actual escaping.

参数:

text - the text to escape

返回:

the escaped text

getMatchAttribute

protected abstract java.lang.String getMatchAttribute()

Specify the configuration attribute that specifies the regular expression. Ideally should be in a form

eventhandler.escape.XYZ.match

where XYZ is the type of escaping being done.

返回:

configuration attribute

referenceInsert

public java.lang.Object referenceInsert(java.lang.String reference,
                                        java.lang.Object value)

Escape the provided text if it matches the configured regular expression.

指定者:

referenceInsert 在接口中 ReferenceInsertionEventHandler

参数:

reference -

value -

返回:

Escaped text.

setRuntimeServices

public void setRuntimeServices(RuntimeServices rs)

Called automatically when event cartridge is initialized.

指定者:

setRuntimeServices 在接口中 RuntimeServicesAware

参数:

rs - instance of RuntimeServices

getRuntimeServices

protected RuntimeServices getRuntimeServices()

Retrieve a reference to RuntimeServices. Use this for checking additional configuration properties.

返回:

The current runtime services object.