Package org.apache.catalina.ssi
Class SSIFilter
java.lang.Object
javax.servlet.GenericFilter
org.apache.catalina.ssi.SSIFilter
- All Implemented Interfaces:
Serializable,Filter,FilterConfig
Filter to process SSI requests within a webpage. Mapped to a content types
from within web.xml.
- Author:
- David Becker
- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected booleanAllow exec (normally blocked for security)protected Patternregex pattern to match when evaluating content typesprotected intDebug level for this servlet.protected LongExpiration time in seconds for the doc.protected booleanvirtual path can be webapp-relativeprotected final Patterndefault pattern for ssi filter content type matching -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoiddoFilter(ServletRequest request, ServletResponse response, FilterChain chain) ThedoFiltermethod of the Filter is called by the container each time a request/response pair is passed through the chain due to a client request for a resource at the end of the chain.voidinit()Convenience method for sub-classes to save them having to callsuper.init(config).Methods inherited from class javax.servlet.GenericFilter
getFilterConfig, getFilterName, getInitParameter, getInitParameterNames, getServletContext, init
-
Field Details
-
debug
protected int debugDebug level for this servlet. -
expires
Expiration time in seconds for the doc. -
isVirtualWebappRelative
protected boolean isVirtualWebappRelativevirtual path can be webapp-relative -
contentTypeRegEx
regex pattern to match when evaluating content types -
shtmlRegEx
default pattern for ssi filter content type matching -
allowExec
protected boolean allowExecAllow exec (normally blocked for security)
-
-
Constructor Details
-
SSIFilter
public SSIFilter()
-
-
Method Details
-
init
Description copied from class:javax.servlet.GenericFilterConvenience method for sub-classes to save them having to callsuper.init(config). This is a NO-OP by default.- Overrides:
initin classGenericFilter- Throws:
ServletException- If an exception occurs that interrupts the Filter's normal operation
-
doFilter
public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException, ServletException Description copied from interface:javax.servlet.FilterThedoFiltermethod of the Filter is called by the container each time a request/response pair is passed through the chain due to a client request for a resource at the end of the chain. The FilterChain passed in to this method allows the Filter to pass on the request and response to the next entity in the chain.A typical implementation of this method would follow the following pattern:-
1. Examine the request
2. Optionally wrap the request object with a custom implementation to filter content or headers for input filtering
3. Optionally wrap the response object with a custom implementation to filter content or headers for output filtering
4. a) Either invoke the next entity in the chain using the FilterChain object (chain.doFilter()),
4. b) or not pass on the request/response pair to the next entity in the filter chain to block the request processing
5. Directly set headers on the response after invocation of the next entity in the filter chain.- Parameters:
request- The request to processresponse- The response associated with the requestchain- Provides access to the next filter in the chain for this filter to pass the request and response to for further processing- Throws:
IOException- if an I/O error occurs during this filter's processing of the requestServletException- if the processing fails for any other reason
-