org.apache.maven.plugins.ear

Class JarModule

java.lang.Object

org.apache.maven.plugins.ear.AbstractEarModule

org.apache.maven.plugins.ear.JarModule

All Implemented Interfaces:

EarModule

Direct Known Subclasses:

EjbClientModule

public class JarModule
extends AbstractEarModule

The EarModule implementation for a non J2EE module such as third party libraries.

Such module is not incorporated in the generated application.xml but some application servers support it. To include it in the generated deployment descriptor anyway, set the includeInApplicationXml boolean flag.

Author:

Stephane Nicoll

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_ARTIFACT_TYPE Default type of the artifact of a non Java EE module such as third party library.

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

ALT_DD, altDeploymentDescriptor, bundleDir, bundleFileName, classPathItem, earExecutionContext, excluded, JAVA_MODULE, libDirectory, MODULE_ELEMENT, type, unpack

Constructor Summary

Constructors

Constructor and Description
JarModule() Create an instance.
JarModule(org.apache.maven.artifact.Artifact a, String defaultLibBundleDir, Boolean includeInApplicationXml)

Method Summary

Modifier and Type	Method and Description
void	appendModule(org.codehaus.plexus.util.xml.XMLWriter writer, String version, Boolean generateId) Appends the XML representation of this module.
boolean	changeManifestClasspath()
void	resolveArtifact(Set<org.apache.maven.artifact.Artifact> artifacts) Resolves the Artifact represented by the module.

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

getAltDeploymentDescriptor, getArtifact, getArtifactId, getBundleDir, getBundleFileName, getClassifier, getGroupId, getLibDir, getModuleId, getType, getUri, isClassPathItem, isExcluded, setEarExecutionContext, shouldUnpack, startModuleElement, toString, writeAltDeploymentDescriptor

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_ARTIFACT_TYPE

public static final String DEFAULT_ARTIFACT_TYPE

Default type of the artifact of a non Java EE module such as third party library.

See Also:

Constant Field Values

Constructor Detail

JarModule

public JarModule()

Create an instance.

JarModule

public JarModule(org.apache.maven.artifact.Artifact a,
                 String defaultLibBundleDir,
                 Boolean includeInApplicationXml)

Parameters:

a - Artifact

defaultLibBundleDir - The default library bundle directory.

includeInApplicationXml - Include the application xml or not.

Method Detail

appendModule

public void appendModule(org.codehaus.plexus.util.xml.XMLWriter writer,
                         String version,
                         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(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

changeManifestClasspath

public boolean changeManifestClasspath()

Specified by:

changeManifestClasspath in interface EarModule

Overrides:

changeManifestClasspath in class AbstractEarModule

Returns:

always true