| <html><head> |
| <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> |
| <title>Chapter 4. Configuring Jetty Connectors</title><link rel="stylesheet" type="text/css" href="css/docbook.css"><meta name="generator" content="DocBook XSL-NS Stylesheets V1.76.1"><meta name="keywords" content="jetty, servlet-api, cometd, http, spdy, eclipse, maven, java, software"><link rel="home" href="index.html" title="Jetty : The Definitive Reference"><link rel="up" href="configuring.html" title="Part II. Jetty Configuration Guide"><link rel="prev" href="configuring.html" title="Part II. Jetty Configuration Guide"><link rel="next" href="configuring-ssl.html" title="Configuring SSL"><link xmlns:jfetch="java:org.eclipse.jetty.xslt.tools.JavaSourceFetchExtension" xmlns:fetch="java:org.eclipse.jetty.xslt.tools.SourceFetchExtension" xmlns:d="http://docbook.org/ns/docbook" xmlns:l="http://docbook.sourceforge.net/xmlns/l10n/1.0" xmlns:xslthl="http://xslthl.sf.net" xmlns:gcse="http://www.google.com" xmlns:date="http://exslt.org/dates-and-times" rel="shortcut icon" href="images/favicon.ico"><script type="text/javascript" src="js/shCore.js"></script><script type="text/javascript" src="js/shBrushJava.js"></script><script type="text/javascript" src="js/shBrushXml.js"></script><script type="text/javascript" src="js/shBrushBash.js"></script><script type="text/javascript" src="js/shBrushJScript.js"></script><script type="text/javascript" src="js/shBrushSql.js"></script><script type="text/javascript" src="js/shBrushProperties.js"></script><script type="text/javascript" src="js/shBrushPlain.js"></script><link type="text/css" rel="stylesheet" href="css/shCore.css"><link type="text/css" rel="stylesheet" href="css/shThemeEclipse.css"><link type="text/css" rel="stylesheet" href="css/font-awesome.min.css"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><table xmlns:jfetch="java:org.eclipse.jetty.xslt.tools.JavaSourceFetchExtension" xmlns:fetch="java:org.eclipse.jetty.xslt.tools.SourceFetchExtension" xmlns:d="http://docbook.org/ns/docbook" xmlns:l="http://docbook.sourceforge.net/xmlns/l10n/1.0" xmlns:xslthl="http://xslthl.sf.net" xmlns:gcse="http://www.google.com" xmlns:date="http://exslt.org/dates-and-times"><tr><td style="width: 25%"><a href="http://www.eclipse.org/jetty"><img src="images/jetty-header-logo.png" alt="Jetty Logo"></a><br><span style="font-size: small"> |
| Version: 9.0.6.v20130930</span></td><td style="width: 50%"><script type="text/javascript"> (function() { |
| var cx = '016459005284625897022:obd4lsai2ds'; |
| var gcse = document.createElement('script'); |
| gcse.type = 'text/javascript'; |
| gcse.async = true; |
| gcse.src = (document.location.protocol == 'https:' ? 'https:' : 'http:') + |
| '//www.google.com/cse/cse.js?cx=' + cx; |
| var s = document.getElementsByTagName('script')[0]; |
| s.parentNode.insertBefore(gcse, s); |
| })(); |
| </script><gcse:search></gcse:search></td></tr></table><div xmlns:jfetch="java:org.eclipse.jetty.xslt.tools.JavaSourceFetchExtension" xmlns:fetch="java:org.eclipse.jetty.xslt.tools.SourceFetchExtension" xmlns:d="http://docbook.org/ns/docbook" xmlns:l="http://docbook.sourceforge.net/xmlns/l10n/1.0" xmlns:xslthl="http://xslthl.sf.net" xmlns:gcse="http://www.google.com" xmlns:date="http://exslt.org/dates-and-times" class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">Chapter 4. Configuring Jetty Connectors</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="configuring.html"><i class="icon-chevron-left"></i> Previous</a> </td><th width="60%" align="center">Part II. Jetty Configuration Guide<br><a accesskey="p" href="index.html"><i class="icon-home"></i> Home</a></th><td width="20%" align="right"> <a accesskey="n" href="configuring-ssl.html">Next <i class="icon-chevron-right"></i></a></td></tr></table><hr></div><div xmlns:jfetch="java:org.eclipse.jetty.xslt.tools.JavaSourceFetchExtension" xmlns:fetch="java:org.eclipse.jetty.xslt.tools.SourceFetchExtension" xmlns:d="http://docbook.org/ns/docbook" xmlns:l="http://docbook.sourceforge.net/xmlns/l10n/1.0" xmlns:xslthl="http://xslthl.sf.net" xmlns:gcse="http://www.google.com" xmlns:date="http://exslt.org/dates-and-times" class="jetty-callout"><h5 class="callout"><a href="http://www.webtide.com/support.jsp">Contact the core Jetty developers at |
| <span class="website">www.webtide.com</span></a></h5><p> |
| private support for your internal/customer projects ... custom extensions and distributions ... versioned snapshots for indefinite support ... |
| scalability guidance for your apps and Ajax/Comet projects ... development services from 1 day to full product delivery |
| </p></div><div class="chapter"><div class="titlepage"><div><div><h2 class="title"><a name="configuring-connectors"></a>Chapter 4. Configuring Jetty Connectors</h2></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="section"><a href="configuring-connectors.html#jetty-connectors">Connector Configuration Overview</a></span></dt><dt><span class="section"><a href="configuring-ssl.html">Configuring SSL</a></span></dt><dt><span class="section"><a href="setting-port80-access.html">Setting Port 80 Access for a Non-Root User</a></span></dt></dl></div><p>This chapter discusses various options for configuring Jetty connectors.</p><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="jetty-connectors"></a>Connector Configuration Overview</h2></div></div></div><div class="toc"><dl><dt><span class="section"><a href="configuring-connectors.html#d0e2008">Constructing a <code class="code">ServerConnector</code></a></span></dt><dt><span class="section"><a href="configuring-connectors.html#jetty-connectors-network-settings">Network Settings.</a></span></dt><dt><span class="section"><a href="configuring-connectors.html#jetty-connectors-http-configuration">HTTP Configuration</a></span></dt><dt><span class="section"><a href="configuring-connectors.html#d0e2218">SSL Context Configuration</a></span></dt><dt><span class="section"><a href="configuring-connectors.html#d0e2250">Configuring Connection Factories</a></span></dt></dl></div><p>Connectors are the mechanism through which Jetty accepts network |
| connections for various protocols. Configuring a connector is a combination |
| of configuring the following:</p><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem"><p>Network parameters on the connector itself (for example: the listening port).</p></li><li class="listitem"><p>Services the connector uses (for example: executors, schedulers).</p></li><li class="listitem"><p>Connection factories that instantiate and configure the protocol |
| for an accepted connection.</p></li></ul></div><p>Jetty primarily uses a single connector type called <a class="link" href="http://download.eclipse.org/jetty/stable-9/apidocs/org/eclipse/jetty/server/ServerConnector.html" target="_top">ServerConnector</a>.</p><div xmlns:jfetch="java:org.eclipse.jetty.xslt.tools.JavaSourceFetchExtension" xmlns:fetch="java:org.eclipse.jetty.xslt.tools.SourceFetchExtension" xmlns:d="http://docbook.org/ns/docbook" xmlns:l="http://docbook.sourceforge.net/xmlns/l10n/1.0" xmlns:xslthl="http://xslthl.sf.net" xmlns:gcse="http://www.google.com" xmlns:date="http://exslt.org/dates-and-times" class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title"><i class="icon-asterisk"></i> Note</h3><p>Prior to Jetty 9, the type of the connector specified both the |
| protocol and the implementation used (for example, selector-based non blocking I/O vs blocking I/O, or |
| SSL connector vs non-SSL connector). |
| Jetty 9 has only a selector-based non blocking I/O connector, and a collection of <a class="link" href="http://download.eclipse.org/jetty/stable-9/apidocs/org/eclipse/jetty/server/ConnectionFactory.html" target="_top"><code class="code">ConnectionFactories</code></a> |
| now configure the protocol on the connector.</p></div><p>The standard Jetty distribution comes with the following Jetty XML |
| files that create and configure connectors; you should examine them as you |
| read this section:</p><div class="variablelist"><dl><dt><span class="term"><a class="link" href="http://git.eclipse.org/c/jetty/org.eclipse.jetty.project.git/plain/jetty-server/src/main/config/etc/jetty-http.xml" target="_top"><code class="filename">jetty-http.xml</code></a></span></dt><dd><p>Instantiates a <a class="link" href="http://download.eclipse.org/jetty/stable-9/apidocs/org/eclipse/jetty/server/ServerConnector.html" target="_top"><code class="code">ServerConnector</code></a> |
| that accepts HTTP connections (that may be upgraded to WebSocket connections).</p></dd><dt><span class="term"><a class="link" href="http://git.eclipse.org/c/jetty/org.eclipse.jetty.project.git/plain/jetty-server/src/main/config/etc/jetty-https.xml" target="_top"><code class="filename">jetty-https.xml</code></a></span></dt><dd><p>Instantiates a <a class="link" href="http://download.eclipse.org/jetty/stable-9/apidocs/org/eclipse/jetty/server/ServerConnector.html" target="_top"><code class="code">ServerConnector</code></a> |
| that accepts SSL/TLS connections. The <code class="code">ConnectionFactory</code> configured after the SSL one is a HTTP |
| <code class="code">ConnectionFactories</code>, and therefore the SSL/TLS connections will carry the HTTP protocol.</p></dd><dt><span class="term"><a class="link" href="http://git.eclipse.org/c/jetty/org.eclipse.jetty.project.git/plain/jetty-spdy/spdy-example-webapp/src/main/config/example-jetty-spdy.xml" target="_top"><code class="filename">example-jetty-spdy.xml</code></a></span></dt><dd><p>Instantiates a <a class="link" href="http://download.eclipse.org/jetty/stable-9/apidocs/org/eclipse/jetty/server/ServerConnector.html" target="_top"><code class="code">ServerConnector</code></a> |
| that accepts SSL connections that carry either HTTP or SPDY traffic. |
| Initially the SSL connection is chained to a Next Protocol Negotiation |
| (NPN) connection, which eventually replaces itself with a connection |
| for a protocol it negotiates with the client; this protocol may be a |
| version of SPDY or HTTP. If the client does not support NPN, HTTP is |
| assumed.</p></dd></dl></div><p>Typically you need to configure very little on connectors other than |
| set the listening port (see <a class="link" href="configuring-connectors.html#jetty-connectors-network-settings" title="Network Settings.">Network |
| Settings</a>), and perhaps enable <code class="code">X-Forwarded-For</code> customization (see |
| <a class="link" href="configuring-connectors.html#jetty-connectors-http-configuration" title="HTTP Configuration">HTTP |
| Configuration</a>). Most other settings are for expert configuration |
| only.</p><div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="d0e2008"></a>Constructing a <code class="code">ServerConnector</code></h3></div></div></div><p>The services a <a class="link" href="http://download.eclipse.org/jetty/stable-9/apidocs/org/eclipse/jetty/server/ServerConnector.html" target="_top"> |
| <code class="code">ServerConnector</code> |
| </a> instance uses are set by constructor injection and once |
| instantiated cannot be changed. Most of the services may be defaulted |
| with null or 0 values so that a reasonable default is used, thus for |
| most purposes only the Server and the connection factories need to be |
| passed to the connector constructor. In Jetty XML (that is, in <a class="link" href="http://git.eclipse.org/c/jetty/org.eclipse.jetty.project.git/plain/jetty-server/src/main/config/etc/jetty-http.xml" target="_top"> |
| <code class="filename">jetty-http.xml</code> |
| </a>), you can do this with:</p><div class="informalexample"><script type="syntaxhighlighter" class="brush: xml;toolbar: false"> |
| <![CDATA[<New class="org.eclipse.jetty.server.ServerConnector"> |
| <Arg name="server"><Ref refid="Server" /></Arg> |
| <Arg name="factories"> |
| <Array type="org.eclipse.jetty.server.ConnectionFactory"> |
| <!-- insert one or more factories here --> |
| </Array> |
| </Arg> |
| <!-- set connector fields here --> |
| </New> ]]> |
| </script></div><p>You can see the other arguments that can be passed when |
| constructing a <code class="code">ServerConnector</code> in the <a class="link" href="http://download.eclipse.org/jetty/stable-9/apidocs/org/eclipse/jetty/server/ServerConnector.html#ServerConnector%28org.eclipse.jetty.server.Server,%20java.util.concurrent.Executor,%20org.eclipse.jetty.util.thread.Scheduler,%20org.eclipse.jetty.io.ByteBufferPool,%20int,%20int,%20org.eclipse.jetty.server.ConnectionFactory...%29" target="_top">Javadoc</a>. |
| Typically the defaults are sufficient for almost all deployments.</p></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="jetty-connectors-network-settings"></a>Network Settings.</h3></div></div></div><p>You configure connector network settings by calling setters on the |
| connector before it is started. For example, you can set the port with |
| the Jetty XML:</p><div class="informalexample"><script type="syntaxhighlighter" class="brush: xml;toolbar: false"> |
| <![CDATA[<New class="org.eclipse.jetty.server.ServerConnector"> |
| <Arg name="server"><Ref refid="Server" /></Arg> |
| <Arg name="factories"><!-- insert one or more factories here --></Arg> |
| |
| <Set name="port">8080</Set> |
| </New> ]]> |
| </script></div><p>Values in Jetty XML can also be parameterized so that they may be |
| passed from property files or set on the command line. Thus typically |
| the port is set within Jetty XML, but uses the <code class="code">Property</code> |
| element to be customizable:</p><div class="informalexample"><script type="syntaxhighlighter" class="brush: xml;toolbar: false"> |
| <![CDATA[<New class="org.eclipse.jetty.server.ServerConnector"> |
| <Arg name="server"><Ref refid="Server" /></Arg> |
| <Arg name="factories"><!-- insert one or more factories here --></Arg> |
| |
| <Set name="port"><Property name="jetty.port" default="8080"/></Set> |
| </New> ]]> |
| </script></div><p>The network settings that you can set on the <a class="link" href="http://download.eclipse.org/jetty/stable-9/apidocs/org/eclipse/jetty/server/ServerConnector.html" target="_top"> |
| <code class="code">ServerConnector</code> |
| </a> include:</p><div class="table"><a name="d0e2062"></a><p class="title"><b>Table 4.1. Connector Configuration</b></p><div class="table-contents"><table summary="Connector Configuration" border="1"><colgroup><col><col></colgroup><thead><tr><th>Field</th><th>Description</th></tr></thead><tbody><tr><td>host</td><td>The network interface this connector binds to as an IP |
| address or a hostname. If null or 0.0.0.0, bind to all |
| interfaces.</td></tr><tr><td>port</td><td>The configured port for the connector or 0 a random |
| available port may be used (selected port available via |
| <code class="code">getLocalPort()</code>).</td></tr><tr><td>idleTimeout</td><td>The time in milliseconds that the connection can be idle |
| before it is closed.</td></tr><tr><td>defaultProtocol</td><td>The name of the default protocol used to select a |
| <code class="code">ConnectionFactory</code> instance. This defaults to the |
| first <code class="code">ConnectionFactory</code> added to the |
| connector.</td></tr><tr><td>stopTimeout</td><td>The time in milliseconds to wait before gently stopping a |
| connector.</td></tr><tr><td>acceptQueueSize</td><td>The size of the pending connection backlog. The exact |
| interpretation is JVM and operating system specific and you can |
| ignore it. Higher values allow more connections to wait pending |
| an acceptor thread. Because the exact interpretation is |
| deployment dependent, it is best to keep this value as the |
| default unless there is a specific connection issue for a |
| specific OS that you need to address.</td></tr><tr><td>reuseAddress</td><td>Allow the server socket to be rebound even if in <a class="link" href="http://www.ssfnet.org/Exchange/tcp/tcpTutorialNotes.html" target="_top">TIME_WAIT</a>. |
| For servers it is typically OK to leave this as the default |
| true.</td></tr><tr><td>soLingerTime</td><td>A value >=0 set the socket <a class="link" href="http://stackoverflow.com/questions/3757289/tcp-option-so-linger-zero-when-its-required" target="_top"> |
| SO_LINGER</a> value in milliseconds. Jetty attempts to gently |
| close all TCP/IP connections with proper half close semantics, |
| so a linger timeout should not be required and thus the default |
| is -1.</td></tr></tbody></table></div></div><br class="table-break"></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="jetty-connectors-http-configuration"></a>HTTP Configuration</h3></div></div></div><p>The <a class="link" href="http://download.eclipse.org/jetty/stable-9/apidocs/org/eclipse/jetty/server/HttpConfiguration.html" target="_top">HttpConfiguration</a> |
| class holds the configuration for <a class="link" href="http://download.eclipse.org/jetty/stable-9/apidocs/org/eclipse/jetty/server/HttpChannel.html" target="_top"> |
| <code class="code">HTTPChannel</code> |
| </a>s, which you can create 1:1 with each HTTP connection or 1:n |
| on a multiplexed SPDY connection. Thus a <code class="code">HTTPConfiguration</code> |
| object is injected into both the HTTP and SPDY connection factories. To |
| avoid duplicate configuration, the standard Jetty distribution creates |
| the common <code class="code">HttpConfiguration</code> instance in <a class="link" href="http://git.eclipse.org/c/jetty/org.eclipse.jetty.project.git/plain/jetty-server/src/main/config/etc/jetty.xml" target="_top"> |
| <code class="filename">jetty.xml</code> |
| </a>, which is a <code class="code">Ref</code> element then used in <a class="link" href="http://git.eclipse.org/c/jetty/org.eclipse.jetty.project.git/plain/jetty-server/src/main/config/etc/jetty-http.xml" target="_top"> |
| <code class="filename">jetty-http.xml</code> |
| </a>, <a class="link" href="http://git.eclipse.org/c/jetty/org.eclipse.jetty.project.git/plain/jetty-server/src/main/config/etc/jetty-https.xml" target="_top"> |
| <code class="filename">jetty-https.xml</code> |
| </a> and <a class="link" href="http://git.eclipse.org/c/jetty/org.eclipse.jetty.project.git/plain/jetty-spdy/spdy-example-webapp/src/main/config/example-jetty-spdy.xml" target="_top"> |
| <code class="filename">example-jetty-spdy.xml</code> |
| </a>.</p><p>A typical configuration of <a class="link" href="http://download.eclipse.org/jetty/stable-9/apidocs/org/eclipse/jetty/server/HttpConfiguration.html" target="_top"> |
| HttpConfiguration</a> is:</p><div class="informalexample"><script type="syntaxhighlighter" class="brush: xml;toolbar: false"> |
| <![CDATA[<New id="httpConfig" class="org.eclipse.jetty.server.HttpConfiguration"> |
| <Set name="secureScheme">https</Set> |
| <Set name="securePort"><Property name="jetty.tls.port" default="8443" /></Set> |
| <Set name="outputBufferSize">32768</Set> |
| <Set name="requestHeaderSize">8192</Set> |
| <Set name="responseHeaderSize">8192</Set> |
| |
| <Call name="addCustomizer"> |
| <Arg><New class="org.eclipse.jetty.server.ForwardedRequestCustomizer"/></Arg> |
| </Call> |
| </New>]]> |
| </script></div><p>This example adds a <a class="link" href="http://download.eclipse.org/jetty/stable-9/apidocs/org/eclipse/jetty/server/ForwardedRequestCustomizer.html" target="_top"> |
| <code class="code">ForwardedRequestCustomizer</code> |
| </a> to process the <a class="link" href="http://en.wikipedia.org/wiki/X-Forwarded-For" target="_top">X-Forward-For</a> |
| and related proxy headers. <code class="filename">jetty-https.xml</code> can, by |
| reference, use the instance created with an ID "httpConfig":</p><div class="informalexample"><script type="syntaxhighlighter" class="brush: xml;toolbar: false"> |
| <![CDATA[<Call name="addConnector"> |
| <Arg> |
| <New class="org.eclipse.jetty.server.ServerConnector"> |
| <Arg name="server"><Ref refid="Server" /></Arg> |
| <Arg name="factories"> |
| <Array type="org.eclipse.jetty.server.ConnectionFactory"> |
| <Item> |
| <New class="org.eclipse.jetty.server.HttpConnectionFactory"> |
| <Arg name="config"><Ref refid="httpConfig" /></Arg> |
| </New> |
| </Item> |
| </Array> |
| </Arg> |
| <!-- ... --> |
| </New> |
| </Arg> |
| </Call>]]> |
| </script></div><p>For SSL based connectors (in |
| <code class="filename">jetty-https.xml</code> and <code class="filename"> |
| jetty-spdy.xml</code>), the common "httpConfig" instance is used as |
| the basis to create an SSL specific configuration with ID |
| "tlsHttpConfig":</p><div class="informalexample"><script type="syntaxhighlighter" class="brush: xml;toolbar: false"> |
| <![CDATA[<New id="tlsHttpConfig" class="org.eclipse.jetty.server.HttpConfiguration"> |
| <Arg><Ref refid="httpConfig"/></Arg> |
| <Call name="addCustomizer"> |
| <Arg><New class="org.eclipse.jetty.server.SecureRequestCustomizer"/></Arg> |
| </Call> |
| </New>]]> |
| </script></div><p>This adds a <code class="code">SecureRequestCustomizer</code> |
| which adds SSL Session IDs and certificate information as request |
| attributes.</p></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="d0e2218"></a>SSL Context Configuration</h3></div></div></div><p>The SSL/TSL connectors for HTTPS and SPDY require a certificate to |
| establish a secure connection. Jetty holds certificates in standard JVM |
| keystores and are configured as keystore and truststores on a <a class="link" href="http://download.eclipse.org/jetty/stable-9/apidocs/org/eclipse/jetty/util/ssl/SslContextFactory.html" target="_top"> |
| <code class="code">SslContextFactory</code> |
| </a> instance that is injected into an <a class="link" href="http://download.eclipse.org/jetty/stable-9/apidocs/org/eclipse/jetty/server/SslConnectionFactory.html" target="_top"> |
| <code class="code">SslConnectionFactory</code> |
| </a> instance. An example using the keystore distributed with Jetty |
| (containing a self signed test certificate) is in <a class="link" href="http://git.eclipse.org/c/jetty/org.eclipse.jetty.project.git/plain/jetty-server/src/main/config/etc/jetty-https.xml" target="_top"> |
| <code class="filename">jetty-https.xml</code> |
| </a> and <a class="link" href="http://git.eclipse.org/c/jetty/org.eclipse.jetty.project.git/plain/jetty-spdy/spdy-example-webapp/src/main/config/example-jetty-spdy.xml" target="_top"> |
| <code class="filename">example-jetty-spdy.xml</code> |
| </a>. Read more about SSL keystores in <a class="link" href="configuring-ssl.html" title="Configuring SSL">Configuring SSL</a>.</p></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="d0e2250"></a>Configuring Connection Factories</h3></div></div></div><p>It is the <code class="code">ConnectionFactory</code> instances injected into a |
| <code class="code">ServerConnector</code> that create the protocol handling |
| Connection instances for the network endpoints the connector accepts. |
| Thus the different instances of connectors in a Jetty setup vary mostly |
| in the configuration of the factories for the protocols they support. |
| Other than selecting which factories to use, there is typically very |
| little factory configuration required other than injecting the |
| <code class="code">HTTPConfiguration</code> or <code class="code">SslContextFactory</code> |
| instances.</p><p>The simplest example in the Jetty distribution is <a class="link" href="http://git.eclipse.org/c/jetty/org.eclipse.jetty.project.git/plain/jetty-server/src/main/config/etc/jetty-http.xml" target="_top"> |
| <code class="filename">jetty-http.xml</code> |
| </a>:</p><div class="informalexample"><script type="syntaxhighlighter" class="brush: xml;toolbar: false"> |
| <![CDATA[<?xml version="1.0"?> |
| <!DOCTYPE Configure PUBLIC "-//Jetty//Configure//EN" "http://www.eclipse.org/jetty/configure_9_0.dtd"> |
| |
| <!-- ============================================================= --> |
| <!-- Configure the Jetty Server instance with an ID "Server" --> |
| <!-- by adding a HTTP connector. --> |
| <!-- This configuration must be used in conjunction with jetty.xml --> |
| <!-- ============================================================= --> |
| <Configure id="Server" class="org.eclipse.jetty.server.Server"> |
| |
| <!-- =========================================================== --> |
| <!-- Add a HTTP Connector. --> |
| <!-- Configure an o.e.j.server.ServerConnector with a single --> |
| <!-- HttpConnectionFactory instance using the common httpConfig --> |
| <!-- instance defined in jetty.xml --> |
| <!-- --> |
| <!-- Consult the javadoc of o.e.j.server.ServerConnector and --> |
| <!-- o.e.j.server.HttpConnectionFactory for all configuration --> |
| <!-- that may be set here. --> |
| <!-- =========================================================== --> |
| <Call name="addConnector"> |
| <Arg> |
| <New class="org.eclipse.jetty.server.ServerConnector"> |
| <Arg name="server"><Ref refid="Server" /></Arg> |
| <Arg name="factories"> |
| <Array type="org.eclipse.jetty.server.ConnectionFactory"> |
| <Item> |
| <New class="org.eclipse.jetty.server.HttpConnectionFactory"> |
| <Arg name="config"><Ref refid="httpConfig" /></Arg> |
| </New> |
| </Item> |
| </Array> |
| </Arg> |
| <Set name="host"><Property name="jetty.host" /></Set> |
| <Set name="port"><Property name="jetty.port" default="8080" /></Set> |
| <Set name="idleTimeout"><Property name="http.timeout" default="30000"/></Set> |
| </New> |
| </Arg> |
| </Call> |
| |
| </Configure> |
| ]]> |
| </script></div><p>Here the connector has only a single |
| <code class="code">ConnectionFactory</code>, and when a new connection is accepted, |
| it is the <code class="code">HttpConnectionFactory</code> that creates an |
| <code class="code">HttpConnection.</code></p><p>A more complex example involving multiple connection factories is |
| <code class="filename">jetty-spdy.xml</code>:</p><div class="informalexample"><script type="syntaxhighlighter" class="brush: xml;toolbar: false"> |
| <![CDATA[<?xml version="1.0" encoding="UTF-8"?> |
| <!DOCTYPE Configure PUBLIC "-//Jetty//Configure//EN" "http://www.eclipse.org/jetty/configure_9_0.dtd"> |
| |
| <Configure id="Server" class="org.eclipse.jetty.server.Server"> |
| |
| <New id="sslContextFactory" class="org.eclipse.jetty.util.ssl.SslContextFactory"> |
| <Set name="keyStorePath">src/main/resources/keystore.jks</Set> |
| <Set name="keyStorePassword">storepwd</Set> |
| <Set name="trustStorePath">src/main/resources/truststore.jks</Set> |
| <Set name="trustStorePassword">storepwd</Set> |
| <Set name="protocol">TLSv1</Set> |
| </New> |
| |
| <New id="tlsHttpConfig" class="org.eclipse.jetty.server.HttpConfiguration"> |
| <Arg> |
| <New id="httpConfig" class="org.eclipse.jetty.server.HttpConfiguration"> |
| <Set name="secureScheme">https</Set> |
| <Set name="securePort"> |
| <Property name="jetty.tls.port" default="8443"/> |
| </Set> |
| <Set name="outputBufferSize">32768</Set> |
| <Set name="requestHeaderSize">8192</Set> |
| <Set name="responseHeaderSize">8192</Set> |
| |
| <!-- Uncomment to enable handling of X-Forwarded- style headers |
| <Call name="addCustomizer"> |
| <Arg><New class="org.eclipse.jetty.server.ForwardedRequestCustomizer"/></Arg> |
| </Call> |
| --> |
| </New> |
| </Arg> |
| <Call name="addCustomizer"> |
| <Arg> |
| <New class="org.eclipse.jetty.server.SecureRequestCustomizer"/> |
| </Arg> |
| </Call> |
| </New> |
| |
| <New id="pushStrategy" class="org.eclipse.jetty.spdy.server.http.ReferrerPushStrategy"> |
| <!-- Uncomment to blacklist browsers for this push strategy. If one of the blacklisted Strings occurs in the |
| user-agent header sent by the client, push will be disabled for this browser. This is case insensitive" --> |
| <!-- |
| <Set name="UserAgentBlacklist"> |
| <Array type="String"> |
| <Item>.*(?i)firefox/14.*</Item> |
| <Item>.*(?i)firefox/15.*</Item> |
| <Item>.*(?i)firefox/16.*</Item> |
| </Array> |
| </Set> |
| --> |
| |
| <!-- Uncomment to override default file extensions to push --> |
| <!-- |
| <Set name="PushRegexps"> |
| <Array type="String"> |
| <Item>.*\.css</Item> |
| <Item>.*\.js</Item> |
| <Item>.*\.png</Item> |
| <Item>.*\.jpg</Item> |
| <Item>.*\.gif</Item> |
| </Array> |
| </Set> |
| --> |
| <Set name="referrerPushPeriod">5000</Set> |
| <Set name="maxAssociatedResources">32</Set> |
| </New> |
| |
| <Call id="sslConnector" name="addConnector"> |
| <Arg> |
| <New class="org.eclipse.jetty.server.ServerConnector"> |
| <Arg name="server"><Ref refid="Server"/></Arg> |
| <Arg name="factories"> |
| <Array type="org.eclipse.jetty.server.ConnectionFactory"> |
| |
| <!-- SSL Connection factory with NPN as next protocol --> |
| <Item> |
| <New class="org.eclipse.jetty.server.SslConnectionFactory"> |
| <Arg name="next">npn</Arg> |
| <Arg name="sslContextFactory"> |
| <Ref refid="sslContextFactory"/> |
| </Arg> |
| </New> |
| </Item> |
| |
| <!-- NPN Connection factory with HTTP as default protocol --> |
| <Item> |
| <New class="org.eclipse.jetty.spdy.server.NPNServerConnectionFactory"> |
| <Arg name="protocols"> |
| <Array type="String"> |
| <Item>spdy/3</Item> |
| <Item>spdy/2</Item> |
| <Item>http/1.1</Item> |
| </Array> |
| </Arg> |
| <Set name="defaultProtocol">http/1.1</Set> |
| </New> |
| </Item> |
| |
| <!-- SPDY/3 Connection factory --> |
| <Item> |
| <New class="org.eclipse.jetty.spdy.server.http.HTTPSPDYServerConnectionFactory"> |
| <Arg name="version" type="int">3</Arg> |
| <Arg name="config"> |
| <Ref refid="tlsHttpConfig"/> |
| </Arg> |
| <Arg name="pushStrategy"> |
| <Ref refid="pushStrategy"/> |
| </Arg> |
| </New> |
| </Item> |
| |
| <!-- SPDY/2 Connection factory --> |
| <Item> |
| <New class="org.eclipse.jetty.spdy.server.http.HTTPSPDYServerConnectionFactory"> |
| <Arg name="version" type="int">2</Arg> |
| <Arg name="config"> |
| <Ref refid="tlsHttpConfig"/> |
| </Arg> |
| </New> |
| </Item> |
| |
| <!-- HTTP Connection factory --> |
| <Item> |
| <New class="org.eclipse.jetty.server.HttpConnectionFactory"> |
| <Arg name="config"> |
| <Ref refid="tlsHttpConfig"/> |
| </Arg> |
| </New> |
| </Item> |
| </Array> |
| </Arg> |
| |
| <Set name="port">8443</Set> |
| </New> |
| </Arg> |
| </Call> |
| |
| </Configure> |
| ]]> |
| </script></div><p>In this case five connection factories are created and linked |
| together by their protocol names:</p><div class="variablelist"><dl><dt><span class="term">"SSL-npn"</span></dt><dd><p>The default protocol is identified by the first connection factory, |
| which in this case is a <code class="code">SslConnectionFactory</code> |
| instantiated with "npn" as the next protocol. Thus accepted |
| endpoints are associated with an <code class="code">SslConnection</code> |
| instance that is chained to an <code class="code">NextProtoNegoServerConnection</code> |
| instance created by the "npn" connection factory.</p></dd><dt><span class="term">"npn"</span></dt><dd><p>This is the <code class="code">NPNServerConnectionFactory</code> |
| chained to the <code class="code">SslConnectionFactory</code>. The NPN connections |
| negotiate with the client for the next protocol and then a factory |
| of that name is looked up to create a connection to replace the |
| NPN connection. If NPN is not supported, the defaultProtocol is |
| configured as "http/1.1".</p></dd><dt><span class="term">"spdy/3"</span></dt><dd><p>The factory NPN connections use if SPDY version 3 is |
| negotiated.</p></dd><dt><span class="term">"spdy/2"</span></dt><dd><p>The factory NPN connections use if SPDY version 2 is |
| negotiated.</p></dd><dt><span class="term">"http/1.1"</span></dt><dd><p>The factory NPN connections use if HTTP version 1.1 is |
| negotiated or if NPN is not supported. Note that HTTP/1.1 can also |
| handle HTTP/1.0.</p></dd></dl></div></div></div></div><script type="text/javascript"> |
| SyntaxHighlighter.all() |
| </script><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="configuring.html"><i class="icon-chevron-left"></i> Previous</a> </td><td width="20%" align="center"><a accesskey="u" href="configuring.html"><i class="icon-chevron-up"></i> Top</a></td><td width="40%" align="right"> <a accesskey="n" href="configuring-ssl.html">Next <i class="icon-chevron-right"></i></a></td></tr><tr><td width="40%" align="left" valign="top">Part II. Jetty Configuration Guide </td><td width="20%" align="center"><a accesskey="h" href="index.html"><i class="icon-home"></i> Home</a></td><td width="40%" align="right" valign="top"> Configuring SSL</td></tr></table></div><p xmlns:jfetch="java:org.eclipse.jetty.xslt.tools.JavaSourceFetchExtension" xmlns:fetch="java:org.eclipse.jetty.xslt.tools.SourceFetchExtension" xmlns:d="http://docbook.org/ns/docbook" xmlns:l="http://docbook.sourceforge.net/xmlns/l10n/1.0" xmlns:xslthl="http://xslthl.sf.net" xmlns:gcse="http://www.google.com" xmlns:date="http://exslt.org/dates-and-times"><div class="jetty-callout"> |
| See an error or something missing? |
| <span class="callout"><a href="http://github.com/jetty-project/jetty-documentation">Contribute to this documentation at |
| <span class="website"><i class="icon-github"></i> Github!</span></a></span><span style="float: right"><i>(Generated: 2013-10-30T13:20:20-05:00)</i></span></div></p><script xmlns:jfetch="java:org.eclipse.jetty.xslt.tools.JavaSourceFetchExtension" xmlns:fetch="java:org.eclipse.jetty.xslt.tools.SourceFetchExtension" xmlns:d="http://docbook.org/ns/docbook" xmlns:l="http://docbook.sourceforge.net/xmlns/l10n/1.0" xmlns:xslthl="http://xslthl.sf.net" xmlns:gcse="http://www.google.com" xmlns:date="http://exslt.org/dates-and-times" type="text/javascript"> |
| var _gaq = _gaq || []; |
| _gaq.push(['_setAccount', 'UA-1149868-7']); |
| _gaq.push(['_trackPageview']); |
| |
| (function() { |
| var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true; |
| ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js'; |
| var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s); |
| })(); |
| </script></body></html> |
