aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorThomas Becker2013-09-19 05:03:42 (EDT)
committerThomas Becker2013-09-19 05:33:36 (EDT)
commit50926a04360a0a645426a8030f341ca89c0621e0 (patch)
tree03217d2820065dc8bf560bef3c9e0013cf5c07e3
parentf19f6ce5cdd5f46486d2fefdd6efb43d6f173e5a (diff)
downloadorg.eclipse.jetty.project-50926a04360a0a645426a8030f341ca89c0621e0.zip
org.eclipse.jetty.project-50926a04360a0a645426a8030f341ca89c0621e0.tar.gz
org.eclipse.jetty.project-50926a04360a0a645426a8030f341ca89c0621e0.tar.bz2
416453 Add comments to embedded OneWebApp example
-rw-r--r--examples/embedded/src/main/java/org/eclipse/jetty/embedded/FileServer.java2
-rw-r--r--examples/embedded/src/main/java/org/eclipse/jetty/embedded/OneWebApp.java19
2 files changed, 19 insertions, 2 deletions
diff --git a/examples/embedded/src/main/java/org/eclipse/jetty/embedded/FileServer.java b/examples/embedded/src/main/java/org/eclipse/jetty/embedded/FileServer.java
index f47b666..d5cb601 100644
--- a/examples/embedded/src/main/java/org/eclipse/jetty/embedded/FileServer.java
+++ b/examples/embedded/src/main/java/org/eclipse/jetty/embedded/FileServer.java
@@ -51,7 +51,7 @@ public class FileServer
handlers.setHandlers(new Handler[] { resource_handler, new DefaultHandler() });
server.setHandler(handlers);
- //Start things up! By using the server.join() the server thread will join with the current thread.
+ // Start things up! By using the server.join() the server thread will join with the current thread.
// See "http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Thread.html#join()" for more details.
server.start();
server.join();
diff --git a/examples/embedded/src/main/java/org/eclipse/jetty/embedded/OneWebApp.java b/examples/embedded/src/main/java/org/eclipse/jetty/embedded/OneWebApp.java
index d2750db..847fe7d 100644
--- a/examples/embedded/src/main/java/org/eclipse/jetty/embedded/OneWebApp.java
+++ b/examples/embedded/src/main/java/org/eclipse/jetty/embedded/OneWebApp.java
@@ -26,19 +26,36 @@ public class OneWebApp
{
public static void main(String[] args) throws Exception
{
+ // Create a basic jetty server object that will listen on port 8080. Note that if you set this to port 0 then
+ // a randomly available port will be assigned that you can either look in the logs for the port,
+ // or programmatically obtain it for use in test cases.
Server server = new Server(8080);
+ // The WebAppContext is the entity that controls the environment in which a web application lives and
+ // breathes. In this example the context path is being set to "/" so it is suitable for serving root context
+ // requests and then we see it setting the location of the war. A whole host of other configurations are
+ // available, ranging from configuring to support annotation scanning in the webapp (through
+ // PlusConfiguration) to choosing where the webapp will unpack itself.
WebAppContext webapp = new WebAppContext();
webapp.setContextPath("/");
webapp.setWar("../../tests/test-webapps/test-jetty-webapp/target/test-jetty-webapp-9.0.0-SNAPSHOT.war");
+
+ // A WebAppContext is a ContextHandler as well so it needs to be set to the server so it is aware of where to
+ // send the appropriate requests.
server.setHandler(webapp);
-
+
// Configure a LoginService
+ // Since this example is for our test webapp, we need to setup a LoginService so this shows how to create a
+ // very simple hashmap based one. The name of the LoginService needs to correspond to what is configured in
+ // the webapp's web.xml and since it has a lifecycle of its own we register it as a bean with the Jetty
+ // server object so it can be started and stopped according to the lifecycle of the server itself.
HashLoginService loginService = new HashLoginService();
loginService.setName("Test Realm");
loginService.setConfig("src/test/resources/realm.properties");
server.addBean(loginService);
+ // Start things up! By using the server.join() the server thread will join with the current thread.
+ // See "http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Thread.html#join()" for more details.
server.start();
server.join();
}