Package org.eclipse.jetty.websocket.server

Class WebSocketUpgradeFilter

    • Method Detail

      • addMapping

        public void addMapping​(String spec,
                       WebSocketCreator creator)
        Deprecated.
        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()
        Deprecated.
        Description copied from interface: 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

      • doFilter

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

      • dump

        public void dump​(Appendable out,
                 String indent)
          throws IOException
        Deprecated.
        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:
        IOException - if unable to write to Appendable

      • init

        public void init​(FilterConfig config)
          throws ServletException
        Deprecated.
        Description copied from interface: 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