com.oracle.tools.packager.windows

Class WinMsiBundler

java.lang.Object

com.oracle.tools.packager.AbstractBundler

com.oracle.tools.packager.windows.WinMsiBundler

All Implemented Interfaces:

Bundler

public class WinMsiBundler
extends AbstractBundler

Field Summary

Fields

Modifier and Type	Field and Description
static BundlerParamInfo<WinAppBundler>	APP_BUNDLER
static BundlerParamInfo<Boolean>	CAN_USE_WIX36
static BundlerParamInfo<File>	CONFIG_ROOT
static BundlerParamInfo<File>	MSI_IMAGE_DIR
static StandardBundlerParam<Boolean>	MSI_SYSTEM_WIDE
static StandardBundlerParam<String>	PRODUCT_VERSION
static BundlerParamInfo<WinServiceBundler>	SERVICE_BUNDLER
static BundlerParamInfo<String>	TOOL_CANDLE_EXECUTABLE
static BundlerParamInfo<String>	TOOL_LIGHT_EXECUTABLE
static BundlerParamInfo<UUID>	UPGRADE_UUID
static BundlerParamInfo<File>	WIN_APP_IMAGE

Fields inherited from class com.oracle.tools.packager.AbstractBundler

baseResourceLoader, BUNDLER_PREFIX, IMAGES_ROOT

Constructor Summary

Constructors

Constructor and Description
WinMsiBundler()

Method Summary

Modifier and Type	Method and Description
File	bundle(Map<String,? super Object> p, File outdir)
protected void	cleanupConfigFiles(Map<String,? super Object> params)
static void	ensureByMutationFileIsRTF(File f)
File	execute(Map<String,? super Object> params, File outputParentDir) Creates a bundle from existing content.
Collection<BundlerParamInfo<?>>	getBundleParameters() The parameters that this bundler uses to generate it's bundle.
String	getBundleType()
String	getDescription()
String	getID()
static Collection<BundlerParamInfo<?>>	getMsiBundleParameters()
String	getName()
boolean	validate(Map<String,? super Object> p) Determines if this bundler will execute with the given parameters.

Methods inherited from class com.oracle.tools.packager.AbstractBundler

fetchResource, fetchResource, preprocessTextResource, toString

Methods inherited from class java.lang.Object

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

Field Detail

APP_BUNDLER

public static final BundlerParamInfo<WinAppBundler> APP_BUNDLER

SERVICE_BUNDLER

public static final BundlerParamInfo<WinServiceBundler> SERVICE_BUNDLER

CAN_USE_WIX36

public static final BundlerParamInfo<Boolean> CAN_USE_WIX36

CONFIG_ROOT

public static final BundlerParamInfo<File> CONFIG_ROOT

MSI_IMAGE_DIR

public static final BundlerParamInfo<File> MSI_IMAGE_DIR

WIN_APP_IMAGE

public static final BundlerParamInfo<File> WIN_APP_IMAGE

MSI_SYSTEM_WIDE

public static final StandardBundlerParam<Boolean> MSI_SYSTEM_WIDE

PRODUCT_VERSION

public static final StandardBundlerParam<String> PRODUCT_VERSION

UPGRADE_UUID

public static final BundlerParamInfo<UUID> UPGRADE_UUID

TOOL_CANDLE_EXECUTABLE

public static final BundlerParamInfo<String> TOOL_CANDLE_EXECUTABLE

TOOL_LIGHT_EXECUTABLE

public static final BundlerParamInfo<String> TOOL_LIGHT_EXECUTABLE

Constructor Detail

WinMsiBundler

public WinMsiBundler()

Method Detail

getName

public String getName()

Returns:

User Friendly name of this bundler.

getDescription

public String getDescription()

Returns:

A more verbose description of the bundler.

getID

public String getID()

Returns:

Command line identifier of the bundler. Should be unique.

getBundleType

public String getBundleType()

Returns:

The bundle type of the bundle that is created by this bundler.

getBundleParameters

public Collection<BundlerParamInfo<?>> getBundleParameters()

Description copied from interface: Bundler

The parameters that this bundler uses to generate it's bundle.

Returns:

immutable collection

getMsiBundleParameters

public static Collection<BundlerParamInfo<?>> getMsiBundleParameters()

execute

public File execute(Map<String,? super Object> params,
                    File outputParentDir)

Description copied from interface: Bundler

Creates a bundle from existing content. If a call to Bundler.validate(java.util.Map) date} returns true with the parameters map, then you can expect a valid output. However if an exception was thrown out of validate or it returned false then you should not expect sensible results from this call. It may or may not return a value, and it may or may not throw an exception. But any output should not be considered valid or sane.

Parameters:

params - The parameters as specified by getBundleParameters. Keyed by the id from the ParamInfo. Execution may modify the map, so if you are going to be using the same map across multiple bundlers you should pass in a deep copy.

outputParentDir - The parent dir that the returned bundle will be placed in.

Returns:

The resulting bundled file For a bundler that produces a single artifact file this will be the location of that artifact (.exe file, .deb file, etc) For a bundler that produces a specific directory format output this will be the location of that specific directory (.app file, etc). For a bundler that produce multiple files, this will be a parent directory of those files (linux and windows images), whose name is not relevant to the result.

validate

public boolean validate(Map<String,? super Object> p)
                 throws UnsupportedPlatformException,
                        ConfigException

Description copied from interface: Bundler

Determines if this bundler will execute with the given parameters.

Parameters:

p - The parameters to be validate. Validation may modify the map, so if you are going to be using the same map across multiple bundlers you should pass in a deep copy.

Returns:

true if valid

Throws:

UnsupportedPlatformException - If the bundler cannot run on this platform (i.e. creating mac apps on windows)

ConfigException - If the configuration params are incorrect. The exception may contain advice on how to modify the params map to make it valid.

bundle

public File bundle(Map<String,? super Object> p,
                   File outdir)

cleanupConfigFiles

protected void cleanupConfigFiles(Map<String,? super Object> params)

ensureByMutationFileIsRTF

public static void ensureByMutationFileIsRTF(File f)