Package org.zkoss.zk.ui.http
Class RichletFilter
- java.lang.Object
-
- org.zkoss.zk.ui.http.RichletFilter
-
- All Implemented Interfaces:
jakarta.servlet.Filter
public class RichletFilter extends java.lang.Object implements jakarta.servlet.Filter
A filter used for ZK RichletTo enable this filter, you can specify the following statement into web.xml and zk.xml. For example,
In the zk.xml<filter> <filter-name>RichletFilter</filter-name> <filter-class>org.zkoss.zk.ui.http.RichletFilter</filter-class> </filter> <filter-mapping> <filter-name>RichletFilter</filter-name> <url-pattern>/zk/*</url-pattern> </filter-mapping>
Note: The url-pattern of richlet-mapping should start with /zk in this example which is the filter-mapping mapping to.<richlet> <richlet-name>Foo</richlet-name> <richlet-class>foo.FooRichlet</richlet-class> <init-param> <param-name>any</param-name> <param-value>any</param-value> </init-param> </richlet> <richlet-mapping> <richlet-name>Foo</richlet-name> <url-pattern>/zk/foo/*</url-pattern> </richlet-mapping>
Init parameters:
- compress
- It specifies whether to compress the output if the browser supports the compression (Accept-Encoding) and this Filter is not included by other Filters.
- Since:
- 7.0.0
- Author:
- jumperchen
-
-
Field Summary
Fields Modifier and Type Field Description protected boolean
_compress
protected jakarta.servlet.FilterConfig
_config
protected WebManager
_webman
protected static java.lang.String
RICHLET_FLAG
-
Constructor Summary
Constructors Constructor Description RichletFilter()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
destroy()
void
doFilter(jakarta.servlet.ServletRequest request, jakarta.servlet.ServletResponse response, jakarta.servlet.FilterChain chain)
void
init(jakarta.servlet.FilterConfig config)
protected boolean
process(Session sess, jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response, java.lang.String originPath, boolean bRichlet)
-
-
-
Field Detail
-
_config
protected jakarta.servlet.FilterConfig _config
-
_webman
protected WebManager _webman
-
_compress
protected boolean _compress
-
RICHLET_FLAG
protected static final java.lang.String RICHLET_FLAG
-
-
Method Detail
-
init
public void init(jakarta.servlet.FilterConfig config) throws jakarta.servlet.ServletException
- Specified by:
init
in interfacejakarta.servlet.Filter
- Throws:
jakarta.servlet.ServletException
-
doFilter
public void doFilter(jakarta.servlet.ServletRequest request, jakarta.servlet.ServletResponse response, jakarta.servlet.FilterChain chain) throws java.io.IOException, jakarta.servlet.ServletException
- Specified by:
doFilter
in interfacejakarta.servlet.Filter
- Throws:
java.io.IOException
jakarta.servlet.ServletException
-
process
protected boolean process(Session sess, jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response, java.lang.String originPath, boolean bRichlet) throws jakarta.servlet.ServletException, java.io.IOException
- Throws:
jakarta.servlet.ServletException
java.io.IOException
-
destroy
public void destroy()
- Specified by:
destroy
in interfacejakarta.servlet.Filter
-
-