org.codehaus.cargo.maven2

Class AbstractCargoMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.codehaus.cargo.maven2.AbstractCommonMojo

org.codehaus.cargo.maven2.AbstractCargoMojo

All Implemented Interfaces:

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

Direct Known Subclasses:

AbstractDaemonMojo, AbstractDeployerMojo, ConfigureMojo, ContainerInstallMojo, ContainerStartMojo, ContainerStopMojo, PackageMojo

public abstract class AbstractCargoMojo
extends AbstractCommonMojo

Common code used by Cargo MOJOs requiring <container> and <configuration> elements and supporting the notion of Auto-deployable.

Field Summary

Fields

Modifier and Type	Field and Description
static String	CONTEXT_KEY_CONTAINER The key under which the container instance is stored in the plugin context.

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

ROLE

Constructor Summary

Constructors

Constructor and Description
AbstractCargoMojo()

Method Summary

Modifier and Type	Method and Description
static String	calculateContainerArtifactId(String containerId) Calculates the container artifact ID for a given container ID.
protected boolean	containsAutoDeployable(Deployable[] deployableElements) Checks if the autodeployable is part of deployables.
protected org.codehaus.cargo.container.deployable.Deployable	createAutoDeployDeployable(org.codehaus.cargo.container.Container container) Create the autodeploy deployable (if the current project is a Java EE deployable)
protected org.codehaus.cargo.container.configuration.Configuration	createConfiguration() Creates a Configuration instance.
protected org.codehaus.cargo.container.Container	createContainer()
protected void	createDefaultContainerElementIfNecessary() Creates a container element if required.
protected void	createDefaultInstallerElementIfNecessary() Creates a installer element if required.
protected org.codehaus.cargo.util.log.Logger	createLogger() Create a logger.
protected org.codehaus.cargo.container.Container	createNewContainer() Creates a brand new Container instance.
protected abstract void	doExecute() Executes the plugin.
void	execute()
protected CargoProject	getCargoProject()
protected Configuration	getConfigurationElement()
protected Container	getContainerElement()
protected Daemon	getDaemon()
protected Deployable[]	getDeployablesElement()
protected Deployer	getDeployerElement()
protected org.codehaus.cargo.util.FileHandler	getFileHandler()
protected void	setCargoProject(CargoProject cargoProject)
protected void	setConfigurationElement(Configuration configurationElement)
protected void	setContainerElement(Container containerElement)
protected void	setDeployablesElement(Deployable[] deployablesElement)
protected void	setDeployerElement(Deployer deployerElement)
protected void	setFileHandler(org.codehaus.cargo.util.FileHandler fileHandler)
protected void	waitDeployableMonitor(org.codehaus.cargo.container.Container container, boolean starting) Waits until all deployables with a deployable monitor are deployed / undeployed.

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

CONTEXT_KEY_CONTAINER

public static final String CONTEXT_KEY_CONTAINER

The key under which the container instance is stored in the plugin context. We store it so that it's possible to get back the same container instance even if this mojo is called in a different Maven execution context. This is required for stopping embedded containers for example as we need to use the same instance that was started in order to stop them.

Constructor Detail

AbstractCargoMojo

public AbstractCargoMojo()

Method Detail

calculateContainerArtifactId

public static String calculateContainerArtifactId(String containerId)

Calculates the container artifact ID for a given container ID. Note that all containers identifier are in the form containerArtifactId + the version number + x; for example jboss42x is from container artifact ID cargo-core-container-jboss.

Parameters:

containerId - Container ID, for example jboss42x.

Returns:

Container artifact ID, for example cargo-core-container-jboss.

getFileHandler

protected org.codehaus.cargo.util.FileHandler getFileHandler()

Returns:

the Cargo file utility class

setFileHandler

protected void setFileHandler(org.codehaus.cargo.util.FileHandler fileHandler)

Parameters:

fileHandler - the Cargo file utility class to use. This method is useful for unit testing with Mock objects as it can be passed a test file handler that doesn't perform any real file action.

getDeployerElement

protected Deployer getDeployerElement()

Returns:

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

setDeployerElement

protected void setDeployerElement(Deployer deployerElement)

Parameters:

deployerElement - the Deployer configuration defined by the user

See Also:

getDeployerElement()

getDaemon

protected Daemon getDaemon()

Returns:

The daemon configuration

getDeployablesElement

protected Deployable[] getDeployablesElement()

Returns:

the user configuration of the list of Deployable. See the Cargo Maven 2 / Maven 3 plugin reference guide for more details.

setDeployablesElement

protected void setDeployablesElement(Deployable[] deployablesElement)

Parameters:

deployablesElement - the list of Deployable. See the Cargo Maven 2 / Maven 3 plugin reference guide for more details.

See Also:

getDeployablesElement()

getConfigurationElement

protected Configuration getConfigurationElement()

Returns:

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

setConfigurationElement

protected void setConfigurationElement(Configuration configurationElement)

Parameters:

configurationElement - the Configuration configuration defined by the user

See Also:

getConfigurationElement()

getContainerElement

protected Container getContainerElement()

Returns:

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

setContainerElement

protected void setContainerElement(Container containerElement)

Parameters:

containerElement - the Container configuration defined by the user

See Also:

getContainerElement()

setCargoProject

protected void setCargoProject(CargoProject cargoProject)

Parameters:

cargoProject - Cargo project

getCargoProject

protected CargoProject getCargoProject()

Returns:

Cargo project

execute

public final void execute()
                   throws org.apache.maven.plugin.MojoExecutionException

Note: This method is final so that extending classes cannot extend it. Instead they should implement the doExecute() method.

Throws:

org.apache.maven.plugin.MojoExecutionException

doExecute

protected abstract 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 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.

Throws:

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

createConfiguration

protected org.codehaus.cargo.container.configuration.Configuration createConfiguration()
                                                                                throws org.apache.maven.plugin.MojoExecutionException

Creates a Configuration instance. If the user has not specified a configuration element in the POM file then automatically create a standalone configuration if the container's type is local or otherwise create a runtime configuration.

Returns:

a valid Configuration instance

Throws:

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

createContainer

protected org.codehaus.cargo.container.Container createContainer()
                                                          throws org.apache.maven.plugin.MojoExecutionException

Returns:

a Container instance if no container object was stored in the Maven Plugin Context or returns the saved instance otherwise. If a new container instance is created it's also saved in the Maven Plugin Context for later retrieval.

Throws:

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

createNewContainer

protected org.codehaus.cargo.container.Container createNewContainer()
                                                             throws org.apache.maven.plugin.MojoExecutionException

Creates a brand new Container instance. If the user has not specified a container element in the POM file or if the user has not specified the container id then automatically create a default container (as defined in createDefaultContainerElementIfNecessary()) if the project calling this plugin has a WAR packaging. If the packaging is different then an exception is raised.

Returns:

a valid Container instance

Throws:

org.apache.maven.plugin.MojoExecutionException - in case of error or if a default container could not be created

createDefaultContainerElementIfNecessary

protected void createDefaultContainerElementIfNecessary()
                                                 throws org.apache.maven.plugin.MojoExecutionException

Creates a container element if required.

Throws:

org.apache.maven.plugin.MojoExecutionException - in case of error or if a default container could not be created

createDefaultInstallerElementIfNecessary

protected void createDefaultInstallerElementIfNecessary()
                                                 throws IOException

Creates a installer element if required.

Throws:

IOException - If the properties file cannot be loaded.

createAutoDeployDeployable

protected org.codehaus.cargo.container.deployable.Deployable createAutoDeployDeployable(org.codehaus.cargo.container.Container container)
                                                                                 throws org.apache.maven.plugin.MojoExecutionException

Create the autodeploy deployable (if the current project is a Java EE deployable)

Parameters:

container - Container.

Returns:

The autodeploy deployable.

Throws:

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

containsAutoDeployable

protected boolean containsAutoDeployable(Deployable[] deployableElements)

Checks if the autodeployable is part of deployables.

Parameters:

deployableElements - Deployable elements.

Returns:

true if autodeployable is in deployableElements, false otherwise.

createLogger

protected org.codehaus.cargo.util.log.Logger createLogger()

Create a logger. If a <log> configuration element has been specified by the user then use it. If none is specified then log to the Maven 2 logging subsystem.

Returns:

the logger to use for logging this plugin's activity

waitDeployableMonitor

protected void waitDeployableMonitor(org.codehaus.cargo.container.Container container,
                                     boolean starting)

Waits until all deployables with a deployable monitor are deployed / undeployed.

Parameters:

container - Container where is deployable deployed.

starting - true if container is starting (i.e., wait for deployment), false otherwise.