Package io.deephaven.process

Class ProcessInfoConfig

java.lang.Object

io.deephaven.process.ProcessInfoConfig

public class ProcessInfoConfig
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
static final String	HOST_PATH_INFO_DIR_DEFAULT	The default SplayedPath root for ProcessInfo.getHostPathInfo().
static final String	HOST_PATH_INFO_DIR_KEY	The lookup key for ProcessInfo.getHostPathInfo().
static final String	PROCESS_INFO_ID_KEY	The lookup key for ProcessInfo.getId().
static final String	PROCESS_INFO_SYSTEM_INFO_ENABLED_KEY	The lookup key to see if ProcessInfo.getSystemInfo() is enabled.
static final boolean	SYSTEM_INFO_ENABLED_DEFAULT	The default value to see if ProcessInfo.getSystemInfo() is enabled.

Constructor Summary

Constructors

Constructor	Description
ProcessInfoConfig()

Method Summary

Modifier and Type	Method	Description
static ProcessInfo	createForCurrentProcess(Configuration config)
static ProcessInfo	createForCurrentProcess(Configuration config, String processInfoId)
static ProcessInfo	createOrGetForCurrentProcess(Configuration config, String processInfoId)
static String	generateNewProcessInfoId()	Generates a unique identifier string suitable for use as a process identifier.
static @Nullable io.deephaven.process.ProcessUniqueId	getThisProcessId()
static @Nullable String	getThisProcessIdValue()

Methods inherited from class java.lang.Object

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

Field Details

PROCESS_INFO_ID_KEY

public static final String PROCESS_INFO_ID_KEY

The lookup key for ProcessInfo.getId(). If not present, will default to a random id.

See Also:

• Constant Field Values

PROCESS_INFO_SYSTEM_INFO_ENABLED_KEY

public static final String PROCESS_INFO_SYSTEM_INFO_ENABLED_KEY

The lookup key to see if ProcessInfo.getSystemInfo() is enabled. If not present, will default to SYSTEM_INFO_ENABLED_DEFAULT.

See Also:

• Constant Field Values

SYSTEM_INFO_ENABLED_DEFAULT

public static final boolean SYSTEM_INFO_ENABLED_DEFAULT

The default value to see if ProcessInfo.getSystemInfo() is enabled.

See Also:

• Constant Field Values

HOST_PATH_INFO_DIR_KEY

public static final String HOST_PATH_INFO_DIR_KEY

The lookup key for ProcessInfo.getHostPathInfo(). If not present, will default to HOST_PATH_INFO_DIR_DEFAULT.

See Also:

• Constant Field Values

HOST_PATH_INFO_DIR_DEFAULT

public static final String HOST_PATH_INFO_DIR_DEFAULT

The default SplayedPath root for ProcessInfo.getHostPathInfo().

See Also:

• Constant Field Values

Constructor Details

ProcessInfoConfig

public ProcessInfoConfig()

Method Details

generateNewProcessInfoId

public static String generateNewProcessInfoId()

Generates a unique identifier string suitable for use as a process identifier. This allows a creating process to obtain an identifier that can be passed to a new process for use as the processInfoId. Generating it here encapsulates where it comes from.

Returns:

a unique identifier string

getThisProcessId

@Nullable
public static @Nullable io.deephaven.process.ProcessUniqueId getThisProcessId()

getThisProcessIdValue

@Nullable
public static @Nullable String getThisProcessIdValue()

createForCurrentProcess

public static ProcessInfo createForCurrentProcess(Configuration config)
                                           throws IOException

Throws:

IOException

createForCurrentProcess

public static ProcessInfo createForCurrentProcess(Configuration config,
 String processInfoId)
                                           throws IOException

Throws:

IOException

createOrGetForCurrentProcess

public static ProcessInfo createOrGetForCurrentProcess(Configuration config,
 String processInfoId)
                                                throws IOException

Throws:

IOException