Package com.github.wix_maven

Class PatchMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

com.github.wix_maven.AbstractWixMojo

com.github.wix_maven.AbstractPackageable

com.github.wix_maven.AbstractTorchMojo

com.github.wix_maven.PatchMojo

All Implemented Interfaces:

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

@Mojo(name="patch",
      requiresProject=true,
      defaultPhase=PACKAGE,
      requiresDependencyResolution=COMPILE)
public class PatchMojo
extends AbstractTorchMojo

Goal which executes WiX torch & pyro to create msp files.

Field Summary

Fields

Modifier and Type	Field	Description
protected String	baseline	Baseline id...
protected org.apache.maven.project.MavenProjectBuilder	mavenProjectBuilder	Project builder -- builds a model from a pom.xml

Fields inherited from class com.github.wix_maven.AbstractPackageable

cabCacheDirectory, externalCabs, mergeLevel, ML_BASE, ML_DEFAULT, ML_REPACK, ML_TRANSFORM, narUnpackDirectory, outputDirectory, packLevel, PL_CACHED_CAB, PL_CULTURE_CAB, PL_DEFAULT, PL_MST, PL_PACKAGE, PL_TRANS_CAB, PL_WIXPDB

Fields inherited from class com.github.wix_maven.AbstractWixMojo

compilePerLocale, harvestInputDirectory, intDirectory, localeList, PACK_BUNDLE, PACK_INSTALL, PACK_LIB, PACK_MERGE, PACK_MSIX, PACK_PATCH, packaging, project, reactorProjects, relativeBase, remoteArtifactRepositories, remoteRepos, repoSession, repoSystem, skip, suppress, toolDirectory, toolDirectoryOverwrite, toolsPluginArtifactId, unpackDirectory, validate, verbose, warn, wixExtensions, wxsGeneratedDirectory, wxsInputDirectory, zipUnArchiver

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

ROLE

Constructor Summary

Constructors

Constructor	Description
PatchMojo()

Method Summary

Modifier and Type	Method	Description
protected void	addOtherOptions(org.codehaus.plexus.util.cli.Commandline cl)
protected void	addValidationOptions(org.codehaus.plexus.util.cli.Commandline cl)
void	execute()
protected Set<org.apache.maven.artifact.Artifact>	getDependencySets()
protected Set<org.apache.maven.artifact.Artifact>	getJARDependencySets(org.apache.maven.artifact.Artifact inputArtifact)
protected org.apache.maven.artifact.Artifact	getRelatedArtifact(ArtifactItem artifactItem, String arch, String culture, String type)	Based on Maven-dependency-plugin AbstractFromConfigurationMojo.
protected File	getRelatedArtifactFiles(org.apache.maven.artifact.Artifact artifact)
protected void	pyro(File pyroTool, File patchInputFile, Map<String,File> transformInputFiles, File archOutputFile)	Prepare and execute the Uber pyro commandline
protected void	pyro(File pyroTool, org.apache.maven.artifact.Artifact baseInputArtifact, org.apache.maven.artifact.Artifact latestInputArtifact, String arch, File patchInputFile, File transformInputFile, File archOutputFile)	Prepare and execute pyro commandline tool
protected void	pyro(org.codehaus.plexus.util.cli.Commandline cl)	Execute the given command line parsing output for pyro comments
protected Set<org.apache.maven.artifact.Artifact>	resolveArtifactDependencies(org.apache.maven.artifact.Artifact artifact)	This method resolves all transitive dependencies of an artifact.
protected String	torchOutputExtension()

Methods inherited from class com.github.wix_maven.AbstractTorchMojo

addTorchOptions, torch, torch, validateTool

Methods inherited from class com.github.wix_maven.AbstractPackageable

alternateCulturespecs, baseCulturespec, defaultLocale, getExternalCabs, getOutput, getPackageOutputExtension, getPackaging, languages

Methods inherited from class com.github.wix_maven.AbstractWixMojo

addExtension, addToolsetGeneralOptions, addWixExtensions, cleanupFileBasedResources, culturespecs, findToolsArtifact, findToolsArtifacts, getArchIntDirectory, getCommandBuilder, getExtDependencySets, getJARDependencySets, getLocales, getNPANDAYDependencySets, getOutput, getOutputPath, getPlatforms, getPrimaryCulture, getRelatedArtifacts, getRelative, getRelativePath, getWixDependencySets, getWixVersion, resolveArtifact, resolveArtifact, setLocales, setPlatforms, unpackFileBasedResources, wixUnpackDirectory

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 Details

baseline

@Parameter(property="wix.baseline",
           required=true)
protected String baseline

Baseline id... needs to match the baseline in the patch file, why then is it needed...I don't get how this works... Can we just read this from the input xml?

mavenProjectBuilder

@Component
protected org.apache.maven.project.MavenProjectBuilder mavenProjectBuilder

Project builder -- builds a model from a pom.xml

Constructor Details

PatchMojo

public PatchMojo()

Method Details

addValidationOptions

protected void addValidationOptions(org.codehaus.plexus.util.cli.Commandline cl)

Specified by:

addValidationOptions in class AbstractTorchMojo

addOtherOptions

protected void addOtherOptions(org.codehaus.plexus.util.cli.Commandline cl)

torchOutputExtension

protected String torchOutputExtension()

Specified by:

torchOutputExtension in class AbstractTorchMojo

getJARDependencySets

protected Set<org.apache.maven.artifact.Artifact> getJARDependencySets(org.apache.maven.artifact.Artifact inputArtifact)
                                                                throws org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoExecutionException

pyro

protected void pyro(File pyroTool,
 org.apache.maven.artifact.Artifact baseInputArtifact,
 org.apache.maven.artifact.Artifact latestInputArtifact,
 String arch,
 File patchInputFile,
 File transformInputFile,
 File archOutputFile)
             throws org.apache.maven.plugin.MojoExecutionException

Prepare and execute pyro commandline tool

Parameters:

pyroTool - pyro executable to run.

baseInputArtifact - baseline artifact, used to source bind paths.

latestInputArtifact - latest artifact, used to source bind paths.

arch - target architecture.

patchInputFile - patch input file.

transformInputFile - transform input file.

archOutputFile - output file to generate.

Throws:

org.apache.maven.plugin.MojoExecutionException - if pyro execution fails.

pyro

protected void pyro(File pyroTool,
 File patchInputFile,
 Map<String,File> transformInputFiles,
 File archOutputFile)
             throws org.apache.maven.plugin.MojoExecutionException

Prepare and execute the Uber pyro commandline

Parameters:

pyroTool - pyro executable to run.

patchInputFile - patch input file.

transformInputFiles - transforms keyed by culture.

archOutputFile - output file to generate.

Throws:

org.apache.maven.plugin.MojoExecutionException - if pyro execution fails.

pyro

protected void pyro(org.codehaus.plexus.util.cli.Commandline cl)
             throws org.apache.maven.plugin.MojoExecutionException

Execute the given command line parsing output for pyro comments

Parameters:

cl - prepared pyro command line.

Throws:

org.apache.maven.plugin.MojoExecutionException - if pyro execution fails.

getDependencySets

protected Set<org.apache.maven.artifact.Artifact> getDependencySets()
                                                             throws org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoExecutionException

execute

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

Throws:

org.apache.maven.plugin.MojoExecutionException

org.apache.maven.plugin.MojoFailureException

getRelatedArtifact

protected org.apache.maven.artifact.Artifact getRelatedArtifact(ArtifactItem artifactItem,
 String arch,
 String culture,
 String type)
                                                         throws org.apache.maven.plugin.MojoExecutionException

Based on Maven-dependency-plugin AbstractFromConfigurationMojo. Resolves the Artifact from the remote repository if necessary. If no version is specified, it will be retrieved from the dependency list or from the DependencyManagement section of the pom.

Parameters:

artifactItem - containing information about artifact from plugin configuration.

arch - target architecture classifier prefix.

culture - target culture, or null for neutral.

type - artifact type to resolve.

Returns:

Artifact object representing the specified file.

Throws:

org.apache.maven.plugin.MojoExecutionException - with a message if the version can't be found in DependencyManagement.

getRelatedArtifactFiles

protected File getRelatedArtifactFiles(org.apache.maven.artifact.Artifact artifact)
                                throws org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoExecutionException

resolveArtifactDependencies

protected Set<org.apache.maven.artifact.Artifact> resolveArtifactDependencies(org.apache.maven.artifact.Artifact artifact)
                                                                       throws org.apache.maven.artifact.resolver.ArtifactResolutionException,
org.apache.maven.artifact.resolver.ArtifactNotFoundException,
org.apache.maven.project.ProjectBuildingException,
org.apache.maven.project.artifact.InvalidDependencyVersionException,
org.apache.maven.plugin.MojoExecutionException

This method resolves all transitive dependencies of an artifact.

Parameters:

artifact - the artifact used to retrieve dependencies

Returns:

resolved set of dependencies

Throws:

org.apache.maven.artifact.resolver.ArtifactResolutionException - if dependency artifacts cannot be resolved.

org.apache.maven.artifact.resolver.ArtifactNotFoundException - if a required artifact cannot be found.

org.apache.maven.project.ProjectBuildingException - if Maven project metadata cannot be built.

org.apache.maven.project.artifact.InvalidDependencyVersionException - if a dependency version is invalid.

org.apache.maven.plugin.MojoExecutionException - if dependency resolution fails unexpectedly.