org.apache.maven.plugins.ear

Class AbstractEarMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.apache.maven.plugins.ear.AbstractEarMojo

All Implemented Interfaces:

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

Direct Known Subclasses:

EarMojo, GenerateApplicationXmlMojo

public abstract class AbstractEarMojo
extends org.apache.maven.plugin.AbstractMojo

A base class for EAR-processing related tasks.

Author:

Stephane Nicoll

Field Summary

Fields

Modifier and Type	Field and Description
static String	APPLICATION_XML_URI The application XML URI META-INF/application.xml
protected org.codehaus.plexus.configuration.PlexusConfiguration	artifactTypeMappings The artifact type mappings.
protected String	defaultLibBundleDir The default bundle dir for libraries.
protected String	encoding Character encoding for the auto-generated deployment file(s).
protected String	generatedDescriptorLocation Directory where the deployment descriptor file(s) will be auto-generated.
static String	META_INF The META-INF folder.
protected org.apache.maven.project.MavenProject	project The maven project.
static String	UTF_8 UTF-8 encoding constant.
protected String	version The version of the application.xml to generate.

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

ROLE

Constructor Summary

Constructors

Constructor and Description
AbstractEarMojo()

Method Summary

Modifier and Type	Method and Description
void	execute()
protected List<EarModule>	getAllEarModules()
protected org.apache.maven.plugins.ear.JbossConfiguration	getJbossConfiguration()
protected List<EarModule>	getModules()
String	getOutputFileNameMapping()
protected org.apache.maven.project.MavenProject	getProject()
protected List<EarModule>	getProvidedEarModules()
protected File	getWorkDirectory()

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

APPLICATION_XML_URI

public static final String APPLICATION_XML_URI

The application XML URI META-INF/application.xml

See Also:

Constant Field Values

META_INF

public static final String META_INF

The META-INF folder.

See Also:

Constant Field Values

UTF_8

public static final String UTF_8

UTF-8 encoding constant.

See Also:

Constant Field Values

version

@Parameter(defaultValue="7")
protected String version

The version of the application.xml to generate. Valid values are 1.3, 1.4, 5, 6, 7 and 8.

encoding

@Parameter(defaultValue="UTF-8")
protected String encoding

Character encoding for the auto-generated deployment file(s).

generatedDescriptorLocation

@Parameter(defaultValue="${project.build.directory}")
protected String generatedDescriptorLocation

Directory where the deployment descriptor file(s) will be auto-generated.

project

@Parameter(defaultValue="${project}",
           readonly=true,
           required=true)
protected org.apache.maven.project.MavenProject project

The maven project.

artifactTypeMappings

@Parameter
protected org.codehaus.plexus.configuration.PlexusConfiguration artifactTypeMappings

The artifact type mappings.

defaultLibBundleDir

@Parameter
protected String defaultLibBundleDir

The default bundle dir for libraries.

Constructor Detail

AbstractEarMojo

public AbstractEarMojo()

Method Detail

execute

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

Throws:

org.apache.maven.plugin.MojoExecutionException

org.apache.maven.plugin.MojoFailureException

getModules

protected List<EarModule> getModules()

Returns:

The list of earModules. This corresponds to modules needed at runtime.

getAllEarModules

protected List<EarModule> getAllEarModules()

Returns:

The list of allEarModules. This corresponds to all modules (provided + compile + runtime).

getProvidedEarModules

protected List<EarModule> getProvidedEarModules()

Returns:

the list of providedEarModules. This corresponds to provided modules.

getProject

protected org.apache.maven.project.MavenProject getProject()

Returns:

MavenProject

getWorkDirectory

protected File getWorkDirectory()

Returns:

workDirectory

getJbossConfiguration

protected org.apache.maven.plugins.ear.JbossConfiguration getJbossConfiguration()

Returns:

jbossConfiguration

getOutputFileNameMapping

public String getOutputFileNameMapping()

Returns:

outputFileNameMapping