Fork me on GitHub

hpi:run

Full name:

org.jenkins-ci.tools:maven-hpi-plugin:1.106:run

Description:

Runs Jenkins with the current plugin project.

This only needs the source files to be compiled, so run in the compile phase.

To specify the HTTP port, use -Djetty.port=PORT

Attributes:

  • Requires a Maven project to be executed.
  • Invokes the execution of the lifecycle phase compile prior to executing itself.

Optional Parameters

Name Type Since Description
connectors Connector[] - List of connectors to use. If none are configured then we use a single SelectChannelConnector at port 8080
consoleForceReload boolean - If true, the context will be restarted after a line feed on the input console. Disabled by default.
Default value is: true.
User property is: jetty.consoleForceReload.
contextPath String - The context path for the webapp. Defaults to "/"
Default value is: /.
User property is: hpi.prefix.
defaultPort String - Specifies the HTTP port number. If connectors are configured in the Mojo, that'll take precedence.
User property is: port.
dependencyResolution String - Decides the level of dependency resolution. This controls what plugins are made available to the running Jenkins.
Default value is: test.
hudsonHome File - Path to $JENKINS_HOME. The launched Jenkins will use this directory as the workspace.
Default value is: ${HUDSON_HOME}.
User property is: 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 value is: ${JENKINS_HOME}.
User property is: jenkinsHome.
jenkinsWarId String 1.68 Optional string that represents "groupId:artifactId" of Jenkins war. If left unspecified, the default groupId/artifactId pair for Jenkins is looked for.
jettyConfig String - Location of a jetty xml configuration file whose contents will be applied before any plugin configuration. Optional.
localRepository ArtifactRepository - (no description)
Default value is: ${localRepository}.
loggers Map 1.98 List of loggers to define. Keys are logger names (usually package or class names); values are level names (such as FINE).
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."


pluginFirstClassLoader boolean 1.94 (no description)
requestLog RequestLog - A RequestLog implementation to use for the webapp at runtime. Optional.
scanIntervalSeconds int - The interval in seconds to scan the webapp for changes and restart the context if necessary. Disabled by default.
Default value is: 0.
User property is: scanIntervalSeconds.
systemProperties Map 1.85 List of additional System properties to set
tmpDirectory File - The temporary directory to use for the webapp. Defaults to target/jetty-tmp
Default value is: ${project.build.directory}/work.
userRealms UserRealm[] - List of security realms to set up. Optional.
warSourceDirectory File - Single directory for extra files to include in the WAR.
Default value is: ${basedir}/src/main/webapp.
webApp 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.


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

Parameter Details

connectors:

List of connectors to use. If none are configured then we use a single SelectChannelConnector at port 8080
  • Type: org.mortbay.jetty.Connector[]
  • Required: No

consoleForceReload:

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

contextPath:

The context path for the webapp. Defaults to "/"
  • Type: java.lang.String
  • Required: No
  • User Property: hpi.prefix
  • Default: /

defaultPort:

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

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

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
  • Since: 1.68
  • Required: No

jettyConfig:

Location of a jetty xml configuration file whose contents will be applied before any plugin configuration. Optional.
  • Type: java.lang.String
  • Required: No

localRepository:

(no description)
  • Type: org.apache.maven.artifact.repository.ArtifactRepository
  • Required: No
  • Default: ${localRepository}

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
  • Since: 1.98
  • 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

pluginFirstClassLoader:

(no description)
  • Type: boolean
  • Since: 1.94
  • 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: No
  • User Property: scanIntervalSeconds
  • Default: 0

systemProperties:

List of additional System properties to set
  • Type: java.util.Map
  • Since: 1.85
  • Required: No

tmpDirectory:

The temporary directory to use for the webapp. Defaults to target/jetty-tmp
  • Type: java.io.File
  • Required: No
  • Default: ${project.build.directory}/work

userRealms:

List of security realms to set up. Optional.
  • Type: org.mortbay.jetty.security.UserRealm[]
  • Required: No

warSourceDirectory:

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

webApp:

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

webDefaultXml:

A webdefault.xml file to use instead of the default for the webapp. Optional.
  • Type: java.io.File
  • Required: No