jbi:generate-jbi-service-unit-descriptor

A Mojo used to build the jbi.xml file for a service unit.

Mojo Attributes:

  • Requires a Maven 2.0 project to execute.
  • Requires dependency resolution of artifacts in scope: runtime
  • Automatically executes within the lifecycle phase: process-classes

Required Parameters

Name Type Description
jbiServicesFile File Single directory for extra files to include in the JBI component.
workDirectory File Directory that resources are copied to during the build.

Optional Parameters

Name Type Description
artifactMetadataSource ArtifactMetadataSource No description.
description String The component description.
encoding String Character encoding for the auto-generated application.xml file.
factory ArtifactFactory No description.
generateJbiDescriptor Boolean Whether the jbi.xml should be generated or not.
generatedDescriptorLocation String Directory where the application.xml file will be auto-generated.
localRepo ArtifactRepository No description. Default value is ${localRepository}.
name String The component name.
projectBuilder MavenProjectBuilder No description.
projectHelper MavenProjectHelper Maven ProjectHelper
remoteRepos List No description. Default value is ${project.remoteArtifactRepositories}.
resolver ArtifactResolver No description.
serviceUnitArtifactsDir File Directory where artifacts for the service unit are held
useServiceUnitAnalyzer Boolean Determines whether to use the service unit analyzer

Parameter Details

artifactMetadataSource No Description.
  • Type: org.apache.maven.artifact.metadata.ArtifactMetadataSource
  • Required: No

description The component description.
  • Type: java.lang.String
  • Required: No
  • Expression: ${project.name}

encoding Character encoding for the auto-generated application.xml file.
  • Type: java.lang.String
  • Required: No

factory No Description.
  • Type: org.apache.maven.artifact.factory.ArtifactFactory
  • Required: No

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

generatedDescriptorLocation Directory where the application.xml file will be auto-generated.
  • Type: java.lang.String
  • Required: No
  • Expression: ${project.build.directory}/classes/META-INF

jbiServicesFile Single directory for extra files to include in the JBI component.
  • Type: java.io.File
  • Required: Yes
  • Expression: ${basedir}/src/main/resources/jbi-services.xml

localRepo No Description.
  • Type: org.apache.maven.artifact.repository.ArtifactRepository
  • Required: No
  • Default: ${localRepository}

name The component name.
  • Type: java.lang.String
  • Required: No
  • Expression: ${project.artifactId}

projectBuilder No Description.
  • Type: org.apache.maven.project.MavenProjectBuilder
  • Required: No

projectHelper Maven ProjectHelper
  • Type: org.apache.maven.project.MavenProjectHelper
  • Required: No

remoteRepos No Description.
  • Type: java.util.List
  • Required: No
  • Default: ${project.remoteArtifactRepositories}

resolver No Description.
  • Type: org.apache.maven.artifact.resolver.ArtifactResolver
  • Required: No

serviceUnitArtifactsDir Directory where artifacts for the service unit are held
  • Type: java.io.File
  • Required: No
  • Expression: ${basedir}/src/main/resources

useServiceUnitAnalyzer Determines whether to use the service unit analyzer
  • Type: java.lang.Boolean
  • Required: No

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