- * TODO comment + * represents infos of a client together with a shown URL and its title *
* @@ -13,20 +13,20 @@ /** - * + * id of a client */ private String clientId; /** - * + * browser used by the client */ private String userAgent; /** - * + * URL of the web site shown by the browser of the client */ private URL url; /** - * + * title of the web site shown by the browser of the client */ private String title; @@ -34,11 +34,12 @@ /** *- * TODO: comment + * instantiates an infos object with client id, browser at client side, the URL of the + * shown website and its title. *
* - * @param clientId - * @param userAgent - * @param url - * @param title + * @param clientId id of a client + * @param userAgent browser used by the client + * @param url URL of the web site shown by the browser of the client + * @param title title of the web site shown by the browser of the client */ public HtmlClientInfos(String clientId, String userAgent, URL url, String title) { Index: trunk/autoquest-htmlmonitor/src/main/java/de/ugoe/cs/autoquest/htmlmonitor/HtmlEvent.java =================================================================== --- trunk/autoquest-htmlmonitor/src/main/java/de/ugoe/cs/autoquest/htmlmonitor/HtmlEvent.java (revision 869) +++ trunk/autoquest-htmlmonitor/src/main/java/de/ugoe/cs/autoquest/htmlmonitor/HtmlEvent.java (revision 870) @@ -3,5 +3,8 @@ /** *- * TODO comment + * represents an event caused by a user on a specific web site. An event contains the infos + * about the client ({@link HtmlClientInfos}, when ant where the event took place, the type of + * event and some additional infos such as the event coordinates or the number of the pressed + * key. *
* @@ -11,35 +14,35 @@ /** - * + * infos about the client that caused the event */ private HtmlClientInfos clientInfos; /** - * + * the time stamp of the event */ private Long time; /** - * + * the path in the HTML DOM to the object on which the event was executed */ private String path; /** - * + * the type of the event, e.g. onclick */ private String eventType; /** - * + * the coordinates of the event, usually an array with two values (x and y) */ private Integer[] coordinates; /** - * + * if the event is a key event, the key that was pressed or released */ private Integer key; /** - * + * if the event is a scroll event, the resulting position of the scrolled element */ private Integer scrollPosition; @@ -47,14 +50,16 @@ /** *- * TODO: comment + * initializes the event with all relevantinfos *
* - * @param clientInfos - * @param time - * @param path - * @param eventType - * @param coordinates - * @param key - * @param scrollPosition + * @param clientInfos infos about the client that caused the event + * @param time the time stamp of the event + * @param path the path in the HTML DOM to the object on which the event was executed + * @param eventType the type of the event, e.g. onclick + * @param coordinates the coordinates of the event, usually an array with two values + * (x and y) + * @param key if the event is a key event, the key that was pressed or released + * @param scrollPosition if the event is a scroll event, the resulting position of the + * scrolled element */ HtmlEvent(HtmlClientInfos clientInfos, Index: trunk/autoquest-htmlmonitor/src/main/java/de/ugoe/cs/autoquest/htmlmonitor/HtmlMonitor.java =================================================================== --- trunk/autoquest-htmlmonitor/src/main/java/de/ugoe/cs/autoquest/htmlmonitor/HtmlMonitor.java (revision 869) +++ trunk/autoquest-htmlmonitor/src/main/java/de/ugoe/cs/autoquest/htmlmonitor/HtmlMonitor.java (revision 870) @@ -5,5 +5,8 @@ /** *- * TODO comment + * The HTML monitor starts a web server ({@link HtmlMonitorServer}) that receives log messages + * of the HTML monitor java script. These messages are logged using the + * {@link HtmlMonitorLogManager}. The class assures that on shutdown e.g. caused by CTRL-C the + * server and the log manager are stopped correctly. *
* @@ -12,27 +15,39 @@ public class HtmlMonitor implements HtmlMonitorComponent { - /** */ + /** + * the port on which the webserver shall listen. Defaults to 8090. + */ private int port = 8090; - /** */ + /** + * the web server receiving the log messages + */ private HtmlMonitorServer server; - /** */ + /** + * the directory into which the log files shall be written + */ private String logFileBaseDir; - /** */ + /** + * the log manager being responsible for performing the logging + */ private HtmlMonitorLogManager logManager; - /** */ + /** + * the thread needed to handle CTRL-C events + */ private Thread shutdownHook; /** *- * TODO: comment + * initializes the monitor with the command line arguments. Those may be the log directory + * as first argument and the port to listen on as second *
* - * @param logFileBaseDir + * @param commandLineArguments the command line arguments when starting the monitor using + * the {@link Runner} */ - HtmlMonitor(String[] commandLineArguments) { + public HtmlMonitor(String[] commandLineArguments) { if (commandLineArguments.length > 0) { this.logFileBaseDir = commandLineArguments[0]; Index: trunk/autoquest-htmlmonitor/src/main/java/de/ugoe/cs/autoquest/htmlmonitor/HtmlMonitorComponent.java =================================================================== --- trunk/autoquest-htmlmonitor/src/main/java/de/ugoe/cs/autoquest/htmlmonitor/HtmlMonitorComponent.java (revision 869) +++ trunk/autoquest-htmlmonitor/src/main/java/de/ugoe/cs/autoquest/htmlmonitor/HtmlMonitorComponent.java (revision 870) @@ -3,5 +3,7 @@ /** *- * TODO comment + * convenience interface for all components making up the HTML monitor. All components implement + * this interface to ensure homogeneity throughout them. A component must first be initialized + * ({@link #init()}), then started ({@link #start()}) and finally stopped ({@link #stop()}). *
* @@ -11,15 +13,27 @@ /** + * initializes a component, i.e. it does everything needed to prepare starting the component * + * @throws IllegalStateException thrown if the method was already called before but + * {@link #stop()} wasn't called yet + * @throws HtmlMonitorException thrown if the initialization fails, e.g. because needed infos + * are missing */ void init() throws IllegalStateException, HtmlMonitorException; /** + * starts a component * + * @throws IllegalStateException thrown if {@link #init()} wasn't called yet of if the component + * is already started through a preceding call to this method + * @throws HtmlMonitorException thrown if the startup fails, e.g. because needed infos + * are missing */ void start() throws IllegalStateException, HtmlMonitorException; /** - * + * stops a component and cleans up any derivate. In the following, {@link #init()} must be + * callable again. If the component is not initialized or started, nothing must happen. If the + * component is initialized but not started, the initialization is revoked. */ void stop(); Index: trunk/autoquest-htmlmonitor/src/main/java/de/ugoe/cs/autoquest/htmlmonitor/HtmlMonitorException.java =================================================================== --- trunk/autoquest-htmlmonitor/src/main/java/de/ugoe/cs/autoquest/htmlmonitor/HtmlMonitorException.java (revision 869) +++ trunk/autoquest-htmlmonitor/src/main/java/de/ugoe/cs/autoquest/htmlmonitor/HtmlMonitorException.java (revision 870) @@ -3,5 +3,6 @@ /** *- * TODO comment + * Exception to notify all irregularities, that are specific to the HTML monitor and its + * components. *
* @@ -15,7 +16,8 @@ /** *+ * initializes an exception with a simple message *
* - * @param message + * @param message the message of the exception */ public HtmlMonitorException(String message) { @@ -25,8 +27,9 @@ /** *+ * initializes an exception with a simple message and a causing exception *
* - * @param message - * @param cause + * @param message the message of the exception + * @param cause the root cause of the exception */ public HtmlMonitorException(String message, Throwable cause) {