oshi.util.platform.windows

Class WmiUtil

java.lang.Object

oshi.util.platform.windows.WmiUtil

public class WmiUtil
extends Object

Provides access to WMI queries

Author:

widdis[at]gmail[dot]com

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	WmiUtil.ValueType Enum for WMI queries for proper parsing from the returned VARIANT

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_NAMESPACE

Constructor Summary

Constructors

Constructor and Description
WmiUtil()

Method Summary

Modifier and Type	Method and Description
static boolean	hasNamespace(String namespace) Determine if WMI has the requested namespace.
static Float	selectFloatFrom(String namespace, String wmiClass, String property, String whereClause) Get a single Float value from WMI
static Map<String,List<Float>>	selectFloatsFrom(String namespace, String wmiClass, String properties, String whereClause) Get multiple Float values from WMI
static Map<String,List<Object>>	selectObjectsFrom(String namespace, String wmiClass, String properties, String whereClause, WmiUtil.ValueType[] propertyTypes) Get multiple individually typed values from WMI
static String	selectStringFrom(String namespace, String wmiClass, String property, String whereClause) Get a single String value from WMI
static Map<String,List<String>>	selectStringsFrom(String namespace, String wmiClass, String properties, String whereClause) Get multiple String values from WMI
static Long	selectUint32From(String namespace, String wmiClass, String property, String whereClause) Get a single Unsigned Integer value from WMI (as Long)
static Map<String,List<Long>>	selectUint32sFrom(String namespace, String wmiClass, String properties, String whereClause) Get multiple Unsigned Integer values from WMI (as Longs)

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_NAMESPACE

public static final String DEFAULT_NAMESPACE

See Also:

Constant Field Values

Constructor Detail

WmiUtil

public WmiUtil()

Method Detail

hasNamespace

public static boolean hasNamespace(String namespace)

Determine if WMI has the requested namespace. Some namespaces only exist on newer versions of Windows.

Parameters:

namespace - The namespace to test

Returns:

true if the namespace exists, false otherwise

selectUint32From

public static Long selectUint32From(String namespace,
                                    String wmiClass,
                                    String property,
                                    String whereClause)

Get a single Unsigned Integer value from WMI (as Long)

Parameters:

namespace - The namespace or null to use the default

wmiClass - The class to query

property - The property whose value to return

whereClause - A WQL where clause matching properties and keywords

Returns:

A Long containing the value of the requested property

selectUint32sFrom

public static Map<String,List<Long>> selectUint32sFrom(String namespace,
                                                       String wmiClass,
                                                       String properties,
                                                       String whereClause)

Get multiple Unsigned Integer values from WMI (as Longs)

Parameters:

namespace - The namespace or null to use the default

wmiClass - The class to query

properties - A comma delimited list of properties whose value to return

whereClause - A WQL where clause matching properties and keywords

Returns:

A map, with each property as the key, containing Longs with the value of the requested properties. Each list's order corresponds to other lists.

selectFloatFrom

public static Float selectFloatFrom(String namespace,
                                    String wmiClass,
                                    String property,
                                    String whereClause)

Get a single Float value from WMI

Parameters:

namespace - The namespace or null to use the default

wmiClass - The class to query

property - The property whose value to return

whereClause - A WQL where clause matching properties and keywords

Returns:

A Float containing the value of the requested property

selectFloatsFrom

public static Map<String,List<Float>> selectFloatsFrom(String namespace,
                                                       String wmiClass,
                                                       String properties,
                                                       String whereClause)

Get multiple Float values from WMI

Parameters:

namespace - The namespace or null to use the default

wmiClass - The class to query

properties - A comma delimited list of properties whose value to return

whereClause - A WQL where clause matching properties and keywords

Returns:

A map, with each property as the key, containing Floats with the value of the requested properties. Each list's order corresponds to other lists.

selectStringFrom

public static String selectStringFrom(String namespace,
                                      String wmiClass,
                                      String property,
                                      String whereClause)

Get a single String value from WMI

Parameters:

namespace - The namespace or null to use the default

wmiClass - The class to query

property - The property whose value to return

whereClause - A WQL where clause matching properties and keywords

Returns:

A string containing the value of the requested property

selectStringsFrom

public static Map<String,List<String>> selectStringsFrom(String namespace,
                                                         String wmiClass,
                                                         String properties,
                                                         String whereClause)

Get multiple String values from WMI

Parameters:

namespace - The namespace or null to use the default

wmiClass - The class to query

properties - A comma delimited list of properties whose value to return

whereClause - A WQL where clause matching properties and keywords

Returns:

A map, with each property as the key, containing strings with the value of the requested properties. Each list's order corresponds to other lists.

selectObjectsFrom

public static Map<String,List<Object>> selectObjectsFrom(String namespace,
                                                         String wmiClass,
                                                         String properties,
                                                         String whereClause,
                                                         WmiUtil.ValueType[] propertyTypes)

Get multiple individually typed values from WMI

Parameters:

namespace - The namespace or null to use the default

wmiClass - The class to query

properties - A comma delimited list of properties whose value to return

whereClause - A WQL where clause matching properties and keywords

propertyTypes - An array of types corresponding to the properties, or a single element array

Returns:

A map, with each property as the key, containing Objects with the value of the requested properties. Each list's order corresponds to other lists. The type of the objects is identified by the propertyTypes array. If only one propertyType is given, all Objects will have that type. It is the responsibility of the caller to cast the returned objects.