org.eclipse.jetty.maven.plugin

Class AbstractJettyMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.eclipse.jetty.maven.plugin.AbstractJettyMojo

All Implemented Interfaces:

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

Direct Known Subclasses:

JettyRunMojo, JettyRunWarExplodedMojo, JettyRunWarMojo

public abstract class AbstractJettyMojo
extends org.apache.maven.plugin.AbstractMojo

AbstractJettyMojo Common base class for most jetty mojos.

Field Summary

Fields

Modifier and Type	Field and Description
protected Thread	consoleScanner A scanner to check ENTER hits on the console
protected ContextHandler[]	contextHandlers List of other contexts to set up.
protected String	contextXml Location of a context xml configuration file whose contents will be applied to the webapp AFTER anything in <webApp>.Optional.
protected boolean	dumpOnStart Use the dump() facility of jetty to print out the server configuration to logging
protected String[]	excludedGoals List of goals that are NOT to be used
protected org.apache.maven.plugin.MojoExecution	execution
protected MavenServerConnector	httpConnector A ServerConnector to use.
protected String	jettyXml Comma separated list of a jetty xml configuration files whose contents will be applied before any plugin configuration.
protected LoginService[]	loginServices List of security realms to set up.
protected boolean	nonblocking Determines whether or not the server blocks when started.
protected List	pluginArtifacts The artifacts for the plugin itself.
String	PORT_SYSPROPERTY
protected org.apache.maven.project.MavenProject	project The maven project.
protected Set	projectArtifacts The artifacts for the project.
protected String	reload reload can be set to either 'automatic' or 'manual' if 'manual' then the context can be reloaded by a linefeed in the console if 'automatic' then traditional reloading on changed files is enabled.
protected RequestLog	requestLog A RequestLog implementation to use for the webapp at runtime.
protected int	scanIntervalSeconds The interval in seconds to scan the webapp for changes and restart the context if necessary.
protected ArrayList<File>	scanList List of files and directories to scan
protected Scanner	scanner A scanner to check for changes to the webapp
protected ArrayList<Scanner.BulkListener>	scannerListeners List of Listeners for the scanner
protected JettyServer	server A wrapper for the Server object
protected boolean	skip Skip this mojo execution.
protected String	stopKey Key to provide when stopping jetty on executing java -DSTOP.KEY=<stopKey> -DSTOP.PORT=<stopPort> -jar start.jar --stop
protected int	stopPort Port to listen to stop jetty on executing -DSTOP.PORT=<stopPort> -DSTOP.KEY=<stopKey> -jar start.jar --stop
protected SystemProperties	systemProperties System properties to set before execution.
protected File	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.
protected boolean	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.
protected JettyWebAppContext	webApp An instance of org.eclipse.jetty.webapp.WebAppContext that represents the webapp.

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

ROLE

Constructor Summary

Constructors

Constructor and Description
AbstractJettyMojo()

Method Summary

Methods

Modifier and Type	Method and Description
void	applyJettyXml()
abstract void	checkPomConfiguration()
void	configureMonitor()
void	configurePluginClasspath()
abstract void	configureScanner()
void	configureWebApplication() Subclasses should invoke this to setup basic info on the webapp
void	execute()
File	findJettyWebXmlFile(File webInfDir) Try and find a jetty-web.xml file, using some historical naming conventions if necessary.
void	finishConfigurationBeforeStart()
List<File>	getJettyXmlFiles()
boolean	isExcluded(String goal)
boolean	isPluginArtifact(org.apache.maven.artifact.Artifact artifact)
protected void	printSystemProperties()
abstract void	restartWebApp(boolean reconfigureScanner)
void	setSystemProperties(SystemProperties systemProperties)
void	setSystemPropertiesFile(File file)
protected void	startConsoleScanner() Run a thread that monitors the console input to detect ENTER hits.
void	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

PORT_SYSPROPERTY

public String PORT_SYSPROPERTY

useProvidedScope

protected boolean 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.

Since:

jetty-7.5.2

excludedGoals

protected String[] excludedGoals

List of goals that are NOT to be used

Since:

jetty-7.5.2

contextHandlers

protected ContextHandler[] contextHandlers

List of other contexts to set up. Consider using instead the <jettyXml> element to specify external jetty xml config file. Optional.

loginServices

protected LoginService[] loginServices

List of security realms to set up. Consider using instead the <jettyXml> element to specify external jetty xml config file. Optional.

requestLog

protected 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.

webApp

protected JettyWebAppContext 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.

scanIntervalSeconds

protected int scanIntervalSeconds

The interval in seconds to scan the webapp for changes and restart the context if necessary. Ignored if reload is enabled. Disabled by default.

reload

protected String reload

reload can be set to either 'automatic' or 'manual' if 'manual' then the context can be reloaded by a linefeed in the console if 'automatic' then traditional reloading on changed files is enabled.

systemPropertiesFile

protected File 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.

systemProperties

protected SystemProperties 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.

jettyXml

protected String jettyXml

Comma separated list of a jetty xml configuration files whose contents will be applied before any plugin configuration. Optional.

stopPort

protected int stopPort

Port to listen to stop jetty on executing -DSTOP.PORT=<stopPort> -DSTOP.KEY=<stopKey> -jar start.jar --stop

stopKey

protected String stopKey

Key to provide when stopping jetty on executing java -DSTOP.KEY=<stopKey> -DSTOP.PORT=<stopPort> -jar start.jar --stop

dumpOnStart

protected boolean dumpOnStart

Use the dump() facility of jetty to print out the server configuration to logging

skip

protected boolean skip

Skip this mojo execution.

contextXml

protected String contextXml

Location of a context xml configuration file whose contents will be applied to the webapp AFTER anything in <webApp>.Optional.

project

protected org.apache.maven.project.MavenProject project

The maven project.

projectArtifacts

protected Set projectArtifacts

The artifacts for the project.

execution

protected org.apache.maven.plugin.MojoExecution execution

pluginArtifacts

protected List pluginArtifacts

The artifacts for the plugin itself.

httpConnector

protected MavenServerConnector httpConnector

A ServerConnector to use.

server

protected JettyServer server

A wrapper for the Server object

scanner

protected Scanner scanner

A scanner to check for changes to the webapp

scanList

protected ArrayList<File> scanList

List of files and directories to scan

scannerListeners

protected ArrayList<Scanner.BulkListener> scannerListeners

List of Listeners for the scanner

consoleScanner

protected Thread consoleScanner

A scanner to check ENTER hits on the console

nonblocking

protected boolean nonblocking

Determines whether or not the server blocks when started. The default behavior (false) will cause the server to pause other processes while it continues to handle web requests. This is useful when starting the server with the intent to work with it interactively. This is the behaviour of the jetty:run, jetty:run-war, jetty:run-war-exploded goals.

If true, the server will not block the execution of subsequent code. This is the behaviour of the jetty:start and default behaviour of the jetty:deploy goals.

Constructor Detail

AbstractJettyMojo

public AbstractJettyMojo()

Method Detail

restartWebApp

public abstract void restartWebApp(boolean reconfigureScanner)
                            throws Exception

Throws:

Exception

checkPomConfiguration

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

Throws:

org.apache.maven.plugin.MojoExecutionException

configureScanner

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

Throws:

org.apache.maven.plugin.MojoExecutionException

execute

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

Throws:

org.apache.maven.plugin.MojoExecutionException

org.apache.maven.plugin.MojoFailureException

See Also:

Mojo.execute()

configurePluginClasspath

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

Throws:

org.apache.maven.plugin.MojoExecutionException

isPluginArtifact

public boolean isPluginArtifact(org.apache.maven.artifact.Artifact artifact)

Parameters:

artifact -

Returns:

finishConfigurationBeforeStart

public void finishConfigurationBeforeStart()
                                    throws Exception

Throws:

Exception

applyJettyXml

public void applyJettyXml()
                   throws Exception

Throws:

Exception

startJetty

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

Throws:

org.apache.maven.plugin.MojoExecutionException

configureMonitor

public void configureMonitor()

configureWebApplication

public void configureWebApplication()
                             throws Exception

Subclasses should invoke this to setup basic info on the webapp

Throws:

org.apache.maven.plugin.MojoExecutionException

Exception

startConsoleScanner

protected void startConsoleScanner()
                            throws Exception

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

Throws:

Exception

printSystemProperties

protected void printSystemProperties()

findJettyWebXmlFile

public File findJettyWebXmlFile(File webInfDir)

Try and find a jetty-web.xml file, using some historical naming conventions if necessary.

Parameters:

webInfDir -

Returns:

the jetty web xml file

setSystemPropertiesFile

public void setSystemPropertiesFile(File file)
                             throws Exception

Parameters:

file -

Throws:

Exception

setSystemProperties

public void setSystemProperties(SystemProperties systemProperties)

Parameters:

systemProperties -

getJettyXmlFiles

public List<File> getJettyXmlFiles()

Returns:

isExcluded

public boolean isExcluded(String goal)

Parameters:

goal -

Returns: