Added documentation

Author: Tomiwa-Ot

webserver/logs/debug-backup-05-14-22-12-49-32-1.log.gz

@@ -0,0 +1 @@
+2022-08-24 20:44:15 WARN  App:47 - Getting ready to shutdown ...

webserver/logs/debug-backup-07-04-22-12-16-22-1.log.gz

@@ -81,6 +81,16 @@ public void run() {
 
     }
 
+    /**
+     * Performs basic authentication on incoming requests
+     * 
+     * @param socket Connection to perform authentication on
+     * @return       Returns a 2 element array of booleans. 
+     *               The first for if the request header contains
+     *               the Authorization header and the second for
+     *               if the supplied credentials are valid.
+     * @throws IOException
+     */
     public static boolean[] authStatus(Socket socket) throws IOException {
     	boolean[] auth = new boolean[2];
     	BufferedReader in = new BufferedReader(new InputStreamReader(socket.getInputStream()));
@@ -96,6 +106,14 @@ public static boolean[] authStatus(Socket socket) throws IOException {
 		return auth;
     }
 
+    /**
+     * Make a copy of the incoming request object
+     * 
+     * @param socket The incoming request
+     * @return       The copy of the request object
+     * @throws IOException
+     * @throws ClassNotFoundException
+     */
     public static Socket cloneSocket(Socket socket) throws IOException, ClassNotFoundException {
     	ByteArrayOutputStream baos = new ByteArrayOutputStream();
 		ObjectOutputStream oos = new ObjectOutputStream(baos);
@@ -106,6 +124,11 @@ public static Socket cloneSocket(Socket socket) throws IOException, ClassNotFoun
 		return (Socket) new ObjectInputStream(bais).readObject();
     }
 
+    /**
+     * Sets the port the web server should listen on
+     * 
+     * @param args
+     */
     public static void setPort(String[] args) {
     	if(args.length == 1 && Integer.parseInt(args[0]) >= Config.PORT_MIN && Integer.parseInt(args[0]) <= Config.PORT_MAX) {
     		Config.PORT = Integer.parseInt(args[0]);

webserver/logs/debug-backup-07-04-22-12-17-27-1.log.gz

@@ -10,10 +10,27 @@
 
 import at.favre.lib.crypto.bcrypt.BCrypt;
 
+/**
+ * Handles HTTP basic authentication
+ * 
+ * @author tomiwa
+ *
+ */
 public class Authenticator {
 
 	private static ArrayList<String> headers = new ArrayList<String>();
 
+	/**
+	 * Validate if authorization credentials are valid
+	 * 
+	 * @param s	       The incoming connection object
+	 * @param base64   The authorization header value 
+	 * 				   extracted from the connection
+	 *                 object
+	 * @return         Returns true if authentication
+	 *                 is successful and false if 
+	 *                 otherwise
+	 */
 	public static boolean authenticate(Socket s, String base64) {
 		String username = new String(Base64.getDecoder().decode(base64)).split(":")[0];
 		String password = new String(Base64.getDecoder().decode(base64)).split(":")[1];
@@ -29,6 +46,12 @@ public static boolean authenticate(Socket s, String base64) {
 		}
 	}
 
+	/**
+	 * Builds the view for a failed basic authentication
+	 * 
+	 * @param socket The connection to send the response to
+	 * @throws IOException
+	 */
 	public static void failedAuthenticationView(Socket socket) throws IOException {
 		failedAuthenticationHeaders(401);
 		DataOutputStream outputStream = new DataOutputStream(socket.getOutputStream());
@@ -41,6 +64,11 @@ public static void failedAuthenticationView(Socket socket) throws IOException {
 		outputStream.flush();
 	}
 
+	/**
+	 * Build the headers for a failed basic authentication
+	 * 
+	 * @param statusCode The HTTP response code
+	 */
 	public static void failedAuthenticationHeaders(int statusCode) {
 		SimpleDateFormat formatter= new SimpleDateFormat("yyyy-MM-dd 'at' HH:mm:ss z");
 		headers.add("HTTP/1.0 " + Integer.toString(statusCode) + " " + Config.STATUS_CODES.get(statusCode));
@@ -49,6 +77,11 @@ public static void failedAuthenticationHeaders(int statusCode) {
 		headers.add("Server: Simple Java Web Server");
 	}
 
+	/**
+	 * 
+	 * @param socket The incoming request
+	 * @throws IOException
+	 */
 	public static void responseView(Socket socket) throws IOException {
 		responseHeaders(401);
 		DataOutputStream outputStream = new DataOutputStream(socket.getOutputStream());
@@ -61,6 +94,11 @@ public static void responseView(Socket socket) throws IOException {
 		outputStream.flush();
 	}
 
+	/**
+	 * Builds a HTTP header that requests for basic authentication
+	 * 
+	 * @param statusCode The HTTP response code
+	 */
 	public static void responseHeaders(int statusCode) {
 		SimpleDateFormat formatter= new SimpleDateFormat("yyyy-MM-dd 'at' HH:mm:ss z");
 		headers.add("HTTP/1.0 " + Integer.toString(statusCode) + " " + Config.STATUS_CODES.get(statusCode));

webserver/logs/debug-backup-07-04-22-12-17-33-1.log.gz

@@ -11,7 +11,12 @@
 import org.json.simple.parser.JSONParser;
 import org.json.simple.parser.ParseException;
 
-
+/**
+ * Parse the web server configurations
+ * 
+ * @author tomiwa
+ *
+ */
 public class Config {
 
 	public static String username = null;
@@ -48,6 +53,12 @@ public static Config getInstance() {
 		return instance;
 	}
 
+	/**
+	 * Loads the web server configurations
+	 * 
+	 * @throws FileNotFoundException
+	 * @throws IOException
+	 */
 	public void loadConfigurations() throws FileNotFoundException, IOException {
 		JSONParser jsonParser = new JSONParser();
 		File properties = new File("src/main/resources/properties.json");

webserver/logs/debug-backup-07-04-22-12-18-49-1.log.gz

@@ -14,6 +14,13 @@
 import com.ot.webserver.maven_ot_webserver.Config;
 import com.ot.webserver.maven_ot_webserver.response.Response;
 
+
+/**
+ * Processes request on its in thread and returns a response to the client
+ * 
+ * @author tomiwa
+ *
+ */
 public class Handler implements Runnable {
 
 	private Socket socket;
@@ -29,6 +36,11 @@ public void run() {
 		processRequest(this.socket);
 	}
 
+	/**
+	 * Build the response header and body
+	 * 
+	 * @param s The incoming connection object
+	 */
 	public void processRequest(Socket s) {
 		try {
 			BufferedReader in = new BufferedReader(new InputStreamReader(this.socket.getInputStream()));
@@ -74,6 +86,12 @@ public void processRequest(Socket s) {
 		}
 	}
 
+	/**
+	 * List files and directories contained in the requested URI
+	 * 
+	 * @param uri  The URI in the incoming request
+	 * @param file The requested file or directory
+	 */
 	public void directoryListing(String uri, File file) {
 		StringBuilder output = new StringBuilder("<html><head><title>Index of " + uri);
 		output.append("</title></head><body><h1>Index of " + uri);

webserver/logs/debug-backup-07-04-22-12-19-42-1.log.gz

@@ -9,12 +9,23 @@
 
 import com.ot.webserver.maven_ot_webserver.Config;
 
+/**
+ * Handles the connection queue
+ * 
+ * @author tomiwa
+ *
+ */
 public class Listener {
 
 	private static final Listener instance = new Listener();
 	private static BlockingQueue<Socket> connectionQueue = new ArrayBlockingQueue<Socket>(Config.CONNECTION_QUEUE);
 	private static final Logger logger = LogManager.getLogger(Listener.class);
 
+	/**
+	 * Adds request to connection buffer
+	 * 
+	 * @param s Incoming connection
+	 */
 	public void addRequestToQueue(Socket s) {
 		try {
 			logger.info("New connection from " + s.getRemoteSocketAddress() + " added to connection queue");
@@ -24,6 +35,11 @@ public void addRequestToQueue(Socket s) {
 		}
 	}
 
+	/**
+	 * Removes request from the connection buffer
+	 * 
+	 * @return The connection object or null if connection buffer is empty
+	 */
 	public Socket handleRequest() {
 		try {
 			Socket s = connectionQueue.take();

webserver/logs/debug-backup-07-04-22-12-19-48-1.log.gz

@@ -12,6 +12,12 @@
 
 import com.ot.webserver.maven_ot_webserver.Config;
 
+/**
+ * Builds HTTP responses
+ * 
+ * @author tomiwa
+ *
+ */
 public class Response {
 
 	private byte[] bytes;
@@ -41,6 +47,9 @@ public Response(int statusCode, Socket socket, byte[] bytes, boolean isFile) {
 		this.isFile = isFile;
 	}
 
+	/**
+	 * Sets HTTP response header 
+	 */
 	public void responseHeaders() {
 		SimpleDateFormat formatter= new SimpleDateFormat("yyyy-MM-dd 'at' HH:mm:ss z");
 		headers.add("HTTP/1.0 " + Integer.toString(this.statusCode) + " " + Config.STATUS_CODES.get(this.statusCode));
@@ -50,6 +59,9 @@ public void responseHeaders() {
 		headers.add("Server: Simple Java Web Server");
 	}
 
+	/**
+	 * Selects the appropriate response view based on the status code
+	 */
 	public void responseView() {
 		responseHeaders();
 		try {
@@ -83,6 +95,14 @@ public void responseView() {
 
 	}
 
+	/**
+	 * Builds the response view
+	 * 
+	 * @param outputStream HTTP response object
+	 * @param bytes        The message to added in the 
+	 *                     response body
+	 * @throws IOException
+	 */
 	public void responseBytes(DataOutputStream outputStream, byte[] bytes) throws IOException {
 		for(String header : headers) {
 			outputStream.writeBytes(header + "\r\n");
@@ -95,6 +115,14 @@ public void responseBytes(DataOutputStream outputStream, byte[] bytes) throws IO
 		outputStream.flush();
 	}
 
+	/**
+	 * Builds the response view
+	 * 
+	 * @param outputStream HTTP response object
+	 * @param response     The message to be added in the
+	 * 					   response body
+	 * @throws IOException
+	 */
 	public void responseBytes(DataOutputStream outputStream, String response) throws IOException {
 		for(String header : headers) {
 			outputStream.writeBytes(header + "\r\n");