Required Parameters

Optional Parameters

Parameter Details

classesDirectory :

The directory containing generated classes.

• Type: java.io.File
• Required: Yes
• Expression: ${project.build.outputDirectory}

connectors :

List of connectors to use. If none are configured then the default is a single SelectChannelConnector at port 8080. You can override this default port number by using the system property jetty.port on the command line, eg: mvn -Djetty.port=9999 jetty:run

• Type: org.mortbay.jetty.Connector[]
• Required: No

contextHandlers :

List of other contexts to set up. Optional.

• Type: org.mortbay.jetty.handler.ContextHandler[]
• Required: No

contextPath :

The context path for the webapp. Defaults to the name of the webapp's artifact.

• Type: java.lang.String
• Required: Yes
• Expression: /${project.artifactId}

deamon :

Determines whether or not the server blocks when started. The default behavior (deamon = false) will cause the server to pause other processes while it continues to handle web requests. This is useful when starting the server with the intent to work with it interactively.

Often, it is desirable to let the server start and continue running subsequent processes in an automated build environment. This can be facilitated by setting deamon to true.

• Type: boolean
• Required: No
• Expression: ${jetty.deamon}
• Default: false

jettyConfig :

Location of a jetty xml configuration file whose contents will be applied before any plugin configuration. Optional.

• Type: java.io.File
• Required: No

jettyEnvXml :

The location of a jetty-env.xml file. Optional.

• Type: java.io.File
• Required: No

overrideWebXml :

A web.xml file to be applied AFTER the webapp's web.xml file. Useful for applying different build profiles, eg test, production etc. Optional.

• Type: java.io.File
• Required: No

requestLog :

A RequestLog implementation to use for the webapp at runtime. Optional.

• Type: org.mortbay.jetty.RequestLog
• Required: No

scanIntervalSeconds :

The interval in seconds to scan the webapp for changes and restart the context if necessary. Disabled by default.

• Type: int
• Required: Yes
• Expression: 0

scanTargetPatterns :

List of directories with ant-style <include> and <exclude> patterns for extra targets to periodically scan for changes. Can be used instead of, or in conjunction with <scanTargets>.Optional.

• Type: org.mortbay.jetty.plugin.util.ScanTargetPattern[]
• Required: No

scanTargets :

List of files or directories to additionally periodically scan for changes. Optional.

• Type: java.io.File[]
• Required: No

stopKey :

Key to provide when stopping jetty on executing java -DSTOP.KEY=<stopKey> -DSTOP.PORT=<stopPort> -jar start.jar --stop

• Type: java.lang.String
• Required: No

stopPort :

Port to listen to stop jetty on executing -DSTOP.PORT=<stopPort> -DSTOP.KEY=<stopKey> -jar start.jar --stop

• Type: int
• Required: No

systemProperties :

System properties to set before execution. Note that these properties will NOT override System properties that have been set on the command line or by the JVM. Optional.

• Type: org.mortbay.jetty.plugin.util.SystemProperty[]
• Required: No

testClassesDirectory :

The directory containing generated test classes.

• Type: java.io.File
• Required: Yes
• Expression: ${project.build.testOutputDirectory}

tmpDirectory :

The temporary directory to use for the webapp. Defaults to target/jetty-tmp

• Type: java.io.File
• Required: Yes
• Expression: ${project.build.directory}/work

useTestClasspath :

If true, the <testOutputDirectory> and the dependencies of <scope>test<scope> will be put first on the runtime classpath.

• Type: boolean
• Required: No
• Default: false

userRealms :

List of security realms to set up. Optional.

• Type: org.mortbay.jetty.security.UserRealm[]
• Required: No

webAppConfig :

The "virtual" webapp created by the plugin

• Type: org.mortbay.jetty.plugin.Jetty6PluginWebAppContext
• Required: No

webAppSourceDirectory :

Root directory for all html/jsp etc files

• Type: java.io.File
• Required: Yes
• Expression: ${basedir}/src/main/webapp

webDefaultXml :

A webdefault.xml file to use instead of the default for the webapp. Optional.

• Type: java.io.File
• Required: No

webXml :

The location of the web.xml file. If not set then it is assumed it is in ${basedir}/src/main/webapp/WEB-INF

• Type: java.io.File
• Required: No
• Expression: ${maven.war.webxml}