org.codehaus.cargo.maven2

Class AbstractDeployerMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.codehaus.cargo.maven2.AbstractCommonMojo

org.codehaus.cargo.maven2.AbstractCargoMojo

org.codehaus.cargo.maven2.AbstractDeployerMojo

All Implemented Interfaces:

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

Direct Known Subclasses:

DeployerDeployMojo, DeployerRedeployMojo, DeployerStartMojo, DeployerStopMojo, DeployerUndeployMojo

public abstract class AbstractDeployerMojo
extends AbstractCargoMojo

Common mojo for all deployer actions (start deployable, stop deployable, deploy deployable, undeploy deployable, etc).

Version:

$Id: AbstractDeployerMojo.java 3337 2012-06-04 19:25:47Z alitokmen $

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	AbstractDeployerMojo.DeployerListener DeployableMonitorListener that logs.

Field Summary

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
AbstractDeployerMojo()

Method Summary

Methods

Modifier and Type	Method and Description
protected org.codehaus.cargo.container.deployer.DeployableMonitor	createDeployableMonitor(URL pingURL, Long pingTimeout, org.codehaus.cargo.container.deployable.Deployable deployable) Create a deployable monitor.
protected org.codehaus.cargo.container.deployer.Deployer	createDeployer(org.codehaus.cargo.container.Container container) Create a deployer.
protected org.codehaus.cargo.generic.deployer.DeployerFactory	createDeployerFactory()
void	doExecute() Executes the plugin.
protected abstract void	performDeployerActionOnSingleDeployable(org.codehaus.cargo.container.deployer.Deployer deployer, org.codehaus.cargo.container.deployable.Deployable deployable, URL pingURL, Long pingTimeout) Perform a deployer action on a single deployable.

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, loadEmbeddedContainerDependencies, setCargoProject, setConfigurationElement, setContainerElement, setDeployablesElement, setDeployerElement, setFileHandler

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

Constructor Detail

AbstractDeployerMojo

public AbstractDeployerMojo()

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

See Also:

AbstractCargoMojo.doExecute()

createDeployer

protected org.codehaus.cargo.container.deployer.Deployer createDeployer(org.codehaus.cargo.container.Container container)
                                                                 throws org.apache.maven.plugin.MojoExecutionException

Create a deployer.

Parameters:

container - Container.

Returns:

Deployer for container.

Throws:

org.apache.maven.plugin.MojoExecutionException - If deployer creation fails.

createDeployerFactory

protected org.codehaus.cargo.generic.deployer.DeployerFactory createDeployerFactory()

Returns:

Deployer factory.

performDeployerActionOnSingleDeployable

protected abstract void performDeployerActionOnSingleDeployable(org.codehaus.cargo.container.deployer.Deployer deployer,
                                           org.codehaus.cargo.container.deployable.Deployable deployable,
                                           URL pingURL,
                                           Long pingTimeout)

Perform a deployer action on a single deployable.

Parameters:

deployer - Deployer.

deployable - Deployable.

pingURL - Application ping URL.

pingTimeout - Timeout (milliseconds).

createDeployableMonitor

protected org.codehaus.cargo.container.deployer.DeployableMonitor createDeployableMonitor(URL pingURL,
                                                                              Long pingTimeout,
                                                                              org.codehaus.cargo.container.deployable.Deployable deployable)

Create a deployable monitor.

Parameters:

pingURL - Ping URL.

pingTimeout - Ping timeout (milliseconds).

deployable - Deployable to monitor.

Returns:

Deployable monitor with specified arguments.