Nested and Inner Type Summary

Modifier and Type	Class and Description
private static enum	WbemcliUtil.NamespaceProperty Enum containing the property used for WMI Namespace query.
public static class	WbemcliUtil.WmiQuery<T extends Enum<T>> Helper class wrapping information required for a WMI query.
public class	WbemcliUtil.WmiResult<T extends Enum<T>> Helper class wrapping an EnumMap containing the results of a query.

Field Summary

Modifier and Type	Field and Description
public static final String	DEFAULT_NAMESPACE The default namespace for most WMI queries.
public static final WbemcliUtil	INSTANCE Instance to generate the WmiQuery class.

Constructor Summary

Access	Constructor and Description
public	WbemcliUtil()

Method Summary

Modifier and Type	Method and Description
public static Wbemcli.IWbemServices	Returns: A service representing the connected namespace, which can be queried. This service may be re-used for multiple queries and should be released by the user connectServer(String The namespace to connect to namespace) Obtains a locator to the WMI server and connects to the specified namespace
public static boolean	Returns: true if the namespace exists, false otherwise hasNamespace(String The namespace to test namespace) Determine if WMI has the requested namespace.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

DEFAULT_NAMESPACE	back to summary
public static final String DEFAULT_NAMESPACE The default namespace for most WMI queries.

INSTANCE	back to summary
public static final WbemcliUtil INSTANCE Instance to generate the WmiQuery class.

Constructor Detail

WbemcliUtil	back to summary
public WbemcliUtil()

Method Detail

connectServer	back to summary
public static Wbemcli.IWbemServices connectServer(String namespace) Obtains a locator to the WMI server and connects to the specified namespace Parameters namespace:String The namespace to connect to Returns:Wbemcli.IWbemServices A service representing the connected namespace, which can be queried. This service may be re-used for multiple queries and should be released by the user

connectServer

back to summary

public static Wbemcli.IWbemServices connectServer(String namespace)

Obtains a locator to the WMI server and connects to the specified namespace

Parameters

namespace:String: The namespace to connect to

Returns:Wbemcli.IWbemServices

A service representing the connected namespace, which can be queried. This service may be re-used for multiple queries and should be released by the user

hasNamespace	back to summary
public static boolean hasNamespace(String namespace) Determine if WMI has the requested namespace. Some namespaces only exist on newer versions of Windows. Parameters namespace:String The namespace to test Returns:boolean true if the namespace exists, false otherwise

hasNamespace

back to summary

public static boolean hasNamespace(String namespace)

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

Parameters

namespace:String: The namespace to test

Returns:boolean

true if the namespace exists, false otherwise

com.sun.jna.platform.win32.COM back to summary

private final Enum WbemcliUtil.NamespaceProperty

Class Inheritance

extends Enum<WbemcliUtil.NamespaceProperty>

java.lang.Object
java.lang.Enum
com.sun.jna.platform.win32.COM.WbemcliUtil.NamespaceProperty

Enum containing the property used for WMI Namespace query.

Field Summary

Modifier and Type	Field and Description
public static final WbemcliUtil.NamespaceProperty	NAME

Constructor Summary

Access	Constructor and Description
private	NamespaceProperty()

Method Summary

Modifier and Type	Method and Description
public static WbemcliUtil.NamespaceProperty	valueOf(String name)
public static WbemcliUtil.NamespaceProperty[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

NAME	back to summary
public static final WbemcliUtil.NamespaceProperty NAME

Constructor Detail

NamespaceProperty	back to summary
private NamespaceProperty()

Method Detail

valueOf	back to summary
public static WbemcliUtil.NamespaceProperty valueOf(String name)

values	back to summary
public static WbemcliUtil.NamespaceProperty[] values()

com.sun.jna.platform.win32.COM back to summary

public Class WbemcliUtil.WmiQuery<T extends java.lang.Enum<T>>

Class Inheritance

extends Object

java.lang.Object
com.sun.jna.platform.win32.COM.WbemcliUtil.WmiQuery

Helper class wrapping information required for a WMI query.

Field Summary

Modifier and Type	Field and Description
private String	nameSpace
private Class<T>	propertyEnum
private String	wmiClassName

Constructor Summary

Access	Constructor and Description
public	WmiQuery(String The WMI namespace to use. nameSpace, String The WMI class to use. Optionally include a WQL WHERE clause with filters results to properties matching the input. wmiClassName, Class<T> An enum for type mapping. propertyEnum) Instantiate a WmiQuery.
public	WmiQuery(String The WMI Class to use. May include a WHERE clause with filtering conditions. wmiClassName, Class<T> An Enum that contains the properties to query propertyEnum) Instantiate a WMI Query in the default namespace

Method Summary

Modifier and Type	Method and Description
private static <T extends Enum<T>> WbemcliUtil.WmiResult<T>	Returns: A WmiResult object encapsulating an EnumMap which will hold the results. Values, that are not supported by this helper (`Dispatch`, `Unknown`, `SAFEARRAY`) are not returned and reported as `null`. enumerateProperties(Wbemcli.IEnumWbemClassObject The enumerator with the results enumerator, Class<T> The enum containing the properties to enumerate, which are the keys to the WmiResult map propertyEnum, int Number of milliseconds to wait for results before timing out. If `IEnumWbemClassObject#WBEM_INFINITE` (-1), will always wait for results. timeout) Enumerate the results of a WMI query.
public WbemcliUtil.WmiResult<T>	Returns: a WmiResult object containing the query results, wrapping an EnumMap execute() Query WMI for values, with no timeout.
public WbemcliUtil.WmiResult<T>	Returns: a WmiResult object containing the query results, wrapping an EnumMap execute(int Number of milliseconds to wait for results before timing out. If `IEnumWbemClassObject#WBEM_INFINITE` (-1), will always wait for results. If a timeout occurs, throws a `TimeoutException`. timeout) Query WMI for values, with a specified timeout.
public String	Returns: The namespace getNameSpace()
public Class<T>	Returns: The enum containing the properties getPropertyEnum()
public String	Returns: The class name getWmiClassName()
private static <T extends Enum<T>> Wbemcli.IEnumWbemClassObject	Returns: An enumerator to receive the results of the query selectProperties(Wbemcli.IWbemServices A WbemServices object to make the calls svc, WbemcliUtil.WmiQuery<T> A WmiQuery object encapsulating the details of the query query) Selects properties from WMI.
public void	setNameSpace(String The namespace to set nameSpace)
public void	setWmiClassName(String The classname to set wmiClassName)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

nameSpace	back to summary
private String nameSpace

propertyEnum	back to summary
private Class<T> propertyEnum

wmiClassName	back to summary
private String wmiClassName

Constructor Detail

WmiQuery	back to summary
public WmiQuery(String nameSpace, String wmiClassName, Class<T> propertyEnum) Instantiate a WmiQuery. Parameters nameSpace:String The WMI namespace to use. wmiClassName:String The WMI class to use. Optionally include a WQL WHERE clause with filters results to properties matching the input. propertyEnum:Class<T> An enum for type mapping.

WmiQuery

back to summary

public WmiQuery(String nameSpace, String wmiClassName, Class<T> propertyEnum)

Instantiate a WmiQuery.

Parameters

nameSpace:String: The WMI namespace to use.
wmiClassName:String: The WMI class to use. Optionally include a WQL WHERE clause with filters results to properties matching the input.
propertyEnum:Class<T>: An enum for type mapping.

WmiQuery	back to summary
public WmiQuery(String wmiClassName, Class<T> propertyEnum) Instantiate a WMI Query in the default namespace Parameters wmiClassName:String The WMI Class to use. May include a WHERE clause with filtering conditions. propertyEnum:Class<T> An Enum that contains the properties to query

WmiQuery

back to summary

public WmiQuery(String wmiClassName, Class<T> propertyEnum)

Instantiate a WMI Query in the default namespace

Parameters

wmiClassName:String: The WMI Class to use. May include a WHERE clause with filtering conditions.
propertyEnum:Class<T>: An Enum that contains the properties to query

Method Detail

enumerateProperties back to summary

enumerateProperties	back to summary
private static <T extends Enum<T>> WbemcliUtil.WmiResult<T> enumerateProperties(Wbemcli.IEnumWbemClassObject enumerator, Class<T> propertyEnum, int timeout) throws TimeoutException Enumerate the results of a WMI query. This method is called while results are still being retrieved and may iterate in the forward direction only. Parameters enumerator:Wbemcli.IEnumWbemClassObject The enumerator with the results propertyEnum:Class<T> The enum containing the properties to enumerate, which are the keys to the WmiResult map timeout:int Number of milliseconds to wait for results before timing out. If `IEnumWbemClassObject#WBEM_INFINITE` (-1), will always wait for results. Returns:WbemcliUtil.WmiResult<T> A WmiResult object encapsulating an EnumMap which will hold the results. Values, that are not supported by this helper (`Dispatch`, `Unknown`, `SAFEARRAY`) are not returned and reported as `null`. Exceptions TimeoutException: if the query times out before completion

private static <T extends Enum<T>> WbemcliUtil.WmiResult<T> enumerateProperties(Wbemcli.IEnumWbemClassObject enumerator, Class<T> propertyEnum, int timeout) throws TimeoutException

Enumerate the results of a WMI query. This method is called while results are still being retrieved and may iterate in the forward direction only.

Parameters

enumerator:Wbemcli.IEnumWbemClassObject: The enumerator with the results
propertyEnum:Class<T>: The enum containing the properties to enumerate, which are the keys to the WmiResult map
timeout:int: Number of milliseconds to wait for results before timing out. If IEnumWbemClassObject#WBEM_INFINITE (-1), will always wait for results.

Returns:WbemcliUtil.WmiResult<T>

A WmiResult object encapsulating an EnumMap which will hold the results. Values, that are not supported by this helper (Dispatch, Unknown, SAFEARRAY) are not returned and reported as null.

Exceptions

TimeoutException:: if the query times out before completion

execute	back to summary
public WbemcliUtil.WmiResult<T> execute() Query WMI for values, with no timeout. Returns:WbemcliUtil.WmiResult<T> a WmiResult object containing the query results, wrapping an EnumMap

execute

back to summary

public WbemcliUtil.WmiResult<T> execute()

Query WMI for values, with no timeout.

Returns:WbemcliUtil.WmiResult<T>: a WmiResult object containing the query results, wrapping an EnumMap

execute back to summary

execute	back to summary
public WbemcliUtil.WmiResult<T> execute(int timeout) throws TimeoutException Query WMI for values, with a specified timeout. Parameters timeout:int Number of milliseconds to wait for results before timing out. If `IEnumWbemClassObject#WBEM_INFINITE` (-1), will always wait for results. If a timeout occurs, throws a `TimeoutException`. Returns:WbemcliUtil.WmiResult<T> a WmiResult object containing the query results, wrapping an EnumMap Exceptions TimeoutException: if the query times out before completion

public WbemcliUtil.WmiResult<T> execute(int timeout) throws TimeoutException

Query WMI for values, with a specified timeout.

Parameters

timeout:int: Number of milliseconds to wait for results before timing out. If IEnumWbemClassObject#WBEM_INFINITE (-1), will always wait for results. If a timeout occurs, throws a TimeoutException.

Returns:WbemcliUtil.WmiResult<T>

a WmiResult object containing the query results, wrapping an EnumMap

Exceptions

TimeoutException:: if the query times out before completion

getNameSpace	back to summary
public String getNameSpace() Returns:String The namespace

getPropertyEnum	back to summary
public Class<T> getPropertyEnum() Returns:Class<T> The enum containing the properties

getWmiClassName	back to summary
public String getWmiClassName() Returns:String The class name

selectProperties	back to summary
private static <T extends Enum<T>> Wbemcli.IEnumWbemClassObject selectProperties(Wbemcli.IWbemServices svc, WbemcliUtil.WmiQuery<T> query) Selects properties from WMI. Returns immediately (asynchronously), even while results are being retrieved; results may begun to be enumerated in the forward direction only. Parameters svc:Wbemcli.IWbemServices A WbemServices object to make the calls query:WbemcliUtil.WmiQuery<T> A WmiQuery object encapsulating the details of the query Returns:Wbemcli.IEnumWbemClassObject An enumerator to receive the results of the query

selectProperties

back to summary

private static <T extends Enum<T>> Wbemcli.IEnumWbemClassObject selectProperties(Wbemcli.IWbemServices svc, WbemcliUtil.WmiQuery<T> query)

Selects properties from WMI. Returns immediately (asynchronously), even while results are being retrieved; results may begun to be enumerated in the forward direction only.

Parameters

svc:Wbemcli.IWbemServices: A WbemServices object to make the calls
query:WbemcliUtil.WmiQuery<T>: A WmiQuery object encapsulating the details of the query

Returns:Wbemcli.IEnumWbemClassObject

An enumerator to receive the results of the query

setNameSpace	back to summary
public void setNameSpace(String nameSpace) Parameters nameSpace:String The namespace to set

setWmiClassName	back to summary
public void setWmiClassName(String wmiClassName) Parameters wmiClassName:String The classname to set

com.sun.jna.platform.win32.COM back to summary

public Class WbemcliUtil.WmiResult<T extends java.lang.Enum<T>>

Class Inheritance

extends Object

java.lang.Object
com.sun.jna.platform.win32.COM.WbemcliUtil.WmiResult

Helper class wrapping an EnumMap containing the results of a query.

Field Summary

Modifier and Type	Field and Description
private Map<T, Integer>	cimTypeMap
private Map<T, List<Object>>	propertyMap
private int	resultCount
private Map<T, Integer>	vtTypeMap

Constructor Summary

Access	Constructor and Description
public	WmiResult(Class<T> The enum associated with this map propertyEnum)

Method Summary

Modifier and Type	Method and Description
private void	add(int The Variant type of this object vtType, int The CIM type of this property cimType, T The property (column) to store property, Object The object to store o) Adds a value to the WmiResult at the next index for that property
public int	Returns: An integer representing the CIM type getCIMType(T The property (column) whose type to fetch property) Gets the CIM type from the WmiResult.
public int	Returns: The number of results in each mapped list getResultCount()
public Object	Returns: The Object containing the specified value, which may be null getValue(T The property (column) to fetch property, int The index (row) to fetch index) Gets a value from the WmiResult, which may be null.
public int	Returns: An integer representing the Variant type getVtType(T The property (column) whose type to fetch property) Gets the Variant type from the WmiResult.
private void	incrementResultCount() Increment the result count by one.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

cimTypeMap	back to summary
private Map<T, Integer> cimTypeMap

propertyMap	back to summary
private Map<T, List<Object>> propertyMap

resultCount	back to summary
private int resultCount

vtTypeMap	back to summary
private Map<T, Integer> vtTypeMap

Constructor Detail

WmiResult	back to summary
public WmiResult(Class<T> propertyEnum) Parameters propertyEnum:Class<T> The enum associated with this map

Method Detail

add	back to summary
private void add(int vtType, int cimType, T property, Object o) Adds a value to the WmiResult at the next index for that property Parameters vtType:int The Variant type of this object cimType:int The CIM type of this property property:T The property (column) to store o:Object The object to store

add

back to summary

private void add(int vtType, int cimType, T property, Object o)

Adds a value to the WmiResult at the next index for that property

Parameters

vtType:int: The Variant type of this object
cimType:int: The CIM type of this property
property:T: The property (column) to store
o:Object: The object to store

getCIMType back to summary

getCIMType	back to summary
public int getCIMType(T property) Gets the CIM type from the WmiResult. The integer value is defined as a CIM_* constant in the `Wbemcli` interface. Parameters property:T The property (column) whose type to fetch Returns:int An integer representing the CIM type

public int getCIMType(T property)

Gets the CIM type from the WmiResult. The integer value is defined as a CIM_* constant in the Wbemcli interface.

Parameters

property:T: The property (column) whose type to fetch

Returns:int

An integer representing the CIM type

getResultCount	back to summary
public int getResultCount() Returns:int The number of results in each mapped list

getValue back to summary

getValue	back to summary
public Object getValue(T property, int index) Gets a value from the WmiResult, which may be null. User must check for null and cast the result. Types correlate to the CIM Type of the enumerated WMI property and will be consistent for a given property, and may be validated by the user using `getVtType` or the Class of the returned Object. Parameters property:T The property (column) to fetch index:int The index (row) to fetch Returns:Object The Object containing the specified value, which may be null

public Object getValue(T property, int index)

Gets a value from the WmiResult, which may be null. User must check for null and cast the result. Types correlate to the CIM Type of the enumerated WMI property and will be consistent for a given property, and may be validated by the user using getVtType or the Class of the returned Object.

Parameters

property:T: The property (column) to fetch
index:int: The index (row) to fetch

Returns:Object

The Object containing the specified value, which may be null

getVtType back to summary

getVtType	back to summary
public int getVtType(T property) Gets the Variant type from the WmiResult. The integer value is defined as a VT_* constant in the `com.sun.jna.platform.win32.Variant` interface. Parameters property:T The property (column) whose type to fetch Returns:int An integer representing the Variant type

public int getVtType(T property)

Gets the Variant type from the WmiResult. The integer value is defined as a VT_* constant in the com.sun.jna.platform.win32.Variant interface.

Parameters

property:T: The property (column) whose type to fetch

Returns:int

An integer representing the Variant type

incrementResultCount	back to summary
private void incrementResultCount() Increment the result count by one.