org.codehaus.cargo.maven2
Class AbstractDeployerMojo

java.lang.Object
  extended by org.apache.maven.plugin.AbstractMojo
      extended by org.codehaus.cargo.maven2.AbstractCommonMojo
          extended by org.codehaus.cargo.maven2.AbstractCargoMojo
              extended by 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 1702 2008-09-02 12:37:46Z adriana $

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
AbstractDeployerMojo()
           
 
Method Summary
protected  Deployer createDeployer(Container container)
           
 void doExecute()
          Executes the plugin.
 DeployerFactory getDeployerFactory()
           
protected abstract  void performDeployerActionOnSingleDeployable(Deployer deployer, Deployable deployable, URL pingURL, Long pingTimeout)
           
 void setDeployerFactory(DeployerFactory factory)
           
 
Methods inherited from class org.codehaus.cargo.maven2.AbstractCargoMojo
containsAutoDeployable, createAutoDeployDeployable, createConfiguration, createContainer, createLogger, createNewContainer, execute, getCargoProject, getConfigurationElement, getContainerElement, getDeployerElement, getFileHandler, loadEmbeddedContainerDependencies, setCargoProject, setConfigurationElement, setContainerElement, 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()

setDeployerFactory

public void setDeployerFactory(DeployerFactory factory)

getDeployerFactory

public DeployerFactory getDeployerFactory()

createDeployer

protected Deployer createDeployer(Container container)
                           throws org.apache.maven.plugin.MojoExecutionException
Throws:
org.apache.maven.plugin.MojoExecutionException

performDeployerActionOnSingleDeployable

protected abstract void performDeployerActionOnSingleDeployable(Deployer deployer,
                                                                Deployable deployable,
                                                                URL pingURL,
                                                                Long pingTimeout)


Copyright © 2004-2012 Codehaus. All Rights Reserved.