Package org.apache.catalina.ssi

Class SSIFilter

java.lang.Object
org.apache.catalina.ssi.SSIFilter
All Implemented Interfaces:
Filter
public class SSIFilter extends Object implements Filter
Filter to process SSI requests within a webpage. Mapped to a content types from within web.xml.
Author:
David Becker
See Also:

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    protected boolean
    allowExec
    Allow exec (normally blocked for security)
    protected FilterConfig
    config
     
    protected Pattern
    contentTypeRegEx
    regex pattern to match when evaluating content types
    protected int
    debug
    Debug level for this servlet.
    protected Long
    expires
    Expiration time in seconds for the doc.
    protected boolean
    isVirtualWebappRelative
    virtual path can be webapp-relative
    protected final Pattern
    shtmlRegEx
    default pattern for ssi filter content type matching

  • Constructor Summary

    Constructors
    Constructor
    Description
    SSIFilter()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    destroy()
    Called by the web container to indicate to a filter that it is being taken out of service.
    void
    doFilter(ServletRequest request, ServletResponse response, FilterChain chain)
    The doFilter method 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.
    void
    init(FilterConfig config)
    Called by the web container to indicate to a filter that it is being placed into service.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Field Details

    • config

      protected FilterConfig config

    • debug

      protected int debug
      Debug level for this servlet.

    • expires

      protected Long expires
      Expiration time in seconds for the doc.

    • isVirtualWebappRelative

      protected boolean isVirtualWebappRelative
      virtual path can be webapp-relative

    • contentTypeRegEx

      protected Pattern contentTypeRegEx
      regex pattern to match when evaluating content types

    • shtmlRegEx

      protected final Pattern shtmlRegEx
      default pattern for ssi filter content type matching

    • allowExec

      protected boolean allowExec
      Allow exec (normally blocked for security)

  • Constructor Details

    • SSIFilter

      public SSIFilter()

  • Method Details

    • init

      public void init(FilterConfig config) throws ServletException
      Description copied from interface: javax.servlet.Filter
      Called by the web container to indicate to a filter that it is being placed into service. The servlet container calls the init method exactly once after instantiating the filter. The init method must complete successfully before the filter is asked to do any filtering work.

      The web container cannot place the filter into service if the init method either:

      • Throws a ServletException
      • Does not return within a time period defined by the web container
      Specified by:
      init in interface Filter
      Parameters:
      config - The configuration information associated with the filter instance being initialised
      Throws:
      ServletException - if the initialisation fails

    • doFilter

      public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException, ServletException
      Description copied from interface: javax.servlet.Filter
      The doFilter method 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.

      Specified by:
      doFilter in interface Filter
      Parameters:
      request - The request to process
      response - The response associated with the request
      chain - 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 request
      ServletException - if the processing fails for any other reason

    • destroy

      public void destroy()
      Description copied from interface: javax.servlet.Filter
      Called by the web container to indicate to a filter that it is being taken out of service. This method is only called once all threads within the filter's doFilter method have exited or after a timeout period has passed. After the web container calls this method, it will not call the doFilter method again on this instance of the filter.

      This method gives the filter an opportunity to clean up any resources that are being held (for example, memory, file handles, threads) and make sure that any persistent state is synchronized with the filter's current state in memory.
      Specified by:
      destroy in interface Filter