|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.zkoss.web.servlet.GenericFilter
public abstract class GenericFilter
A generic class to help implementing servlet filter. Its role is like javax.servlet.GenericServlet to javax.servlet.Servlet.
Field Summary | |
---|---|
protected javax.servlet.FilterConfig |
_config
|
Constructor Summary | |
---|---|
protected |
GenericFilter()
|
Method Summary | |
---|---|
void |
destroy()
Called by the web container to indicate to a filter that it is being taken out of service. |
protected void |
forward(javax.servlet.ServletRequest request,
javax.servlet.ServletResponse response,
java.lang.String uri)
Forward to the specified page. |
protected void |
forward(javax.servlet.ServletRequest request,
javax.servlet.ServletResponse response,
java.lang.String uri,
java.util.Map params,
int mode)
Forward to the specified page with parameters. |
java.lang.String |
getFilterName()
Returns the filter's name. |
java.lang.String |
getInitParameter(java.lang.String name)
Returns a String containing the value of the named initialization parameter, or null if the parameter does not exist. |
java.util.Enumeration |
getInitParameterNames()
Returns a String containing the value of the named initialization parameter, or null if the parameter does not exist. |
javax.servlet.ServletContext |
getServletContext()
Returns the servlet context in which this filter is running. |
protected void |
include(javax.servlet.ServletRequest request,
javax.servlet.ServletResponse response,
java.lang.String uri)
Includes the specified page. |
protected void |
include(javax.servlet.ServletRequest request,
javax.servlet.ServletResponse response,
java.lang.String uri,
java.util.Map params,
int mode)
Includes the specified page with parameters. |
protected void |
init()
A convenience method which can be overridden so that there's no need to call super.init(config). |
void |
init(javax.servlet.FilterConfig config)
Called by the web container to indicate to a filter that it is being placed into service. |
protected void |
sendRedirect(javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response,
java.lang.String page,
java.util.Map params,
int mode)
Redirects to another page. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface javax.servlet.Filter |
---|
doFilter |
Field Detail |
---|
protected javax.servlet.FilterConfig _config
Constructor Detail |
---|
protected GenericFilter()
Method Detail |
---|
protected void init() throws javax.servlet.ServletException
javax.servlet.ServletException
init(FilterConfig)
public final java.lang.String getInitParameter(java.lang.String name)
public final java.util.Enumeration getInitParameterNames()
public final java.lang.String getFilterName()
public final javax.servlet.ServletContext getServletContext()
protected void sendRedirect(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, java.lang.String page, java.util.Map params, int mode) throws javax.servlet.ServletException, java.io.IOException
It resolves "*" contained in URI, if any, to the proper Locale,
and the browser code.
Refer to Servlets.locate(ServletContext, ServletRequest, String, Locator)
for details.
page
- the page's uri; null to denote the same requestmode
- one of Servlets.OVERWRITE_URI
, Servlets.IGNORE_PARAM
,
and Servlets.APPEND_PARAM
. It defines how to handle if both uri
and params contains the same parameter.
mode is used only if both uri contains query string and params is
not empty.
javax.servlet.ServletException
java.io.IOException
protected final void forward(javax.servlet.ServletRequest request, javax.servlet.ServletResponse response, java.lang.String uri) throws javax.servlet.ServletException, java.io.IOException
It resolves "*" contained in URI, if any, to the proper Locale,
and the browser code.
Refer to Servlets.locate(ServletContext, ServletRequest, String, Locator)
for details.
javax.servlet.ServletException
java.io.IOException
protected final void forward(javax.servlet.ServletRequest request, javax.servlet.ServletResponse response, java.lang.String uri, java.util.Map params, int mode) throws javax.servlet.ServletException, java.io.IOException
It resolves "*" contained in URI, if any, to the proper Locale,
and the browser code.
Refer to Servlets.locate(ServletContext, ServletRequest, String, Locator)
for details.
javax.servlet.ServletException
java.io.IOException
protected final void include(javax.servlet.ServletRequest request, javax.servlet.ServletResponse response, java.lang.String uri) throws javax.servlet.ServletException, java.io.IOException
It resolves "*" contained in URI, if any, to the proper Locale,
and the browser code.
Refer to Servlets.locate(ServletContext, ServletRequest, String, Locator)
for details.
javax.servlet.ServletException
java.io.IOException
protected final void include(javax.servlet.ServletRequest request, javax.servlet.ServletResponse response, java.lang.String uri, java.util.Map params, int mode) throws javax.servlet.ServletException, java.io.IOException
It resolves "*" contained in URI, if any, to the proper Locale,
and the browser code.
Refer to Servlets.locate(ServletContext, ServletRequest, String, Locator)
for details.
javax.servlet.ServletException
java.io.IOException
public void destroy()
This implementation does nothing.
destroy
in interface javax.servlet.Filter
public final void init(javax.servlet.FilterConfig config) throws javax.servlet.ServletException
init()
.
init
in interface javax.servlet.Filter
javax.servlet.ServletException
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |