org.apache.maven.plugins.ear

Class AcrModule

java.lang.Object

org.apache.maven.plugins.ear.AbstractEarModule

org.apache.maven.plugins.ear.AcrModule

All Implemented Interfaces:

EarModule

public class AcrModule
extends AbstractEarModule

The EarModule implementation for an Acr Module.

Since:

3.0.0

Author:

Karl Heinz Marbaise

Field Summary

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

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

Constructor Summary

Constructors

Constructor and Description
AcrModule() Create an instance.
AcrModule(Artifact a, String defaultLibBundleDir, Boolean includeInApplicationXml)

Method Summary

Modifier and Type	Method and Description
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.plugins.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

AcrModule

public AcrModule()

Create an instance.

AcrModule

public AcrModule(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(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<Artifact> artifacts)
                     throws EarPluginException,
                            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

MojoFailureException - if an unexpected error occurred

getType

public String getType()

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

Returns:

always true