Package io.undertow.websockets.jsr

Class JsrWebSocketFilter

  • All Implemented Interfaces:
    jakarta.servlet.Filter
    public class JsrWebSocketFilter
extends java.lang.Object
implements jakarta.servlet.Filter
    Filter that provides HTTP upgrade functionality. This should be run after all user filters, but before any servlets.

    The use of a filter rather than a servlet allows for normal HTTP requests to be served from the same location as a web socket endpoint if no upgrade header is found.

    Author:
    Stuart Douglas

    • 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 filterConfig)  

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • JsrWebSocketFilter

        public JsrWebSocketFilter()

    • Method Detail

      • init

        public void init​(jakarta.servlet.FilterConfig filterConfig)
          throws jakarta.servlet.ServletException
        Specified by:
        init in interface jakarta.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 interface jakarta.servlet.Filter
        Throws:
        java.io.IOException
        jakarta.servlet.ServletException

      • destroy

        public void destroy()
        Specified by:
        destroy in interface jakarta.servlet.Filter