Package org.eclipse.jetty.server.handler

Class IdleTimeoutHandler

java.lang.Object
org.eclipse.jetty.util.component.AbstractLifeCycle
org.eclipse.jetty.util.component.ContainerLifeCycle
org.eclipse.jetty.server.Handler.Abstract
org.eclipse.jetty.server.Handler.AbstractContainer
org.eclipse.jetty.server.Handler.Wrapper
org.eclipse.jetty.server.handler.IdleTimeoutHandler
All Implemented Interfaces:
Handler, Handler.Container, Handler.Singleton, Request.Handler, Container, Destroyable, Dumpable, Dumpable.DumpableContainer, LifeCycle, Invocable
public class IdleTimeoutHandler extends Handler.Wrapper
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 Details

    • IdleTimeoutHandler

      public IdleTimeoutHandler()

    • IdleTimeoutHandler

      public IdleTimeoutHandler(Handler handler)

  • Method Details

    • 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 boolean handle(Request request, Response response, Callback callback) throws Exception
      Description copied from interface: Request.Handler

      Invoked to handle the passed HTTP request and response.

      The request is accepted by returning true, then handling must be concluded by completing the passed callback. The handling may be asynchronous, i.e. this method may return true and complete the given callback later, possibly from a different thread. If this method returns false, then the callback must not be invoked and any mutation on the response reversed.

      Exceptions thrown by this method may be subsequently handled by an error Request.Handler, if present, otherwise a default HTTP 500 error is generated and the callback completed while writing the error response.

      The simplest implementation is:

       public boolean handle(Request request, Response response, Callback callback)
 {
     callback.succeeded();
     return true;
 }

      A HelloWorld implementation is:

       public boolean handle(Request request, Response response, Callback callback)
 {
     response.write(true, ByteBuffer.wrap("Hello World\n".getBytes(StandardCharsets.UTF_8)), callback);
     return true;
 }
      Specified by:
      handle in interface Request.Handler
      Overrides:
      handle in class Handler.Wrapper
      Parameters:
      request - the HTTP request to handle
      response - the HTTP response to handle
      callback - the callback to complete when the handling is complete
      Returns:
      True if and only if the request will be handled, a response generated and the callback eventually called. This may occur within the scope of the call to this method, or asynchronously some time later. If false is returned, then this method must not generate a response, nor complete the callback.
      Throws:
      Exception - if there is a failure during the handling. Catchers cannot assume that the callback will be called and thus should attempt to complete the request as if a false had been returned.