org.codehaus.cargo.maven2

Class AbstractDaemonMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.codehaus.cargo.maven2.AbstractCommonMojo

org.codehaus.cargo.maven2.AbstractCargoMojo

org.codehaus.cargo.maven2.AbstractDaemonMojo

All Implemented Interfaces:

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

Direct Known Subclasses:

DaemonStartMojo, DaemonStopMojo

public abstract class AbstractDaemonMojo
extends AbstractCargoMojo

Common mojo for all daemon actions (start deployable, stop deployable).

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	daemonAutostartContainer Tells if the container should autostart.
protected List<String>	daemonClasspaths The additional classpath entries the daemon should use.
protected DaemonClient	daemonClient The daemon client instance.
protected InstalledLocalContainer	daemonContainer The container that should be started by the daemon.
protected List<Deployable>	daemonDeployables The deployables to deploy.
protected String	daemonHandleId The daemon handle identifier to use.

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

CONTEXT_KEY_CLASSLOADER, CONTEXT_KEY_CONTAINER

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

ROLE

Constructor Summary

Constructors

Constructor and Description
AbstractDaemonMojo()

Method Summary

Modifier and Type	Method and Description
void	doExecute() Executes the plugin.
protected abstract void	performAction() Performs the actual action.

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

calculateContainerArtifactId, createAutoDeployDeployable, createConfiguration, createContainer, createDefaultContainerElementIfNecessary, createDefaultInstallerElementIfNecessary, createLogger, createNewContainer, execute, getCargoProject, getConfigurationElement, getContainerElement, getDaemon, getDeployablesElement, getDeployerElement, getFileHandler, isIgnoreFailures, setCargoProject, setConfigurationElement, setContainerElement, setDeployablesElement, setDeployerElement, setFileHandler, setIgnoreFailures, 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

daemonClient

protected DaemonClient daemonClient

The daemon client instance.

daemonHandleId

protected String daemonHandleId

The daemon handle identifier to use.

daemonAutostartContainer

protected boolean daemonAutostartContainer

Tells if the container should autostart.

daemonClasspaths

protected List<String> daemonClasspaths

The additional classpath entries the daemon should use.

daemonDeployables

protected final List<Deployable> daemonDeployables

The deployables to deploy.

daemonContainer

protected InstalledLocalContainer daemonContainer

The container that should be started by the daemon.

Constructor Detail

AbstractDaemonMojo

public AbstractDaemonMojo()

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

performAction

protected abstract void performAction()
                               throws org.apache.maven.plugin.MojoExecutionException

Performs the actual action.

Throws:

org.apache.maven.plugin.MojoExecutionException - If an error happens