Package org.sonar.api.web

Class HttpFilter

  • @ServerSide
@ExtensionPoint
public abstract class HttpFilter
extends java.lang.Object
    A filter is an object that performs filtering tasks on either the request to a resource (a servlet or static content), or on the response from a resource, or both. This extension point is not intended to intercept all requests. When the platform intercepts and serves a request (for example with a web service filter), plugin filters do not get invoked, as the filters defined by plugins are at the end of the filter chain.
    Since:
    9.16

    • Constructor Summary

      Constructors 
      Constructor Description
      HttpFilter()  

    • Method Summary

      All Methods Instance Methods Abstract Methods Concrete Methods 
      Modifier and Type Method Description
      void destroy()
      Called by the SonarQube to indicate to a filter that it is being taken out of service.
      abstract void doFilter​(HttpRequest request, HttpResponse response, FilterChain chain)
      The doFilter method of the Filter is called by the SonarQube 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.
      UrlPattern doGetPattern()
      Override to change URL.
      void init()
      This method is called exactly once after instantiating the filter.

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • HttpFilter

        public HttpFilter()

    • Method Detail

      • init

        public void init()
        This method is called exactly once after instantiating the filter. The init method must complete successfully before the filter is asked to do any filtering work.

      • doFilter

        public abstract void doFilter​(HttpRequest request,
                              HttpResponse response,
                              FilterChain chain)
                       throws java.io.IOException
        The doFilter method of the Filter is called by the SonarQube 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
          • Either invoke the next entity in the chain using the FilterChain object (chain.doFilter()),
          • 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.
        Throws:
        java.io.IOException

      • destroy

        public void destroy()
        Called by the SonarQube 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.

      • doGetPattern

        public UrlPattern doGetPattern()
        Override to change URL. Default is /*