Class IdleTimeoutHandler

  • All Implemented Interfaces:
    Handler, HandlerContainer, Container, Destroyable, Dumpable, LifeCycle

    public class IdleTimeoutHandler
    extends HandlerWrapper
    Handler to adjust the idle timeout of requests while dispatched. Can be applied in jetty.xml with
       <Get id='handler' name='Handler'/>
       <Set name='Handler'>
         <New id='idleTimeoutHandler' class='org.eclipse.jetty.server.handler.IdleTimeoutHandler'>
           <Set name='Handler'><Ref id='handler'/></Set>
           <Set name='IdleTimeoutMs'>5000</Set>
         </New>
       </Set>
     
    • Constructor Detail

      • IdleTimeoutHandler

        public IdleTimeoutHandler()
    • Method Detail

      • isApplyToAsync

        public boolean isApplyToAsync()
      • setApplyToAsync

        public void setApplyToAsync​(boolean applyToAsync)
        Should the adjusted idle time be maintained for asynchronous requests
        Parameters:
        applyToAsync - true if alternate idle timeout is applied to asynchronous requests
      • getIdleTimeoutMs

        public long getIdleTimeoutMs()
      • setIdleTimeoutMs

        public void setIdleTimeoutMs​(long idleTimeoutMs)
        Parameters:
        idleTimeoutMs - The idle timeout in MS to apply while dispatched or async
      • handle

        public void handle​(java.lang.String target,
                           Request baseRequest,
                           javax.servlet.http.HttpServletRequest request,
                           javax.servlet.http.HttpServletResponse response)
                    throws java.io.IOException,
                           javax.servlet.ServletException
        Description copied from interface: Handler
        Handle a request.
        Specified by:
        handle in interface Handler
        Overrides:
        handle in class HandlerWrapper
        Parameters:
        target - The target of the request - either a URI or a name.
        baseRequest - The original unwrapped request object.
        request - The request either as the Request object or a wrapper of that request. The HttpConnection.getCurrentConnection().getHttpChannel().getRequest() method can be used access the Request object if required.
        response - The response as the Response object or a wrapper of that request. The HttpConnection.getCurrentConnection().getHttpChannel().getResponse() method can be used access the Response object if required.
        Throws:
        java.io.IOException - if unable to handle the request or response processing
        javax.servlet.ServletException - if unable to handle the request or response due to underlying servlet issue