org.jenkinsci.maven.plugins.hpi

Class RunMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.jenkinsci.maven.plugins.hpi.AbstractJettyMojo

org.jenkinsci.maven.plugins.hpi.RunMojo

All Implemented Interfaces:

org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo

Direct Known Subclasses:

WarMojo

@Mojo(name="run")
@Execute(phase=COMPILE)
public class RunMojo
extends AbstractJettyMojo

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

Author:

Kohsuke Kawaguchi

Field Summary

Fields

Modifier and Type	Field and Description
protected org.apache.maven.artifact.factory.ArtifactFactory	artifactFactory
protected org.apache.maven.artifact.metadata.ArtifactMetadataSource	artifactMetadataSource
protected org.apache.maven.artifact.resolver.ArtifactResolver	artifactResolver
protected boolean	consoleForceReload If true, the context will be restarted after a line feed on the input console.
protected String	contextPath Deprecated. Use <webApp><contextPath> instead.
protected int	defaultPort Specifies the HTTP port number.
protected String	dependencyResolution Decides the level of dependency resolution.
protected String	jenkinsCoreId Optional string that represents "groupId:artifactId" of Jenkins core jar.
protected String	jenkinsWarId Optional string that represents "groupId:artifactId" of Jenkins war.
protected org.apache.maven.artifact.repository.ArtifactRepository	localRepository
protected String	maskClasses [ws|tab|CR|LF]+ separated list of package prefixes that your plugin doesn't want to see from the core.
protected boolean	pluginFirstClassLoader
protected org.apache.maven.project.MavenProjectBuilder	projectBuilder
protected List<org.apache.maven.artifact.repository.ArtifactRepository>	remoteRepos
protected File	warSourceDirectory Single directory for extra files to include in the WAR.

Fields inherited from class org.jenkinsci.maven.plugins.hpi.AbstractJettyMojo

consoleScanner, contextHandlers, contextXml, dumpOnStart, excludedGoals, execution, httpConnector, jettyXml, loginServices, nonblocking, pluginArtifacts, PORT_SYSPROPERTY, project, projectArtifacts, reload, requestLog, scanIntervalSeconds, scanList, scanner, scannerListeners, server, skip, stopKey, stopPort, systemPropertiesFile, useProvidedScope, webApp

Fields inherited from interface org.apache.maven.plugin.Mojo

ROLE

Constructor Summary

Constructors

Constructor and Description
RunMojo()

Method Summary

Methods

Modifier and Type	Method and Description
void	checkPomConfiguration()
void	configureScanner()
void	configureWebApplication() Subclasses should invoke this to setup basic info on the webapp
void	execute()
void	finishConfigurationBeforeStart()
protected org.apache.maven.artifact.Artifact	getJenkinsWarArtifact()
protected org.apache.maven.project.MavenProject	getProject()
Set<MavenArtifact>	getProjectArtifacts()
org.eclipse.jetty.webapp.WebAppContext	getWebAppConfig()
protected Set<org.apache.maven.artifact.Artifact>	resolveDependencies(String scope) Performs the equivalent of "@requireDependencyResolution" mojo attribute, so that we can choose the scope at runtime.
void	restartWebApp(boolean reconfigureScanner)
protected void	startConsoleScanner() Run a thread that monitors the console input to detect ENTER hits.
void	startJetty()
protected MavenArtifact	wrap(org.apache.maven.artifact.Artifact a)

Methods inherited from class org.jenkinsci.maven.plugins.hpi.AbstractJettyMojo

applyJettyXml, configureMonitor, configurePluginClasspath, findJettyWebXmlFile, getJettyXmlFiles, isExcluded, isPluginArtifact, printSystemProperties, setSystemProperties, setSystemPropertiesFile

Methods inherited from class org.apache.maven.plugin.AbstractMojo

getLog, getPluginContext, setLog, setPluginContext

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

dependencyResolution

@Parameter(defaultValue="test")
protected String dependencyResolution

Decides the level of dependency resolution. This controls what plugins are made available to the running Jenkins.

warSourceDirectory

@Parameter(defaultValue="${basedir}/src/main/webapp")
protected File warSourceDirectory

Single directory for extra files to include in the WAR.

artifactResolver

@Component
protected org.apache.maven.artifact.resolver.ArtifactResolver artifactResolver

artifactFactory

@Component
protected org.apache.maven.artifact.factory.ArtifactFactory artifactFactory

remoteRepos

@Parameter(defaultValue="${project.remoteArtifactRepositories}",
           readonly=true,
           required=true)
protected List<org.apache.maven.artifact.repository.ArtifactRepository> remoteRepos

localRepository

@Parameter(defaultValue="${localRepository}")
protected org.apache.maven.artifact.repository.ArtifactRepository localRepository

artifactMetadataSource

@Component
protected org.apache.maven.artifact.metadata.ArtifactMetadataSource artifactMetadataSource

defaultPort

@Parameter(property="port")
protected int defaultPort

Specifies the HTTP port number. If connectors are configured in the Mojo, that'll take precedence.

consoleForceReload

@Parameter(property="jetty.consoleForceReload",
           defaultValue="true")
protected boolean consoleForceReload

If true, the context will be restarted after a line feed on the input console. Disabled by default.

projectBuilder

@Component
protected org.apache.maven.project.MavenProjectBuilder projectBuilder

jenkinsCoreId

@Parameter
protected String jenkinsCoreId

Optional string that represents "groupId:artifactId" of Jenkins core jar. If left unspecified, the default groupId/artifactId pair for Jenkins is looked for.

Since:

1.65

jenkinsWarId

@Parameter
protected String jenkinsWarId

Optional string that represents "groupId:artifactId" of Jenkins war. If left unspecified, the default groupId/artifactId pair for Jenkins is looked for.

Since:

1.68

maskClasses

@Parameter
protected String 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."

pluginFirstClassLoader

@Parameter
protected boolean pluginFirstClassLoader

Since:

1.94

contextPath

@Parameter(readonly=true,
           required=true,
           defaultValue="/${project.artifactId}")
protected String contextPath

Deprecated. Use <webApp><contextPath> instead.

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

Constructor Detail

RunMojo

public RunMojo()

Method Detail

execute

public void execute()
             throws org.apache.maven.plugin.MojoExecutionException,
                    org.apache.maven.plugin.MojoFailureException

Specified by:

execute in interface org.apache.maven.plugin.Mojo

Overrides:

execute in class AbstractJettyMojo

Throws:

org.apache.maven.plugin.MojoExecutionException

org.apache.maven.plugin.MojoFailureException

See Also:

Mojo.execute()

configureWebApplication

public void configureWebApplication()
                             throws Exception

Description copied from class: AbstractJettyMojo

Subclasses should invoke this to setup basic info on the webapp

Overrides:

configureWebApplication in class AbstractJettyMojo

Throws:

org.apache.maven.plugin.MojoExecutionException

Exception

configureScanner

public void configureScanner()
                      throws org.apache.maven.plugin.MojoExecutionException

Specified by:

configureScanner in class AbstractJettyMojo

Throws:

org.apache.maven.plugin.MojoExecutionException

restartWebApp

public void restartWebApp(boolean reconfigureScanner)
                   throws Exception

Specified by:

restartWebApp in class AbstractJettyMojo

Throws:

Exception

startConsoleScanner

protected void startConsoleScanner()
                            throws Exception

Description copied from class: AbstractJettyMojo

Run a thread that monitors the console input to detect ENTER hits.

Overrides:

startConsoleScanner in class AbstractJettyMojo

Throws:

Exception

checkPomConfiguration

public void checkPomConfiguration()
                           throws org.apache.maven.plugin.MojoExecutionException

Specified by:

checkPomConfiguration in class AbstractJettyMojo

Throws:

org.apache.maven.plugin.MojoExecutionException

finishConfigurationBeforeStart

public void finishConfigurationBeforeStart()
                                    throws Exception

Overrides:

finishConfigurationBeforeStart in class AbstractJettyMojo

Throws:

Exception

startJetty

public void startJetty()
                throws org.apache.maven.plugin.MojoExecutionException

Overrides:

startJetty in class AbstractJettyMojo

Throws:

org.apache.maven.plugin.MojoExecutionException

resolveDependencies

protected Set<org.apache.maven.artifact.Artifact> resolveDependencies(String scope)
                                                               throws org.apache.maven.plugin.MojoExecutionException

Performs the equivalent of "@requireDependencyResolution" mojo attribute, so that we can choose the scope at runtime.

Parameters:

scope -

Throws:

org.apache.maven.plugin.MojoExecutionException

getProjectArtifacts

public Set<MavenArtifact> getProjectArtifacts()

wrap

protected MavenArtifact wrap(org.apache.maven.artifact.Artifact a)

getJenkinsWarArtifact

protected org.apache.maven.artifact.Artifact getJenkinsWarArtifact()
                                                            throws org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoExecutionException

getProject

protected org.apache.maven.project.MavenProject getProject()

getWebAppConfig

public org.eclipse.jetty.webapp.WebAppContext getWebAppConfig()