Class DelayHandler

  • All Implemented Interfaces:
    Handler, TemplateInterface

    public class DelayHandler
    extends Template
    implements Handler
    Handler or template for adding a delay into a response.

    Properties:

    prefix, suffix, match, glob
    Specify which url's to process.
    delay
    The delay, in ms (defaults to 1000).
    Template: <delay sec=nnn ms=nnn />

    Delay the specified amount of seconds plus msec - either or both may be specified.

    • Field Summary

    • Constructor Summary

      Constructors 
      Constructor Description
      DelayHandler()  
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean init​(Server server, java.lang.String prefix)
      Initializes the handler.
      boolean respond​(Request request)
      Delay before servicing this request.
      void tag_delay​(RewriteContext hr)
      Pause for "ms" ms and/or "sec" seconds.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • DelayHandler

        public DelayHandler()
    • Method Detail

      • init

        public boolean init​(Server server,
                            java.lang.String prefix)
        Description copied from interface: Handler
        Initializes the handler.
        Specified by:
        init in interface Handler
        Parameters:
        server - The HTTP server that created this Handler. Typical Handlers will use Server.props to obtain run-time configuration information.
        prefix - The handlers name. The string this Handler may prepend to all of the keys that it uses to extract configuration information from Server.props. This is set (by the Server and ChainHandler) to help avoid configuration parameter namespace collisions.
        Returns:
        true if this Handler initialized successfully, false otherwise. If false is returned, this Handler should not be used.
      • respond

        public boolean respond​(Request request)
                        throws java.io.IOException
        Delay before servicing this request.
        <delay sec=nnn ms=nnn>
        Specified by:
        respond in interface Handler
        Parameters:
        request - The Request object that represents the HTTP request.
        Returns:
        true if the request was handled. A request was handled if a response was supplied to the client, typically by calling Request.sendResponse() or Request.sendError.
        Throws:
        java.io.IOException - if there was an I/O error while sending the response to the client. Typically, in that case, the Server will (try to) send an error message to the client and then close the client's connection.

        The IOException should not be used to silently ignore problems such as being unable to access some server-side resource (for example getting a FileNotFoundException due to not being able to open a file). In that case, the Handler's duty is to turn that IOException into a HTTP response indicating, in this case, that a file could not be found.

      • tag_delay

        public void tag_delay​(RewriteContext hr)
        Pause for "ms" ms and/or "sec" seconds.