Class GuestOS

java.lang.Object

com.ibm.virtualization.management.internal.GuestOS

All Implemented Interfaces:

GuestOSMXBean, PlatformManagedObject

public final class GuestOS
extends Object
implements GuestOSMXBean

Runtime type for GuestOSMXBean.

Implements retrieving Guest (Virtual Machine(VM)/Logical Partition(LPAR)) Processor and Memory usage statistics from the Hypervisor Host.

Since:

1.7.1

Method Summary

Modifier and Type	Method	Description
static GuestOS	getInstance()	Singleton accessor method.
ObjectName	getObjectName()	Returns the object name of the MXBean.
GuestOSMemoryUsage	retrieveMemoryUsage()	Function instantiates a GuestOSMemoryUsage object and populates it with the current snapshot of Memory Usage statistics of the Guest as seen by the Hypervisor.
GuestOSMemoryUsage	retrieveMemoryUsage(GuestOSMemoryUsage gmUsage)	Snapshot of the Guest Memory usage statistics as seen by the Hypervisor, returned as a GuestOSMemoryUsage object.
GuestOSProcessorUsage	retrieveProcessorUsage()	Function instantiates a GuestOSProcessorUsage object and populates it with the current snapshot of Processor Usage statistics of the Guest as seen by the Hypervisor.
GuestOSProcessorUsage	retrieveProcessorUsage(GuestOSProcessorUsage gpUsage)	Snapshot of the Guest Processor usage statistics as seen by the Hypervisor, returned as a GuestOSProcessorUsage object.

Methods declared in class Object

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

Method Details

getInstance

public static GuestOS getInstance()

Singleton accessor method.

Returns:

the GuestOS singleton.

getObjectName

public ObjectName getObjectName()

Returns the object name of the MXBean.

Specified by:

getObjectName in interface PlatformManagedObject

Returns:

objectName representing the MXBean.

retrieveProcessorUsage

public GuestOSProcessorUsage retrieveProcessorUsage()
                                             throws GuestOSInfoRetrievalException

Function instantiates a GuestOSProcessorUsage object and populates it with the current snapshot of Processor Usage statistics of the Guest as seen by the Hypervisor. The statistics are an aggregate across all physical CPUs assigned to the Guest by the Hypervisor.

Specified by:

retrieveProcessorUsage in interface GuestOSMXBean

Returns:

The new GuestOSProcessorUsage object.

Throws:

GuestOSInfoRetrievalException - if it failed to obtain usage statistics.

In case of an exception, the handler code can use toString() on the exception code to obtain a description of the exception.

retrieveProcessorUsage

public GuestOSProcessorUsage retrieveProcessorUsage(GuestOSProcessorUsage gpUsage)
                                             throws NullPointerException,
GuestOSInfoRetrievalException

Snapshot of the Guest Processor usage statistics as seen by the Hypervisor, returned as a GuestOSProcessorUsage object. The statistics are an aggregate across all physical CPUs assigned to the Guest by the Hypervisor.

Specified by:

retrieveProcessorUsage in interface GuestOSMXBean

Parameters:

gpUsage - User provided GuestOSProcessorUsage object.

Returns:

The updated GuestOSProcessorUsage object.

Throws:

NullPointerException - if a null reference is passed.

GuestOSInfoRetrievalException - if it failed to obtain usage statistics.

In case of an exception, the handler code can use toString() on the exception code to obtain a description of the exception.

retrieveMemoryUsage

public GuestOSMemoryUsage retrieveMemoryUsage()
                                       throws GuestOSInfoRetrievalException

Function instantiates a GuestOSMemoryUsage object and populates it with the current snapshot of Memory Usage statistics of the Guest as seen by the Hypervisor.

Specified by:

retrieveMemoryUsage in interface GuestOSMXBean

Returns:

The new GuestOSMemoryUsage object.

Throws:

GuestOSInfoRetrievalException - if it failed to obtain usage statistics.

In case of an exception, the handler code can use toString() on the exception code to obtain a description of the exception.

retrieveMemoryUsage

public GuestOSMemoryUsage retrieveMemoryUsage(GuestOSMemoryUsage gmUsage)
                                       throws NullPointerException,
GuestOSInfoRetrievalException

Snapshot of the Guest Memory usage statistics as seen by the Hypervisor, returned as a GuestOSMemoryUsage object.

Specified by:

retrieveMemoryUsage in interface GuestOSMXBean

Parameters:

gmUsage - User provided GuestOSMemoryUsage object.

Returns:

The updated GuestOSMemoryUsage object.

Throws:

NullPointerException - if a null reference is passed.

GuestOSInfoRetrievalException - if it failed to obtain usage statistics.

In case of an exception, the handler code can use toString() on the exception code to obtain a description of the exception.