co.codewizards.cloudstore.ls.core

Class LsConfig

java.lang.Object

co.codewizards.cloudstore.ls.core.LsConfig

public class LsConfig
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
static String	CONFIG_KEY_LOCAL_SERVER_ENABLED Config-key controlling whether the local-server enabled.
static String	CONFIG_KEY_LOCAL_SERVER_PROCESS_ENABLED Config-key controlling whether the separate local-server-process is launched.
static String	CONFIG_KEY_LOCAL_SERVER_PROCESS_MAX_HEAP_SIZE Controls the value passed as -Xmx to the child-process, thus specifying the maximum heap size of the local-server's JVM.
static String	CONFIG_KEY_LOCAL_SERVER_PROCESS_START_TIMEOUT Config-key controlling the timeout in milliseconds the primary (first launched) process waits for the separate local-server-process to become available.
static Pattern	CONFIG_KEY_PATTERN_LOCAL_SERVER_PROCESS_VM_ARGS
static boolean	DEFAULT_LOCAL_SERVER_ENABLED Default value for CONFIG_KEY_LOCAL_SERVER_ENABLED.
static boolean	DEFAULT_LOCAL_SERVER_PROCESS_ENABLED Default value for CONFIG_KEY_LOCAL_SERVER_PROCESS_ENABLED
static String	DEFAULT_LOCAL_SERVER_PROCESS_MAX_HEAP_SIZE Default value for CONFIG_KEY_LOCAL_SERVER_PROCESS_MAX_HEAP_SIZE
static long	DEFAULT_LOCAL_SERVER_PROCESS_START_TIMEOUT Default value for CONFIG_KEY_LOCAL_SERVER_PROCESS_START_TIMEOUT

Method Summary

Modifier and Type	Method and Description
static String	getLocalServerProcessMaxHeapSize()
static long	getLocalServerProcessStartTimeout() Gets the timeout in milliseconds the primary (first launched) process waits for the separate local-server-process to become available.
static List<String>	getLocalServerProcessVmArgs()
static Uid	getProcessId()
static boolean	isLocalServerEnabled() Is the local-server enabled?
static boolean	isLocalServerProcessEnabled() Should the separate local-server-process be launched?

Methods inherited from class java.lang.Object

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

Field Detail

CONFIG_KEY_LOCAL_SERVER_ENABLED

public static final String CONFIG_KEY_LOCAL_SERVER_ENABLED

Config-key controlling whether the local-server enabled.

See Also:

DEFAULT_LOCAL_SERVER_ENABLED, isLocalServerEnabled(), Constant Field Values

DEFAULT_LOCAL_SERVER_ENABLED

public static final boolean DEFAULT_LOCAL_SERVER_ENABLED

Default value for CONFIG_KEY_LOCAL_SERVER_ENABLED.

See Also:

Constant Field Values

CONFIG_KEY_LOCAL_SERVER_PROCESS_ENABLED

public static final String CONFIG_KEY_LOCAL_SERVER_PROCESS_ENABLED

Config-key controlling whether the separate local-server-process is launched.

See Also:

DEFAULT_LOCAL_SERVER_PROCESS_ENABLED, isLocalServerProcessEnabled(), Constant Field Values

DEFAULT_LOCAL_SERVER_PROCESS_ENABLED

public static final boolean DEFAULT_LOCAL_SERVER_PROCESS_ENABLED

Default value for CONFIG_KEY_LOCAL_SERVER_PROCESS_ENABLED

See Also:

Constant Field Values

CONFIG_KEY_LOCAL_SERVER_PROCESS_START_TIMEOUT

public static final String CONFIG_KEY_LOCAL_SERVER_PROCESS_START_TIMEOUT

Config-key controlling the timeout in milliseconds the primary (first launched) process waits for the separate local-server-process to become available.

See Also:

DEFAULT_LOCAL_SERVER_PROCESS_START_TIMEOUT, getLocalServerProcessStartTimeout(), Constant Field Values

DEFAULT_LOCAL_SERVER_PROCESS_START_TIMEOUT

public static final long DEFAULT_LOCAL_SERVER_PROCESS_START_TIMEOUT

Default value for CONFIG_KEY_LOCAL_SERVER_PROCESS_START_TIMEOUT

See Also:

Constant Field Values

CONFIG_KEY_LOCAL_SERVER_PROCESS_MAX_HEAP_SIZE

public static final String CONFIG_KEY_LOCAL_SERVER_PROCESS_MAX_HEAP_SIZE

Controls the value passed as -Xmx to the child-process, thus specifying the maximum heap size of the local-server's JVM.

Possible values are everything understood by the JVM after the "-Xmx", for example:

• "1G" for 1 Gibibyte
• "2g" for 2 Gibibyte
• "512M" for 512 Mebibyte
• "256M" for 256 Mebibyte

This only has an effect, if CONFIG_KEY_LOCAL_SERVER_PROCESS_ENABLED is true.

See Also:

DEFAULT_LOCAL_SERVER_PROCESS_MAX_HEAP_SIZE, getLocalServerProcessMaxHeapSize(), Constant Field Values

DEFAULT_LOCAL_SERVER_PROCESS_MAX_HEAP_SIZE

public static final String DEFAULT_LOCAL_SERVER_PROCESS_MAX_HEAP_SIZE

Default value for CONFIG_KEY_LOCAL_SERVER_PROCESS_MAX_HEAP_SIZE

See Also:

Constant Field Values

CONFIG_KEY_PATTERN_LOCAL_SERVER_PROCESS_VM_ARGS

public static final Pattern CONFIG_KEY_PATTERN_LOCAL_SERVER_PROCESS_VM_ARGS

Method Detail

isLocalServerEnabled

public static boolean isLocalServerEnabled()

Is the local-server enabled?

Controls, whether a TCP (HTTP+REST) server is started on localhost.

If false, it also prevents the local-server-process from being launched. Thus in order to launch the local-server-process, both isLocalServerEnabled() and isLocalServerProcessEnabled() must be true.

Returns:

true, if the local-server should be listening; false otherwise.

See Also:

CONFIG_KEY_LOCAL_SERVER_ENABLED

isLocalServerProcessEnabled

public static boolean isLocalServerProcessEnabled()

Should the separate local-server-process be launched?

Controls, whether a TCP (HTTP+REST) server is started in a separate process, i.e. whether the current process should launch a separate process.

If false, the local-server (if enabled) runs inside the primary (first-launched) VM process.

Note: In order to launch the local-server-process, both isLocalServerEnabled() and isLocalServerProcessEnabled() must be true.

Returns:

true, if the local-server should be listening; false otherwise.

See Also:

CONFIG_KEY_LOCAL_SERVER_PROCESS_ENABLED

getLocalServerProcessStartTimeout

public static long getLocalServerProcessStartTimeout()

Gets the timeout in milliseconds the primary (first launched) process waits for the separate local-server-process to become available.

If the local-server does not get ready within this timeout, an exception is thrown.

Returns:

the timeout in milliseconds within which the local-server-process must be launched completely (i.e. the TCP server become available).

See Also:

CONFIG_KEY_LOCAL_SERVER_PROCESS_START_TIMEOUT

getLocalServerProcessMaxHeapSize

public static String getLocalServerProcessMaxHeapSize()

getLocalServerProcessVmArgs

public static List<String> getLocalServerProcessVmArgs()

getProcessId

public static Uid getProcessId()