Fork me on GitHub

hpi:custom-war

Full name:

org.jenkins-ci.tools:maven-hpi-plugin:3.54-SNAPSHOT:custom-war

Description:

Builds a custom Jenkins war that includes all the additional plugins referenced in this POM.

Attributes:

  • Requires a Maven project to be executed.
  • Requires dependency resolution of artifacts in scope: runtime.
  • The goal is not marked as thread-safe and thus does not support parallel builds.
  • Binds by default to the lifecycle phase: package.
  • Invokes the execution of the following lifecycle phase prior to executing itself: compile.

Required Parameters

Name Type Since Description
<scan> int - The interval in seconds to pause before checking if changes have occurred and re-deploying as necessary. A value of 0 indicates no re-deployment will be done. In that case, you can force redeployment by typing a linefeed character at the command line.
Default: 0
User Property: jetty.scan

Optional Parameters

Name Type Since Description
<addThisPluginToCustomWar> boolean - Add this plugin to custom war
Default: false
User Property: addThisPluginToCustomWar
<consoleForceReload> boolean -
Deprecated.
use org.eclipse.jetty.maven.plugin.JettyRunWarMojo.scan

If true, the context will be restarted after a line feed on the input console. Enabled by default.
Default: true
User Property: jetty.consoleForceReload
<contextHandlers> List<ContextHandler> - List of other contexts to set up. Consider using instead the <jettyXml> element to specify external jetty xml config file. Optional.
<contextXml> String - Location of a context xml configuration file whose contents will be applied to the webapp AFTER anything in <webApp>.Optional.
<defaultHost> String - Specifies the host (network interface) to bind to. If connectors are configured in the Mojo, that'll take precedence.
Default: localhost
User Property: host
<defaultPort> int - Specifies the HTTP port number. If connectors are configured in the Mojo, that'll take precedence.
Default: 8080
User Property: port
<dependencyResolution> String - Decides the level of dependency resolution. This controls what plugins are made available to the running Jenkins.
Default: test
<deployMode> AbstractWebAppMojo$DeploymentMode - Controls how to run jetty. Valid values are EMBED,FORK,EXTERNAL.
Default: EMBED
User Property: jetty.deployMode
<env> Map<String,String> - Extra environment variables to be passed to the forked process
<excludedGoals> String[] jetty-7.5.2 List of goals that are NOT to be used
<forkWebXml> File - The file into which to generate the quickstart web xml for the forked process to use
Default: ${project.build.directory}/fork-web.xml
<httpConnector> MavenServerConnector - A ServerConnector to use.
<hudsonHome> File - Path to $JENKINS_HOME. The launched Jenkins will use this directory as the workspace.
Default: ${HUDSON_HOME}
User Property: hudsonHome
<jenkinsCoreId> String 1.65 Optional string that represents "groupId:artifactId" of Jenkins core jar. If left unspecified, the default groupId/artifactId pair for Jenkins is looked for.
<jenkinsHome> File - Path to $JENKINS_HOME. The launched Jenkins will use this directory as the workspace.
Default: ${JENKINS_HOME}
User Property: jenkinsHome
<jenkinsWarId> String - Optional string that represents "groupId:artifactId" of Jenkins war. If left unspecified, the default groupId/artifactId pair for Jenkins is looked for.
<jettyBase> File - Location of jetty base directory
<jettyHome> File - Location of jetty home directory
<jettyOptions> String - Extra options that can be passed to the jetty command line
User Property: jetty.options
<jettyProperties> Map<String,String> - Optional jetty properties to put on the command line
<jettyXmls> List<File> - List of jetty xml configuration files whose contents will be applied (in order declared) before any plugin configuration. Optional.
<jvmArgs> String - Arbitrary jvm args to pass to the forked process
User Property: jetty.jvmArgs
<loggers> Map<String,String> 1.98 List of loggers to define. Keys are logger names (usually package or class names); values are level names (such as FINE).
<loginServices> List<LoginService> - List of security realms to set up. Consider using instead the <jettyXml> element to specify external jetty xml config file. Optional.
<maskClasses> String - [ws|tab|CR|LF]+ separated list of package prefixes that your plugin doesn't want to see from the core.

Tokens in this list is prefix-matched against the fully-qualified class name, so add "." to the end of each package name, like "com.foo. com.bar."

<maxChildStartCheckMs> long - How long to wait in msec between checks to see if jetty has started correctly when running in FORK or EXTERNAL mode.
Default: 200
<maxChildStartChecks> int - Max number of times to check to see if jetty has started correctly when running in FORK or EXTERNAL mode.
Default: 10
<minimumJavaVersion> String -
Deprecated.
removed without replacement

Specify the minimum version of Java that this plugin requires.
<modules> String[] - Optional list of other modules to activate.
<outputFile> File - No description.
<pluginFirstClassLoader> boolean 1.94 No description.
<requestLog> RequestLog - A RequestLog implementation to use for the webapp at runtime. Consider using instead the <jettyXml> element to specify external jetty xml config file. Optional.
<scanTargetPatterns> List<ScanTargetPattern> - List of directories with ant-style <include> and <exclude> patterns for extra targets to periodically scan for changes.Optional.
<server> Server - A wrapper for the Server object
<skip> boolean - Skip this mojo execution.
Default: false
User Property: jetty.skip
<stopKey> String - Key to provide when stopping jetty on executing java -DSTOP.KEY=<stopKey> -DSTOP.PORT=<stopPort> -jar start.jar --stop
<stopPort> int - Port to listen to stop jetty on executing -DSTOP.PORT=<stopPort> -DSTOP.KEY=<stopKey> -jar start.jar --stop
<supportedPackagings> List<String> - Default supported project type is war packaging.
<systemProperties> Map<String,String> - 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. They WILL override System properties that have been set via systemPropertiesFile. Optional.
<systemPropertiesFile> File - File containing system properties to be set before execution Note that these properties will NOT override System properties that have been set on the command line, by the JVM, or directly in the POM via systemProperties. Optional.
User Property: jetty.systemPropertiesFile
<useProvidedScope> boolean jetty-7.5.2 Whether or not to include dependencies on the plugin's classpath with <scope>provided</scope> Use WITH CAUTION as you may wind up with duplicate jars/classes.
Default: false
<useTestScope> boolean - If true, the <testOutputDirectory> and the dependencies of <scope>test<scope> will be put first on the runtime classpath.
Default: false
<warSourceDirectory> File - Single directory for extra files to include in the WAR.
Default: ${basedir}/src/main/webapp
<webApp> MavenWebAppContext - An instance of org.eclipse.jetty.webapp.WebAppContext that represents the webapp. Use any of its setters to configure the webapp. This is the preferred and most flexible method of configuration, rather than using the (deprecated) individual parameters like "tmpDirectory", "contextPath" etc.
<webAppFile> File - The location of the war file.

Normally this should be left empty, in which case the plugin loads it from the repository. But this parameter allows that to be overwritten.


User Property: webAppFile
<wildcardDNS> String - Optional wildcard DNS domain to help set a distinct Jenkins root URL from every plugin. Just prints a URL you ought to set. Recommended: nip.io
User Property: wildcardDNS

Parameter Details

<addThisPluginToCustomWar>

Add this plugin to custom war
  • Type: boolean
  • Required: No
  • User Property: addThisPluginToCustomWar
  • Default: false

<consoleForceReload>

Deprecated.
use org.eclipse.jetty.maven.plugin.JettyRunWarMojo.scan

If true, the context will be restarted after a line feed on the input console. Enabled by default.
  • Type: boolean
  • Required: No
  • User Property: jetty.consoleForceReload
  • Default: true

<contextHandlers>

List of other contexts to set up. Consider using instead the <jettyXml> element to specify external jetty xml config file. Optional.
  • Type: java.util.List<org.eclipse.jetty.server.handler.ContextHandler>
  • Required: No

<contextXml>

Location of a context xml configuration file whose contents will be applied to the webapp AFTER anything in <webApp>.Optional.
  • Type: java.lang.String
  • Required: No

<defaultHost>

Specifies the host (network interface) to bind to. If connectors are configured in the Mojo, that'll take precedence.
  • Type: java.lang.String
  • Required: No
  • User Property: host
  • Default: localhost

<defaultPort>

Specifies the HTTP port number. If connectors are configured in the Mojo, that'll take precedence.
  • Type: int
  • Required: No
  • User Property: port
  • Default: 8080

<dependencyResolution>

Decides the level of dependency resolution. This controls what plugins are made available to the running Jenkins.
  • Type: java.lang.String
  • Required: No
  • Default: test

<deployMode>

Controls how to run jetty. Valid values are EMBED,FORK,EXTERNAL.
  • Type: org.eclipse.jetty.maven.plugin.AbstractWebAppMojo$DeploymentMode
  • Required: No
  • User Property: jetty.deployMode
  • Default: EMBED

<env>

Extra environment variables to be passed to the forked process
  • Type: java.util.Map<java.lang.String, java.lang.String>
  • Required: No

<excludedGoals>

List of goals that are NOT to be used
  • Type: java.lang.String[]
  • Since: jetty-7.5.2
  • Required: No

<forkWebXml>

The file into which to generate the quickstart web xml for the forked process to use
  • Type: java.io.File
  • Required: No
  • Default: ${project.build.directory}/fork-web.xml

<httpConnector>

A ServerConnector to use.
  • Type: org.eclipse.jetty.maven.plugin.MavenServerConnector
  • Required: No

<hudsonHome>

Path to $JENKINS_HOME. The launched Jenkins will use this directory as the workspace.
  • Type: java.io.File
  • Required: No
  • User Property: hudsonHome
  • Default: ${HUDSON_HOME}

<jenkinsCoreId>

Optional string that represents "groupId:artifactId" of Jenkins core jar. If left unspecified, the default groupId/artifactId pair for Jenkins is looked for.
  • Type: java.lang.String
  • Since: 1.65
  • Required: No

<jenkinsHome>

Path to $JENKINS_HOME. The launched Jenkins will use this directory as the workspace.
  • Type: java.io.File
  • Required: No
  • User Property: jenkinsHome
  • Default: ${JENKINS_HOME}

<jenkinsWarId>

Optional string that represents "groupId:artifactId" of Jenkins war. If left unspecified, the default groupId/artifactId pair for Jenkins is looked for.
  • Type: java.lang.String
  • Required: No

<jettyBase>

Location of jetty base directory
  • Type: java.io.File
  • Required: No

<jettyHome>

Location of jetty home directory
  • Type: java.io.File
  • Required: No

<jettyOptions>

Extra options that can be passed to the jetty command line
  • Type: java.lang.String
  • Required: No
  • User Property: jetty.options

<jettyProperties>

Optional jetty properties to put on the command line
  • Type: java.util.Map<java.lang.String, java.lang.String>
  • Required: No

<jettyXmls>

List of jetty xml configuration files whose contents will be applied (in order declared) before any plugin configuration. Optional.
  • Type: java.util.List<java.io.File>
  • Required: No

<jvmArgs>

Arbitrary jvm args to pass to the forked process
  • Type: java.lang.String
  • Required: No
  • User Property: jetty.jvmArgs

<loggers>

List of loggers to define. Keys are logger names (usually package or class names); values are level names (such as FINE).
  • Type: java.util.Map<java.lang.String, java.lang.String>
  • Since: 1.98
  • Required: No

<loginServices>

List of security realms to set up. Consider using instead the <jettyXml> element to specify external jetty xml config file. Optional.
  • Type: java.util.List<org.eclipse.jetty.security.LoginService>
  • Required: No

<maskClasses>

[ws|tab|CR|LF]+ separated list of package prefixes that your plugin doesn't want to see from the core.

Tokens in this list is prefix-matched against the fully-qualified class name, so add "." to the end of each package name, like "com.foo. com.bar."

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

<maxChildStartCheckMs>

How long to wait in msec between checks to see if jetty has started correctly when running in FORK or EXTERNAL mode.
  • Type: long
  • Required: No
  • Default: 200

<maxChildStartChecks>

Max number of times to check to see if jetty has started correctly when running in FORK or EXTERNAL mode.
  • Type: int
  • Required: No
  • Default: 10

<minimumJavaVersion>

Deprecated.
removed without replacement

Specify the minimum version of Java that this plugin requires.
  • Type: java.lang.String
  • Required: No

<modules>

Optional list of other modules to activate.
  • Type: java.lang.String[]
  • Required: No

<outputFile>

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

<pluginFirstClassLoader>

No description.
  • Type: boolean
  • Since: 1.94
  • Required: No

<requestLog>

A RequestLog implementation to use for the webapp at runtime. Consider using instead the <jettyXml> element to specify external jetty xml config file. Optional.
  • Type: org.eclipse.jetty.server.RequestLog
  • Required: No

<scan>

The interval in seconds to pause before checking if changes have occurred and re-deploying as necessary. A value of 0 indicates no re-deployment will be done. In that case, you can force redeployment by typing a linefeed character at the command line.
  • Type: int
  • Required: Yes
  • User Property: jetty.scan
  • Default: 0

<scanTargetPatterns>

List of directories with ant-style <include> and <exclude> patterns for extra targets to periodically scan for changes.Optional.
  • Type: java.util.List<org.eclipse.jetty.maven.plugin.ScanTargetPattern>
  • Required: No

<server>

A wrapper for the Server object
  • Type: org.eclipse.jetty.server.Server
  • Required: No

<skip>

Skip this mojo execution.
  • Type: boolean
  • Required: No
  • User Property: jetty.skip
  • Default: false

<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

<supportedPackagings>

Default supported project type is war packaging.
  • Type: java.util.List<java.lang.String>
  • 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. They WILL override System properties that have been set via systemPropertiesFile. Optional.
  • Type: java.util.Map<java.lang.String, java.lang.String>
  • Required: No

<systemPropertiesFile>

File containing system properties to be set before execution Note that these properties will NOT override System properties that have been set on the command line, by the JVM, or directly in the POM via systemProperties. Optional.
  • Type: java.io.File
  • Required: No
  • User Property: jetty.systemPropertiesFile

<useProvidedScope>

Whether or not to include dependencies on the plugin's classpath with <scope>provided</scope> Use WITH CAUTION as you may wind up with duplicate jars/classes.
  • Type: boolean
  • Since: jetty-7.5.2
  • Required: No
  • Default: false

<useTestScope>

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

<warSourceDirectory>

Single directory for extra files to include in the WAR.
  • Type: java.io.File
  • Required: No
  • Default: ${basedir}/src/main/webapp

<webApp>

An instance of org.eclipse.jetty.webapp.WebAppContext that represents the webapp. Use any of its setters to configure the webapp. This is the preferred and most flexible method of configuration, rather than using the (deprecated) individual parameters like "tmpDirectory", "contextPath" etc.
  • Type: org.eclipse.jetty.maven.plugin.MavenWebAppContext
  • Required: No

<webAppFile>

The location of the war file.

Normally this should be left empty, in which case the plugin loads it from the repository. But this parameter allows that to be overwritten.

  • Type: java.io.File
  • Required: No
  • User Property: webAppFile

<wildcardDNS>

Optional wildcard DNS domain to help set a distinct Jenkins root URL from every plugin. Just prints a URL you ought to set. Recommended: nip.io
  • Type: java.lang.String
  • Required: No
  • User Property: wildcardDNS