Jetty example source code file (README.txt)

This example Jetty source code file (README.txt) is included in the DevDaily.com "Java Source Code Warehouse" project. The intent of this project is to help you "Learn Java by Example" ^TM.

Java - Jetty tags/keywords

dependencies, deployment, generated, if, jetty, jetty, running, running, source, the, the, this, this, with

The Jetty README.txt source code

This is the Jetty 6 HTTP server and servlet container.

For more information about Jetty, please see the Jetty wiki: 

   http://docs.codehaus.org/display/JETTY/

DIRECTORY LAYOUT
================
bin                   utility scripts and executables
contexts              Deployment directory for context descriptors
contrib               Source modules for optional jetty packages in the jetty-contrib repository, which has a larger more open group of committers
etc                   Configuration files
examples              Example projects
extras                Source modules for optional jetty packages in the main jetty repository.
javadoc               Generated javadoc
lib                   Generated libraries
LICENSES              License
logs                  Request log and server log files
modules               Source modules for core jetty packages
patches               Optional patches for source modules
pom.xml               Build configuration for maven
project-website       Project Website
README.txt            This file
resources             Directory for resources to include on classpath
start.jar             Start jar for jetty
VERSION.txt           Version history
webapps               Deployment directory for standard webapps


RUNNING JETTY
=============
From the release, you can run the server with:

   java -jar start.jar

and then point your browser at 

   http://localhost:8080

and click to the test webapp, where there are some demos and more
information.

The start command above is equivalent to 

   java -jar start.jar etc/jetty.xml

which gives a configuration file on the commandline. An explicit
configuration file (or multiple configuration files) may be
given to select specific configurations.

There is also a unix start script in bin/jetty.sh that can be used
in /etc/init.d

JETTY DEPENDENCIES
==================

The Jetty build is rather large, because it bundles many optional
packages.

Jetty depends ONLY on a jre 1.4 runtime and the three jars found in
the top level of the $JETTY_HOME/lib directory:

  servlet-api-2.5-$VERSION.jar
  jetty-$VERSION.jar
  jetty-util-$VERSION.jar
 
For small foot print applications, these three jars can be 
trimmed of excess classes - we will soon automate generation
of such minimal assemblies.

The jars found in the subdirectories are all optional:

  jsp-2.0/*.jar   (depends on java 2 (jre 1.4))
  jsp-2.1/*.jar   (depends on java 5 (jre 1.5))
  management/*.jar
  naming/*.jar
  plus/*.jar
  xbean/*.jar

The start.jar includes all these options if they are
left in the lib subdirectories.

The start.jar will also select the version of JSP to
use based on the version of the jre available.


RUNNING WITH JMX
================

The server can be run with JMX management with the command:

   java -jar start.jar etc/jetty-jmx.xml etc/jetty.xml
   
This command adds the jmx configuration file before the server
configuration.

RUNNING WITH JETTY PLUS
=======================

The server can be run as JettyPlus (JNDI, JAAS etc.) with the 
command:

   java -jar start.jar etc/jetty.xml etc/jetty-plus.xml
   
This command adds the plus configuration file after the server configuration file,
although you will first need to follow the instructions inside the etc/jetty-plus.xml
file.

RUNNING WITH OTHER CONTAINERS
=============================
If you wish to use Continuations in other containers, the jetty-util.jar
can be included in WEB-INF/lib and will provide waiting continuations


BUILDING JETTY
==============

Jetty uses maven 2 as its build system.  Maven will fetch
the dependancies, build the server and assemble a runnable
version:

  mvn install

Jetty itself only needs java 1.4, however to build JSP 2.1 
support you need to use java5 AND you will need to have
cvs installed.    If you want to use java1.4,
then you can use the jsp-2.0 modules instead of the 
jsp-api-2.1 and  jsp-2.1 modules.


DEPENDENCIES 
============
The only real dependancy is the servlet api, so only 
the jars in the top level of the lib directory are needed
to run Jetty (and they can be trimmed from many applications).

The jars in the subdirectories of lib are all optional, but
are included on the classpath by the standard start.jar 
mechanism