org.apache.maven.plugin.ear
Interface EarModule

All Known Implementing Classes:

AbstractEarModule, Ejb3Module, EjbClientModule, EjbModule, JavaModule, ParModule, RarModule, SarModule, WebModule, WsrModule

public interface EarModule

The ear module interface.

Version:

$Id: EarModule.java 332974 2005-11-13 12:42:44Z snicoll $

Author:

Stephane Nicoll

Method Summary

void	appendModule(org.codehaus.plexus.util.xml.XMLWriter writer, java.lang.String version) Appends the XML representation of this module.
org.apache.maven.artifact.Artifact	getArtifact() Returns the Artifact representing this module.
java.lang.String	getUri() Returns the URI for this module.
boolean	isExcluded() Specify whether this module should be excluded or not.
void	resolveArtifact(java.util.Set artifacts, java.lang.String defaultJavaBundleDir) Resolves the Artifact represented by the module with the specified execution configuration.

Method Detail

getArtifact

org.apache.maven.artifact.Artifact getArtifact()

Returns the Artifact representing this module.

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

Returns:

the artifact

See Also:

resolveArtifact(java.util.Set, String)

getUri

java.lang.String getUri()

Returns the URI for this module.

Returns:

the URI

isExcluded

boolean isExcluded()

Specify whether this module should be excluded or not.

Returns:

true if this module should be skipped, false otherwise

appendModule

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

Appends the XML representation of this module.

Parameters:

writer - the writer to use

version - the version of the application.xml file

resolveArtifact

void resolveArtifact(java.util.Set artifacts,
                     java.lang.String defaultJavaBundleDir)
                     throws EarPluginException,
                            org.apache.maven.plugin.MojoFailureException

Resolves the Artifact represented by the module with the specified execution configuration.

Parameters:

artifacts - the project's artifacts

defaultJavaBundleDir - the default bundle dir for JavaModule

Throws:

EarPluginException - if the artifact could not be resolved

org.apache.maven.plugin.MojoFailureException