org.codehaus.cargo.maven2

Class ContainerStartMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.codehaus.cargo.maven2.AbstractCommonMojo

org.codehaus.cargo.maven2.AbstractCargoMojo

org.codehaus.cargo.maven2.ContainerStartMojo

All Implemented Interfaces:

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

Direct Known Subclasses:

ContainerRestartMojo, ContainerRunMojo

public class ContainerStartMojo
extends AbstractCargoMojo

Start a container using Cargo.

Field Summary

Fields

Modifier and Type	Field and Description
protected org.codehaus.cargo.container.LocalContainer	localContainer Local container.

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

CONTEXT_KEY_CONTAINER

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

ROLE

Constructor Summary

Constructors

Constructor and Description
ContainerStartMojo()

Method Summary

Modifier and Type	Method and Description
protected void	addAutoDeployDeployable(org.codehaus.cargo.container.LocalContainer container) If the project's packaging is war, ear or ejb and there is no deployer specified and the user has not defined the auto-deployable inside the <deployables> element, then add the generated artifact to the list of deployables to deploy statically.
void	doExecute() Executes the plugin.
protected void	executeLocalContainerAction() Executes the local container action.

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

calculateContainerArtifactId, containsAutoDeployable, createAutoDeployDeployable, createConfiguration, createContainer, createDefaultContainerElementIfNecessary, createDefaultInstallerElementIfNecessary, createLogger, createNewContainer, execute, getCargoProject, getConfigurationElement, getContainerElement, getDaemon, getDeployablesElement, getDeployerElement, getFileHandler, setCargoProject, setConfigurationElement, setContainerElement, setDeployablesElement, setDeployerElement, setFileHandler, waitDeployableMonitor

Methods inherited from class org.codehaus.cargo.maven2.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

Field Detail

localContainer

protected org.codehaus.cargo.container.LocalContainer localContainer

Local container.

Constructor Detail

ContainerStartMojo

public ContainerStartMojo()

Method Detail

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

executeLocalContainerAction

protected void executeLocalContainerAction()

Executes the local container action.

addAutoDeployDeployable

protected void addAutoDeployDeployable(org.codehaus.cargo.container.LocalContainer container)
                                throws org.apache.maven.plugin.MojoExecutionException

If the project's packaging is war, ear or ejb and there is no deployer specified and the user has not defined the auto-deployable inside the <deployables> element, then add the generated artifact to the list of deployables to deploy statically. Note that the reason we check that a deployer element has not been specified is because if it has then the auto deployable will be deployed by the specified deployer.

Parameters:

container - the local container to which to add the project's artifact

Throws:

org.apache.maven.plugin.MojoExecutionException - if an error occurs