com.oracle.tools.packager.jnlp

Class JNLPBundler

java.lang.Object

com.oracle.tools.packager.AbstractBundler

com.oracle.tools.packager.jnlp.JNLPBundler

All Implemented Interfaces:

Bundler

public class JNLPBundler
extends AbstractBundler

Created by dferrin on 1/7/15.

Field Summary

Fields

Modifier and Type	Field and Description
static StandardBundlerParam<Boolean>	ALL_PERMISSIONS
static StandardBundlerParam<Map<String,String>>	APP_PARAMS
static StandardBundlerParam<Map<String,String>>	APPLET_PARAMS
static StandardBundlerParam<String>	CODEBASE
static StandardBundlerParam<Boolean>	EMBED_JNLP
static StandardBundlerParam<String>	EMBEDDED_HEIGHT
static StandardBundlerParam<String>	EMBEDDED_WIDTH
static StandardBundlerParam<Map<String,String>>	ESCAPED_APPLET_PARAMS
static StandardBundlerParam<Boolean>	EXTENSION
static StandardBundlerParam<String>	FALLBACK_APP
static StandardBundlerParam<String>	FX_PLATFORM
static StandardBundlerParam<Integer>	HEIGHT
static StandardBundlerParam<List<Map<String,? super Object>>>	ICONS
static StandardBundlerParam<String>	ICONS_DEPTH
static StandardBundlerParam<String>	ICONS_HEIGHT
static StandardBundlerParam<String>	ICONS_HREF
static StandardBundlerParam<String>	ICONS_KIND
static StandardBundlerParam<String>	ICONS_WIDTH
static StandardBundlerParam<Boolean>	INCLUDE_DT
static StandardBundlerParam<String>	JRE_PLATFORM
static StandardBundlerParam<Map<String,String>>	JS_CALLBACKS
static StandardBundlerParam<Boolean>	OFFLINE_ALLOWED
static StandardBundlerParam<String>	OUT_FILE
static StandardBundlerParam<String>	PLACEHOLDER
static StandardBundlerParam<Boolean>	SWING_APP
static StandardBundlerParam<Map<File,File>>	TEMPLATES
static StandardBundlerParam<String>	UPDATE_MODE
static StandardBundlerParam<Integer>	WIDTH

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

baseResourceLoader, BUNDLER_PREFIX, IMAGES_ROOT

Constructor Summary

Constructors

Constructor and Description
JNLPBundler()

Method Summary

Modifier and Type	Method and Description
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()
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.AbstractBundler

fetchResource, fetchResource, preprocessTextResource, toString

Methods inherited from class java.lang.Object

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

Field Detail

OUT_FILE

public static final StandardBundlerParam<String> OUT_FILE

SWING_APP

public static final StandardBundlerParam<Boolean> SWING_APP

INCLUDE_DT

public static final StandardBundlerParam<Boolean> INCLUDE_DT

EMBED_JNLP

public static final StandardBundlerParam<Boolean> EMBED_JNLP

EXTENSION

public static final StandardBundlerParam<Boolean> EXTENSION

TEMPLATES

public static final StandardBundlerParam<Map<File,File>> TEMPLATES

CODEBASE

public static final StandardBundlerParam<String> CODEBASE

PLACEHOLDER

public static final StandardBundlerParam<String> PLACEHOLDER

OFFLINE_ALLOWED

public static final StandardBundlerParam<Boolean> OFFLINE_ALLOWED

ALL_PERMISSIONS

public static final StandardBundlerParam<Boolean> ALL_PERMISSIONS

WIDTH

public static final StandardBundlerParam<Integer> WIDTH

HEIGHT

public static final StandardBundlerParam<Integer> HEIGHT

EMBEDDED_WIDTH

public static final StandardBundlerParam<String> EMBEDDED_WIDTH

EMBEDDED_HEIGHT

public static final StandardBundlerParam<String> EMBEDDED_HEIGHT

FALLBACK_APP

public static final StandardBundlerParam<String> FALLBACK_APP

UPDATE_MODE

public static final StandardBundlerParam<String> UPDATE_MODE

FX_PLATFORM

public static final StandardBundlerParam<String> FX_PLATFORM

JRE_PLATFORM

public static final StandardBundlerParam<String> JRE_PLATFORM

ICONS

public static final StandardBundlerParam<List<Map<String,? super Object>>> ICONS

APP_PARAMS

public static final StandardBundlerParam<Map<String,String>> APP_PARAMS

ESCAPED_APPLET_PARAMS

public static final StandardBundlerParam<Map<String,String>> ESCAPED_APPLET_PARAMS

APPLET_PARAMS

public static final StandardBundlerParam<Map<String,String>> APPLET_PARAMS

JS_CALLBACKS

public static final StandardBundlerParam<Map<String,String>> JS_CALLBACKS

ICONS_HREF

public static final StandardBundlerParam<String> ICONS_HREF

ICONS_KIND

public static final StandardBundlerParam<String> ICONS_KIND

ICONS_WIDTH

public static final StandardBundlerParam<String> ICONS_WIDTH

ICONS_HEIGHT

public static final StandardBundlerParam<String> ICONS_HEIGHT

ICONS_DEPTH

public static final StandardBundlerParam<String> ICONS_DEPTH

Constructor Detail

JNLPBundler

public JNLPBundler()

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

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.