ZEST Filter"

From Documentation
m (Created page with "{{ZESTEssentialsPageHeader}} =Version History= {{LastUpdated}} {| border='1px' | width="100%" ! Version !! Date !! Content |- |   |   |   |} {{ZESTEssentialsPage...")
 
 
Line 1: Line 1:
 
{{ZESTEssentialsPageHeader}}
 
{{ZESTEssentialsPageHeader}}
 +
 +
=ZestFilter=
 +
[Required] Class: <javadoc directory="zest">org.zkoss.zest.sys.ZestFilter</javadoc>
 +
 +
ZEST filter is used to intercept every request sent to a server. It must be configured for any Web application that would like to use ZEST.
 +
 +
= The Initial Parameters =
 +
 +
{| border="1"
 +
! <center>init-param</center>
 +
! <center>Descriptions</center>
 +
 +
|-
 +
|  manager-class
 +
|  [Optional][Default: <javadoc directory="zest">org.zkoss.zest.sys.ZestManager</javadoc>]
 +
 +
It specifies the class of ZEST manager to use.  Since <javadoc directory="zest">org.zkoss.zest.sys.ZestFilter</javadoc> depends on ZEST manager to finish all the jobs, replacing ZEST manager with a custom implementation could generally replace all the default behaviors you want.
 +
 +
The specified class must extend from <javadoc directory="zest">org.zkoss.zest.sys.ZestManager</javadoc>.
 +
 +
|-
 +
|  parser-class
 +
|  [Optional][Default: <javadoc directory="zest">org.zkoss.zest.sys.impl.ParserImpl</javadoc>]
 +
 +
It specifies the class used to parse [[ZEST Essentials/Configuration/zest.xml|WEB-INF/zest.xml]].
 +
 +
The specified class must implement <javadoc directory="zest">org.zkoss.zest.sys.Parser</javadoc>, though it is generally easier to extend from <javadoc directory="zest">org.zkoss.zest.sys.impl.ParserImpl</javadoc>.
 +
|}
 +
 +
=Map URL to ZEST Filter=
 +
Technically, you could map ZEST filter to any URL you'd like, but it is generally recommended to map it to <code>/*</code>. For example,
 +
 +
<source lang="xml">
 +
<web-app>
 +
    <filter>
 +
        <filter-name>zest</filter-name>
 +
        <filter-class>org.zkoss.zest.sys.ZestFilter</filter-class>
 +
    </filter>
 +
    <filter-mapping>
 +
        <filter-name>zest</filter-name>
 +
        <url-pattern>/*</url-pattern>
 +
    </filter-mapping>
 +
</web-app>
 +
</source>
  
 
=Version History=
 
=Version History=

Latest revision as of 05:07, 14 March 2011


ZestFilter

[Required] Class: ZestFilter

ZEST filter is used to intercept every request sent to a server. It must be configured for any Web application that would like to use ZEST.

The Initial Parameters

init-param
Descriptions
manager-class [Optional][Default: ZestManager]

It specifies the class of ZEST manager to use. Since ZestFilter depends on ZEST manager to finish all the jobs, replacing ZEST manager with a custom implementation could generally replace all the default behaviors you want.

The specified class must extend from ZestManager.

parser-class [Optional][Default: ParserImpl]

It specifies the class used to parse WEB-INF/zest.xml.

The specified class must implement Parser, though it is generally easier to extend from ParserImpl.

Map URL to ZEST Filter

Technically, you could map ZEST filter to any URL you'd like, but it is generally recommended to map it to /*. For example,

<web-app>
    <filter>
        <filter-name>zest</filter-name>
        <filter-class>org.zkoss.zest.sys.ZestFilter</filter-class>
    </filter>
    <filter-mapping>
        <filter-name>zest</filter-name>
        <url-pattern>/*</url-pattern>
    </filter-mapping>
</web-app>

Version History

Last Update : 2011/03/14


Version Date Content
     



Last Update : 2011/03/14

Copyright © Potix Corporation. This article is licensed under GNU Free Documentation License.