Field Detail

• factory

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

  Used to look up Artifacts in the remote repository.

• resolver

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

  Used to look up Artifacts in the remote repository.

• project

  @Component
  protected org.apache.maven.project.MavenProject project

  The maven project.

  Since:

  1.0

• useSeparateTomcatClassLoader

  @Parameter(property="tomcat.useSeparateTomcatClassLoader",
             defaultValue="false")
  protected boolean useSeparateTomcatClassLoader

  if true a new classLoader separated from maven core will be created to start tomcat.

  Since:

  1.0

• contextReloadable

  @Parameter(property="maven.tomcat.contextReloadable",
             defaultValue="false")
  protected boolean contextReloadable

  Force context scanning if you don't use a context file with reloadable = "true". The other way to use contextReloadable is to add attribute reloadable = "true" in your context file.

  Since:

  2.0

• backgroundProcessorDelay

  @Parameter(property="maven.tomcat.backgroundProcessorDelay",
             defaultValue="-1")
  protected int backgroundProcessorDelay

  represents the delay in seconds between each classPathScanning change invocation

  See Also:

  http://tomcat.apache.org/tomcat-7.0-doc/config/context.html

• contextFile

  @Parameter(property="maven.tomcat.contextFile")
  protected File contextFile

  The path of the Tomcat context XML file.

  Since release 2.0, the file is filtered as a maven resource so you can use interpolation tokens ${ }

• skip

  @Parameter(property="maven.tomcat.skip",
             defaultValue="false")
  protected boolean skip

  Skip execution

  Since:

  2.0

• classLoaderClass

  @Parameter
  protected String classLoaderClass

  Class loader class to set.

  Since:

  2.0

• session

  @Parameter(defaultValue="${session}",
             readonly=true,
             required=true)
  protected org.apache.maven.execution.MavenSession session

• propertiesPortFilePath

  @Parameter(property="maven.tomcat.propertiesPortFilePath")
  protected String propertiesPortFilePath

  Will dump port in a properties file (see ports for property names). If empty no file generated

• hostName

  @Parameter(property="maven.tomcat.hostName",
             defaultValue="localhost")
  protected String hostName

  configure host name

  Since:

  2.0

• aliases

  @Parameter
  protected String[] aliases

  configure aliases see Host Name aliases

  Since:

  2.0

• clientAuth

  @Parameter(property="maven.tomcat.https.clientAuth",
             defaultValue="false")
  protected String clientAuth

  enable client authentication for https (if configured) see http://tomcat.apache.org/tomcat-7.0-doc/config/http.html#SSL_Support_-_BIO_and_NIO

  Since:

  2.1

• mavenFileFilter

  @Component(role=org.apache.maven.shared.filtering.MavenFileFilter.class,
             hint="default")
  protected org.apache.maven.shared.filtering.MavenFileFilter mavenFileFilter

• jarScanAllDirectories

  @Parameter(property="maven.tomcat.jarScan.allDirectories",
             defaultValue="true")
  protected boolean jarScanAllDirectories

  In case a module in your reactors has some web-fragments they will be read. If you don't need that for performance reasons, you can deactivate it.

  Since:

  2.2

• useBodyEncodingForURI

  @Parameter(property="maven.tomcat.useBodyEncodingForURI",
             defaultValue="false")
  protected boolean useBodyEncodingForURI

  Since:

  2.2

• trustManagerClassName

  @Parameter
  protected String trustManagerClassName

  Since:

  2.2

• trustMaxCertLength

  @Parameter
  protected String trustMaxCertLength

  Since:

  2.2

• truststoreAlgorithm

  @Parameter
  protected String truststoreAlgorithm

  Since:

  2.2

• truststoreFile

  @Parameter
  protected String truststoreFile

  Since:

  2.2

• truststorePass

  @Parameter
  protected String truststorePass

  Since:

  2.2

• truststoreProvider

  @Parameter
  protected String truststoreProvider

  Since:

  2.2

• truststoreType

  @Parameter
  protected String truststoreType

  Since:

  2.2

Constructor Detail

• AbstractRunMojo

  public AbstractRunMojo()

Method Detail

• 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

• getPath

  protected String getPath()

  Gets the webapp context path to use for the web application being run.

  Overrides:

  getPath in class AbstractTomcat7Mojo

  Returns:

  the webapp context path

• createContext

  protected Context createContext(Tomcat container)
                           throws IOException,
                                  org.apache.maven.plugin.MojoExecutionException,
                                  javax.servlet.ServletException

  Gets the context to run this web application under for the specified embedded Tomcat.

  Parameters:

  container - the embedded Tomcat container being used

  Returns:

  the context to run this web application under

  Throws:

  IOException - if the context could not be created

  org.apache.maven.plugin.MojoExecutionException - in case of an error creating the context

  javax.servlet.ServletException

• parseContextFile

  protected StandardContext parseContextFile(File file)
                                      throws org.apache.maven.plugin.MojoExecutionException

  Throws:

  org.apache.maven.plugin.MojoExecutionException

• createWebappLoader

  protected WebappLoader createWebappLoader()
                                     throws IOException,
                                            org.apache.maven.plugin.MojoExecutionException

  Gets the webapp loader to run this web application under.

  Returns:

  the webapp loader to use

  Throws:

  IOException - if the webapp loader could not be created

  org.apache.maven.plugin.MojoExecutionException - in case of an error creating the webapp loader

• isContextReloadable

  protected boolean isContextReloadable()
                                 throws org.apache.maven.plugin.MojoExecutionException

  Determine whether the passed context.xml file declares the context as reloadable or not.

  Returns:

  false by default, true if reloadable="true" in context.xml.

  Throws:

  org.apache.maven.plugin.MojoExecutionException

• getDocBase

  protected abstract File getDocBase()
                              throws IOException

  Gets the webapp directory to run.

  Returns:

  the webapp directory

  Throws:

  IOException

• getContextFile

  protected abstract File getContextFile()
                                  throws org.apache.maven.plugin.MojoExecutionException

  Gets the Tomcat context XML file to use.

  Returns:

  the context XML file

  Throws:

  org.apache.maven.plugin.MojoExecutionException

• isWar

  protected boolean isWar()

  Gets whether this project uses WAR packaging.

  Returns:

  whether this project uses WAR packaging

• getTomcatClassLoader

  protected org.codehaus.plexus.classworlds.realm.ClassRealm getTomcatClassLoader()
                                                                           throws org.apache.maven.plugin.MojoExecutionException

  Throws:

  org.apache.maven.plugin.MojoExecutionException

• getProjectArtifacts

  public Set<org.apache.maven.artifact.Artifact> getProjectArtifacts()

• getArtifact

  protected org.apache.maven.artifact.Artifact getArtifact(AbstractWebapp additionalWebapp)
                                                    throws org.apache.maven.plugin.MojoExecutionException

  Resolves the Artifact from the remote repository if necessary. If no version is specified, it will be retrieved from the dependency list or from the DependencyManagement section of the pom.

  Parameters:

  additionalWebapp - containing information about artifact from plugin configuration.

  Returns:

  Artifact object representing the specified file.

  Throws:

  org.apache.maven.plugin.MojoExecutionException - with a message if the version can't be found in DependencyManagement.