com.oracle.tools.packager.linux

Class LinuxAppBundler

java.lang.Object

com.oracle.tools.packager.AbstractBundler

com.oracle.tools.packager.AbstractImageBundler

com.oracle.tools.packager.linux.LinuxAppBundler

All Implemented Interfaces:

Bundler

public class LinuxAppBundler
extends AbstractImageBundler

Field Summary

Fields

Modifier and Type	Field and Description
private static java.lang.String	EXECUTABLE_NAME
private static java.util.ResourceBundle	I18N
static BundlerParamInfo<java.io.File>	ICON_PNG
private static java.lang.String	LIBRARY_NAME
protected static java.lang.String	LINUX_BUNDLER_PREFIX
static BundlerParamInfo<JreUtils.Rule[]>	LINUX_JRE_RULES
static BundlerParamInfo<RelativeFileSet>	LINUX_RUNTIME
static BundlerParamInfo<java.net.URL>	RAW_EXECUTABLE_URL

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
LinuxAppBundler()

Method Summary

Modifier and Type	Method and Description
private void	copyApplication(java.util.Map<java.lang.String,? super java.lang.Object> params, java.io.File appDirectory)
private void	copyRuntime(java.util.Map<java.lang.String,? super java.lang.Object> params, java.io.File runtimeDirectory)
private void	createLauncherForEntryPoint(java.util.Map<java.lang.String,? super java.lang.Object> p, java.io.File rootDir)
(package private) java.io.File	doBundle(java.util.Map<java.lang.String,? super java.lang.Object> p, java.io.File outputDirectory, boolean dependentTask)
(package private) 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.
void	extractRuntimeFlags(java.util.Map<java.lang.String,? super java.lang.Object> params)
static java.util.Collection<BundlerParamInfo<?>>	getAppBundleParameters()
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)
java.lang.String	getDescription()
java.lang.String	getID()
static java.lang.String	getLauncherCfgName(java.util.Map<java.lang.String,? super java.lang.Object> p)
static java.lang.String	getLauncherName(java.util.Map<java.lang.String,? super java.lang.Object> p)
java.lang.String	getName()
static java.io.File	getRootDir(java.io.File outDir, java.util.Map<java.lang.String,? super java.lang.Object> p)
private java.lang.String	getRuntimeLocation(java.util.Map<java.lang.String,? super java.lang.Object> params)
boolean	validate(java.util.Map<java.lang.String,? super java.lang.Object> p) Determines if this bundler will execute with the given parameters.
private void	writeCfgFile(java.util.Map<java.lang.String,? super java.lang.Object> params, java.io.File rootDir)

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

LINUX_BUNDLER_PREFIX

protected static final java.lang.String LINUX_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

ICON_PNG

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

RAW_EXECUTABLE_URL

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

LINUX_JRE_RULES

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

LINUX_RUNTIME

public static final BundlerParamInfo<RelativeFileSet> LINUX_RUNTIME

Constructor Detail

LinuxAppBundler

public LinuxAppBundler()

Method Detail

validate

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

doValidate

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

Throws:

UnsupportedPlatformException

ConfigException

getRootDir

public static java.io.File getRootDir(java.io.File outDir,
                                      java.util.Map<java.lang.String,? super java.lang.Object> p)

getLauncherName

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

getLauncherCfgName

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

doBundle

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

createLauncherForEntryPoint

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

Throws:

java.io.IOException

copyApplication

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

Throws:

java.io.IOException

getRuntimeLocation

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

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

copyRuntime

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

Throws:

java.io.IOException

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.

getCacheLocation

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

Specified by:

getCacheLocation in class AbstractImageBundler

extractRuntimeFlags

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

Specified by:

extractRuntimeFlags in class AbstractImageBundler