BaseClientBuilderOptions (P2J - Progress 4GL to Java Conversion and Runtime)

java.lang.Object
- com.goldencode.p2j.main.BaseClientBuilderOptions

```
public abstract class BaseClientBuilderOptions
extends java.lang.Object
```
The parameters stored inside this structure are read from directory and are used as default parameters to create and spawn a P2J client process.

Field Summary

Fields
Modifier and Type	Field and Description
`private java.util.List<java.lang.String>`	`cfgOverrides` Unmodifiable list of P2J client bootstrap configs
`private java.lang.String`	`classPath` Class path.
`private java.lang.String`	`command` Java launcher executable name.
`private java.lang.String`	`configFile` Client configuration file.
`private static java.util.regex.Pattern`	`DEBUGGER_SUSPEND_PATTERN` The search pattern for the debugger suspend option
`private static java.lang.String`	`DEFAULT_COMMAND` Default command.
`private static java.lang.String`	`DEFAULT_PATH` Runtime calculated path to our main jar file.
`private static java.lang.String`	`DEFAULT_WORK_DIR` Default working directory.
`private java.util.List<java.lang.String>`	`defaultJvmArguments` JVM arguments.
`private java.util.Map<java.lang.String,java.lang.String>`	`envProperties` The operating system environment variables to be set at the spawned OS process.
`private java.lang.String`	`libPath` Native library path.
`private static CentralLogger`	`LOG` Logger.
`private static java.lang.Class<?>`	`MAIN_CLASS` Main class, must have a main method
`private java.lang.ThreadLocal<java.util.List<java.lang.String>>`	`runtimeJvmArguments` JVM arguments overrides.
`private boolean`	`secure` Secure socket flag.
`private java.lang.String`	`spawner` Spawner executable name.
`private boolean`	`spawnerDebugEnabled` Using optional logging in native spawn code.
`private java.lang.String`	`suspendOption` Storage for debugger suspend option
`private java.lang.String`	`workingDirectory` User's working directory.

Constructor Summary

Constructors
Modifier Constructor and Description

protected BaseClientBuilderOptions(java.util.Map<java.lang.String,java.lang.String> env)
Initialize.

Constructors
Modifier	Constructor and Description
`protected`	`BaseClientBuilderOptions(java.util.Map<java.lang.String,java.lang.String> env)` Initialize.

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`private java.lang.String`	`addJarsToClasspath()` Reads the classpath and the extra jars from directory, appends each entry to the default path and checks if the file exists before compiling the final classpath.
`java.util.List<java.lang.String>`	`getCfgOverrides()` Get P2J client's bootstrap config.
`java.lang.String`	`getClassPath()` Get classpath
`java.lang.String`	`getCommand()` Get command
`java.lang.String`	`getConfigFile()` Get configuration file name.
`private static java.lang.String`	`getDefaultPath()` Get default path as the p2j.jar file location.
`java.util.Map<java.lang.String,java.lang.String>`	`getEnvProperties()` Get the `envProperties`.
`java.util.List<java.lang.String>`	`getJvmArguments()` Get JVM arguments
`java.lang.String`	`getLibPath()` Get native library path.
`java.lang.Class<?>`	`getMainClass()` Get the Java process main class.
`java.lang.String`	`getSpawner()` Get spawner command.
`java.lang.String`	`getSuspendOption()` Returns the debugger suspend option.
`java.lang.String`	`getWorkingDirectory()` Get user working directory.
`boolean`	`isSecure()` Get the security mode.
`boolean`	`isSpawnerDebugEnabled()` Check if native log option is required.
`private java.lang.String`	`parseDebuggerSuspendOption(java.lang.String jvmArgs, java.lang.String defaultValue)` Get the debugger suspend option from the jvm arguments string, otherwise return null.
`(package private) static java.lang.String`	`quotedString(java.lang.String text)` When the string contains space characters a quoted string is build.
`(package private) abstract <T> T`	`read(ConfigItem<T> clientConfig, T defaultValue)` A convenience method to read the client config with the specified default value.
`(package private) abstract <T> T`	`read(ConfigItem<T> clientConfig, T defaultValue, java.lang.String placeholderValue)` A convenience method to read the client config with the specified default value.
`(package private) abstract java.lang.String`	`readCfgOverrides(java.lang.String defaultValue)` Reads and returns the value of clientConfig/cfgOverrides.
`void`	`reset()` Resets the thread local value of `runtimeJvmArguments`.
`private java.util.Map<java.lang.String,java.lang.String>`	`resolveEnvVars(java.util.Map<java.lang.String,java.lang.String> env)` Reads the map of env vars from directory and merges it with the map of runtime env vars.
`private java.util.List<java.lang.String>`	`resolveJvmArgs(java.lang.String jvmConfig)` Parses the JVM arguments line from directory, adds the necessary 'headless' argument if missing and returns the arguments as an unmodifiable list.
`(package private) void`	`updateJvmArgument(java.lang.String key, java.lang.String value)` Update jvmArguments with new key and value pair.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - LOG
```
private static final CentralLogger LOG
```
    Logger.
  - DEFAULT_COMMAND
```
private static final java.lang.String DEFAULT_COMMAND
```
    Default command.
    
    See Also:
    
    Constant Field Values
  - MAIN_CLASS
```
private static final java.lang.Class<?> MAIN_CLASS
```
    Main class, must have a main method
  - DEFAULT_PATH
```
private static final java.lang.String DEFAULT_PATH
```
    Runtime calculated path to our main jar file.
  - DEFAULT_WORK_DIR
```
private static final java.lang.String DEFAULT_WORK_DIR
```
    Default working directory.
    
    See Also:
    
    Constant Field Values
  - DEBUGGER_SUSPEND_PATTERN
```
private static final java.util.regex.Pattern DEBUGGER_SUSPEND_PATTERN
```
    The search pattern for the debugger suspend option
  - secure
```
private final boolean secure
```
    Secure socket flag.
  - command
```
private final java.lang.String command
```
    Java launcher executable name.
  - workingDirectory
```
private final java.lang.String workingDirectory
```
    User's working directory.
  - classPath
```
private final java.lang.String classPath
```
    Class path.
  - libPath
```
private final java.lang.String libPath
```
    Native library path.
  - spawner
```
private final java.lang.String spawner
```
    Spawner executable name.
  - configFile
```
private final java.lang.String configFile
```
    Client configuration file.
  - spawnerDebugEnabled
```
private final boolean spawnerDebugEnabled
```
    Using optional logging in native spawn code.
  - defaultJvmArguments
```
private final java.util.List<java.lang.String> defaultJvmArguments
```
    JVM arguments.
  - runtimeJvmArguments
```
private final java.lang.ThreadLocal<java.util.List<java.lang.String>> runtimeJvmArguments
```
    JVM arguments overrides.
  - suspendOption
```
private final java.lang.String suspendOption
```
    Storage for debugger suspend option
  - envProperties
```
private final java.util.Map<java.lang.String,java.lang.String> envProperties
```
    The operating system environment variables to be set at the spawned OS process.
  - cfgOverrides
```
private final java.util.List<java.lang.String> cfgOverrides
```
    Unmodifiable list of P2J client bootstrap configs
- Constructor Detail
  - BaseClientBuilderOptions
```
protected BaseClientBuilderOptions(java.util.Map<java.lang.String,java.lang.String> env)
```
    Initialize. Read all configuration parameters from directory.
    
    Parameters:
    
    env - Map of additional environment properties, in the key=value form.
- Method Detail
  - reset
```
public void reset()
```
    Resets the thread local value of runtimeJvmArguments.
  - getEnvProperties
```
public java.util.Map<java.lang.String,java.lang.String> getEnvProperties()
```
    Get the envProperties.
    
    Returns:
    
    See above.
  - isSecure
```
public boolean isSecure()
```
    Get the security mode.
    
    Returns:
    
    true use a secured connection false otherwise.
  - getCommand
```
public java.lang.String getCommand()
```
    Get command
    
    Returns:
    
    Command name string.
  - getClassPath
```
public java.lang.String getClassPath()
```
    Get classpath
    
    Returns:
    
    Class path string.
  - getLibPath
```
public java.lang.String getLibPath()
```
    Get native library path.
    
    Returns:
    
    Native library path string.
  - getWorkingDirectory
```
public java.lang.String getWorkingDirectory()
```
    Get user working directory.
    
    Returns:
    
    User working directory.
  - getConfigFile
```
public java.lang.String getConfigFile()
```
    Get configuration file name.
    
    Returns:
    
    Configuration file name.
  - getJvmArguments
```
public java.util.List<java.lang.String> getJvmArguments()
```
    Get JVM arguments
    
    Returns:
    
    A List with JVM arguments.
  - getSpawner
```
public java.lang.String getSpawner()
```
    Get spawner command.
    
    Returns:
    
    The spawner command;
  - getMainClass
```
public java.lang.Class<?> getMainClass()
```
    Get the Java process main class.
    
    Returns:
    
    The main class.
  - isSpawnerDebugEnabled
```
public boolean isSpawnerDebugEnabled()
```
    Check if native log option is required.
    
    Returns:
    
    If true use a extra logger in native code false otherwise.
  - getSuspendOption
```
public java.lang.String getSuspendOption()
```
    Returns the debugger suspend option.
    
    Returns:
    
    See above.
  - getCfgOverrides
```
public java.util.List<java.lang.String> getCfgOverrides()
```
    Get P2J client's bootstrap config.
    
    Returns:
    
    A List with bootstrap config settings.
  - quotedString
```
static java.lang.String quotedString(java.lang.String text)
```
    When the string contains space characters a quoted string is build. On Windows OS spaces could be used in file path, file name, font name and other strings. In order to use such kind of strings in API calls the string should be transformed in quoted form.
    
    Parameters:
    
    text - Text to search for spaces.
    
    Returns:
    
    If no spaces found return the initial string otherwise return a quoted string.
  - updateJvmArgument
```
void updateJvmArgument(java.lang.String key,
                       java.lang.String value)
```
    Update jvmArguments with new key and value pair.
    
    Parameters:
    
    key - The key of a target jvm argument
    
    value - Its new value
  - read
```
abstract <T> T read(ConfigItem<T> clientConfig,
                    T defaultValue)
```
    A convenience method to read the client config with the specified default value.
    
    Type Parameters:
    
    T - The type of the client config.
    
    Parameters:
    
    clientConfig - The client config to read.
    
    defaultValue - The default value returned if no value found in directory.
    
    Returns:
    
    The client config value as read from directory.
  - read
```
abstract <T> T read(ConfigItem<T> clientConfig,
                    T defaultValue,
                    java.lang.String placeholderValue)
```
    A convenience method to read the client config with the specified default value.
    
    Type Parameters:
    
    T - The type of the client config.
    
    Parameters:
    
    clientConfig - The client config to read.
    
    defaultValue - The default value returned if no value found in directory.
    
    placeholderValue - The value to replace the placeholder in the directory node name for the config.
    
    Returns:
    
    The client config value as read from directory.
  - readCfgOverrides
```
abstract java.lang.String readCfgOverrides(java.lang.String defaultValue)
```
    Reads and returns the value of clientConfig/cfgOverrides.
    
    Parameters:
    
    defaultValue - The default value returned if no value found in directory.
    
    Returns:
    
    The cfgOverrides value.
  - parseDebuggerSuspendOption
```
private java.lang.String parseDebuggerSuspendOption(java.lang.String jvmArgs,
                                                    java.lang.String defaultValue)
```
    Get the debugger suspend option from the jvm arguments string, otherwise return null.
    
    Parameters:
    
    jvmArgs - The jvm arguments string
    
    defaultValue - The default value
    
    Returns:
    
    The debugger suspend option or null value.
  - getDefaultPath
```
private static java.lang.String getDefaultPath()
```
    Get default path as the p2j.jar file location.
    
    Returns:
    
    Path to p2j.jar file.
  - addJarsToClasspath
```
private java.lang.String addJarsToClasspath()
```
    Reads the classpath and the extra jars from directory, appends each entry to the default path and checks if the file exists before compiling the final classpath.
    
    Returns:
    
    The verified classpath.
  - resolveEnvVars
```
private java.util.Map<java.lang.String,java.lang.String> resolveEnvVars(java.util.Map<java.lang.String,java.lang.String> env)
```
    Reads the map of env vars from directory and merges it with the map of runtime env vars. Returns an unmodifiable map.
    
    Parameters:
    
    env - The map of env vars.
    
    Returns:
    
    The final map of env vars, unmodifiable.
  - resolveJvmArgs
```
private java.util.List<java.lang.String> resolveJvmArgs(java.lang.String jvmConfig)
```
    Parses the JVM arguments line from directory, adds the necessary 'headless' argument if missing and returns the arguments as an unmodifiable list.
    
    Parameters:
    
    jvmConfig - The JVM arguments as read from directory.
    
    Returns:
    
    The final list of JVM arguments, unmodifiable.

Class BaseClientBuilderOptions

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

LOG

DEFAULT_COMMAND

MAIN_CLASS

DEFAULT_PATH

DEFAULT_WORK_DIR

DEBUGGER_SUSPEND_PATTERN

secure

command

workingDirectory

classPath

libPath

spawner

configFile

spawnerDebugEnabled

defaultJvmArguments

runtimeJvmArguments

suspendOption

envProperties

cfgOverrides

Constructor Detail

BaseClientBuilderOptions

Method Detail

reset

getEnvProperties

isSecure

getCommand

getClassPath

getLibPath

getWorkingDirectory

getConfigFile

getJvmArguments

getSpawner

getMainClass

isSpawnerDebugEnabled

getSuspendOption

getCfgOverrides

quotedString

updateJvmArgument

read

read

readCfgOverrides

parseDebuggerSuspendOption

getDefaultPath

addJarsToClasspath

resolveEnvVars

resolveJvmArgs