org.eclipse.jetty.maven.plugin

Class JettyRunMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.eclipse.jetty.maven.plugin.AbstractJettyMojo

org.eclipse.jetty.maven.plugin.JettyRunMojo

All Implemented Interfaces:

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

Direct Known Subclasses:

JettyEffectiveWebXml, JettyRunForkedMojo, JettyStartMojo

public class JettyRunMojo
extends AbstractJettyMojo

This goal is used in-situ on a Maven project without first requiring that the project is assembled into a war, saving time during the development cycle. The plugin forks a parallel lifecycle to ensure that the "compile" phase has been completed before invoking Jetty. This means that you do not need to explicity execute a "mvn compile" first. It also means that a "mvn clean jetty:run" will ensure that a full fresh compile is done before invoking Jetty.

Once invoked, the plugin can be configured to run continuously, scanning for changes in the project and automatically performing a hot redeploy when necessary. This allows the developer to concentrate on coding changes to the project using their IDE of choice and have those changes immediately and transparently reflected in the running web container, eliminating development time that is wasted on rebuilding, reassembling and redeploying.

You may also specify the location of a jetty.xml file whose contents will be applied before any plugin configuration. This can be used, for example, to deploy a static webapp that is not part of your maven build.

There is a reference guide to the configuration parameters for this plugin.

Field Summary

Fields

Modifier and Type	Field and Description
protected File	classesDirectory The directory containing generated classes.
static String	DEFAULT_WEBAPP_SRC
protected List<File>	extraScanTargets Extra scan targets as a list
static String	FAKE_WEBAPP
protected ScanTargetPattern[]	scanTargetPatterns List of directories with ant-style <include> and <exclude> patterns for extra targets to periodically scan for changes.
protected File[]	scanTargets List of files or directories to additionally periodically scan for changes.
protected File	testClassesDirectory The directory containing generated test classes.
protected boolean	useTestScope If true, the <testOutputDirectory> and the dependencies of <scope>test<scope> will be put first on the runtime classpath.
protected List<org.apache.maven.artifact.Artifact>	warArtifacts List of deps that are wars
protected WarPluginInfo	warPluginInfo maven-war-plugin reference
protected File	webAppSourceDirectory Root directory for all html/jsp etc files
protected String	webXml The default location of the web.xml file.

Fields inherited from class org.eclipse.jetty.maven.plugin.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, systemProperties, systemPropertiesFile, useProvidedScope, webApp

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

ROLE

Constructor Summary

Constructors

Constructor and Description
JettyRunMojo()

Method Summary

Methods

Modifier and Type	Method and Description
void	checkPomConfiguration() Verify the configuration given in the pom.
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	getArtifactForOverlay(OverlayConfig o, List<org.apache.maven.artifact.Artifact> warArtifacts)
void	restartWebApp(boolean reconfigureScanner)

Methods inherited from class org.eclipse.jetty.maven.plugin.AbstractJettyMojo

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

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

DEFAULT_WEBAPP_SRC

public static final String DEFAULT_WEBAPP_SRC

FAKE_WEBAPP

public static final String FAKE_WEBAPP

See Also:

Constant Field Values

useTestScope

protected boolean useTestScope

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

webXml

protected String webXml

The default location of the web.xml file. Will be used if <webApp><descriptor> is not set.

classesDirectory

protected File classesDirectory

The directory containing generated classes.

testClassesDirectory

protected File testClassesDirectory

The directory containing generated test classes.

webAppSourceDirectory

protected File webAppSourceDirectory

Root directory for all html/jsp etc files

scanTargets

protected File[] scanTargets

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

scanTargetPatterns

protected ScanTargetPattern[] 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.

extraScanTargets

protected List<File> extraScanTargets

Extra scan targets as a list

warPluginInfo

protected WarPluginInfo warPluginInfo

maven-war-plugin reference

warArtifacts

protected List<org.apache.maven.artifact.Artifact> warArtifacts

List of deps that are wars

Constructor Detail

JettyRunMojo

public JettyRunMojo()

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:

AbstractJettyMojo.execute()

checkPomConfiguration

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

Verify the configuration given in the pom.

Specified by:

checkPomConfiguration in class AbstractJettyMojo

Throws:

org.apache.maven.plugin.MojoExecutionException

See Also:

AbstractJettyMojo.checkPomConfiguration()

finishConfigurationBeforeStart

public void finishConfigurationBeforeStart()
                                    throws Exception

Overrides:

finishConfigurationBeforeStart in class AbstractJettyMojo

Throws:

Exception

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

See Also:

AbstractJettyMojo.configureWebApplication()

configureScanner

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

Specified by:

configureScanner in class AbstractJettyMojo

Throws:

org.apache.maven.plugin.MojoExecutionException

See Also:

AbstractJettyMojo.configureScanner()

restartWebApp

public void restartWebApp(boolean reconfigureScanner)
                   throws Exception

Specified by:

restartWebApp in class AbstractJettyMojo

Throws:

Exception

See Also:

AbstractJettyMojo.restartWebApp(boolean)

getArtifactForOverlay

protected org.apache.maven.artifact.Artifact getArtifactForOverlay(OverlayConfig o,
                                                       List<org.apache.maven.artifact.Artifact> warArtifacts)

Parameters:

o -

warArtifacts -

Returns: