Package org.eclipse.jetty.maven.plugin

Class JettyEffectiveWebXml

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.eclipse.jetty.maven.plugin.AbstractJettyMojo

org.eclipse.jetty.maven.plugin.JettyRunMojo

org.eclipse.jetty.maven.plugin.JettyEffectiveWebXml

All Implemented Interfaces:

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

@Mojo(name="effective-web-xml",
      requiresDependencyResolution=TEST)
@Execute(phase=TEST_COMPILE)
public class JettyEffectiveWebXml
extends JettyRunMojo

This goal runs the jetty quickstart feature on an unassembled webapp in order to generate a comprehensive web.xml that combines all information from annotations, webdefault.xml and all web-fragment.xml files. By default, the web.xml is generated to the console output only. Use the effectiveWebXml parameter to provide a file name into which to save the output. See https://jetty.org/docs/ for more information on this and other jetty plugins. Runs jetty on the unassembled webapp to generate the effective web.xml

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	deleteOnExit
protected java.io.File	effectiveWebXml	The name of the file to generate into
protected java.io.File	target	The target directory

Fields inherited from class org.eclipse.jetty.maven.plugin.JettyRunMojo

classesDirectory, DEFAULT_WEBAPP_SRC, FAKE_WEBAPP, originalBaseResource, scanClassesPattern, scanTargetPatterns, scanTargets, scanTestClassesPattern, testClassesDirectory, useTestScope, warArtifacts, warPluginInfo, webAppSourceDirectory, webXml

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

consoleScanner, contextHandlers, contextXml, dumpOnStart, excludedGoals, execution, httpConnector, jettyXml, loginServices, nonBlocking, pluginArtifacts, project, projectArtifacts, reload, requestLog, scanIntervalSeconds, scanner, server, serverSupport, skip, stopKey, stopPort, supportedPackagings, systemProperties, systemPropertiesFile, useProvidedScope, webApp

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

ROLE

Constructor Summary

Constructors

Constructor	Description
JettyEffectiveWebXml()

Method Summary

Modifier and Type	Method	Description
void	execute()
void	startJetty()

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

checkPomConfiguration, configureScanner, configureWebApplication, fileSeparators, finishConfigurationBeforeStart, gatherScannables, getArtifactForOverlay, getJavaBin, restartWebApp, unpackOverlay, unpackOverlays

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

applyJettyXml, checkPackagingConfiguration, configureMonitor, configurePluginClasspath, findJettyWebXmlFile, getJettyXmlFiles, getSkipMessage, isConfigurationSupported, isExcluded, isPluginArtifact, isScanningEnabled, printSystemProperties, setSystemProperties, setSystemPropertiesFile, startConsoleScanner, startScanner, stopScanner

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

target

@Parameter(defaultValue="${project.build.directory}",
           readonly=true,
           required=true)
protected java.io.File target

The target directory

effectiveWebXml

@Parameter
protected java.io.File effectiveWebXml

The name of the file to generate into

deleteOnExit

protected boolean deleteOnExit

Constructor Detail

JettyEffectiveWebXml

public JettyEffectiveWebXml()

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 JettyRunMojo

Throws:

org.apache.maven.plugin.MojoExecutionException

org.apache.maven.plugin.MojoFailureException

See Also:

Mojo.execute()

startJetty

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

Overrides:

startJetty in class AbstractJettyMojo

Throws:

org.apache.maven.plugin.MojoExecutionException