Package org.codehaus.cargo.maven3

Class PackageMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.codehaus.cargo.maven3.AbstractCommonMojo

org.codehaus.cargo.maven3.AbstractCargoMojo

org.codehaus.cargo.maven3.PackageMojo

All Implemented Interfaces:

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

@Mojo(name="package",
      requiresDependencyResolution=TEST,
      threadSafe=true)
public class PackageMojo
extends AbstractCargoMojo

Package a container distribution, a Configuration and deployed deployables. See Packager.

Field Summary

Fields inherited from class org.codehaus.cargo.maven3.AbstractCargoMojo

CONTEXT_KEY_CLASSLOADER, CONTEXT_KEY_CONTAINER

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

ROLE

Constructor Summary

Constructors

Constructor	Description
PackageMojo()

Method Summary

Modifier and Type	Method	Description
protected Packager	createPackager(Container container)	Create the packager.
void	doExecute()	Executes the plugin.
protected Packager	getPackagerElement()
protected void	setPackagerElement(Packager packagerElement)

Methods inherited from class org.codehaus.cargo.maven3.AbstractCargoMojo

calculateArtifact, calculateContainerArtifactId, createAutoDeployDeployable, createConfiguration, createContainer, createDefaultContainerElementIfNecessary, createDefaultInstallerElementIfNecessary, createLogger, createNewContainer, execute, getCargoProject, getConfigurationElement, getContainerElement, getDaemon, getDeployablesElement, getDeployerElement, isIgnoreFailures, setCargoProject, setConfigurationElement, setContainerElement, setDeployablesElement, setDeployerElement, setIgnoreFailures, waitDeployableMonitor

Methods inherited from class org.codehaus.cargo.maven3.AbstractCommonMojo

getProject

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

Constructor Detail

PackageMojo

public PackageMojo()

Method Detail

getPackagerElement

protected Packager getPackagerElement()

Returns:

the user configuration of a Cargo Packager. See the Cargo Maven 3 plugin reference guide and Packager for more details.

setPackagerElement

protected void setPackagerElement(Packager packagerElement)

Parameters:

packagerElement - the Packager configuration defined by the user

See Also:

getPackagerElement()

doExecute

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

Executes the plugin.

This method must be implemented by all Mojos extending this class. The reason for this pattern is because we want the AbstractCargoMojo.execute() method to always be called so that necessary plugin initialization can be performed. Without this pattern Mojos extending this class could "forget" to call super.execute() thus leading to unpredictible results.

Specified by:

doExecute in class AbstractCargoMojo

Throws:

org.apache.maven.plugin.MojoExecutionException - in case of error

createPackager

protected Packager createPackager(Container container)
                           throws org.apache.maven.plugin.MojoExecutionException

Create the packager.

Parameters:

container - Container to use.

Returns:

Packager for the container and the Maven 3 packager element.

Throws:

org.apache.maven.plugin.MojoExecutionException - If anything goes wrong.