Core Jetty - DZone - Refcardz https://dzone.

com/refcardz/jetty

Refcard #154

A Lightweight, Open-Source Web Server

and Servlet Container
Written Jos Dirksen
by (/users/121174
(/users
/jd44165.html)
/121174
Architect, atos
/jd44165.html)
origin

Includes architecture, configuration, basic, and

advanced usage, with many code examples.
Free PDF
DOWNLOAD (/ASSET/DOWNLOAD/255)
SAVE

18k

1 of 10 2/9/2016 11:35 PM
Core Jetty - DZone - Refcardz https://dzone.com/refcardz/jetty

SECTION 1

Jetty, an open-source web server hosted

by the Eclipse foundation, is a
full-fledged HTTP server and Servlet
container that can be easily configured to
serve static and dynamic content. You
can very easily embed Jetty into your
own applications using Java or
XML-based configuration or run Jetty
directly from Maven. Additionally, you
can use Jetty in many different
high-demand areas such as Yahoo
Hadoop Cluster, Google AppEngine, and
Yahoo! Zimbra. This RefCard refers
primarily to Jetty 8; however, most of
the configuration discussed will work on
Jetty 7.

2 of 10 2/9/2016 11:35 PM
Core Jetty - DZone - Refcardz https://dzone.com/refcardz/jetty

SECTION 2

It's important to understand the

architecture behind Jetty. The main
architecture of Jetty consists out of the
following four components.

The server is the container class for all

the other components of the
architecture. A server contains a number
of connectors that listen on a specific
port and accepts connections (e.g.,
HTTP, HTTPS, or AJP13) from clients. A
server also contains a set of handlers
that process the client requests from the
connectors and produce responses that
are returned to the client. Threads
retrieved from the configured threadpool
do this processing.

Jetty provides a number of connectors

that accept requests from clients to be
processed by the handlers. Jetty comes
with the following set of default
connectors.

DESCRIPTION AND
CONNECTOR
USAGE

Uses blocking IO and

normal JRE sockets.

3 of 10 2/9/2016 11:35 PM
Core Jetty - DZone - Refcardz https://dzone.com/refcardz/jetty

SECTION 3

When you configure Jetty, you create

and configure a set of connectors and
handlers. You can do this using XML or
plain java.

Jetty provides an XML-based

configuration language based on the
Java Reflection API. When starting Jetty
with an XML configuration, Jetty will
parse this XML and create and configure
the specified objects. The following is a
basic configuration using the XML
syntax with a server, connector, handler,
and threadpool.
1

<Configure id="Server" class="org.eclipse.j

<Set name="threadPool">

<New class="org.eclipse.jetty.util.thread.Q

<Set name="minThreads">10</Set>

<Set name="maxThreads">10</Set>

</New>

</Set>

<Call name="addConnector">

4 of 10 2/9/2016 11:35 PM
Core Jetty - DZone - Refcardz https://dzone.com/refcardz/jetty

SECTION 4

This section describes how to use Jetty

for a number of basic use cases.

scripting to change bar colors on a chart

based on plotted data. When running
Jetty as an embedded web server in your
own application, it can be useful to be
able to serve static content (e.g.,
documentation). The easiest way to
server static content is by using a
ResourceHandler:
1

<New class="org.eclipse.jetty.server.handle

<Set name="directoryListed">true</Set>

<Set name="resourceBase">./files</Set>

</New>

The ResourceHandler can be configured

with the following properties:

PROPERTY DESCRIPTION

Boolean; if true symlinks are

aliases
followed.

Boolean; if true show directory

directoryListed
listings.

String[]; a welcome file is shown

welcomeFiles for a directory if it matches an
item from the supplied String[].

String: The path from where to

resourceBase
serve content.

If you want the ResourceHandler to

5 of 10 2/9/2016 11:35 PM
Core Jetty - DZone - Refcardz https://dzone.com/refcardz/jetty

SECTION 5

This section describes a couple of

advanced configurations for Jetty.

When creating applications, it's very

useful to use context and dependency
injection (CDI). With JEE6, this is a
standard feature of an application server.
You can also use CDI with Jetty. The
following configuration can be used to
configure Weld (the CDI reference
implementation) for a specific web
application on Jetty.
1

<Configure id="webAppCtx"

class="org.eclipse.jetty.webapp.WebAppCo

<New id="BManager" class="org.eclipse.jet

<Arg><Ref id="webAppCtx"/></Arg>

<Arg>BeanManager</Arg>

<Arg>

<New class="javax.naming.Reference">

<Arg>javax.enterprise.inject.spi.BeanMan

<Arg>org.jboss.weld.resources.ManagerObj

10

<Arg/>

11

6 of 10 2/9/2016 11:35 PM
Core Jetty - DZone - Refcardz https://dzone.com/refcardz/jetty

SECTION 6

This section shows how to run an

application based on a number of
popular Java web frameworks using an
embedded Jetty. This is especially useful
during development for a quick compile-
build-test cycle or when you want to run
your application in a debugger with
hot-code replace. If your favorite web
application framework isn't listed here,
these examples should point you in the
right direction to get Jetty working with
your framework.

JSF2 scans the WEB-INF/classes

directories for beans. Before you can use
an embedded Jetty to directly launch a
JSF application, you have to make sure
you configure your project to output its
class files to the WEB-INF/ classes
directory in your project. After that, you
can use the standard WebAppContext to
run your JSF 2.0 web application
directly from Jetty.
1

WebAppContext handler = new WebAppContext()

handler.setResourceBase("src/main/webapp"

handler.setDescriptor("src/main/webapp/WE

handler.setContextPath("/");

handler.setParentLoaderPriority(true);

7 of 10 2/9/2016 11:35 PM
Core Jetty - DZone - Refcardz https://dzone.com/refcardz/jetty

SECTION 7

If you want to configure the standard

Jetty distribution and not run Jetty
embedded from your own application,
you can configure Jetty using the
following XML files.

File Description

Main configuration file.

Configures a Server class.
jett.xml Normally located
in $JETTY_HOME/etc
/jetty.xml

Configure a web application

context. Located in the
jetty-web.xml
WEB-INF directory
of a specific web application.

Allows you to configure JNDI

resources for a web application.
jetty-env.xml
Located in the WEB-INF
directory of a web application.

Set default values on a web

application context that will be
applied
to all web applications. This is
webdefault.xml
loaded before the web.xml is
processed.
Located in ${jetty.home}/etc
/webdefault

Jetty applies the configuration

in this file after the web.xml
from a
override-
web application is parsed. This
web.xml
file is located in the WEB-INF
directory
of a web application

More information on running Jetty

standalone can be found at the Jetty
Wiki: http://wiki.eclipse.org/Jetty
/Feature/Start.jar

8 of 10 2/9/2016 11:35 PM
Core Jetty - DZone - Refcardz https://dzone.com/refcardz/jetty

SECTION 8

Jetty is also often used in a maven build

file to easily run and test a webapp
project. When running from Maven, you
can configure Jetty using the
configuration elements provided by the
plugin.

XML ELEMENT DESCRIPTION

List of connectors objects. If not

connectors specified, a SelectChannelConnector
will be configured on port 8080.

Location of a jetty.xml configuration

jettyXML file. Use this for objects that
can't be configured from the plugin.

Interval to check for changes to the

scanIntervalSeconds webapp. If a change is
detected, the webapp is redeployed.

Sets system properties that are used

systemProperties during the execution of the
plugin.

Loads system properties from a file.

systemPropertiesFile These properties are available
during the execution of the plugin.

A list of LoginService
implementations that are available to
loginServices
the
webapp.

Configures an implementation of a
requestLog
RequestLog.

Configures the webapplication. You

can use any of the setters
of the WebAppContext to configure
your web application.For
instance:
<contextHandlers>
webApp <contextHandler
implementation="..WebAppContext">
<war>${basedir}../..
/another.war</war>
<contextPath>/other</contextPath>
</contextHandler>
</contextHandlers>

The Jetty plugin defines the following

9 of 10 2/9/2016 11:35 PM
Core Jetty - DZone - Refcardz https://dzone.com/refcardz/jetty

10 of 10 2/9/2016 11:35 PM