Class WebSocketUpgradeFilter

    • Field Detail

      • CONTEXT_ATTRIBUTE_KEY

        public static final java.lang.String CONTEXT_ATTRIBUTE_KEY
        See Also:
        Constant Field Values
      • CONFIG_ATTRIBUTE_KEY

        public static final java.lang.String CONFIG_ATTRIBUTE_KEY
        See Also:
        Constant Field Values
      • ATTR_KEY

        public static final java.lang.String ATTR_KEY
    • Method Detail

      • addMapping

        public void addMapping​(java.lang.String spec,
                               WebSocketCreator creator)
        Description copied from interface: MappedWebSocketCreator
        Add a mapping, of a pathspec to a WebSocketCreator.

        Recognized Path Spec syntaxes

        /path/to or / or *.ext or servlet|{spec}
        Servlet Syntax
        ^{spec} or regex|{spec}
        Regex Syntax
        uri-template|{spec}
        URI Template (see JSR356 and RFC6570 level 1)
        Specified by:
        addMapping in interface MappedWebSocketCreator
        Parameters:
        spec - the path spec to use.
        creator - the websocket creator for this specific mapping
      • destroy

        public void destroy()
        Specified by:
        destroy in interface javax.servlet.Filter
      • doFilter

        public void doFilter​(javax.servlet.ServletRequest request,
                             javax.servlet.ServletResponse response,
                             javax.servlet.FilterChain chain)
                      throws java.io.IOException,
                             javax.servlet.ServletException
        Specified by:
        doFilter in interface javax.servlet.Filter
        Throws:
        java.io.IOException
        javax.servlet.ServletException
      • dump

        public java.lang.String dump()
        Specified by:
        dump in interface Dumpable
      • dump

        public void dump​(java.lang.Appendable out,
                         java.lang.String indent)
                  throws java.io.IOException
        Description copied from interface: Dumpable
        Dump this object (and children) into an Appendable using the provided indent after any new lines. The indent should not be applied to the first object dumped.
        Specified by:
        dump in interface Dumpable
        Parameters:
        out - The appendable to dump to
        indent - The indent to apply after any new lines.
        Throws:
        java.io.IOException - if unable to write to Appendable
      • init

        public void init​(javax.servlet.FilterConfig config)
                  throws javax.servlet.ServletException
        Specified by:
        init in interface javax.servlet.Filter
        Throws:
        javax.servlet.ServletException
      • setToAttribute

        public void setToAttribute​(javax.servlet.ServletContext context,
                                   java.lang.String key)
                            throws javax.servlet.ServletException
        Throws:
        javax.servlet.ServletException
      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object