JavaServer Faces

Name

<filter>

Synopsis

The <filter> element registers a filter component.

Syntax

<filter>
  [<description [xml:lang="lang"]>description</description>]*
  [<display-name [xml:lang="lang"]>displayName</display-name>]*
  [<icon [xml:lang="lang"]>
     [<small-icon>iconPath</small-icon>]
     [<large-icon>iconPath</large-icon>]
   </icon>]*
  <filter-name>filterName</filter-name>
  <filter-class>className</filter-class>
  [<init-param>
     [<description [xml:lang="lang"]>description</description>]*
     <param-name>paramName</param-name>
     <param-value>paramValue</param-value>
   </init-param>]*
</filter>

Nested <icon>, <display-name>, and <description> elements can optionally define icons and descriptions that can be used by a tool. The nested <filter-name> element defines a unique logical name for the filter, and the <filter-class> element the class name. A set of initialization parameters can optionally be defined by <init-param> elements.

<filter>
  <filter-name>accessControl</filter-name>
  <filter-class>com.mycomp.AccessControlFilter</filter-class>
  <init-param>
    <param-name>loginPage</param-name>
    <param-value>/login.jsp</param-value>
  </init-param>
</filter>