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

Timestamp:

02/13/14 11:28:18 (10 years ago)

Author:

pharms

Message:

• Added JavaDoc?

File:

• trunk/autoquest-httpmonitor/src/main/java/de/ugoe/cs/autoquest/httpmonitor/proxy/HttpMonitorRemoteExchangeHandler.java (modified) (4 diffs)

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

@@ -34 +34 @@
 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;
@@ -43 +44 @@
 /**
  * <p>
- * TODO comment
+ * If the exchanges recorded by the proxy are to be transmitted to a central {@link HttpMonitor},
+ * this exchanges handler is used. It is called by the exchange listener on completion of a proxied
+ * 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.
  * </p>
  * 
@@ -55 +60 @@
     private static final long serialVersionUID = 1L;
 
-    /** */
+    /**
+     * <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>();
     
     /**
      * <p>
-     * TODO: comment
+     * initializes the exchange handler with the host and port of the central server
      * </p>
      *
-     * @param httpMonitorServer2
-     * @param httpMonitorPort2
+     * @param httpMonitorServer the host name of the central server
+     * @param httpMonitorPort   the port of the central server
      */
     public HttpMonitorRemoteExchangeHandler(String httpMonitorServer, int httpMonitorPort) {
@@ -187 +208 @@
 
     /**
-     * 
+     * <p>
+     * convenience method to create an initialize the utilized HTTP client
+     * </p>
      */
     private HttpClient createHttpClient() {