com.openfin.desktop

Class RuntimeConfiguration

java.lang.Object

org.json.JSONObject

com.openfin.desktop.RuntimeConfiguration

public class RuntimeConfiguration
extends org.json.JSONObject

Configuration for launching OpenFin Runtime Created by wche on 3/26/2016.

Field Summary

Fields inherited from class org.json.JSONObject

NULL

Constructor Summary

Constructors

Constructor and Description
RuntimeConfiguration() Constructor

Method Summary

Modifier and Type	Method and Description
void	addAppAsset(org.json.JSONObject assetConfig) Add configuration of an app asset
void	addConfigurationItem(String key, Object value) Add a configuration setting for launching Runtime.
String	generateRuntimeConfig() Generates JSON string that can be passed as --config to RVM and Insaller
String	getAdditionalRvmArguments() Get additional arguments for RVM and Installer
String	getRdmURL() Get URL of RDM service
String	getRuntimeAssetURL() Get URL of Runtime assets
String	getRuntimeVersion() Get version number of Runtime
String	getSecurityRealm() Get security realm
boolean	isLaunchWithRVM() return value of launchWithRVM
void	setAdditionalRuntimeArguments(String additionalRuntimeArguments) Set additional arguments for Runtime
void	setAdditionalRvmArguments(String additionalRvmArguments) Set additional arguments for RVM and Installer
void	setDevToolsPort(int port) Set port for accessing devtools on localhost
void	setDialogSettings(org.json.JSONObject dialogSettings) set configuration to customize the appearance of the RVM progress dialog
void	setLaunchWithRVM(boolean launchWithRVM) By default, Java adapter launches Runtime with OpenFin installer.
void	setRdmURL(String rdmURL) Set URL of RDM service
void	setRuntimeAssetURL(String runtimeAssetURL) Set URL of Runtime assets, including RVM and Runtime
void	setRuntimeVersion(String version) Set version number of Runtime to launch
void	setRvmVersion(String rvmVersion) set Defines the minimum RVM version the app requires.
void	setSecurityRealm(String securityRealm) Set security realm of Runtime
void	setShortCut(org.json.JSONObject shortCut) set configuration for shortcut
void	setSplashScreenImage(String splashScreenImage) Specify an image to display while the runtime is loading.
void	setStartupApp(org.json.JSONObject startupApp) Set configuration of starutp application.
void	setSupportInformation(String supportInformation) Specify customized error messages during launch

Methods inherited from class org.json.JSONObject

accumulate, append, doubleToString, get, getBoolean, getDouble, getInt, getJSONArray, getJSONObject, getLong, getNames, getNames, getString, has, increment, isNull, keys, keySet, length, names, numberToString, opt, optBoolean, optBoolean, optDouble, optDouble, optInt, optInt, optJSONArray, optJSONObject, optLong, optLong, optString, optString, put, put, put, put, put, put, put, putOnce, putOpt, quote, quote, remove, stringToValue, testValidity, toJSONArray, toString, toString, valueToString, wrap, write

Methods inherited from class java.lang.Object

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

Constructor Detail

RuntimeConfiguration

public RuntimeConfiguration()

Constructor

Method Detail

setDevToolsPort

public void setDevToolsPort(int port)

Set port for accessing devtools on localhost

Parameters:

port - port number

setRuntimeVersion

public void setRuntimeVersion(String version)

Set version number of Runtime to launch

Parameters:

version - version number

getRuntimeVersion

public String getRuntimeVersion()

Get version number of Runtime

Returns:

version of Runtime

setSecurityRealm

public void setSecurityRealm(String securityRealm)

Set security realm of Runtime

Parameters:

securityRealm - name of security realm

getSecurityRealm

public String getSecurityRealm()

Get security realm

Returns:

security realm

setAdditionalRuntimeArguments

public void setAdditionalRuntimeArguments(String additionalRuntimeArguments)

Set additional arguments for Runtime

Parameters:

additionalRuntimeArguments - additional arguments

addAppAsset

public void addAppAsset(org.json.JSONObject assetConfig)

Add configuration of an app asset

Parameters:

assetConfig - configuration in JSON format

setRdmURL

public void setRdmURL(String rdmURL)

Set URL of RDM service

Parameters:

rdmURL - RDM URL

getRdmURL

public String getRdmURL()

Get URL of RDM service

Returns:

URL of RDM service

setRuntimeAssetURL

public void setRuntimeAssetURL(String runtimeAssetURL)

Set URL of Runtime assets, including RVM and Runtime

Parameters:

runtimeAssetURL - URL of Runtime assets

getRuntimeAssetURL

public String getRuntimeAssetURL()

Get URL of Runtime assets

Returns:

URL of Runtime assets

getAdditionalRvmArguments

public String getAdditionalRvmArguments()

Get additional arguments for RVM and Installer

Returns:

additional arguments

setRvmVersion

public void setRvmVersion(String rvmVersion)

set Defines the minimum RVM version the app requires. This option is available in RVM 2.3 or greater

Parameters:

rvmVersion - version of RVM required

setShortCut

public void setShortCut(org.json.JSONObject shortCut)

set configuration for shortcut

Parameters:

shortCut - config for shortcut

setDialogSettings

public void setDialogSettings(org.json.JSONObject dialogSettings)

set configuration to customize the appearance of the RVM progress dialog

Parameters:

dialogSettings -

setSplashScreenImage

public void setSplashScreenImage(String splashScreenImage)

Specify an image to display while the runtime is loading. It takes any image file (including semi-transparent PNGs)

Parameters:

splashScreenImage - URL of the image

setSupportInformation

public void setSupportInformation(String supportInformation)

Specify customized error messages during launch

Parameters:

supportInformation - config for support info

setAdditionalRvmArguments

public void setAdditionalRvmArguments(String additionalRvmArguments)

Set additional arguments for RVM and Installer

Parameters:

additionalRvmArguments - set additional arguments

setStartupApp

public void setStartupApp(org.json.JSONObject startupApp)

Set configuration of starutp application.

Parameters:

startupApp - configuration in JSON format

addConfigurationItem

public void addConfigurationItem(String key,
                                 Object value)

Add a configuration setting for launching Runtime. value can be type of Integer, Long, Double, String or JSONObject

Parameters:

key - key value of the setting

value - value of the setting

setLaunchWithRVM

public void setLaunchWithRVM(boolean launchWithRVM)

By default, Java adapter launches Runtime with OpenFin installer. If launchWithRVM is true, installer is skipped and RVM is started instead.

Parameters:

launchWithRVM - true or false

isLaunchWithRVM

public boolean isLaunchWithRVM()

return value of launchWithRVM

Returns:

generateRuntimeConfig

public String generateRuntimeConfig()

Generates JSON string that can be passed as --config to RVM and Insaller

Returns:

JSON string