Jetty/Tutorial/Jetty and Maven HelloWorld

From Eclipsepedia

< Jetty‎ | Tutorial
Revision as of 13:54, 23 April 2013 by (Talk | contribs)

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search



Apache Maven is a software project management and comprehension tool. Based on the concept of a project object model (POM), Maven can manage a project's build, reporting and documentation from a central piece of information. It is an ideal tool to build a web application project, and such projects can use the Jetty Maven Plugin to run the web application in development mode.

You can use Maven both to build embedded Jetty applications and standards based web applications.

To understand the basic operations of building and running against Jetty, first review:


Configuring Embedded Jetty with Maven

Maven uses convention over configuration, so it is best to use the project structure as Maven recommends. You can use Archetypes to quickly setup Maven projects, but for this tutorial, we will set up the structure manually:

mkdir JettyMavenHelloWorld
cd JettyMavenHelloWorld
mkdir -p src/main/java/org/example

Creating the HelloWorld Class

Use an editor to create the file src/main/java/org/example/ with the following contents:

package org.example;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import javax.servlet.ServletException;
import org.eclipse.jetty.server.Server;
import org.eclipse.jetty.server.Request;
import org.eclipse.jetty.server.handler.AbstractHandler;
public class HelloWorld extends AbstractHandler
    public void handle(String target,
                       Request baseRequest,
                       HttpServletRequest request,
                       HttpServletResponse response) 
        throws IOException, ServletException
        response.getWriter().println("<h1>Hello World</h1>");
    public static void main(String[] args) throws Exception
        Server server = new Server(8080);
        server.setHandler(new HelloWorld());

Creating the POM Descriptor

The pom.xml file declares the project name and it's dependencies. Use an editor to create the file pom.xml with the following contents:

<project xmlns="" 
  <name>Jetty HelloWorld</name>
        <!-- This plugin is needed for the servlet example -->

Building and Running Embedded HelloWorld

You can now compile and execute the HelloWorld class by using these commands:

mvn clean compile exec:java

You can point your browser to http://localhost:8080 to see the hello world page. You can observe what Maven is doing for you behind the scenes by using the mvn dependency:tree command, which reveals the transitive dependency resolved and downloaded as:

> mvn dependency:tree
[INFO] Scanning for projects...
[INFO] Searching repository for plugin with prefix: 'dependency'.
[INFO] ------------------------------------------------------------------------
[INFO] Building Jetty HelloWorld
[INFO]    task-segment: [dependency:tree]
[INFO] ------------------------------------------------------------------------
[INFO] [dependency:tree {execution: default-cli}]
[INFO] org.example:hello-world:jar:0.1-SNAPSHOT
[INFO] \- org.eclipse.jetty:jetty-server:jar:7.0.1.v20091125:compile
[INFO]    +- javax.servlet:servlet-api:jar:2.5:compile
[INFO]    +- org.eclipse.jetty:jetty-continuation:jar:7.0.1.v20091125:compile
[INFO]    \- org.eclipse.jetty:jetty-http:jar:7.0.1.v20091125:compile
[INFO]       \- org.eclipse.jetty:jetty-io:jar:7.0.1.v20091125:compile
[INFO]          \- org.eclipse.jetty:jetty-util:jar:7.0.1.v20091125:compile
[INFO] ------------------------------------------------------------------------
[INFO] ------------------------------------------------------------------------
[INFO] Total time: 4 seconds
[INFO] Finished at: Tue Feb 16 16:19:08 EST 2010
[INFO] Final Memory: 11M/68M
[INFO] ------------------------------------------------------------------------

Developing a Standard WebApp with Jetty and Maven

The example above shows how to run a hello world example as an embedded Jetty handler. The following example shows how to develop a standard webapp with Maven and Jetty. First create the Maven structure:

mkdir JettyMavenHelloWarApp
cd JettyMavenHelloWarApp
mkdir -p src/main/java/org/example
mkdir -p src/main/webapp/WEB-INF

Creating Static Content

A web application can contain static content, so create the file src/main/webapp/index.html with the following contents:

<h1>Hello World Webapp</h1>
<a href="/hello">Hello Servlet</a>

Creating a Servlet

Use an editor to create the file src/main/java/org/example/ with the following contents:

package org.example;
import javax.servlet.ServletException;
import javax.servlet.http.HttpServlet;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
public class HelloServlet extends HttpServlet
    protected void doGet(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException
        response.getWriter().println("<h1>Hello Servlet</h1>");
        response.getWriter().println("session=" + request.getSession(true).getId());

This servlet needs to be declared in the deployment descriptor, so edit the file src/main/webapp/WEB-INF/web.xml and add the following contents:

<?xml version="1.0" encoding="ISO-8859-1"?>

Building and Running the Web Application

Copy the pom.xml and then you can build and run the web application by using the command:

mvn jetty:run

You can see the static and dynamic content at http://localhost:8080/hello-world/hello. The context path portion of the url ("hello-world") comes from the artifact ID in the pom.xml file.

Building a WAR file

You can create a Web Application Archive (WAR) file from the project with the command:

mvn package

The resulting war file is in the target directory and may be deployed on any standard servlet server or deployed to jetty.