org.xwiki.tool.extension.util

Class AbstractExtensionMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.xwiki.tool.extension.util.AbstractExtensionMojo

All Implemented Interfaces:

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

Direct Known Subclasses:

RegisterMojo, WarMojo, XIPMojo

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

Base class for Maven plugins manipulating extensions.

Since:

8.4RC1

Version:

$Id: 1a781a9014f9a1e552048864aeac4856ffcb6261 $

Field Summary

Fields

Modifier and Type	Field and Description
protected org.codehaus.plexus.PlexusContainer	container
protected List<ComponentRepresentation>	disabledComponents The list of components to unregister.
protected ExtensionMojoHelper	extensionHelper
protected List<ExtensionOverride>	extensionOverrides
protected org.apache.maven.artifact.repository.ArtifactRepository	localRepository The local Maven repository used to resolve required artifacts.
protected File	permanentDirectory The permanent directory.
protected org.apache.maven.project.MavenProject	project
protected String	recommendedVersions
protected org.apache.maven.execution.MavenSession	session The current Maven session being executed.
protected boolean	skip

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

ROLE

Constructor Summary

Constructors

Constructor and Description
AbstractExtensionMojo()

Method Summary

Modifier and Type	Method and Description
protected void	after()
protected void	before()
void	execute()
protected abstract void	executeInternal()
protected void	initializeExtensionMojoHelper()
protected boolean	isSkipExecution()

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

container

@Component
protected org.codehaus.plexus.PlexusContainer container

session

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

The current Maven session being executed.

localRepository

@Parameter(property="localRepository")
protected org.apache.maven.artifact.repository.ArtifactRepository localRepository

The local Maven repository used to resolve required artifacts.

extensionOverrides

@Parameter
protected List<ExtensionOverride> extensionOverrides

Since:

9.5RC1

skip

@Parameter
protected boolean skip

Since:

9.5RC1

project

@Parameter(defaultValue="${project}",
           required=true,
           readonly=true)
protected org.apache.maven.project.MavenProject project

permanentDirectory

@Parameter(defaultValue="${project.build.directory}/data/")
protected File permanentDirectory

The permanent directory.

Since:

9.5RC1

recommendedVersions

@Parameter(defaultValue="${xwiki.extension.recommendedVersions}")
protected String recommendedVersions

disabledComponents

@Unstable
 @Parameter
protected List<ComponentRepresentation> disabledComponents

The list of components to unregister.

Since:

12.2

extensionHelper

protected ExtensionMojoHelper extensionHelper

Constructor Detail

AbstractExtensionMojo

public AbstractExtensionMojo()

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

isSkipExecution

protected boolean isSkipExecution()

before

protected void before()
               throws org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoExecutionException

after

protected void after()
              throws org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoExecutionException

executeInternal

protected abstract void executeInternal()
                                 throws org.apache.maven.plugin.MojoExecutionException,
                                        org.apache.maven.plugin.MojoFailureException

Throws:

org.apache.maven.plugin.MojoExecutionException

org.apache.maven.plugin.MojoFailureException

initializeExtensionMojoHelper

protected void initializeExtensionMojoHelper()
                                      throws org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoExecutionException