com.oracle.tools.packager.mac

Class MacDmgBundler

java.lang.Object

com.oracle.tools.packager.AbstractBundler

com.oracle.tools.packager.mac.MacBaseInstallerBundler

com.oracle.tools.packager.mac.MacDmgBundler

All Implemented Interfaces:

Bundler

public class MacDmgBundler
extends MacBaseInstallerBundler

Field Summary

Fields

Modifier and Type	Field and Description
static BundlerParamInfo<String>	INSTALLER_SUFFIX
static BundlerParamInfo<Boolean>	SIMPLE_DMG

Fields inherited from class com.oracle.tools.packager.mac.MacBaseInstallerBundler

APP_BUNDLER, APP_IMAGE_BUILD_ROOT, CONFIG_ROOT, DAEMON_BUNDLER, DAEMON_IMAGE_BUILD_ROOT, INSTALLER_NAME, MAC_APP_IMAGE, SIGNING_KEY_USER, SIGNING_KEYCHAIN

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

baseResourceLoader, BUNDLER_PREFIX, IMAGES_ROOT

Constructor Summary

Constructors

Constructor and Description
MacDmgBundler()

Method Summary

Modifier and Type	Method and Description
File	bundle(Map<String,? super Object> params, File outdir)
protected void	cleanupConfigFiles(Map<String,? super Object> params)
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	getDescription()
Collection<BundlerParamInfo<?>>	getDMGBundleParameters()
String	getID()
String	getName()
boolean	validate(Map<String,? super Object> params) Determines if this bundler will execute with the given parameters.

Methods inherited from class com.oracle.tools.packager.mac.MacBaseInstallerBundler

findKey, getBundleType, getPredefinedImage, prepareAppBundle, prepareDaemonBundle, signAppBundle, signAppBundle, validateAppImageAndBundeler

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

SIMPLE_DMG

public static final BundlerParamInfo<Boolean> SIMPLE_DMG

INSTALLER_SUFFIX

public static final BundlerParamInfo<String> INSTALLER_SUFFIX

Constructor Detail

MacDmgBundler

public MacDmgBundler()

Method Detail

bundle

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

cleanupConfigFiles

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

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.

getBundleParameters

public Collection<BundlerParamInfo<?>> getBundleParameters()

Description copied from interface: Bundler

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

Specified by:

getBundleParameters in interface Bundler

Overrides:

getBundleParameters in class MacBaseInstallerBundler

Returns:

immutable collection

getDMGBundleParameters

public Collection<BundlerParamInfo<?>> getDMGBundleParameters()

validate

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

Description copied from interface: Bundler

Determines if this bundler will execute with the given parameters.

Parameters:

params - 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.

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.