Package org.apache.maven.plugins.site.descriptor

Class SiteDescriptorAttachMojo

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.descriptor.SiteDescriptorAttachMojo

All Implemented Interfaces:

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

@Mojo(name="attach-descriptor",
      defaultPhase=PACKAGE,
      threadSafe=true)
public class SiteDescriptorAttachMojo
extends AbstractSiteDescriptorMojo

Adds the site descriptor (site.xml) to the list of files to be installed/deployed.
For Maven-2.x this is enabled by default only when the project has pom packaging since it will be used by modules inheriting, but this can be enabled for other projects packaging if needed.
This default execution has been removed from the built-in lifecycle of Maven 3.x for pom-projects. Users that actually use those projects to provide a common site descriptor for sub modules will need to explicitly define this goal execution to restore the intended behavior.

Since:

2.0

Version:

$Id: SiteDescriptorAttachMojo.java 1743884 2016-05-15 07:08:58Z hboutemy $

Field Summary

Fields

Modifier and Type	Field	Description
private File	basedir
private boolean	pomPackagingOnly	Attach site descriptor only if packaging is pom.
private org.apache.maven.project.MavenProjectHelper	projectHelper	Maven ProjectHelper.

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	Description
SiteDescriptorAttachMojo()

Method Summary

Modifier and Type	Method	Description
void	execute()
private static String	getClassifier(File descriptorFile)

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

Field Details

basedir

@Parameter(property="basedir",
           required=true,
           readonly=true)
private File basedir

projectHelper

@Component
private org.apache.maven.project.MavenProjectHelper projectHelper

Maven ProjectHelper.

Since:

2.1.1

pomPackagingOnly

@Parameter(defaultValue="true")
private boolean pomPackagingOnly

Attach site descriptor only if packaging is pom.

Since:

3.0

Constructor Details

SiteDescriptorAttachMojo

public SiteDescriptorAttachMojo()

Method Details

execute

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

Throws:

org.apache.maven.plugin.MojoExecutionException

getClassifier

private static String getClassifier(File descriptorFile)
                             throws org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoExecutionException