Package org.apache.wicket.protocol.ws

Class AbstractUpgradeFilter

  • All Implemented Interfaces:
    javax.servlet.Filter
    public class AbstractUpgradeFilter
extends org.apache.wicket.protocol.http.WicketFilter
    An extension of WicketFilter that is used to check whether the processed HttpServletRequest needs to upgrade its protocol from HTTP to something else
    Since:
    6.0

    • Field Summary

      • Fields inherited from class org.apache.wicket.protocol.http.WicketFilter

        APP_FACT_PARAM, FILTER_MAPPING_PARAM, IGNORE_PATHS_PARAM

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      protected boolean acceptWebSocket​(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse resp)  
      protected java.util.List<java.lang.String> getTokensFromHeader​(javax.servlet.http.HttpServletRequest req, java.lang.String headerName)  
      protected boolean processRequestCycle​(org.apache.wicket.request.cycle.RequestCycle requestCycle, org.apache.wicket.request.http.WebResponse webResponse, javax.servlet.http.HttpServletRequest httpServletRequest, javax.servlet.http.HttpServletResponse httpServletResponse, javax.servlet.FilterChain chain)  
      protected java.lang.String selectSubProtocol​(java.util.List<java.lang.String> subProtocols)
      Intended to be overridden by sub-classes that wish to select a sub-protocol if the client provides a list of supported protocols.
      protected boolean verifyOrigin​(java.lang.String origin)
      Intended to be overridden by sub-classes that wish to verify the origin of a WebSocket request before processing it.

      • Methods inherited from class org.apache.wicket.protocol.http.WicketFilter

        checkIfRedirectRequired, destroy, doFilter, getApplication, getApplicationFactory, getClassLoader, getFilterConfig, getFilterPath, getFilterPath, getFilterPathFromAnnotation, getFilterPathFromConfig, getFilterPathFromWebXml, getRelativePath, init, init, setFilterPath

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • AbstractUpgradeFilter

        public AbstractUpgradeFilter()

      • AbstractUpgradeFilter

        public AbstractUpgradeFilter​(org.apache.wicket.protocol.http.WebApplication application)

    • Method Detail

      • processRequestCycle

        protected boolean processRequestCycle​(org.apache.wicket.request.cycle.RequestCycle requestCycle,
                                      org.apache.wicket.request.http.WebResponse webResponse,
                                      javax.servlet.http.HttpServletRequest httpServletRequest,
                                      javax.servlet.http.HttpServletResponse httpServletResponse,
                                      javax.servlet.FilterChain chain)
                               throws java.io.IOException,
                                      javax.servlet.ServletException
        Overrides:
        processRequestCycle in class org.apache.wicket.protocol.http.WicketFilter
        Throws:
        java.io.IOException
        javax.servlet.ServletException

      • acceptWebSocket

        protected boolean acceptWebSocket​(javax.servlet.http.HttpServletRequest req,
                                  javax.servlet.http.HttpServletResponse resp)
                           throws javax.servlet.ServletException,
                                  java.io.IOException
        Throws:
        javax.servlet.ServletException
        java.io.IOException

      • getTokensFromHeader

        protected java.util.List<java.lang.String> getTokensFromHeader​(javax.servlet.http.HttpServletRequest req,
                                                               java.lang.String headerName)

      • verifyOrigin

        protected boolean verifyOrigin​(java.lang.String origin)
        Intended to be overridden by sub-classes that wish to verify the origin of a WebSocket request before processing it.
        Parameters:
        origin - The value of the origin header from the request which may be null
        Returns:
        true to accept the request. false to reject it. This default implementation always returns true.

      • selectSubProtocol

        protected java.lang.String selectSubProtocol​(java.util.List<java.lang.String> subProtocols)
        Intended to be overridden by sub-classes that wish to select a sub-protocol if the client provides a list of supported protocols.
        Parameters:
        subProtocols - The list of sub-protocols supported by the client in client preference order. The server is under no obligation to respect the declared preference
        Returns:
        null if no sub-protocol is selected or the name of the protocol which must be one of the protocols listed by the client. This default implementation always returns null.