jboss-packaging:aop

Full name:

org.codehaus.mojo:jboss-packaging-maven-plugin:2.2:aop

Description:

Builds a deployable JBoss AOP Archive.

Attributes:

  • Requires a Maven 2.0 project to be executed.
  • Requires dependency resolution of artifacts in scope: runtime.
  • The goal is thread-safe and supports parallel builds.
  • Since version: 2.2.
  • Binds by default to the lifecycle phase: package.

Optional Parameters

Name Type Since Description
archive MavenArchiveConfiguration 2.2 The maven archive configuration to use.
archiveName String 2.2 The name of the generated packaging archive.
Default value is: ${project.build.finalName}.
classifier String 2.2 Classifier to add to the generated artifact. If given, the artifact will not be the primary project artifact.
deploymentDescriptorDest File 2.2 The destination of the deployment descriptor file.
Default value is: ${project.build.directory}/${project.build.finalName}/META-INF.
deploymentDescriptorDestName String 2.2 The filename for the output deployment descriptor. By default the deployment descriptor will retain the same filename.
deploymentDescriptorFile File 2.2 The location of the JBoss AOP descriptor file (jboss-aop.xml). If it is present in src/main/resources/META-INF then it will automatically be included. Otherwise this parameter must be set.
Default value is: ${project.build.outputDirectory}/META-INF/jboss-aop.xml.
excludeAll boolean 2.2 All artifacts are excluded.
Default value is: false.
excludes Set 2.2 Dependency Artifacts excluded from packaging within the generated archive file. Use artifactId:groupId in nested exclude tags.
explodedOnly boolean 2.0 Whether to generate only the exploded archive format. By default both an exploded directory and a zipped file will be created. If set to "true" only the exploded directory will be created.
Default value is: false.
libDirectory File 2.2 The directory where to put the libs.
Default value is: ${project.build.directory}/${project.build.finalName}/lib.
manifest File 2.2 The manifest file for the archive.
outputDirectory File 2.2 The directory for the generated packaging.
Default value is: ${project.build.directory}.
packagingDirectory File 2.2 The directory where the JBoss packaging is built.
Default value is: ${project.build.directory}/${project.build.finalName}.
primaryArtifact boolean 2.2 Whether this is the main artifact of the current project.
Default value is: true.
removeDependencyVersions boolean 2.2 Whether to remove the version numbers from the filenames of the included dependencies. By default the included dependencies will have the format [artifactId]-[version]-[classifier].[type] If this parameter is set to true, the jar name will be in the format [artifactId]-[classifier].[type]
Default value is: false.

Parameter Details

archive:

The maven archive configuration to use.
  • Type: org.apache.maven.archiver.MavenArchiveConfiguration
  • Since: 2.2
  • Required: No

archiveName:

The name of the generated packaging archive.
  • Type: java.lang.String
  • Since: 2.2
  • Required: No
  • Default: ${project.build.finalName}

classifier:

Classifier to add to the generated artifact. If given, the artifact will not be the primary project artifact.
  • Type: java.lang.String
  • Since: 2.2
  • Required: No

deploymentDescriptorDest:

The destination of the deployment descriptor file.
  • Type: java.io.File
  • Since: 2.2
  • Required: No
  • Default: ${project.build.directory}/${project.build.finalName}/META-INF

deploymentDescriptorDestName:

The filename for the output deployment descriptor. By default the deployment descriptor will retain the same filename.
  • Type: java.lang.String
  • Since: 2.2
  • Required: No

deploymentDescriptorFile:

The location of the JBoss AOP descriptor file (jboss-aop.xml). If it is present in src/main/resources/META-INF then it will automatically be included. Otherwise this parameter must be set.
  • Type: java.io.File
  • Since: 2.2
  • Required: No
  • Expression: ${deploymentDescriptorFile}
  • Default: ${project.build.outputDirectory}/META-INF/jboss-aop.xml

excludeAll:

All artifacts are excluded.
  • Type: boolean
  • Since: 2.2
  • Required: No
  • Expression: ${excludeAll}
  • Default: false

excludes:

Dependency Artifacts excluded from packaging within the generated archive file. Use artifactId:groupId in nested exclude tags.
  • Type: java.util.Set
  • Since: 2.2
  • Required: No

explodedOnly:

Whether to generate only the exploded archive format. By default both an exploded directory and a zipped file will be created. If set to "true" only the exploded directory will be created.
  • Type: boolean
  • Since: 2.0
  • Required: No
  • Expression: ${explodedOnly}
  • Default: false

libDirectory:

The directory where to put the libs.
  • Type: java.io.File
  • Since: 2.2
  • Required: No
  • Default: ${project.build.directory}/${project.build.finalName}/lib

manifest:

The manifest file for the archive.
  • Type: java.io.File
  • Since: 2.2
  • Required: No

outputDirectory:

The directory for the generated packaging.
  • Type: java.io.File
  • Since: 2.2
  • Required: No
  • Default: ${project.build.directory}

packagingDirectory:

The directory where the JBoss packaging is built.
  • Type: java.io.File
  • Since: 2.2
  • Required: No
  • Default: ${project.build.directory}/${project.build.finalName}

primaryArtifact:

Whether this is the main artifact of the current project.
  • Type: boolean
  • Since: 2.2
  • Required: No
  • Default: true

removeDependencyVersions:

Whether to remove the version numbers from the filenames of the included dependencies. By default the included dependencies will have the format [artifactId]-[version]-[classifier].[type] If this parameter is set to true, the jar name will be in the format [artifactId]-[classifier].[type]
  • Type: boolean
  • Since: 2.2
  • Required: No
  • Default: false