Package com.github.wix_maven

Class AbstractPackageable

java.lang.Object

org.apache.maven.plugin.AbstractMojo

com.github.wix_maven.AbstractWixMojo

com.github.wix_maven.AbstractPackageable

All Implemented Interfaces:

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

Direct Known Subclasses:

AbstractInsigniaMojo, AbstractLinker, AbstractTorchMojo, HarvestMojo, PackageMojo, PreparePackageMojo, SmokeMojo, ValidateMojo

public abstract class AbstractPackageable
extends AbstractWixMojo

Field Summary

Fields

Modifier and Type	Field	Description
protected File	cabCacheDirectory	The cab cache directory (-cc) only added to light if reuseCab is enabled - will have ${arch} appended TODO: make this a formatted item so user can choose to add arch or not
protected String	externalCabs	The names of cabs that are not embedded Comma separated value.
protected String	mergeLevel	How to build the msi(s) base - base culture msi only default - each culture as full msi trans - default + transforms & cabs for each additional culture repack - trans + the additional culture (transform+cab) packed into 1 msi note: first culture listed is base
final String	ML_BASE
final String	ML_DEFAULT
final String	ML_REPACK
final String	ML_TRANSFORM
protected File	narUnpackDirectory	Target directory for Nar file unpacking.
protected File	outputDirectory	Output directory in future may have 'configuration' appended (default to Release, but not appended yet) will have ${arch} appended may also have ${culture} appended
protected String	packLevel	What of the steps should be packaged default - step output (msi/msp/mst/repack) wixpdb - the wixpdbs for all cultures mst - the mst (ie.
final String	PL_CACHED_CAB
final String	PL_CULTURE_CAB
final String	PL_DEFAULT
final String	PL_MST
final String	PL_PACKAGE
final String	PL_TRANS_CAB
final String	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
AbstractPackageable()

Method Summary

Modifier and Type	Method	Description
protected Set<String>	alternateCulturespecs()
protected String	baseCulturespec()
protected void	defaultLocale()
protected String[]	getExternalCabs()
protected File	getOutput(String arch, String culturespec, String extension)
protected String	getPackageOutputExtension()
protected String	getPackaging()
protected Set<String>	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

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

execute

Field Details

outputDirectory

@Parameter(property="wix.outputDirectory",
           defaultValue="${project.build.directory}/Release")
protected File outputDirectory

Output directory

• in future may have 'configuration' appended (default to Release, but not appended yet)
• will have ${arch} appended
• may also have ${culture} appended

mergeLevel

@Parameter(property="wix.merge",
           defaultValue="default")
protected String mergeLevel

How to build the msi(s)

• base - base culture msi only
• default - each culture as full msi
• trans - default + transforms & cabs for each additional culture
• repack - trans + the additional culture (transform+cab) packed into 1 msi note: first culture listed is base

ML_REPACK

public final String ML_REPACK

See Also:

• Constant Field Values

ML_TRANSFORM

public final String ML_TRANSFORM

See Also:

• Constant Field Values

ML_DEFAULT

public final String ML_DEFAULT

See Also:

• Constant Field Values

ML_BASE

public final String ML_BASE

See Also:

• Constant Field Values

packLevel

@Parameter(property="wix.pack",
           defaultValue="default,wixpdb,cached_cab")
protected String packLevel

What of the steps should be packaged

• default - step output (msi/msp/mst/repack)
• wixpdb - the wixpdbs for all cultures
• mst - the mst (ie. add to a mergeLevel repack build if used with default)
• package - all the msi/msp (ie. add to a mergeLevel trans or repack build if used with default)
• culture_cab - externalCabs for each arch/culture
• cached_cab - externalCabs from the cabCacheDirectory(s) for each arch
• trans_cab - cabs for each arch/culture generated by transform (msi with diff per culture) Comma separated value, default is "default,wixpdb,cached_cab"

PL_DEFAULT

public final String PL_DEFAULT

See Also:

• Constant Field Values

PL_WIXPDB

public final String PL_WIXPDB

See Also:

• Constant Field Values

PL_MST

public final String PL_MST

See Also:

• Constant Field Values

PL_PACKAGE

public final String PL_PACKAGE

See Also:

• Constant Field Values

PL_CACHED_CAB

public final String PL_CACHED_CAB

See Also:

• Constant Field Values

PL_CULTURE_CAB

public final String PL_CULTURE_CAB

See Also:

• Constant Field Values

PL_TRANS_CAB

public final String PL_TRANS_CAB

See Also:

• Constant Field Values

cabCacheDirectory

@Parameter(property="wix.cabCacheDirectory",
           defaultValue="${project.build.directory}/Release/cabs")
protected File cabCacheDirectory

The cab cache directory (-cc) only added to light if reuseCab is enabled
- will have ${arch} appended
TODO: make this a formatted item so user can choose to add arch or not

externalCabs

@Parameter(property="wix.externalCabs",
           defaultValue="")
protected String externalCabs

The names of cabs that are not embedded Comma separated value.
ie. in wxs
<Media Id="1" Cabinet="Product1.cab" EmbedCab="no"/>
<Media Id="2" Cabinet="Product2.cab" EmbedCab="yes"/>
<Media Id="3" Cabinet="Product3.bar"/>
Could add
<externalCabs>Product1.cab,Product3.bar</externalCabs> TODO: this might need to be more like an include/exclude filter list

narUnpackDirectory

@Parameter(property="wix.narUnpackDirectory",
           defaultValue="${project.build.directory}/nar")
protected File narUnpackDirectory

Target directory for Nar file unpacking.

Constructor Details

AbstractPackageable

public AbstractPackageable()

Method Details

defaultLocale

protected void defaultLocale()

getOutput

protected File getOutput(String arch,
 String culturespec,
 String extension)

baseCulturespec

protected String baseCulturespec()

alternateCulturespecs

protected Set<String> alternateCulturespecs()

languages

protected Set<String> languages()

getExternalCabs

protected String[] getExternalCabs()

getPackageOutputExtension

protected String getPackageOutputExtension()

getPackaging

protected String getPackaging()