com.oracle.tools.packager.mac

Class MacAppBundler

java.lang.Object

com.oracle.tools.packager.AbstractBundler

com.oracle.tools.packager.AbstractImageBundler

com.oracle.tools.packager.mac.MacAppBundler

All Implemented Interfaces:

Bundler

public class MacAppBundler
extends AbstractImageBundler

Field Summary

Fields

Modifier and Type	Field and Description
static BundlerParamInfo<java.lang.String>	BUNDLE_ID_SIGNING_PREFIX
static BundlerParamInfo<java.io.File>	CONFIG_ROOT
static BundlerParamInfo<java.lang.String>	DEFAULT_ICNS_ICON
static BundlerParamInfo<java.lang.String>	DEVELOPER_ID_APP_SIGNING_KEY
private static java.lang.String	EXECUTABLE_NAME
private static java.util.ResourceBundle	I18N
static BundlerParamInfo<java.io.File>	ICON_ICNS
private static java.lang.String	LIBRARY_NAME
static java.lang.String	MAC_BUNDLER_PREFIX
static EnumeratedBundlerParam<java.lang.String>	MAC_CATEGORY
static BundlerParamInfo<java.lang.String>	MAC_CF_BUNDLE_IDENTIFIER
static BundlerParamInfo<java.lang.String>	MAC_CF_BUNDLE_NAME
static BundlerParamInfo<java.lang.String>	MAC_CF_BUNDLE_VERSION
static BundlerParamInfo<java.lang.Boolean>	MAC_CONFIGURE_LAUNCHER_IN_PLIST
static BundlerParamInfo<JreUtils.Rule[]>	MAC_RULES
static BundlerParamInfo<RelativeFileSet>	MAC_RUNTIME
private static java.lang.String	OS_TYPE_CODE
static BundlerParamInfo<java.net.URL>	RAW_EXECUTABLE_URL
private static java.lang.String	TEMPLATE_BUNDLE_ICON
private static java.lang.String	TEMPLATE_INFO_PLIST_LEGACY
private static java.lang.String	TEMPLATE_INFO_PLIST_LITE

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

CFG_FORMAT_INI, CFG_FORMAT_PROPERTIES, LAUNCHER_CFG_FORMAT

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

baseResourceLoader, BUNDLER_PREFIX, IMAGES_ROOT

Constructor Summary

Constructors

Constructor and Description
MacAppBundler()

Method Summary

Modifier and Type	Method and Description
void	cleanupConfigFiles(java.util.Map<java.lang.String,? super java.lang.Object> params)
private void	copyClassPathEntries(java.io.File javaDirectory, java.util.Map<java.lang.String,? super java.lang.Object> params)
private void	copyRuntime(java.io.File plugInsDirectory, java.util.Map<java.lang.String,? super java.lang.Object> params)
private void	createLauncherForEntryPoint(java.util.Map<java.lang.String,? super java.lang.Object> p, java.io.File rootDirectory)
static JreUtils.Rule[]	createMacRuntimeRules(java.util.Map<java.lang.String,? super java.lang.Object> params)
java.io.File	doBundle(java.util.Map<java.lang.String,? super java.lang.Object> p, java.io.File outputDirectory, boolean dependentTask)
boolean	doValidate(java.util.Map<java.lang.String,? super java.lang.Object> p)
java.io.File	execute(java.util.Map<java.lang.String,? super java.lang.Object> params, java.io.File outputParentDir) Creates a bundle from existing content.
static RelativeFileSet	extractMacRuntime(java.lang.String base, java.util.Map<java.lang.String,? super java.lang.Object> params)
void	extractRuntimeFlags(java.util.Map<java.lang.String,? super java.lang.Object> params)
static java.util.Collection<BundlerParamInfo<?>>	getAppBundleParameters()
private java.lang.String	getBundleName(java.util.Map<java.lang.String,? super java.lang.Object> params)
java.util.Collection<BundlerParamInfo<?>>	getBundleParameters() The parameters that this bundler uses to generate it's bundle.
java.lang.String	getBundleType()
protected java.lang.String	getCacheLocation(java.util.Map<java.lang.String,? super java.lang.Object> params)
private java.io.File	getConfig_Icon(java.util.Map<java.lang.String,? super java.lang.Object> params)
private java.io.File	getConfig_InfoPlist(java.util.Map<java.lang.String,? super java.lang.Object> params)
java.lang.String	getDescription()
java.lang.String	getID()
static java.lang.String	getLauncherCfgName(java.util.Map<java.lang.String,? super java.lang.Object> p)
private java.lang.String	getLauncherName(java.util.Map<java.lang.String,? super java.lang.Object> params)
private static java.util.Map<java.lang.String,java.lang.String>	getMacCategories()
java.lang.String	getName()
private java.lang.String	getRuntimeLocation(java.util.Map<java.lang.String,? super java.lang.Object> params)
private void	prepareConfigFiles(java.util.Map<java.lang.String,? super java.lang.Object> params)
private void	prepareIcon(java.util.Map<java.lang.String,? super java.lang.Object> params)
boolean	validate(java.util.Map<java.lang.String,? super java.lang.Object> params) Determines if this bundler will execute with the given parameters.
static boolean	validCFBundleVersion(java.lang.String v)
private void	writeCfgFile(java.util.Map<java.lang.String,? super java.lang.Object> params, java.io.File rootDir)
private void	writeInfoPlist(java.io.File file, java.util.Map<java.lang.String,? super java.lang.Object> params)
private void	writePkgInfo(java.io.File file)

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

extractFlagsFromVersion, imageBundleValidation, testRuntime, writeCfgFile

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

I18N

private static final java.util.ResourceBundle I18N

MAC_BUNDLER_PREFIX

public static final java.lang.String MAC_BUNDLER_PREFIX

EXECUTABLE_NAME

private static final java.lang.String EXECUTABLE_NAME

See Also:

Constant Field Values

LIBRARY_NAME

private static final java.lang.String LIBRARY_NAME

See Also:

Constant Field Values

TEMPLATE_BUNDLE_ICON

private static final java.lang.String TEMPLATE_BUNDLE_ICON

See Also:

Constant Field Values

OS_TYPE_CODE

private static final java.lang.String OS_TYPE_CODE

See Also:

Constant Field Values

TEMPLATE_INFO_PLIST_LEGACY

private static final java.lang.String TEMPLATE_INFO_PLIST_LEGACY

See Also:

Constant Field Values

TEMPLATE_INFO_PLIST_LITE

private static final java.lang.String TEMPLATE_INFO_PLIST_LITE

See Also:

Constant Field Values

MAC_CONFIGURE_LAUNCHER_IN_PLIST

public static final BundlerParamInfo<java.lang.Boolean> MAC_CONFIGURE_LAUNCHER_IN_PLIST

MAC_CATEGORY

public static final EnumeratedBundlerParam<java.lang.String> MAC_CATEGORY

MAC_CF_BUNDLE_NAME

public static final BundlerParamInfo<java.lang.String> MAC_CF_BUNDLE_NAME

MAC_CF_BUNDLE_IDENTIFIER

public static final BundlerParamInfo<java.lang.String> MAC_CF_BUNDLE_IDENTIFIER

MAC_CF_BUNDLE_VERSION

public static final BundlerParamInfo<java.lang.String> MAC_CF_BUNDLE_VERSION

CONFIG_ROOT

public static final BundlerParamInfo<java.io.File> CONFIG_ROOT

RAW_EXECUTABLE_URL

public static final BundlerParamInfo<java.net.URL> RAW_EXECUTABLE_URL

DEFAULT_ICNS_ICON

public static final BundlerParamInfo<java.lang.String> DEFAULT_ICNS_ICON

MAC_RULES

public static final BundlerParamInfo<JreUtils.Rule[]> MAC_RULES

MAC_RUNTIME

public static final BundlerParamInfo<RelativeFileSet> MAC_RUNTIME

DEVELOPER_ID_APP_SIGNING_KEY

public static final BundlerParamInfo<java.lang.String> DEVELOPER_ID_APP_SIGNING_KEY

BUNDLE_ID_SIGNING_PREFIX

public static final BundlerParamInfo<java.lang.String> BUNDLE_ID_SIGNING_PREFIX

ICON_ICNS

public static final BundlerParamInfo<java.io.File> ICON_ICNS

Constructor Detail

MacAppBundler

public MacAppBundler()

Method Detail

getMacCategories

private static java.util.Map<java.lang.String,java.lang.String> getMacCategories()

extractMacRuntime

public static RelativeFileSet extractMacRuntime(java.lang.String base,
                                                java.util.Map<java.lang.String,? super java.lang.Object> params)

getCacheLocation

protected java.lang.String getCacheLocation(java.util.Map<java.lang.String,? super java.lang.Object> params)

Specified by:

getCacheLocation in class AbstractImageBundler

validCFBundleVersion

public static boolean validCFBundleVersion(java.lang.String v)

validate

public boolean validate(java.util.Map<java.lang.String,? super java.lang.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.

doValidate

public boolean doValidate(java.util.Map<java.lang.String,? super java.lang.Object> p)
                   throws UnsupportedPlatformException,
                          ConfigException

Throws:

UnsupportedPlatformException

ConfigException

getConfig_InfoPlist

private java.io.File getConfig_InfoPlist(java.util.Map<java.lang.String,? super java.lang.Object> params)

getConfig_Icon

private java.io.File getConfig_Icon(java.util.Map<java.lang.String,? super java.lang.Object> params)

prepareConfigFiles

private void prepareConfigFiles(java.util.Map<java.lang.String,? super java.lang.Object> params)
                         throws java.io.IOException

Throws:

java.io.IOException

doBundle

public java.io.File doBundle(java.util.Map<java.lang.String,? super java.lang.Object> p,
                             java.io.File outputDirectory,
                             boolean dependentTask)

cleanupConfigFiles

public void cleanupConfigFiles(java.util.Map<java.lang.String,? super java.lang.Object> params)

copyClassPathEntries

private void copyClassPathEntries(java.io.File javaDirectory,
                                  java.util.Map<java.lang.String,? super java.lang.Object> params)
                           throws java.io.IOException

Throws:

java.io.IOException

copyRuntime

private void copyRuntime(java.io.File plugInsDirectory,
                         java.util.Map<java.lang.String,? super java.lang.Object> params)
                  throws java.io.IOException

Throws:

java.io.IOException

prepareIcon

private void prepareIcon(java.util.Map<java.lang.String,? super java.lang.Object> params)
                  throws java.io.IOException

Throws:

java.io.IOException

getLauncherName

private java.lang.String getLauncherName(java.util.Map<java.lang.String,? super java.lang.Object> params)

getBundleName

private java.lang.String getBundleName(java.util.Map<java.lang.String,? super java.lang.Object> params)

getRuntimeLocation

private java.lang.String getRuntimeLocation(java.util.Map<java.lang.String,? super java.lang.Object> params)

writeInfoPlist

private void writeInfoPlist(java.io.File file,
                            java.util.Map<java.lang.String,? super java.lang.Object> params)
                     throws java.io.IOException

Throws:

java.io.IOException

writePkgInfo

private void writePkgInfo(java.io.File file)
                   throws java.io.IOException

Throws:

java.io.IOException

createMacRuntimeRules

public static JreUtils.Rule[] createMacRuntimeRules(java.util.Map<java.lang.String,? super java.lang.Object> params)

getName

public java.lang.String getName()

Returns:

User Friendly name of this bundler.

getDescription

public java.lang.String getDescription()

Returns:

A more verbose description of the bundler.

getID

public java.lang.String getID()

Returns:

Command line identifier of the bundler. Should be unique.

getBundleType

public java.lang.String getBundleType()

Returns:

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

getBundleParameters

public java.util.Collection<BundlerParamInfo<?>> getBundleParameters()

Description copied from interface: Bundler

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

Returns:

immutable collection

getAppBundleParameters

public static java.util.Collection<BundlerParamInfo<?>> getAppBundleParameters()

execute

public java.io.File execute(java.util.Map<java.lang.String,? super java.lang.Object> params,
                            java.io.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.

createLauncherForEntryPoint

private void createLauncherForEntryPoint(java.util.Map<java.lang.String,? super java.lang.Object> p,
                                         java.io.File rootDirectory)
                                  throws java.io.IOException

Throws:

java.io.IOException

getLauncherCfgName

public static java.lang.String getLauncherCfgName(java.util.Map<java.lang.String,? super java.lang.Object> p)

writeCfgFile

private void writeCfgFile(java.util.Map<java.lang.String,? super java.lang.Object> params,
                          java.io.File rootDir)
                   throws java.io.FileNotFoundException

Throws:

java.io.FileNotFoundException

extractRuntimeFlags

public void extractRuntimeFlags(java.util.Map<java.lang.String,? super java.lang.Object> params)

Specified by:

extractRuntimeFlags in class AbstractImageBundler