Required Parameters

Name	Type	Since	Description
earSourceDirectory	File	-	Single directory for extra files to include in the EAR. Default value is: ${basedir}/src/main/application.
finalName	String	-	The name of the EAR file to generate. Default value is: ${project.build.finalName}.
outputDirectory	String	-	The directory for the generated EAR. Default value is: ${project.build.directory}.
workDirectory	File	-	Directory that resources are copied to during the build. Default value is: ${project.build.directory}/${project.build.finalName}.

Optional Parameters

Name	Type	Since	Description
applicationXml	String	-	The ___location of a custom application.xml file to be used within the ear file.
archive	MavenArchiveConfiguration	-	The archive configuration to use. See Maven Archiver Reference.
artifactTypeMappings	PlexusConfiguration	-	The artifact type mappings.
classifier	String	-	Classifier to add to the artifact generated. If given, the artifact will be an attachment instead.
defaultLibBundleDir	String	-	The default bundle dir for libraries.
earSourceExcludes	String	-	The comma separated list of tokens to exclude from the EAR.
earSourceIncludes	String	-	The comma separated list of tokens to include in the EAR. Default value is: **.
encoding	String	-	Character encoding for the auto-generated deployment file(s). Default value is: UTF-8.
escapeString	String	2.3.2	Expression preceded with the String won't be interpolated \${foo} will be replaced with ${foo}
escapedBackslashesInFilePath	boolean	2.3.2	To escape interpolated value with windows path c:\foo\bar will be replaced with c:\\foo\\bar Default value is: false.
fileNameMapping	String	-	The file name mapping to use for all dependencies included in the EAR file.
filtering	boolean	2.3.2	Specify that the ear sources should be filtered. Default value is: false.
filters	List	2.3.2	Filters (property files) to include during the interpolation of the pom.xml.
generatedDescriptorLocation	String	-	Directory where the deployment descriptor file(s) will be auto-generated. Default value is: ${project.build.directory}.
includeLibInApplicationXml	Boolean	-	Should libraries be added in application.xml Default value is: false.
jboss	PlexusConfiguration	-	The JBoss specific configuration.
mainArtifactId	String	-	The id to use to define the main artifact (e.g. the artifact without a classifier) when there is multiple candidates.
manifestFile	File	-	The ___location of the manifest file to be used within the ear file. If not value if specified, the default ___location in the workDirectory is taken. If the file does not exist, a manifest will be generated automatically.
modules	EarModule[]	-	The ear modules configuration.
nonFilteredFileExtensions	List	2.3.2	A list of file extensions that should not be filtered if filtering is enabled.
resourcesDir	File	-	Deprecated. please use earSourceDirectory instead
unpackTypes	String	-	The comma separated list of artifact's type(s) to unpack by default.
version	String	-	The version of the application.xml to generate. Valid values are 1.3, 1.4, 5 and 6. Default value is: 1.3.

Parameter Details

applicationXml:

• Type: java.lang.String
• Required: No

---

archive:

• Type: org.apache.maven.archiver.MavenArchiveConfiguration
• Required: No

---

artifactTypeMappings:

• Type: org.codehaus.plexus.configuration.PlexusConfiguration
• Required: No

---

classifier:

• Type: java.lang.String
• Required: No

---

defaultLibBundleDir:

• Type: java.lang.String
• Required: No

---

earSourceDirectory:

• Type: java.io.File
• Required: Yes
• Default: ${basedir}/src/main/application

---

earSourceExcludes:

• Type: java.lang.String
• Required: No

---

earSourceIncludes:

• Type: java.lang.String
• Required: No
• Default: **

---

encoding:

• Type: java.lang.String
• Required: No
• Default: UTF-8

---

escapeString:

• Type: java.lang.String
• Since: 2.3.2
• Required: No
• Expression: ${maven.ear.escapeString}

---

escapedBackslashesInFilePath:

• Type: boolean
• Since: 2.3.2
• Required: No
• Expression: ${maven.ear.escapedBackslashesInFilePath}
• Default: false

---

fileNameMapping:

• Type: java.lang.String
• Required: No

---

filtering:

• Type: boolean
• Since: 2.3.2
• Required: No
• Default: false

---

filters:

• Type: java.util.List
• Since: 2.3.2
• Required: No

---

finalName:

• Type: java.lang.String
• Required: Yes
• Default: ${project.build.finalName}

---

generatedDescriptorLocation:

• Type: java.lang.String
• Required: No
• Default: ${project.build.directory}

---

includeLibInApplicationXml:

• Type: java.lang.Boolean
• Required: No
• Default: false

---

jboss:

• Type: org.codehaus.plexus.configuration.PlexusConfiguration
• Required: No

---

mainArtifactId:

• Type: java.lang.String
• Required: No

---

manifestFile:

• Type: java.io.File
• Required: No

---

modules:

• Type: org.apache.maven.plugin.ear.EarModule[]
• Required: No

---

nonFilteredFileExtensions:

• Type: java.util.List
• Since: 2.3.2
• Required: No

---

outputDirectory:

• Type: java.lang.String
• Required: Yes
• Default: ${project.build.directory}

---

resourcesDir:

• Type: java.io.File
• Required: No

---

unpackTypes:

• Type: java.lang.String
• Required: No

---

version:

• Type: java.lang.String
• Required: No
• Default: 1.3

---

workDirectory:

• Type: java.io.File
• Required: Yes
• Default: ${project.build.directory}/${project.build.finalName}