Changeset 1991 for trunk/autoquest-httpmonitor/src/main/java

Timestamp:

07/08/15 09:03:46 (9 years ago)

Author:

pharms

Message:

• added ordering id for requests and responses

Location:

trunk/autoquest-httpmonitor/src/main/java/de/ugoe/cs/autoquest/httpmonitor

Files:

• HttpMonitor.java (modified) (5 diffs)
• HttpMonitorServer.java (modified) (1 diff)
• HttpMonitorServlet.java (modified) (3 diffs)
• IdGenerator.java (added)
• SimpleIdGenerator.java (added)
• proxy/ExchangeListener.java (modified) (10 diffs)
• proxy/ExchangeListenerManager.java (modified) (4 diffs)
• proxy/HttpMonitorRemoteConnection.java (added)
• proxy/HttpMonitorRemoteExchangeHandler.java (modified) (9 diffs)
• proxy/HttpMonitorRemoteIdGenerator.java (added)
• proxy/HttpMonitoringProxy.java (modified) (9 diffs)

trunk/autoquest-httpmonitor/src/main/java/de/ugoe/cs/autoquest/httpmonitor/HttpMonitor.java

@@ -22 +22 @@
  * <p>
  * The HTTP monitor starts a web server ({@link HttpMonitorServer}) that receives exchanges
- * of the HTTP proxy. These exchanges are logged using the {@link HttpMonitorLogManager}. The
- * class assures that on shutdown e.g. caused by CTRL-C the server and the log manager are
- * stopped correctly.
+ * of the HTTP proxy. In addition, it provides via get a unique ordering id for requests and
+ * responses that can be used by the proxies when creating the exchanges. The exchanges are
+ * logged using the {@link HttpMonitorLogManager}. The class assures that on shutdown e.g. caused
+ * by CTRL-C the server and the log manager are stopped correctly.
  * </p>
  * 
@@ -50 +51 @@
      */
     private HttpMonitorLogManager logManager;
+
+    /**
+     * the id generator used for getting new unique ids
+     */
+    private IdGenerator idGenerator;
 
     /**
@@ -92 +98 @@
         
         try {
+            idGenerator = new SimpleIdGenerator();
+            idGenerator.init();
+
             logManager = new HttpMonitorLogManager(logFileBaseDir);
             logManager.init();
         
-            Servlet servlet = new HttpMonitorServlet(logManager);
+            Servlet servlet = new HttpMonitorServlet(logManager, idGenerator);
             server = new HttpMonitorServer(port, servlet);
             server.init();
@@ -118 +127 @@
         try {
             Runtime.getRuntime().addShutdownHook(shutdownHook);
+            idGenerator.start();
             logManager.start();
             server.start();
@@ -139 +149 @@
         server.stop();
         logManager.stop();
+        idGenerator.stop();
         
         server = null;
         logManager = null;
+        idGenerator = null;
     }
 

trunk/autoquest-httpmonitor/src/main/java/de/ugoe/cs/autoquest/httpmonitor/HttpMonitorServer.java

@@ -55 +55 @@
      *
      * @param port    the port to listen on
-     * @param servlet teh servlet to be deployed
+     * @param servlet the servlet to be deployed
      */
     public HttpMonitorServer(int port, Servlet servlet) {

trunk/autoquest-httpmonitor/src/main/java/de/ugoe/cs/autoquest/httpmonitor/HttpMonitorServlet.java

@@ -33 +33 @@
  * the servlet deployed in the web server that receives all recorded exchanges from the proxy. The
  * exchanges are parsed and forwarded to the provided exchange handler. If an exchange can not
- * be parsed it is discarded. Exchanges are only received via the POST HTTP method.
+ * be parsed it is discarded. Exchanges are only received via the POST HTTP method. Via the GET
+ * method, the servlet provides unique ordering ids as a header parameter in the response. The
+ * header parameter is named "X-AutoQUEST-OrderingId". For creating the ids it uses a provided id
+ * generator.
  * </p>
  * 
@@ -47 +50 @@
      */
     private transient HttpMonitorExchangeHandler exchangeHandler;
+    
+    /**
+     * the id generator used to return new unique ids.
+     */
+    private transient IdGenerator idGenerator;
 
     /**
      * <p>
      * initializes the servlet with the exchange handler to which all exchanges shall be forwarded
+     * and the id generator to be used for returning new ids
      * </p>
      *
      * @param exchangeHandler the exchange handler that shall receive all exchanges
+     * @param idGenerator     the id generator used to generate new ids
      */
-    HttpMonitorServlet(HttpMonitorExchangeHandler exchangeHandler) {
+    HttpMonitorServlet(HttpMonitorExchangeHandler exchangeHandler, IdGenerator idGenerator) {
         this.exchangeHandler = exchangeHandler;
+        this.idGenerator = idGenerator;
     }
 
@@ -87 +98 @@
         }
     }
+
+    /**
+     * this implements handling of doGet. For this servlet this means that we return a unique
+     * ordering id which can be used by proxies as ordering ids for requests and responses.
+     * 
+     * (non-Javadoc) (non-Javadoc)
+     * @see HttpServlet#doGet(HttpServletRequest, HttpServletResponse)
+     */
+    @Override
+    protected void doGet(HttpServletRequest request, HttpServletResponse response)
+        throws ServletException, IOException
+    {
+        response.setHeader("X-AutoQUEST-OrderingId", Long.toString(idGenerator.getNextId()));
+    }
     
 }

trunk/autoquest-httpmonitor/src/main/java/de/ugoe/cs/autoquest/httpmonitor/proxy/ExchangeListener.java

@@ -27 +27 @@
 
 import de.ugoe.cs.autoquest.httpmonitor.HttpMonitorExchangeHandler;
+import de.ugoe.cs.autoquest.httpmonitor.IdGenerator;
 import de.ugoe.cs.autoquest.plugin.http.logdata.Address;
 import de.ugoe.cs.autoquest.plugin.http.logdata.Content;
@@ -46 +47 @@
  * recording an exchange can not be done in one step. This is due to the fact, that the proxy
  * servlet notifies different processing states for requests and response. An exchange listener
- * records all these event. On the occurrence of the final event, it compiles an
- * {@link HttpExchange} and forwards it to the exchange handler.
+ * records all these events. On the occurrence of the final event, it compiles an
+ * {@link HttpExchange} and forwards it to the exchange handler. When receiving the first event
+ * of the request, it also determines a respective ordering id. The same applies for the response.
+ * The ordering ids are retrieved from a provided id generator.
  * </p>
  * 
@@ -63 +66 @@
     /**
      * <p>
+     * the id generator used to generate ordering ids for requests and responses
+     * </p>
+     */
+    private IdGenerator idGenerator;
+    
+    /**
+     * <p>
      * the request of compiled exchange
      * </p>
      */
     private HttpServletRequest request;
+    
+    /**
+     * <p>
+     * the ordering id for the request
+     * </p>
+     */
+    private long requestOrderingId;
 
     /**
@@ -81 +98 @@
      */
     private HttpServletResponse response;
+    
+    /**
+     * <p>
+     * the ordering id for the response
+     * </p>
+     */
+    private long responseOrderingId;
 
     /**
@@ -99 +123 @@
      * <p>
      * initialized the exchange listener with the exchange handler to forward compiled exchanges to
+     * and the id generator to be used for generating ordering ids for requests and responses
      * </p>
      * 
      * @param exchangeHandler the exchange handler to forward compiled exchanges to
-     */
-    ExchangeListener(HttpMonitorExchangeHandler exchangeHandler) {
+     * @param idGenerator     the id generator to used for generating ordering ids
+     */
+    ExchangeListener(HttpMonitorExchangeHandler exchangeHandler, IdGenerator idGenerator) {
         this.exchangeHandler = exchangeHandler;
+        this.idGenerator = idGenerator;
     }
 
@@ -123 +150 @@
         lastUpdate = System.currentTimeMillis();
         this.request = request;
+        this.requestOrderingId = idGenerator.getNextId();
     }
 
@@ -159 +187 @@
         lastUpdate = System.currentTimeMillis();
         this.response = response;
+        this.responseOrderingId = idGenerator.getNextId();
     }
     
@@ -239 +268 @@
         exchange.setReceiver(address);
         
-        exchange.setRequest(map(request, eventObjectFactory));
-        exchange.setResponse(map(response, eventObjectFactory));
+        exchange.setRequest(map(request, requestOrderingId, eventObjectFactory));
+        exchange.setResponse(map(response, responseOrderingId, eventObjectFactory));
         
         exchangeHandler.handleHttpExchange(exchange);
@@ -250 +279 @@
      * </p>
      */
-    private HttpRequest map(HttpServletRequest request, ObjectFactory eventObjectFactory) {
+    private HttpRequest map(HttpServletRequest request,
+                            long               requestOrderingId,
+                            ObjectFactory      eventObjectFactory)
+    {
         HttpRequest eventRequest = eventObjectFactory.createHttpRequest();
+        eventRequest.setOrderingId(requestOrderingId);
         eventRequest.setMethod(Method.fromValue(request.getMethod()));
         eventRequest.setProtocol(Protocol.fromValue(request.getProtocol()));
@@ -311 +344 @@
      * </p>
      */
-    private HttpResponse map(HttpServletResponse response, ObjectFactory eventObjectFactory) {
+    private HttpResponse map(HttpServletResponse response,
+                             long                responseOrderingId,
+                             ObjectFactory       eventObjectFactory)
+    {
         HttpResponse eventResponse = eventObjectFactory.createHttpResponse();
         
         eventResponse.setStatus(BigInteger.valueOf(response.getStatus()));
+        eventResponse.setOrderingId(responseOrderingId);
 
         Headers headers = eventObjectFactory.createHeaders();

trunk/autoquest-httpmonitor/src/main/java/de/ugoe/cs/autoquest/httpmonitor/proxy/ExchangeListenerManager.java

@@ -30 +30 @@
 import de.ugoe.cs.autoquest.httpmonitor.HttpMonitorException;
 import de.ugoe.cs.autoquest.httpmonitor.HttpMonitorExchangeHandler;
+import de.ugoe.cs.autoquest.httpmonitor.IdGenerator;
 import de.ugoe.cs.autoquest.plugin.http.logdata.Status;
 import de.ugoe.cs.util.console.Console;
@@ -60 +61 @@
     /**
      * <p>
+     * the id generator used to generate ordering ids for requests and responses
+     * </p>
+     */
+    private IdGenerator idGenerator;
+    
+    /**
+     * <p>
      * the mapping of requests handled by the proxy to the respective exchange listeners
      * </p>
@@ -79 +87 @@
      * 
      * @param exchangeHandler the exchange handler to be forwarded to the exchange listeners
-     */
-    ExchangeListenerManager(HttpMonitorExchangeHandler exchangeHandler) {
+     * @param idGenerator     the id generator to used for generating ordering ids
+     */
+    ExchangeListenerManager(HttpMonitorExchangeHandler exchangeHandler, IdGenerator idGenerator) {
         this.exchangeHandler = exchangeHandler;
+        this.idGenerator = idGenerator;
     }
 
@@ -219 +229 @@
                 if (listener == null) {
                     Console.traceln(Level.FINEST, "creating exchange listener for " + request);
-                    listener = new ExchangeListener(exchangeHandler); 
+                    listener = new ExchangeListener(exchangeHandler, idGenerator); 
                     listeners.put(request, listener);
                 }

trunk/autoquest-httpmonitor/src/main/java/de/ugoe/cs/autoquest/httpmonitor/proxy/HttpMonitorRemoteExchangeHandler.java

@@ -17 +17 @@
 import java.io.IOException;
 import java.io.OutputStreamWriter;
-import java.util.HashSet;
-import java.util.Set;
 import java.util.logging.Level;
 
@@ -25 +23 @@
 import javax.xml.bind.Marshaller;
 
-import org.eclipse.jetty.client.HttpClient;
 import org.eclipse.jetty.client.api.Request;
-import org.eclipse.jetty.client.api.Response.CompleteListener;
 import org.eclipse.jetty.client.api.Result;
 import org.eclipse.jetty.client.util.OutputStreamContentProvider;
 import org.eclipse.jetty.http.HttpMethod;
 import org.eclipse.jetty.http.HttpVersion;
-import org.eclipse.jetty.util.thread.QueuedThreadPool;
 
 import de.ugoe.cs.autoquest.httpmonitor.HttpMonitor;
-import de.ugoe.cs.autoquest.httpmonitor.HttpMonitorComponent;
-import de.ugoe.cs.autoquest.httpmonitor.HttpMonitorException;
 import de.ugoe.cs.autoquest.httpmonitor.HttpMonitorExchangeHandler;
 import de.ugoe.cs.autoquest.plugin.http.logdata.HttpExchange;
@@ -48 +41 @@
  * request/response. It then creates an HTTP request to the central monitor and sends it there.
  * It is initialized with the name of the server and the port on which the central monitor runs.
- * If the exchanges can not be forwarded to the central server, they are discarded.
+ * If the exchanges cannot be forwarded to the central server, they are discarded.
  * </p>
  * 
@@ -54 +47 @@
  */
 public class HttpMonitorRemoteExchangeHandler
-    implements CompleteListener, HttpMonitorExchangeHandler, HttpMonitorComponent
+    extends HttpMonitorRemoteConnection
+    implements HttpMonitorExchangeHandler
 {
-
-    /**
-     * <p>
-     * the HTTP client used internally to send data to the central server
-     * </p>
-     */
-    private HttpClient httpClient;
-    
-    /**
-     * <p>
-     * the host name of the central server
-     * </p>
-     */
-    private String httpMonitorServer;
-    
-    /**
-     * <p>
-     * the port of the central server
-     * </p>
-     */
-    private int httpMonitorPort;
-
-    /**
-     * <p>
-     * a set of requests send to the central server for which the response was not received yet
-     * </p>
-     */
-    private Set<Request> openRequests = new HashSet<Request>();
     
     /**
@@ -94 +60 @@
      */
     public HttpMonitorRemoteExchangeHandler(String httpMonitorServer, int httpMonitorPort) {
-        this.httpMonitorServer = httpMonitorServer;
-        this.httpMonitorPort = httpMonitorPort;
-    }
-
-    /* (non-Javadoc)
-     * @see de.ugoe.cs.autoquest.httpmonitor.HttpMonitorComponent#init()
-     */
-    @Override
-    public void init() throws IllegalStateException, HttpMonitorException {
-        httpClient = createHttpClient();
-    }
-
-    /* (non-Javadoc)
-     * @see de.ugoe.cs.autoquest.httpmonitor.HttpMonitorComponent#start()
-     */
-    @Override
-    public void start() throws IllegalStateException, HttpMonitorException {
-        try {
-            httpClient.start();
-            httpClient.getContentDecoderFactories().clear();
-        }
-        catch (Exception e) {
-            throw new HttpMonitorException("could not start client for HTTP-Monitor", e);
-        }
-    }
-
-    /* (non-Javadoc)
-     * @see de.ugoe.cs.autoquest.httpmonitor.HttpMonitorComponent#stop()
-     */
-    @Override
-    public void stop() {
-        if (httpClient != null) {
-            try {
-                httpClient.stop();
-            }
-            catch (Exception e) {
-                Console.traceln(Level.WARNING, "could not stop client for HTTP-Monitor");
-                Console.logException(e);
-            }
-        }
-        
-        httpClient = null;
+        super(httpMonitorServer, httpMonitorPort);
     }
 
@@ -144 +69 @@
     public synchronized void handleHttpExchange(HttpExchange httpExchange) {
         // send the exchange to the server and wait for completion
-        Request httpMonitorRequest = httpClient.newRequest(httpMonitorServer, httpMonitorPort);
+        Request httpMonitorRequest = super.newRequest();
         httpMonitorRequest.method(HttpMethod.POST);
         httpMonitorRequest.version(HttpVersion.HTTP_1_1);
@@ -151 +76 @@
         httpMonitorRequest.content(out);
         
-        openRequests.add(httpMonitorRequest);
-        httpMonitorRequest.send(this);
+        super.sendRequest(httpMonitorRequest);
 
         try {
@@ -173 +97 @@
             Console.logException(e);
         }
-
-        try {
-            // wait for the request to be removed from the list asynchronously
-            int count = 30;
-            while (openRequests.contains(httpMonitorRequest)) {
-                this.wait(1000);
-                
-                if (--count == 0) {
-                    // after 30 seconds, cancel the sending of the loggin request
-                    openRequests.remove(httpMonitorRequest);
-                    break;
-                }
-            }
-        }
-        catch (InterruptedException e) {
-            // ignore, as this may only happen on system shutdown
-        }
-    }
-
-    /* (non-Javadoc)
-     * @see org.eclipse.jetty.client.api.Response.CompleteListener#onComplete(Result)
-     */
-    @Override
-    public synchronized void onComplete(Result result) {
+        
+        // wait to ensure that the request was received
+        Result result = super.getResult(httpMonitorRequest);
+        
         if (result.isFailed()) {
             Console.traceln
@@ -202 +106 @@
             Console.logException((Exception) result.getFailure());
         }
-        
-        openRequests.remove(result.getRequest());
-        this.notify();
-    }
-
-    /**
-     * <p>
-     * convenience method to create an initialize the utilized HTTP client
-     * </p>
-     */
-    private HttpClient createHttpClient() {
-        HttpClient client = new HttpClient();
-        
-        QueuedThreadPool executor = new QueuedThreadPool(10);
-        executor.setName("HttpMonitorClients");
-        client.setExecutor(executor);
-
-        client.setMaxConnectionsPerDestination(10000);
-        client.setIdleTimeout(30000);
-        client.setConnectTimeout(30000);
-        client.setStopTimeout(30000);
-        client.setRequestBufferSize(1024*1024);
-        client.setResponseBufferSize(1024*1024);
-        
-        return client;
     }
 }

trunk/autoquest-httpmonitor/src/main/java/de/ugoe/cs/autoquest/httpmonitor/proxy/HttpMonitoringProxy.java

@@ -22 +22 @@
 import de.ugoe.cs.autoquest.httpmonitor.HttpMonitorLogManager;
 import de.ugoe.cs.autoquest.httpmonitor.HttpMonitorServer;
+import de.ugoe.cs.autoquest.httpmonitor.IdGenerator;
 import de.ugoe.cs.autoquest.httpmonitor.Runner;
 import de.ugoe.cs.autoquest.httpmonitor.ShutdownHook;
+import de.ugoe.cs.autoquest.httpmonitor.SimpleIdGenerator;
 import de.ugoe.cs.util.console.Console;
 
@@ -29 +31 @@
  * <p>
  * The HTTP monitory proxy monitor starts a web server ({@link HttpMonitorServer}) that receives
- * proxies HTTP messages and response. Each exchange of a request and a response is forwarded to
+ * proxied HTTP messages and response. Each exchange of a request and a response is forwarded to
  * an exchange handler. The exchange handler is either a local log manager
  * ({@link HttpMonitorLogManager}) or a connection to an external and central HTTP monitor via
- * an {@link HttpMonitorRemoteExchangeHandler}. The class ensures that on shutdown e.g. caused
+ * an {@link HttpMonitorRemoteExchangeHandler}. It also holds a reference to an id generator. If
+ * the exchanges are handled locally, then also a local {@link SimpleIdGenerator} is used. If
+ * the exchanges are send to a central HTTP monitor, then this monitor is used as id generator via
+ * an {@link HttpMonitorRemoteIdGenerator}. The class ensures that on shutdown e.g. caused
  * by CTRL-C the server and all other requied components are stopped correctly.
  * </p>
@@ -59 +64 @@
      */
     private HttpMonitorExchangeHandler exchangeHandler;
+    
+    /**
+     *  the id generator used to generate order ids for the requests and responses
+     */
+    private IdGenerator idGenerator;
     
     /**
@@ -170 +180 @@
             exchangeHandler =
                 new HttpMonitorRemoteExchangeHandler(httpMonitorServer, httpMonitorPort);
+            
+            idGenerator = new HttpMonitorRemoteIdGenerator(httpMonitorServer, httpMonitorPort);
         }
         else {
             Console.println("storing logs locally into directory " + logFileBaseDir);
             exchangeHandler = new HttpMonitorLogManager(logFileBaseDir);
+            idGenerator = new SimpleIdGenerator();
         }
     }
@@ -187 +200 @@
         
         exchangeHandler.init();
-        
-        exchangeListenerManager = new ExchangeListenerManager(exchangeHandler);
+        idGenerator.init();
+        
+        exchangeListenerManager = new ExchangeListenerManager(exchangeHandler, idGenerator);
         exchangeListenerManager.init();
         
@@ -205 +219 @@
     @Override
     public synchronized void start() {
-        if ((exchangeHandler == null) || (exchangeListenerManager == null) || (server == null)) {
+        if ((exchangeHandler == null) || (idGenerator == null) ||
+            (exchangeListenerManager == null) || (server == null))
+        {
             throw new IllegalStateException("not initialized.");
         }
@@ -212 +228 @@
             Runtime.getRuntime().addShutdownHook(shutdownHook);
             exchangeHandler.start();
+            idGenerator.start();
             exchangeListenerManager.start();
             server.start();
@@ -226 +243 @@
     @Override
     public synchronized void stop() {
-        if ((exchangeHandler == null) || (exchangeListenerManager == null) || (server == null)) {
+        if ((exchangeHandler == null) || (idGenerator == null) ||
+            (exchangeListenerManager == null) || (server == null))
+        {
             throw new IllegalStateException("not initialized.");
         }
@@ -233 +252 @@
         server.stop();
         exchangeListenerManager.stop();
+        idGenerator.stop();
         exchangeHandler.stop();
         
         server = null;
         exchangeListenerManager = null;
+        idGenerator = null;
         exchangeHandler = null;
     }