jdk.packager.services.userjvmoptions

Class LauncherUserJvmOptions

java.lang.Object

jdk.packager.services.userjvmoptions.LauncherUserJvmOptions

All Implemented Interfaces:

UserJvmOptionsService

public final class LauncherUserJvmOptions
extends java.lang.Object
implements UserJvmOptionsService

Access the UserJVMOptions via a native library provided by the launcher. Do not instantiate this class directly, instead use UserJvmOptionsService.getUserJVMDefaults() to get an instance.

Since:

8u40

Field Summary

Fields

Modifier and Type	Field and Description
private static java.lang.Object	semaphore

Constructor Summary

Constructors

Constructor and Description
LauncherUserJvmOptions()

Method Summary

Modifier and Type	Method and Description
private static java.lang.String[]	_getUserJvmOptionDefaultKeys() This lists the keys for User JVM Options that will have a default provided by the launcher.
private static java.lang.String	_getUserJvmOptionDefaultValue(java.lang.String option) Access the default User JVM Option for a specific key
private static java.lang.String[]	_getUserJvmOptionKeys() This lists the keys for all User JVM Options that will be used by the launcher.
private static java.lang.String	_getUserJvmOptionValue(java.lang.String option) Access the current User JVM Option for a specific key
private static void	_setUserJvmKeysAndValues(java.lang.String[] options, java.lang.String[] values) Update the all User JVM Options All option/value pairs will be replaced with the values provided.
private static void	checkAllPermissions()
java.util.Map<java.lang.String,java.lang.String>	getUserJVMOptionDefaults() The "default" set of UserJVMOptions.
java.util.Map<java.lang.String,java.lang.String>	getUserJVMOptions() The "current" set of UserJVMOptions.
void	setUserJVMOptions(java.util.Map<java.lang.String,java.lang.String> options) Sets the passed in options as the UserJVMOptions.

Methods inherited from class java.lang.Object

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

Methods inherited from interface jdk.packager.services.UserJvmOptionsService

getUserJVMDefaults

Field Detail

semaphore

private static final java.lang.Object semaphore

Constructor Detail

LauncherUserJvmOptions

public LauncherUserJvmOptions()

Method Detail

checkAllPermissions

private static void checkAllPermissions()

_getUserJvmOptionDefaultValue

private static java.lang.String _getUserJvmOptionDefaultValue(java.lang.String option)

Access the default User JVM Option for a specific key

Parameters:

option - the key for the User JVM Option

Returns:

the default value of the user JVM Option. Currently set user values are not considered, and only the default is returned. If there is no default value then null is returned.

_getUserJvmOptionDefaultKeys

private static java.lang.String[] _getUserJvmOptionDefaultKeys()

This lists the keys for User JVM Options that will have a default provided by the launcher. This list will be a subset of the keys used by the launcher and only lists those values that will have a default value provided if the user does not set a value of their own.

Returns:

an array of keys in no particular order.

_getUserJvmOptionValue

private static java.lang.String _getUserJvmOptionValue(java.lang.String option)

Access the current User JVM Option for a specific key

Parameters:

option - the key for the User JVM Option

Returns:

the current value of the user JVM Option. If the user has not set a value then the default value is returned, except in the case where there is no default value, where null is returned.

_setUserJvmKeysAndValues

private static void _setUserJvmKeysAndValues(java.lang.String[] options,
                                             java.lang.String[] values)

Update the all User JVM Options All option/value pairs will be replaced with the values provided. The parameters options and values are paired at the same index. Example: options[3] = -Xmx and values[3] = 999m This cannot be used to adjust default values.

Parameters:

options - the keys for the User JVM Options

values - the values for the User JVM Options

_getUserJvmOptionKeys

private static java.lang.String[] _getUserJvmOptionKeys()

This lists the keys for all User JVM Options that will be used by the launcher. This list will be a superset of the defaults as may also include user values that do not have a default.

Returns:

an array of keys in no particular order.

getUserJVMOptions

public java.util.Map<java.lang.String,java.lang.String> getUserJVMOptions()

Description copied from interface: UserJvmOptionsService

The "current" set of UserJVMOptions. This will take effect on the next application start, and this may not reflect the current set of UserJVMOptions used to start this application.

Specified by:

getUserJVMOptions in interface UserJvmOptionsService

Returns:

A map of the keys and values. Alterations to this map will not change the stored UserJVMOptions

setUserJVMOptions

public void setUserJVMOptions(java.util.Map<java.lang.String,java.lang.String> options)

Description copied from interface: UserJvmOptionsService

Sets the passed in options as the UserJVMOptions. If the application has specified default values and those keys are not in this map, they will be replaced by the default values. No validation or error checking is performed on these values. It is entirely possible that you may provide a set of UserJVMOptions that may prevent the normal startup of your application and may require manual intervention to resolve.

Specified by:

setUserJVMOptions in interface UserJvmOptionsService

Parameters:

options - The UserJVMOptions to set.

getUserJVMOptionDefaults

public java.util.Map<java.lang.String,java.lang.String> getUserJVMOptionDefaults()

Description copied from interface: UserJvmOptionsService

The "default" set of UserJVMOptions. This returns the default set of keys and values that the application has been configured to use.

Specified by:

getUserJVMOptionDefaults in interface UserJvmOptionsService

Returns:

the keys and values of the default UserJVMOptions.