FC TIBCO Factory/BWMaven plugin

bw:include-dependencies-in-bw-ear

Full name:

fr.fastconnect.factory.tibco.bw.maven:bw-maven-plugin:2.4.2-SNAPSHOT:include-dependencies-in-bw-ear

Description:

This goal includes the JAR dependencies of the runtime scope inside the "lib.zip" of the TIBCO BusinessWorks EAR.
It allows to load seamlessly the transitive dependencies of JARs of the TIBCO BusinessWorks project and avoid the ClassNotFoundException issues when the application is deployed on a TIBCO domain.

This step can be ignored by setting includeTransitiveJARsInEAR to false.

Attributes:

  • Requires a Maven project to be executed.
  • Binds by default to the lifecycle phase: compile.

Required Parameters

Name Type Since Description
buildLibDirectory File - Path to the dependencies (Projlibs, JARs...) for the build. Default is "target/lib"
Default value is: ${project.build.directory}/lib.
User property is: project.build.directory.lib.
buildSrcDirectory File - Path to the BusinessWorks sources for the build. Default is "target/src"
Default value is: ${project.build.directory}/src.
User property is: project.build.directory.src.
finalName String - Name of the generated artifact (without file extension).
User property is: project.build.finalName.
outputDirectory File - Directory containing the generated artifact.
User property is: project.build.outputDirectory.
packageDirectory File - Path to the package folder. Default is "target/package"
Default value is: ${project.build.directory}/package.
User property is: project.package.directory.
testDirectory File - Path to the test folder. Default is "target/test"
Default value is: ${project.build.directory}/test.
User property is: project.build.test.directory.
testLibDirectory File - Path to the dependencies (Projlibs, JARs...) for the test. Default is "target/test/lib"
Default value is: ${project.build.test.directory}/lib.
User property is: project.build.test.directory.lib.
testSrcDirectory File - Path to the BusinessWorks sources for the test. Default is "target/test/src"
Default value is: ${project.build.test.directory}/src.
User property is: project.build.test.directory.src.
tibcoBWEngineTRAPath File - Path to the BusinessWorks Engine TRA configuration file.
User property is: bwengine.tra.path.

Optional Parameters

Name Type Since Description
classifier String - (no description)
User property is: project.build.classifier.
dependenciesIgnored ArrayList - List of "groupId:artifactId" to ignore when building
hawkDomain String - (no description)
Default value is: ${tibco.domain.name}.
User property is: hawk.domain.
hawkRvDaemon String - (no description)
Default value is: tcp:7474.
User property is: hawk.rv.daemon.
hawkRvNetwork String - (no description)
Default value is: ;.
User property is: hawk.rv.network.
hawkRvService String - (no description)
Default value is: 7474.
User property is: hawk.rv.service.
hawkSubscribeInterval Integer - (no description)
Default value is: 10.
User property is: hawk.subscribe.interval.
hawkSubscribeNumberOfRetry Integer - (no description)
Default value is: 30.
User property is: hawk.subscribe.retry.count.
hawkVersion String - (no description)
User property is: tibco.hawk.version.
hideLibraryResources boolean - Allows to ignore any alias when building EAR or Projlib. This will mimic the "Hide Library Resources" behaviour of the TIBCO Designer.
User property is: bw.hide.library.resources.
includeTransitiveJARsInEAR Boolean - Whether to add JARs files inside EAR.
Default value is: true.
User property is: includeTransitiveJARsInEAR.
projectDirectory File - Path to the BusinessWorks project.
User property is: bw.project.location.
removeVersionFromFileNames Boolean - Whether to rename JARs files inside EAR without their version.
Default value is: false.
User property is: removeVersionFromFileNames.
skipCompile Boolean - Whether to skip the compilation of EAR and Projlib.

NB: shall be used with 'bw.package.skip', 'maven.install.skip' and 'maven.deploy.skip' set to true.
Default value is: false.
User property is: bw.compile.skip.
skipEARCompile Boolean - Whether to skip the compilation of EAR.

NB: shall be used with 'bw.package.skip', 'maven.install.skip' and 'maven.deploy.skip' set to true.
Default value is: false.
User property is: bw.compile.ear.skip.
skipPackage Boolean - Whether to skip the package goals. NB: shall be used with 'maven.install.skip' and 'maven.deploy.skip' set to true.
Default value is: false.
User property is: bw.package.skip.
skipProjlibCompile Boolean - Whether to skip the compilation of Projlib.

NB: shall be used with 'bw.package.skip', 'maven.install.skip' and 'maven.deploy.skip' set to true
Default value is: false.
User property is: bw.compile.projlib.skip.
tibcoAppManagePath File - Path to the TIBCO "AppManage" binary.
User property is: appmanage.path.
tibcoAppManageTRAPath File - Path to the TIBCO "AppManage" TRA configuration file.
User property is: appmanage.tra.path.
tibcoBuildEARTRAPath File - Path to the TIBCO "buildear" TRA configuration file.
User property is: buildear.tra.path.
tibcoBuildEARUseDesignerTRA boolean - Sometimes a TRA can reference another TRA, for instance 'buildear.tra' will reference 'designer.tra'. This field specifies whether we will use the default referenced TRA or override with a provided TRA.
User property is: tra.buildear.uses.designer.tra.path.
tibcoBuildLibraryTRAPath File - Path to the TIBCO Designer "buildlibrary" TRA configuration file.
User property is: buildlibrary.tra.path.
tibcoBuildLibraryUseDesignerTRA boolean - Sometimes a TRA can reference another TRA, for instance 'buildlibrary.tra' will reference 'designer.tra'. This field specifies whether we will use the default referenced TRA or override with a provided TRA.
User property is: tra.buildlibrary.uses.designer.tra.path.
tibcoDesignerPath File - Path to the TIBCO Designer binary.
User property is: designer.path.
tibcoDesignerTRAPath File - Path to the TIBCO Designer TRA configuration file.
User property is: designer.tra.path.
tibcoHome File - Path to the TIBCO home directory.
User property is: tibco.home.
tibcoRvHomePath File - Path to the TIBCO RendezVous folder.
User property is: tibrv.home.path.
timeOut int - Timeout for the execution of TIBCO commands to build artifacts. This time is given in seconds.
Default value is: 180.
User property is: timeOut.
touchEARIfSkipped Boolean - Whether to "touch" the EAR file when EAR compilation is skipped.

NB: must be used with 'bw.compile.skip' or 'bw.compile.ear.skip' set to true.
Default value is: false.
User property is: bw.compile.ear.skip.touch.
touchFinalDeploymentDescriptorIfSkipped Boolean - Whether to "touch" the final deployment descriptor file when final deployment descriptor generation is skipped.

NB: must be used with 'bw.package.skip' set to true.
Default value is: false.
User property is: bw.package.skip.deploy.descriptor.final.touch.
touchProjlibIfSkipped Boolean - Whether to "touch" the Projlib file when Projlib compilation is skipped.

NB: must be used with 'bw.compile.skip' or 'bw.compile.projlib.skip' set to true.
Default value is: false.
User property is: bw.compile.projlib.skip.touch.

Parameter Details

buildLibDirectory:

Path to the dependencies (Projlibs, JARs...) for the build. Default is "target/lib"
  • Type: java.io.File
  • Required: Yes
  • User Property: project.build.directory.lib
  • Default: ${project.build.directory}/lib

buildSrcDirectory:

Path to the BusinessWorks sources for the build. Default is "target/src"
  • Type: java.io.File
  • Required: Yes
  • User Property: project.build.directory.src
  • Default: ${project.build.directory}/src

classifier:

(no description)
  • Type: java.lang.String
  • Required: No
  • User Property: project.build.classifier

dependenciesIgnored:

List of "groupId:artifactId" to ignore when building
  • Type: java.util.ArrayList
  • Required: No

finalName:

Name of the generated artifact (without file extension).
  • Type: java.lang.String
  • Required: Yes
  • User Property: project.build.finalName

hawkDomain:

(no description)
  • Type: java.lang.String
  • Required: No
  • User Property: hawk.domain
  • Default: ${tibco.domain.name}

hawkRvDaemon:

(no description)
  • Type: java.lang.String
  • Required: No
  • User Property: hawk.rv.daemon
  • Default: tcp:7474

hawkRvNetwork:

(no description)
  • Type: java.lang.String
  • Required: No
  • User Property: hawk.rv.network
  • Default: ;

hawkRvService:

(no description)
  • Type: java.lang.String
  • Required: No
  • User Property: hawk.rv.service
  • Default: 7474

hawkSubscribeInterval:

(no description)
  • Type: java.lang.Integer
  • Required: No
  • User Property: hawk.subscribe.interval
  • Default: 10

hawkSubscribeNumberOfRetry:

(no description)
  • Type: java.lang.Integer
  • Required: No
  • User Property: hawk.subscribe.retry.count
  • Default: 30

hawkVersion:

(no description)
  • Type: java.lang.String
  • Required: No
  • User Property: tibco.hawk.version

hideLibraryResources:

Allows to ignore any alias when building EAR or Projlib. This will mimic the "Hide Library Resources" behaviour of the TIBCO Designer.
  • Type: boolean
  • Required: No
  • User Property: bw.hide.library.resources

includeTransitiveJARsInEAR:

Whether to add JARs files inside EAR.
  • Type: java.lang.Boolean
  • Required: No
  • User Property: includeTransitiveJARsInEAR
  • Default: true

outputDirectory:

Directory containing the generated artifact.
  • Type: java.io.File
  • Required: Yes
  • User Property: project.build.outputDirectory

packageDirectory:

Path to the package folder. Default is "target/package"
  • Type: java.io.File
  • Required: Yes
  • User Property: project.package.directory
  • Default: ${project.build.directory}/package

projectDirectory:

Path to the BusinessWorks project.
  • Type: java.io.File
  • Required: No
  • User Property: bw.project.location

removeVersionFromFileNames:

Whether to rename JARs files inside EAR without their version.
  • Type: java.lang.Boolean
  • Required: No
  • User Property: removeVersionFromFileNames
  • Default: false

skipCompile:

Whether to skip the compilation of EAR and Projlib.

NB: shall be used with 'bw.package.skip', 'maven.install.skip' and 'maven.deploy.skip' set to true.
  • Type: java.lang.Boolean
  • Required: No
  • User Property: bw.compile.skip
  • Default: false

skipEARCompile:

Whether to skip the compilation of EAR.

NB: shall be used with 'bw.package.skip', 'maven.install.skip' and 'maven.deploy.skip' set to true.
  • Type: java.lang.Boolean
  • Required: No
  • User Property: bw.compile.ear.skip
  • Default: false

skipPackage:

Whether to skip the package goals. NB: shall be used with 'maven.install.skip' and 'maven.deploy.skip' set to true.
  • Type: java.lang.Boolean
  • Required: No
  • User Property: bw.package.skip
  • Default: false

skipProjlibCompile:

Whether to skip the compilation of Projlib.

NB: shall be used with 'bw.package.skip', 'maven.install.skip' and 'maven.deploy.skip' set to true
  • Type: java.lang.Boolean
  • Required: No
  • User Property: bw.compile.projlib.skip
  • Default: false

testDirectory:

Path to the test folder. Default is "target/test"
  • Type: java.io.File
  • Required: Yes
  • User Property: project.build.test.directory
  • Default: ${project.build.directory}/test

testLibDirectory:

Path to the dependencies (Projlibs, JARs...) for the test. Default is "target/test/lib"
  • Type: java.io.File
  • Required: Yes
  • User Property: project.build.test.directory.lib
  • Default: ${project.build.test.directory}/lib

testSrcDirectory:

Path to the BusinessWorks sources for the test. Default is "target/test/src"
  • Type: java.io.File
  • Required: Yes
  • User Property: project.build.test.directory.src
  • Default: ${project.build.test.directory}/src

tibcoAppManagePath:

Path to the TIBCO "AppManage" binary.
  • Type: java.io.File
  • Required: No
  • User Property: appmanage.path

tibcoAppManageTRAPath:

Path to the TIBCO "AppManage" TRA configuration file.
  • Type: java.io.File
  • Required: No
  • User Property: appmanage.tra.path

tibcoBWEngineTRAPath:

Path to the BusinessWorks Engine TRA configuration file.
  • Type: java.io.File
  • Required: Yes
  • User Property: bwengine.tra.path

tibcoBuildEARTRAPath:

Path to the TIBCO "buildear" TRA configuration file.
  • Type: java.io.File
  • Required: No
  • User Property: buildear.tra.path

tibcoBuildEARUseDesignerTRA:

Sometimes a TRA can reference another TRA, for instance 'buildear.tra' will reference 'designer.tra'. This field specifies whether we will use the default referenced TRA or override with a provided TRA.
  • Type: boolean
  • Required: No
  • User Property: tra.buildear.uses.designer.tra.path

tibcoBuildLibraryTRAPath:

Path to the TIBCO Designer "buildlibrary" TRA configuration file.
  • Type: java.io.File
  • Required: No
  • User Property: buildlibrary.tra.path

tibcoBuildLibraryUseDesignerTRA:

Sometimes a TRA can reference another TRA, for instance 'buildlibrary.tra' will reference 'designer.tra'. This field specifies whether we will use the default referenced TRA or override with a provided TRA.
  • Type: boolean
  • Required: No
  • User Property: tra.buildlibrary.uses.designer.tra.path

tibcoDesignerPath:

Path to the TIBCO Designer binary.
  • Type: java.io.File
  • Required: No
  • User Property: designer.path

tibcoDesignerTRAPath:

Path to the TIBCO Designer TRA configuration file.
  • Type: java.io.File
  • Required: No
  • User Property: designer.tra.path

tibcoHome:

Path to the TIBCO home directory.
  • Type: java.io.File
  • Required: No
  • User Property: tibco.home

tibcoRvHomePath:

Path to the TIBCO RendezVous folder.
  • Type: java.io.File
  • Required: No
  • User Property: tibrv.home.path

timeOut:

Timeout for the execution of TIBCO commands to build artifacts. This time is given in seconds.
  • Type: int
  • Required: No
  • User Property: timeOut
  • Default: 180

touchEARIfSkipped:

Whether to "touch" the EAR file when EAR compilation is skipped.

NB: must be used with 'bw.compile.skip' or 'bw.compile.ear.skip' set to true.
  • Type: java.lang.Boolean
  • Required: No
  • User Property: bw.compile.ear.skip.touch
  • Default: false

touchFinalDeploymentDescriptorIfSkipped:

Whether to "touch" the final deployment descriptor file when final deployment descriptor generation is skipped.

NB: must be used with 'bw.package.skip' set to true.
  • Type: java.lang.Boolean
  • Required: No
  • User Property: bw.package.skip.deploy.descriptor.final.touch
  • Default: false

touchProjlibIfSkipped:

Whether to "touch" the Projlib file when Projlib compilation is skipped.

NB: must be used with 'bw.compile.skip' or 'bw.compile.projlib.skip' set to true.
  • Type: java.lang.Boolean
  • Required: No
  • User Property: bw.compile.projlib.skip.touch
  • Default: false

Back to top

Copyright ©2011-2016 FastConnect SAS. All Rights Reserved.

Version: 2.4.2-SNAPSHOT. Last Published: 2016-06-15.