org.apache.maven.plugin.ear
Class JarModule

java.lang.Object
  org.apache.maven.plugin.ear.AbstractEarModule
      org.apache.maven.plugin.ear.JarModule

All Implemented Interfaces:

EarModule

Direct Known Subclasses:

EjbClientModule, JavaModule

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.

This class deprecates JavaModule.

Version:

$Id: JarModule.java 1228837 2012-01-08 13:19:38Z rfscholte $

Author:

Stephane Nicoll

Field Summary

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

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

Constructor Summary

JarModule()

JarModule(Artifact a, String defaultLibBundleDir, Boolean includeInApplicationXml)

Method Summary

void	appendModule(XMLWriter writer, String version, Boolean generateId) Appends the XML representation of this module.
boolean	changeManifestClasspath()
String	getType() Returns the type associated to the module.
void	resolveArtifact(Set<Artifact> artifacts) Resolves the Artifact represented by the module.

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

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

Methods inherited from class java.lang.Object

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

Constructor Detail

JarModule

public JarModule()

JarModule

public JarModule(Artifact a,
                 String defaultLibBundleDir,
                 Boolean includeInApplicationXml)

Method Detail

appendModule

public void appendModule(XMLWriter writer,
                         String version,
                         Boolean generateId)

Description copied from interface: EarModule

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<Artifact> artifacts)
                     throws EarPluginException,
                            MojoFailureException

Description copied from class: AbstractEarModule

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

MojoFailureException - if an unexpected error occurred

getType

public String getType()

Description copied from interface: EarModule

Returns the type associated to the module.

Returns:

the artifact's type of the module

changeManifestClasspath

public boolean changeManifestClasspath()

Specified by:

changeManifestClasspath in interface EarModule

Overrides:

changeManifestClasspath in class AbstractEarModule