Merge pull request #3 from michalwa/master

Minor Enhancements & Code Style Fixes

Author: simonwep

README.md

@@ -33,9 +33,7 @@ Express app = new Express();
 
 app.get("/", (req, res) -> {
    res.send("Hello World");
-});
-
-app.listen(); // Will listen on port 80 which is set as default
+}).listen(); // Will listen on port 80 which is set as default
 ```
 
 # Docs:

src/main/java/examples/AuthorizationExamples.java

@@ -0,0 +1,24 @@
+package examples;
+
+import express.Express;
+import express.http.request.Authorization;
+import express.utils.Status;
+
+public class AuthorizationExamples
+{
+	public static void main(String[] args)
+	{
+		Express app = new Express();
+		
+		app.get("/", (req, res) -> {
+			if(Authorization.validate(req, Authorization.validator("Basic", "123456789"))) {
+				res.send("You are authorized!");
+			} else {
+				res.setStatus(Status._401);
+				res.send();
+			}
+		});
+		
+		app.listen(() -> System.out.println("Listening!"));
+	}
+}

src/main/java/examples/Examples.java

@@ -12,54 +12,52 @@ public class Examples {
   public static void main(String[] args) throws IOException {
     Express app = new Express();
 
-    app.get("/", (req, res) -> {
-      res.send("Hello World");
-    });
-
-    app.get("/posts", (req, res) -> {
+    app.get("/", (req, res) -> res.send("Hello World"))
+    
+    .get("/posts", (req, res) -> {
       String page = req.getQuery("page"); // Contains '12'
       String from = req.getQuery("from"); // Contains 'John'
       res.send("Page: " + page + ", from: " + from); // Send: "Page: 12, from: John"
-    });
+    })
 
-    app.get("/posts/:user/:type", (req, res) -> {
+    .get("/posts/:user/:type", (req, res) -> {
       String user = req.getParam("user"); // Contains 'john'
       String type = req.getParam("type"); // Contains 'all'
       res.send("User: " + user + ", type: " + type); // Send: "User: john, type: all"
-    });
+    })
 
-    app.get("/setcookie", (req, res) -> {
+    .get("/setcookie", (req, res) -> {
       Cookie cookie = new Cookie("username", "john");
       res.setCookie(cookie);
       res.send("Cookie has been set!");
-    });
+    })
 
-    app.get("/showcookie", (req, res) -> {
+    .get("/showcookie", (req, res) -> {
       Cookie cookie = req.getCookie("username");
       String username = cookie.getValue();
       res.send("The username is: " + username); // Prints "The username is: john"
-    });
+    })
 
-    app.post("/register", (req, res) -> {
+    .post("/register", (req, res) -> {
       String email = req.getFormQuery("email");
       String username = req.getFormQuery("username");
       // Process data
 
       // Prints "E-Mail: [email protected], Username: john"
       res.send("E-Mail: " + email + ", Username: " + username);
-    });
+    })
 
-    app.get("/res", (req, res) -> {
+    .get("/res", (req, res) -> {
       // res.send();                     // Send empty response
       // res.send("Hello World");        // Send an string
       // res.send("chart.pdf");          // Send an file
       // res.setStatus(200);             // Set the response status
       // res.getStatus();                // Returns the current response status
       // res.setCookie(new Cookie(...)); // Send an cookie
       // res.isClosed();                 // Check if already something has been send to the client
-    });
+    })
 
-    app.get("/req/", (req, res) -> {
+    .get("/req/", (req, res) -> {
       // req.getURI();                        // Request URI
       // req.getHost();                       // Request host (mostly localhost)
       // req.getMethod();                     // Request method (here GET)
@@ -76,14 +74,14 @@ public static void main(String[] args) throws IOException {
       // req.getAuthorization();              // Returns the authorization header
       // req.getMiddlewareContent("name");    // Returns data from middleware
       // req.pipe(new OutputStream() {...});  // Pipe the body to an outputstream
-    });
+    })
 
-    app.use(Middleware.cookieSession("f3v4", 9000));
+    .use(Middleware.cookieSession("f3v4", 9000))
 
-    app.get("/session", (req, res) -> {
+    .get("/session", (req, res) -> {
 
       /*
-       * CookieSession named his data "Session Cookie" which is
+       * CookieSession named its data "SessionCookie" which is
        * an SessionCookie so we can Cast it.
        */
       SessionCookie sessionCookie = (SessionCookie) req.getMiddlewareContent("SessionCookie");
@@ -93,18 +91,18 @@ public static void main(String[] args) throws IOException {
       if (sessionCookie.getData() == null) {
 
         // Set the default data to 1 (first request with this session cookie)
-        count = (Integer) sessionCookie.setData(1);
+        count = (int) sessionCookie.setData(1);
       } else {
 
         // Now we know that the cookie has an integer as data property, increase it
-        count = (Integer) sessionCookie.setData((Integer) sessionCookie.getData() + 1);
+        count = (int) sessionCookie.setData((int) sessionCookie.getData() + 1);
       }
 
       // Send an info message
       res.send("You take use of your session cookie " + count + " times.");
-    });
+    })
 
-    app.listen(() -> System.out.println("Express is listening!"));
+    .listen(() -> System.out.println("Express is listening!"));
   }
 
 }

src/main/java/examples/PortMiddleware.java

@@ -1,11 +1,11 @@
 package examples;
 
 import express.filter.Filter;
-import express.http.HttpRequest;
+import express.http.HttpRequestHandler;
 import express.http.request.Request;
 import express.http.response.Response;
 
-public class PortMiddleware implements HttpRequest, Filter {
+public class PortMiddleware implements HttpRequestHandler, Filter {
 
 
   /**

src/main/java/express/Express.java

@@ -7,7 +7,7 @@
 import express.filter.FilterLayerHandler;
 import express.filter.FilterTask;
 import express.filter.FilterWorker;
-import express.http.HttpRequest;
+import express.http.HttpRequestHandler;
 
 import java.io.IOException;
 import java.net.InetSocketAddress;
@@ -22,11 +22,11 @@
  */
 public class Express implements Router {
 
-  private final ConcurrentHashMap<String, HttpRequest> PARAMETER_LISTENER;
-  private final ConcurrentHashMap<Object, Object> LOCALS;
+  private final ConcurrentHashMap<String, HttpRequestHandler> parameterListener;
+  private final ConcurrentHashMap<Object, Object> locals;
 
-  private final ArrayList<FilterWorker> WORKER;
-  private final FilterLayerHandler HANDLER;
+  private final ArrayList<FilterWorker> worker;
+  private final FilterLayerHandler handler;
 
   private Executor executor;
   private String hostname;
@@ -35,11 +35,11 @@ public class Express implements Router {
 
   {
     // Initialize
-    PARAMETER_LISTENER = new ConcurrentHashMap<>();
-    LOCALS = new ConcurrentHashMap<>();
+    parameterListener = new ConcurrentHashMap<>();
+    locals = new ConcurrentHashMap<>();
 
-    WORKER = new ArrayList<>();
-    HANDLER = new FilterLayerHandler(2);
+    worker = new ArrayList<>();
+    handler = new FilterLayerHandler(2);
 
     executor = Executors.newCachedThreadPool();
   }
@@ -89,17 +89,18 @@ public boolean isSecure() {
   }
 
   /**
-   * Add an listener which will be called when an url with this parameter is called.
+   * Add a listener which will be called when an url with this parameter is called.
    *
    * @param param   The parameter name.
    * @param request An request handler.
    */
-  public void onParam(String param, HttpRequest request) {
-    PARAMETER_LISTENER.put(param, request);
+  public Express onParam(String param, HttpRequestHandler request) {
+    parameterListener.put(param, request);
+    return this;
   }
 
-  public ConcurrentHashMap<String, HttpRequest> getParameterListener() {
-    return PARAMETER_LISTENER;
+  public ConcurrentHashMap<String, HttpRequestHandler> getParameterListener() {
+    return parameterListener;
   }
 
   /**
@@ -111,7 +112,7 @@ public ConcurrentHashMap<String, HttpRequest> getParameterListener() {
    * @return The last value which was attached by this key, can be null.
    */
   public Object set(String key, String val) {
-    return LOCALS.put(key, val);
+    return locals.put(key, val);
   }
 
   /**
@@ -121,7 +122,7 @@ public Object set(String key, String val) {
    * @return The value.
    */
   public Object get(String key) {
-    return LOCALS.get(key);
+    return locals.get(key);
   }
 
   /**
@@ -144,9 +145,10 @@ public void setExecutor(Executor executor) throws IOException {
    *
    * @param router The router.
    */
-  public void use(ExpressRouter router) {
-    this.HANDLER.combine(router.getHandler());
-    this.WORKER.addAll(router.getWorker());
+  public Express use(ExpressRouter router) {
+    this.handler.combine(router.getHandler());
+    this.worker.addAll(router.getWorker());
+    return this;
   }
 
   /**
@@ -156,67 +158,80 @@ public void use(ExpressRouter router) {
    * @param router The router.
    */
   @SuppressWarnings("unchecked")
-  public void use(String root, ExpressRouter router) {
+  public Express use(String root, ExpressRouter router) {
 
     router.getHandler().forEach(fl -> fl.getFilter().forEach(layer -> {
       ((FilterImpl) layer).setRoot(root);
     }));
 
-    this.HANDLER.combine(router.getHandler());
-    this.WORKER.addAll(router.getWorker());
+    this.handler.combine(router.getHandler());
+    this.worker.addAll(router.getWorker());
+  
+    return this;
   }
 
-  public void use(HttpRequest middleware) {
+  public Express use(HttpRequestHandler middleware) {
     addMiddleware("*", "*", middleware);
+    return this;
   }
 
-  public void use(String context, HttpRequest middleware) {
+  public Express use(String context, HttpRequestHandler middleware) {
     addMiddleware("*", context, middleware);
+    return this;
   }
 
-  public void use(String context, String requestMethod, HttpRequest middleware) {
+  public Express use(String context, String requestMethod, HttpRequestHandler middleware) {
     addMiddleware(requestMethod.toUpperCase(), context, middleware);
+    return this;
   }
 
   // Internal service to handle middleware
-  private void addMiddleware(String requestMethod, String context, HttpRequest middleware) {
+  private void addMiddleware(String requestMethod, String context, HttpRequestHandler middleware) {
     if (middleware instanceof FilterTask) {
-      WORKER.add(new FilterWorker((FilterTask) middleware));
+      worker.add(new FilterWorker((FilterTask) middleware));
     }
 
-    HANDLER.add(0, new FilterImpl(requestMethod, context, middleware));
+    handler.add(0, new FilterImpl(requestMethod, context, middleware));
   }
 
-  public void all(HttpRequest request) {
-    HANDLER.add(1, new FilterImpl("*", "*", request));
+  public Express all(HttpRequestHandler request) {
+    handler.add(1, new FilterImpl("*", "*", request));
+    return this;
   }
 
-  public void all(String context, HttpRequest request) {
-    HANDLER.add(1, new FilterImpl("*", context, request));
+  public Express all(String context, HttpRequestHandler request) {
+    handler.add(1, new FilterImpl("*", context, request));
+    return this;
   }
 
-  public void all(String context, String requestMethod, HttpRequest request) {
-    HANDLER.add(1, new FilterImpl(requestMethod, context, request));
+  public Express all(String context, String requestMethod, HttpRequestHandler request) {
+    handler.add(1, new FilterImpl(requestMethod, context, request));
+    return this;
   }
 
-  public void get(String context, HttpRequest request) {
-    HANDLER.add(1, new FilterImpl("GET", context, request));
+  public Express get(String context, HttpRequestHandler request) {
+    handler.add(1, new FilterImpl("GET", context, request));
+    return this;
   }
 
-  public void post(String context, HttpRequest request) {
-    HANDLER.add(1, new FilterImpl("POST", context, request));
+  public Express post(String context, HttpRequestHandler request) {
+    handler.add(1, new FilterImpl("POST", context, request));
+    return this;
   }
 
-  public void put(String context, HttpRequest request) {
-    HANDLER.add(1, new FilterImpl("PUT", context, request));
+  public Express put(String context, HttpRequestHandler request) {
+    handler.add(1, new FilterImpl("PUT", context, request));
+    return this;
   }
 
-  public void delete(String context, HttpRequest request) {
-    HANDLER.add(1, new FilterImpl("DELETE", context, request));
+  public Express delete(String context, HttpRequestHandler request) {
+    handler.add(1, new FilterImpl("DELETE", context, request));
+    return this;
   }
 
-  public void patch(String context, HttpRequest request) {
-    HANDLER.add(1, new FilterImpl("PATCH", context, request));
+  public Express patch(String context, HttpRequestHandler request) {
+    handler.add(1, new FilterImpl("PATCH", context, request));
+    return this;
   }
 
   /**
@@ -259,7 +274,7 @@ public void listen(ExpressListener onStart, int port) {
       try {
 
         // Fire worker threads
-        WORKER.forEach(FilterWorker::start);
+        worker.forEach(FilterWorker::start);
 
         InetSocketAddress socketAddress = this.hostname == null ? new InetSocketAddress(port) : new InetSocketAddress(this.hostname, port);
         if (httpsConfigurator != null) {
@@ -277,7 +292,7 @@ public void listen(ExpressListener onStart, int port) {
         httpServer.setExecutor(executor);
 
         // Create handler for all contexts
-        httpServer.createContext("/", exchange -> HANDLER.handle(exchange, this));
+        httpServer.createContext("/", exchange -> handler.handle(exchange, this));
 
         // Start server
         httpServer.start();
@@ -302,7 +317,7 @@ public void stop() {
       httpServer.stop(0);
 
       // Stop worker threads
-      WORKER.forEach(FilterWorker::stop);
+      worker.forEach(FilterWorker::stop);
     }
   }
 }