Interface E3QueueManager

All Superinterfaces:
E3DynamicComponent

public interface E3QueueManager extends E3DynamicComponent
Describes a queue manager object.

A queue manager stores HTTP requests for execution later; for each request queued, it returns a response indicating that the request has been queued.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    init(E3RequestContext context, com.arbortext.e3cf.E3QueueManagerDescriptor descriptor)
    Called by E3 servlet initialization after everything else has been initialized, but before any requests are received.
    service(javax.servlet.http.HttpServletRequest request)
    Examines a request and, possibly, saves the request for execution later.

    Methods inherited from interface com.arbortext.e3.E3DynamicComponent

    destroy, getId, getStatus
  • Method Details

    • init

      void init(E3RequestContext context, com.arbortext.e3cf.E3QueueManagerDescriptor descriptor) throws com.arbortext.e3.E3RequestException
      Called by E3 servlet initialization after everything else has been initialized, but before any requests are received.
      Parameters:
      context - data/services block
      descriptor - data from e3config.xml
      Throws:
      com.arbortext.e3.E3RequestException - upon error
    • service

      E3RequestResponse service(javax.servlet.http.HttpServletRequest request) throws com.arbortext.e3.E3RequestException
      Examines a request and, possibly, saves the request for execution later. If the request is queued, sets the response to say so.
      Parameters:
      request - HTTP request from a client
      Returns:
      response object saying we queued the request or null if we couldn't queue it
      Throws:
      com.arbortext.e3.E3RequestException