fr.fastconnect.factory.tibco.bw.maven

Class AbstractBWArtifactMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

fr.fastconnect.factory.tibco.bw.maven.AbstractBWMojo

fr.fastconnect.factory.tibco.bw.maven.AbstractBWArtifactMojo

All Implemented Interfaces:

org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo

Direct Known Subclasses:

AbstractPackagingMojo, CompileEARMojo, CompileProjlibMojo, IncludeDependenciesInEARMojo, UpdateAliasesLibsMojo

public abstract class AbstractBWArtifactMojo
extends AbstractBWMojo

This abstract class is aimed at preparing the build of a TIBCO artefact, either EAR, Projlib, deployment POM, XML configuration file...
Because this class inherits from AbstractBWMojo, a TIBCO environment will be initialized before building the artefact. The created artefact will hence be the same on every platform.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	classifier
protected java.lang.String	finalName Name of the generated artifact (without file extension).
protected java.lang.Boolean	skipCompile Whether to skip the compilation of EAR and Projlib.
protected java.lang.Boolean	skipEARCompile Whether to skip the compilation of EAR.
protected java.lang.Boolean	skipPackage Whether to skip the package goals.
protected java.lang.Boolean	skipProjlibCompile Whether to skip the compilation of Projlib.
protected java.lang.Boolean	touchEARIfSkipped Whether to "touch" the EAR file when EAR compilation is skipped.
protected java.lang.Boolean	touchFinalDeploymentDescriptorIfSkipped Whether to "touch" the final deployment descriptor file when final deployment descriptor generation is skipped.
protected java.lang.Boolean	touchProjlibIfSkipped Whether to "touch" the Projlib file when Projlib compilation is skipped.
protected static java.lang.String	WARN_NO_ARTIFACT_ATTACHED

Fields inherited from class fr.fastconnect.factory.tibco.bw.maven.AbstractBWMojo

ALIASES_FILE, APPMANAGE_BINARY_NOTFOUND, buildLibDirectory, buildSrcDirectory, BWEAR_DEPLOY_TYPE, BWEAR_EXTENSION, BWEAR_TYPE, BWPROJECT_NOTFOUND, BWPROJECT_PREF_LIB_ERROR_MSG, dependenciesIgnored, DESIGNER_BINARY_NOTFOUND, DESIGNER5_PREFS, directory, DTL_FILE_NAME, FILE_ALIAS_PREFIX, FILE_ALIAS_PREFIX_ESCAPED, HAWK_BINARY_NOTFOUND, hawkDomain, hawkRvDaemon, hawkRvNetwork, hawkRvService, hawkSubscribeInterval, hawkSubscribeNumberOfRetry, hawkVersion, hideLibraryResources, JAR_EXTENSION, JAR_TYPE, mavenPropertyPattern, outputDirectory, packageDirectory, POM_EXTENSION, POM_TYPE, projectDirectory, PROJLIB_EXTENSION, PROJLIB_TYPE, PROPERTIES_EXTENSION, session, SKIPPING, sourceEncoding, testDirectory, testLibDirectory, testSrcDirectory, TIBCO_ALIAS_PREFIX, TIBCO_HOME_DIR, tibcoAppManagePath, tibcoAppManageTRAPath, tibcoBuildEARTRAPath, tibcoBuildEARUseDesignerTRA, tibcoBuildLibraryTRAPath, tibcoBuildLibraryUseDesignerTRA, tibcoBWEngineTRAPath, tibcoDesignerPath, tibcoDesignerTRAPath, tibcoHome, tibcoRvHomePath, timeOut, XML_EXTENSION, XML_TYPE

Fields inherited from interface org.apache.maven.plugin.Mojo

ROLE

Constructor Summary

Constructors

Constructor and Description
AbstractBWArtifactMojo()

Method Summary

Modifier and Type	Method and Description
protected void	attachFile(java.io.File f, java.lang.String type, java.lang.String classifier)
protected void	checkOutputDirectory() This will check whether outputDirectory exists and is a directory.
void	execute() The execute method of this Mojo will : check that the BusinessWorks project exists copy the Designer5.prefs file copy the .designtimelibs file useful for setting a TIBCO environment for the project being built.
protected java.io.File	getArtifactFile(java.io.File basedir, java.lang.String finalName, java.lang.String classifier) Retrieves the full path of the artifact that will be created.
protected abstract java.lang.String	getArtifactFileExtension()
protected java.io.File	getOutputFile()

Methods inherited from class fr.fastconnect.factory.tibco.bw.maven.AbstractBWMojo

checkAppManage, checkDesigner, enableTestScope, getAliasesFile, getBWEARAlias, getBWEARName, getBWEARsDependencies, getDependencies, getDependencyPath, getDesigner5Prefs, getJarAlias, getJarDependencies, getJarName, getProject, getProjlibAlias, getProjlibName, getProjlibsDependencies, getPropertyValue, getPropertyValue, getPropertyValue, getPropertyValue, getPropertyValueInSettings, getRootProjectProperty, getRootProjectProperty, getSession, initHawk, isCurrentGoal, launchTIBCOBinary, launchTIBCOBinary, propertiesManager, propertyExists, propertyExists, propertyExistsInSettings, propertyExistsInSettings, readDependenciesFromFile, replaceProperties, setProject, setSession, setSettings

Methods inherited from class org.apache.maven.plugin.AbstractMojo

getLog, getPluginContext, setLog, setPluginContext

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

WARN_NO_ARTIFACT_ATTACHED

protected static final java.lang.String WARN_NO_ARTIFACT_ATTACHED

See Also:

Constant Field Values

skipCompile

@Parameter(property="bw.compile.skip",
           required=false,
           defaultValue="false")
protected java.lang.Boolean 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.

skipEARCompile

@Parameter(property="bw.compile.ear.skip",
           required=false,
           defaultValue="false")
protected java.lang.Boolean 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.

touchEARIfSkipped

@Parameter(property="bw.compile.ear.skip.touch",
           required=false,
           defaultValue="false")
protected java.lang.Boolean 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.

skipProjlibCompile

@Parameter(property="bw.compile.projlib.skip",
           required=false,
           defaultValue="false")
protected java.lang.Boolean 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

touchProjlibIfSkipped

@Parameter(property="bw.compile.projlib.skip.touch",
           required=false,
           defaultValue="false")
protected java.lang.Boolean 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.

skipPackage

@Parameter(property="bw.package.skip",
           required=false,
           defaultValue="false")
protected java.lang.Boolean skipPackage

Whether to skip the package goals. NB: shall be used with 'maven.install.skip' and 'maven.deploy.skip' set to true.

touchFinalDeploymentDescriptorIfSkipped

@Parameter(property="bw.package.skip.deploy.descriptor.final.touch",
           required=false,
           defaultValue="false")
protected java.lang.Boolean 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.

finalName

@Parameter(property="project.build.finalName",
           required=true)
protected java.lang.String finalName

Name of the generated artifact (without file extension).

classifier

@Parameter(property="project.build.classifier")
protected java.lang.String classifier

Constructor Detail

AbstractBWArtifactMojo

public AbstractBWArtifactMojo()

Method Detail

getArtifactFileExtension

protected abstract java.lang.String getArtifactFileExtension()

attachFile

protected void attachFile(java.io.File f,
                          java.lang.String type,
                          java.lang.String classifier)

getArtifactFile

protected java.io.File getArtifactFile(java.io.File basedir,
                                       java.lang.String finalName,
                                       java.lang.String classifier)

Retrieves the full path of the artifact that will be created.

Parameters:

basedir, - the directory where the artifact will be created

finalName, - the name of the artifact, without file extension

classifier -

Returns:

a File object with the path of the artifact

getOutputFile

protected java.io.File getOutputFile()

Returns:

the Maven artefact as a File

checkOutputDirectory

protected void checkOutputDirectory()

This will check whether outputDirectory exists and is a directory. Otherwise it will be created.

execute

public void execute()
             throws org.apache.maven.plugin.MojoExecutionException

Description copied from class: AbstractBWMojo

The execute method of this Mojo will :

• check that the BusinessWorks project exists
• copy the Designer5.prefs file
• copy the .designtimelibs file useful for setting a TIBCO environment for the project being built.

Specified by:

execute in interface org.apache.maven.plugin.Mojo

Overrides:

execute in class AbstractBWMojo

Throws:

org.apache.maven.plugin.MojoExecutionException