ear:generate-application-xml

A Mojo that generates the EAR deployment descriptor file(s).

Mojo Attributes:

  • Requires a Maven 2.0 project to execute.
  • Requires dependency resolution of artifacts in scope: test
  • Automatically executes within the lifecycle phase: generate-resources

Required Parameters

Name Type Description
workDirectory File Directory that resources are copied to during the build.

Optional Parameters

Name Type Description
artifactTypeMappings PlexusConfiguration The artifact type mappings.
defaultLibBundleDir String The default bundle dir for libraries.
description String Description of the application to be used when application.xml file is autogenerated.
displayName String Display name of the application to be used when application.xml file is autogenerated.
encoding String Character encoding for the auto-generated deployment file(s).
fileNameMapping String The file name mapping to use for all dependencies included in the EAR file.
generateApplicationXml Boolean Whether the application.xml should be generated or not.
generatedDescriptorLocation String Directory where the deployment descriptor file(s) will be auto-generated.
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.
modules EarModule[] The ear modules configuration.
security PlexusConfiguration The security-roles to be added to the auto-generated application.xml file.
version String The version of the application.xml to generate. Valid values are 1.3, 1.4 and 5.

Parameter Details

artifactTypeMappings The artifact type mappings.
  • Type: org.codehaus.plexus.configuration.PlexusConfiguration
  • Required: No

defaultLibBundleDir The default bundle dir for libraries.
  • Type: java.lang.String
  • Required: No

description Description of the application to be used when application.xml file is autogenerated.
  • Type: java.lang.String
  • Required: No
  • Expression: ${project.description}

displayName Display name of the application to be used when application.xml file is autogenerated.
  • Type: java.lang.String
  • Required: No
  • Expression: ${project.artifactId}

encoding Character encoding for the auto-generated deployment file(s).
  • Type: java.lang.String
  • Required: No

fileNameMapping The file name mapping to use for all dependencies included in the EAR file.
  • Type: java.lang.String
  • Required: No

generateApplicationXml Whether the application.xml should be generated or not.
  • Type: java.lang.Boolean
  • Required: No

generatedDescriptorLocation Directory where the deployment descriptor file(s) will be auto-generated.
  • Type: java.lang.String
  • Required: No
  • Expression: ${project.build.directory}

jboss The JBoss specific configuration.
  • Type: org.codehaus.plexus.configuration.PlexusConfiguration
  • Required: No

mainArtifactId The id to use to define the main artifact (e.g. the artifact without a classifier) when there is multiple candidates.
  • Type: java.lang.String
  • Required: No

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

security The security-roles to be added to the auto-generated application.xml file.
  • Type: org.codehaus.plexus.configuration.PlexusConfiguration
  • Required: No

version The version of the application.xml to generate. Valid values are 1.3, 1.4 and 5.
  • Type: java.lang.String
  • Required: No

workDirectory Directory that resources are copied to during the build.
  • Type: java.io.File
  • Required: Yes
  • Expression: ${project.build.directory}/${project.build.finalName}