The <filter> Element

Purpose

The <filter> element defines an action filter.

Either the class attribute or the name attribute can be used to specify the filter class.

The when attribute may contain an EL expression to conditionally include the filter during action processing.

Attributes

NameTypeDescription
class CDATA Dynamic - The name of a class implementing the Filter interface.
name NMTOKEN The name, under which a filter class has been registered by a plugin.
when CDATA Dynamic - An EL expression (without "${" and "}"). If given, the expression is evaluated to a boolean value during action processing. If it evaluates to false, the module skips the filter when executing the filter chain.

Body

The body of the <filter> element is defined by the following sequence:

(param*,dispatch*)

Related elements

<param>, <dispatch>, <action>