- 1 Introduction
- 2 Configuring Jetty
- 3 Consulting the Jetty API Docs
Configuring Jetty consists of building a network of connectors and handlers and providing their individual configurations. It is a combination of
- HTTP server configuration (ports, thread pools, buffers, etc.)
- Web container configuration (webapps deployment, security realms, JNDI etc.)
- Web application (init parameters, non standard options, etc.)
See Jetty Architecture for graphical representations of the interactions among connectors and handlers.
Since Jetty components are simply Plain Old Java Objects (POJOs), you can accomplish this assembly and configuration of Jetty by a variety of techniques:
Developing Against the Jetty API
You can develop both standard web applications and embedded web applications by writing code. The basic approach is to install the required Jetty-7 jars and dependencies on your class path and then write and run a variation of one of the examples in the Embedding Jetty Tutorial.
For more details about setting up your class path, see:
For more information on developing against the Jetty API, as well as explanations of other tools, including the Jetty Maven, Ant, and OSGi plugins, see: How to Develop Jetty.
Above all, study the examples in the Jetty 7 Latest Source XRef.
Using Jetty XML
Jetty XML offers XML equivalents to code. It is based on Java's Reflection API. Classes in the java.lang.reflect represent Java methods and classes, such that you can instantiate objects and invoke their methods based on their names and argument types. Behind the scenes, Jetty's XML config parser translates the XML elements and attributes into Reflection calls.
The default configuration file for Jetty is jetty.xml, typically located at $JETTY_HOME/etc/jetty.xml. Usually jetty.xml configures these components:
- the Server class (or subclass if extended) and global options
- a ThreadPool (min & max thread)
- connectors (ports, timeouts, buffer sizes, protocol, etc.)
- the handler structure (default handlers and/or a contextHandlerCollections, etc.)
- the deployment manager that scans for and deploys webapps and contexts
- login services that provide authentication checking
- a request log
Not all Jetty features are configured in jetty.xml. There are several optional configuration files that share the same format as jetty.xml and, if specified, concatenate to it. These configuration files are also stored in $JETTY_HOME/etc/, and examples of them are in svn.
- Start.jar selects the configuration files to use.
- jetty XML Usage describes the process of merging configuration files.
- Jetty.xml Syntax describes the syntax for using jetty.xml
- configure.dtd - document type descriptor for the org.eclipse.XmlConfiguration class
- jetty-web.xml - Webapp configuration file
- jetty-env.xml - JNDI configuration file
- webdefault.xml - Pre-web.xml configuration
- override-web.xml - Post-web.xml configuration
- Ethan McAllum makes this point in his appreciative article about Jetty, What is Jetty
You can embed Jetty in an application. This is an alternative to bundling your application as a standard WAR to be deployed in Jetty. Jetty is designed to work as a software component that can be instantiated and used in a Java program just like any any POJO. For more information and configuration instructions, see Embedding Jetty.
Using the Jetty Maven Plugin
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. For information and configuration instructions, see
Using Your Favorite Dependency Injection Framework: Spring, XBean
You can use almost any IoC-style framework, including Spring and XBean, to assemble and configure Jetty.
Configuring Jetty with Spring
The jetty-spring module is included in jetty@codehaus with some convenience classes and a Main method to run Jetty from Spring. For more information, see:
Configuring Jetty with XBean
Jetty7 includes support for XBean, allowing you to use an XML format to customize Jetty within an XBean configuration file. For more information, see Configuring Jetty with XBean.
Consulting the Jetty API Docs
The Jetty API docs are the ultimate resource for configuration, regardless of the configuration method you use. This is because Jetty configuration can be considered as calling setters on a collection of POJOs.