SiteRunMojo (Apache Maven Site Plugin 3.9.0 API)

java.lang.Object
- org.apache.maven.plugin.AbstractMojo
- - org.apache.maven.plugins.site.AbstractSiteMojo
  - - org.apache.maven.plugins.site.descriptor.AbstractSiteDescriptorMojo
    - - org.apache.maven.plugins.site.render.AbstractSiteRenderingMojo
      - org.apache.maven.plugins.site.run.SiteRunMojo

All Implemented Interfaces:

ContextEnabled, Mojo, org.codehaus.plexus.personality.plexus.lifecycle.phase.Contextualizable
```
@Mojo(name="run",
      aggregator=true,
      requiresReports=true)
public class SiteRunMojo
extends AbstractSiteRenderingMojo
```
Starts the site up, rendering documents as requested for faster editing. It uses Jetty as the web server.

Author:

Brett Porter

- Field Summary
  - Fields inherited from class org.apache.maven.plugins.site.render.AbstractSiteRenderingMojo
    generatedSiteDirectory, mavenSession, reports, siteRenderer
  - Fields inherited from class org.apache.maven.plugins.site.descriptor.AbstractSiteDescriptorMojo
    repositories, siteDirectory
  - Fields inherited from class org.apache.maven.plugins.site.AbstractSiteMojo
    i18n, localRepository, project, reactorProjects, siteTool, skip
  - Fields inherited from interface org.apache.maven.plugin.Mojo
    ROLE
- Constructor Summary
  
  Constructors
  Constructor and Description
  
  SiteRunMojo()
- Method Summary
  
  Methods
  Modifier and Type Method and Description
  
  void execute()
  
  void setPort(int port)
  
  void setTempWebappDirectory(File tempWebappDirectory)
  - Methods inherited from class org.apache.maven.plugins.site.render.AbstractSiteRenderingMojo
    categoriseReports, checkInputEncoding, contextualize, createSiteRenderingContext, getInputEncoding, getOutputEncoding, getReports, locateDocuments, locateReports, populateReportItems
  - Methods inherited from class org.apache.maven.plugins.site.descriptor.AbstractSiteDescriptorMojo
    prepareDecorationModel
  - Methods inherited from class org.apache.maven.plugins.site.AbstractSiteMojo
    getLocales, getMavenVersion, isMaven3OrMore
  - 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

Constructors
Constructor and Description
`SiteRunMojo()`

Methods
Modifier and Type	Method and Description
`void`	`execute()`
`void`	`setPort(int port)`
`void`	`setTempWebappDirectory(File tempWebappDirectory)`

Constructor Detail
- SiteRunMojo
```
public SiteRunMojo()
```

Method Detail

execute

public void execute()
             throws MojoExecutionException,
                    MojoFailureException

Throws:: MojoExecutionException; MojoFailureException
See Also:: Mojo.execute()

setTempWebappDirectory

public void setTempWebappDirectory(File tempWebappDirectory)

setPort
```
public void setPort(int port)
```

Class SiteRunMojo

Field Summary

Fields inherited from class org.apache.maven.plugins.site.render.AbstractSiteRenderingMojo

Fields inherited from class org.apache.maven.plugins.site.descriptor.AbstractSiteDescriptorMojo

Fields inherited from class org.apache.maven.plugins.site.AbstractSiteMojo

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

Constructor Summary

Method Summary

Methods inherited from class org.apache.maven.plugins.site.render.AbstractSiteRenderingMojo

Methods inherited from class org.apache.maven.plugins.site.descriptor.AbstractSiteDescriptorMojo

Methods inherited from class org.apache.maven.plugins.site.AbstractSiteMojo

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

Methods inherited from class java.lang.Object

Constructor Detail

SiteRunMojo

Method Detail

execute

setTempWebappDirectory

setPort