Package oshi.util

Class GlobalConfig

java.lang.Object

oshi.util.GlobalConfig

@NotThreadSafe
public final class GlobalConfig
extends Object

The global configuration utility. See src/main/resources/oshi.properties for default values.

This class is not thread safe if methods manipulating the configuration are used. These methods are intended for use by a single thread at startup, before instantiation of any other OSHI classes. OSHI does not guarantee re- reading of any configuration changes.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	GlobalConfig.PropertyException	Indicates that a configuration value is invalid.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	OSHI_NETWORK_FILESYSTEM_TYPES
static final String	OSHI_OS_LINUX_ALLOWUDEV
static final String	OSHI_OS_LINUX_PROCFS_LOGWARNING
static final String	OSHI_OS_MAC_SYSCTL_LOGWARNING
static final String	OSHI_OS_SOLARIS_ALLOWKSTAT2
static final String	OSHI_OS_UNIX_WHOCOMMAND
static final String	OSHI_OS_WINDOWS_COMMANDLINE_BATCH
static final String	OSHI_OS_WINDOWS_CPU_UTILITY
static final String	OSHI_OS_WINDOWS_EVENTLOG
static final String	OSHI_OS_WINDOWS_HKEYPERFDATA
static final String	OSHI_OS_WINDOWS_LEGACY_SYSTEM_COUNTERS
static final String	OSHI_OS_WINDOWS_LOADAVERAGE
static final String	OSHI_OS_WINDOWS_PERF_DISABLE_ALL_ON_FAILURE
static final String	OSHI_OS_WINDOWS_PERFDISK_DIABLED
static final String	OSHI_OS_WINDOWS_PERFOS_DIABLED
static final String	OSHI_OS_WINDOWS_PERFPROC_DIABLED
static final String	OSHI_OS_WINDOWS_PROCSTATE_SUSPENDED
static final String	OSHI_PSEUDO_FILESYSTEM_TYPES
static final String	OSHI_UTIL_DEV_PATH
static final String	OSHI_UTIL_MEMOIZER_EXPIRATION
static final String	OSHI_UTIL_PROC_PATH
static final String	OSHI_UTIL_SYS_PATH
static final String	OSHI_UTIL_WMI_TIMEOUT

Method Summary

Modifier and Type	Method	Description
static void	clear()	Clear the configuration.
static String	get(String key)	Get the property associated with the given key.
static boolean	get(String key, boolean def)	Get the boolean property associated with the given key.
static double	get(String key, double def)	Get the double property associated with the given key.
static int	get(String key, int def)	Get the int property associated with the given key.
static String	get(String key, String def)	Get the String property associated with the given key.
static void	load(Properties properties)	Load the given Properties into the global configuration.
static void	remove(String key)	Reset the given property to its default value.
static void	set(String key, Object val)	Set the given property, overwriting any existing value.

Methods inherited from class java.lang.Object

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

Field Details

OSHI_UTIL_MEMOIZER_EXPIRATION

public static final String OSHI_UTIL_MEMOIZER_EXPIRATION

See Also:

• Constant Field Values

OSHI_UTIL_WMI_TIMEOUT

public static final String OSHI_UTIL_WMI_TIMEOUT

See Also:

• Constant Field Values

OSHI_UTIL_PROC_PATH

public static final String OSHI_UTIL_PROC_PATH

See Also:

• Constant Field Values

OSHI_UTIL_SYS_PATH

public static final String OSHI_UTIL_SYS_PATH

See Also:

• Constant Field Values

OSHI_UTIL_DEV_PATH

public static final String OSHI_UTIL_DEV_PATH

See Also:

• Constant Field Values

OSHI_PSEUDO_FILESYSTEM_TYPES

public static final String OSHI_PSEUDO_FILESYSTEM_TYPES

See Also:

• Constant Field Values

OSHI_NETWORK_FILESYSTEM_TYPES

public static final String OSHI_NETWORK_FILESYSTEM_TYPES

See Also:

• Constant Field Values

OSHI_OS_LINUX_ALLOWUDEV

public static final String OSHI_OS_LINUX_ALLOWUDEV

See Also:

• Constant Field Values

OSHI_OS_LINUX_PROCFS_LOGWARNING

public static final String OSHI_OS_LINUX_PROCFS_LOGWARNING

See Also:

• Constant Field Values

OSHI_OS_MAC_SYSCTL_LOGWARNING

public static final String OSHI_OS_MAC_SYSCTL_LOGWARNING

See Also:

• Constant Field Values

OSHI_OS_WINDOWS_EVENTLOG

public static final String OSHI_OS_WINDOWS_EVENTLOG

See Also:

• Constant Field Values

OSHI_OS_WINDOWS_PROCSTATE_SUSPENDED

public static final String OSHI_OS_WINDOWS_PROCSTATE_SUSPENDED

See Also:

• Constant Field Values

OSHI_OS_WINDOWS_COMMANDLINE_BATCH

public static final String OSHI_OS_WINDOWS_COMMANDLINE_BATCH

See Also:

• Constant Field Values

OSHI_OS_WINDOWS_HKEYPERFDATA

public static final String OSHI_OS_WINDOWS_HKEYPERFDATA

See Also:

• Constant Field Values

OSHI_OS_WINDOWS_LEGACY_SYSTEM_COUNTERS

public static final String OSHI_OS_WINDOWS_LEGACY_SYSTEM_COUNTERS

See Also:

• Constant Field Values

OSHI_OS_WINDOWS_LOADAVERAGE

public static final String OSHI_OS_WINDOWS_LOADAVERAGE

See Also:

• Constant Field Values

OSHI_OS_WINDOWS_CPU_UTILITY

public static final String OSHI_OS_WINDOWS_CPU_UTILITY

See Also:

• Constant Field Values

OSHI_OS_WINDOWS_PERFDISK_DIABLED

public static final String OSHI_OS_WINDOWS_PERFDISK_DIABLED

See Also:

• Constant Field Values

OSHI_OS_WINDOWS_PERFOS_DIABLED

public static final String OSHI_OS_WINDOWS_PERFOS_DIABLED

See Also:

• Constant Field Values

OSHI_OS_WINDOWS_PERFPROC_DIABLED

public static final String OSHI_OS_WINDOWS_PERFPROC_DIABLED

See Also:

• Constant Field Values

OSHI_OS_WINDOWS_PERF_DISABLE_ALL_ON_FAILURE

public static final String OSHI_OS_WINDOWS_PERF_DISABLE_ALL_ON_FAILURE

See Also:

• Constant Field Values

OSHI_OS_UNIX_WHOCOMMAND

public static final String OSHI_OS_UNIX_WHOCOMMAND

See Also:

• Constant Field Values

OSHI_OS_SOLARIS_ALLOWKSTAT2

public static final String OSHI_OS_SOLARIS_ALLOWKSTAT2

See Also:

• Constant Field Values

Method Details

get

public static String get(String key)

Get the property associated with the given key.

Parameters:

key - The property key

Returns:

The property value if it exists, or null otherwise

get

public static String get(String key,
 String def)

Get the String property associated with the given key.

Parameters:

key - The property key

def - The default value

Returns:

The property value or the given default if not found

get

public static int get(String key,
 int def)

Get the int property associated with the given key.

Parameters:

key - The property key

def - The default value

Returns:

The property value or the given default if not found

get

public static double get(String key,
 double def)

Get the double property associated with the given key.

Parameters:

key - The property key

def - The default value

Returns:

The property value or the given default if not found

get

public static boolean get(String key,
 boolean def)

Get the boolean property associated with the given key.

Parameters:

key - The property key

def - The default value

Returns:

The property value or the given default if not found

set

public static void set(String key,
 Object val)

Set the given property, overwriting any existing value. If the given value is null, the property is removed.

Parameters:

key - The property key

val - The new value

remove

public static void remove(String key)

Reset the given property to its default value.

Parameters:

key - The property key

clear

public static void clear()

Clear the configuration.

load

public static void load(Properties properties)

Load the given Properties into the global configuration.

Parameters:

properties - The new properties