Skip to main content

Notice: this Wiki will be going read only early in 2024 and edits will no longer be possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.

Jump to: navigation, search

Jetty/Reference/jetty.xml usage



Introduction

Jetty provides an XML-based configuration. 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.

Using jetty.xml

To use jetty.xml, specify it as a configuration file when running Jetty.

java -jar start.jar etc/jetty.xml
Note.png
Configuration files
If you start up Jetty without specifying a configuration file, Jetty automatically locates and uses the default installation jetty.xml file. Therefore java -jar start.jar is equivalent to java -jar start.jar etc/jetty.xml.


Multiple Configuration Files

You are not limited to one configuration file; you can use multiple configuration files when running Jetty, and Jetty will configure the appropriate server instance.

The id of the server in the <Configure> tag specifies the instance you want to configure. Each server id in a configuration file creates a new Server instance within the same JVM. If you use the same id across multiple configuration files, those configurations are all applied to the same server.

Parameterizing Configuration Files

You can set parameters in configuration files either with system properties (using <SystemProperty>) or properties files (using <Property>) passed via the command line. For example, this code in jetty.xml allows the port to be defined on the command line, falling back onto 8080 if the port is not specified:

  <Set name="port"><SystemProperty name="jetty.port" default="8080"/></Set>

Then you modify the port while running Jetty by using this command:

java -Djetty.port=8888 -jar start.jar etc/jetty.xml

An example of defining both system properties and properties files from the command line:

java -Djetty.port=8888 -jar start.jar myjetty.properties etc/jetty.xml etc/other.xml

Back to the top