Package org.apache.maven.plugin.ear
Interface EarModule
-
- All Known Implementing Classes:
AbstractEarModule
,AppClientModule
,Ejb3Module
,EjbClientModule
,EjbModule
,HarModule
,JarModule
,JavaModule
,ParModule
,RarModule
,SarModule
,WebModule
,WsrModule
public interface EarModule
The ear module interface.- Version:
- $Id: EarModule.java 1645331 2014-12-13 17:31:09Z khmarbaise $
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method 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.boolean
changeManifestClasspath()
java.lang.String
getAltDeploymentDescriptor()
The alt-dd element specifies an optional URI to the post-assembly version of the deployment descriptor file for a particular Java EE module.org.apache.maven.artifact.Artifact
getArtifact()
Returns theArtifact
representing this module.java.lang.String
getLibDir()
java.lang.String
getType()
Returns the type associated to the 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<org.apache.maven.artifact.Artifact> artifacts)
Resolves theArtifact
represented by the module.void
setEarExecutionContext(EarExecutionContext earExecutionContext)
java.lang.Boolean
shouldUnpack()
Specify whether this module should be unpacked in the EAR archive or not.
-
-
-
Method Detail
-
getArtifact
org.apache.maven.artifact.Artifact getArtifact()
Returns theArtifact
representing this module. Note that this might return null till the module has been resolved.- Returns:
- the artifact
- See Also:
resolveArtifact(java.util.Set)
-
getUri
java.lang.String getUri()
Returns the URI for this module.- Returns:
- the URI
-
getType
java.lang.String getType()
Returns the type associated to the module.- Returns:
- the artifact's type of the module
-
isExcluded
boolean isExcluded()
Specify whether this module should be excluded or not.- Returns:
- true if this module should be skipped, false otherwise
-
shouldUnpack
java.lang.Boolean shouldUnpack()
Specify whether this module should be unpacked in the EAR archive or not. Returns null if no configuration was specified so that defaulting may apply.- Returns:
- true if this module should be bundled unpacked, false otherwise
-
getAltDeploymentDescriptor
java.lang.String getAltDeploymentDescriptor()
The alt-dd element specifies an optional URI to the post-assembly version of the deployment descriptor file for a particular Java EE module. The URI must specify the full pathname of the deployment descriptor file relative to the application's root directory.- Returns:
- the alternative deployment descriptor for this module
- Since:
- JavaEE 5
-
appendModule
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 useversion
- the version of the application.xml filegenerateId
- whether an id should be generated
-
resolveArtifact
void resolveArtifact(java.util.Set<org.apache.maven.artifact.Artifact> artifacts) throws EarPluginException, org.apache.maven.plugin.MojoFailureException
Resolves theArtifact
represented by the module. Note that theEarExecutionContext
might be used to customize further the resolution.- Parameters:
artifacts
- the project's artifacts- Throws:
EarPluginException
- if the artifact could not be resolvedorg.apache.maven.plugin.MojoFailureException
- if an unexpected error occurred
-
setEarExecutionContext
void setEarExecutionContext(EarExecutionContext earExecutionContext)
- Parameters:
earExecutionContext
- The execution context.
-
changeManifestClasspath
boolean changeManifestClasspath()
- Returns:
- the state if manifest classpath will be changed or not.
-
getLibDir
java.lang.String getLibDir()
- Returns:
- The libDir.
-
-