org.apache.maven.plugin.ear

Class WebModule

java.lang.Object

org.apache.maven.plugin.ear.AbstractEarModule

org.apache.maven.plugin.ear.WebModule

All Implemented Interfaces:

EarModule

public class WebModule
extends AbstractEarModule

The EarModule implementation for a Web application module.

Version:

$Id: WebModule.java 1645331 2014-12-13 17:31:09Z khmarbaise $

Field Summary

Fields

Modifier and Type	Field and Description
private static java.lang.String	CONTEXT_ROOT_FIELD
private java.lang.String	contextRoot
private static java.lang.String	WEB_MODULE
private static java.lang.String	WEB_URI_FIELD

Fields inherited from class org.apache.maven.plugin.ear.AbstractEarModule

ALT_DD, altDeploymentDescriptor, bundleDir, bundleFileName, earExecutionContext, excluded, JAVA_MODULE, MODULE_ELEMENT, unpack

Constructor Summary

Constructors

Constructor and Description
WebModule() Create an instance.
WebModule(org.apache.maven.artifact.Artifact a)

Method Summary

Modifier and Type	Method and Description
void	appendModule(org.codehaus.plexus.util.xml.XMLWriter writer, java.lang.String version, java.lang.Boolean generateId) Appends the XML representation of this module.
java.lang.String	getContextRoot() Returns the context root to use for the web module.
private static java.lang.String	getDefaultContextRoot(org.apache.maven.artifact.Artifact a) Generates a default context root for the given artifact, based on the artifactId.
java.lang.String	getLibDir()
java.lang.String	getType() Returns the type associated to the module.
void	resolveArtifact(java.util.Set<org.apache.maven.artifact.Artifact> artifacts) Resolves the Artifact represented by the module.

Methods inherited from class org.apache.maven.plugin.ear.AbstractEarModule

areNullOrEqual, changeManifestClasspath, cleanBundleDir, getAltDeploymentDescriptor, getArtifact, getArtifactId, getBundleDir, getBundleFileName, getClassifier, getGroupId, getModuleId, getOriginalBundleFileName, getUri, isExcluded, setEarExecutionContext, setUri, shouldUnpack, startModuleElement, toString, writeAltDeploymentDescriptor

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

WEB_MODULE

private static final java.lang.String WEB_MODULE

See Also:

Constant Field Values

WEB_URI_FIELD

private static final java.lang.String WEB_URI_FIELD

See Also:

Constant Field Values

CONTEXT_ROOT_FIELD

private static final java.lang.String CONTEXT_ROOT_FIELD

See Also:

Constant Field Values

contextRoot

private java.lang.String contextRoot

Constructor Detail

WebModule

public WebModule()

Create an instance.

WebModule

public WebModule(org.apache.maven.artifact.Artifact a)

Parameters:

a - Artifact

Method Detail

appendModule

public void appendModule(org.codehaus.plexus.util.xml.XMLWriter writer,
                         java.lang.String version,
                         java.lang.Boolean generateId)

Appends the XML representation of this module.

Parameters:

writer - the writer to use

version - the version of the application.xml file

generateId - whether an id should be generated

resolveArtifact

public void resolveArtifact(java.util.Set<org.apache.maven.artifact.Artifact> artifacts)
                     throws EarPluginException,
                            org.apache.maven.plugin.MojoFailureException

Resolves the Artifact represented by the module. Note that the EarExecutionContext might be used to customize further the resolution.

Specified by:

resolveArtifact in interface EarModule

Overrides:

resolveArtifact in class AbstractEarModule

Parameters:

artifacts - the project's artifacts

Throws:

EarPluginException - if the artifact could not be resolved

org.apache.maven.plugin.MojoFailureException - if an unexpected error occurred

getContextRoot

public java.lang.String getContextRoot()

Returns the context root to use for the web module.

Note that this might return null till the artifact has been resolved.

Returns:

the context root

getType

public java.lang.String getType()

Returns the type associated to the module.

Returns:

the artifact's type of the module

getDefaultContextRoot

private static java.lang.String getDefaultContextRoot(org.apache.maven.artifact.Artifact a)

Generates a default context root for the given artifact, based on the artifactId.

Parameters:

a - the artifact

Returns:

a context root for the artifact

getLibDir

public java.lang.String getLibDir()

Specified by:

getLibDir in interface EarModule

Overrides:

getLibDir in class AbstractEarModule

Returns:

always null