com.vmware.vim25.mo
Class ManagedObject

java.lang.Object
  com.vmware.vim25.mo.ManagedObject

Direct Known Subclasses:

AlarmManager, AuthorizationManager, CustomFieldsManager, CustomizationSpecManager, DiagnosticManager, DistributedVirtualSwitchManager, EnvironmentBrowser, EventManager, ExtensibleManagedObject, ExtensionManager, FileManager, GuestAuthManager, GuestFileManager, GuestOperationsManager, GuestProcessManager, HistoryCollector, HostAuthenticationManager, HostAuthenticationStore, HostAutoStartManager, HostBootDeviceSystem, HostCacheConfigurationManager, HostCpuSchedulerSystem, HostDatastoreBrowser, HostDatastoreSystem, HostDateTimeSystem, HostDiagnosticSystem, HostEsxAgentHostManager, HostFirmwareSystem, HostHealthStatusSystem, HostImageConfigManager, HostKernelModuleSystem, HostLocalAccountManager, HostPatchManager, HostPowerSystem, HostSnmpSystem, HttpNfcLease, IpPoolManager, IscsiManager, LicenseAssignmentManager, LicenseManager, LocalizationManager, OptionManager, OvfManager, PerformanceManager, Profile, ProfileComplianceManager, ProfileManager, PropertyCollector, PropertyFilter, ScheduledTaskManager, SearchIndex, ServiceInstance, SessionManager, StorageResourceManager, TaskManager, UserDirectory, View, ViewManager, VirtualDiskManager, VirtualMachineCompatibilityChecker, VirtualMachineProvisioningChecker, VirtualMachineSnapshot

public abstract class ManagedObject
extends Object

This class is intended to provide a wrapper around a managed object class. The abstraction will hide the web service details and make the managed objects OO style in the client side programming. Every managed object class can inherit from this and take advantage of this abstraction.

Author:

Steve JIN (sjin@vmware.com)

Constructor Summary

protected	ManagedObject()
	ManagedObject(ServerConnection serverConnection, ManagedObjectReference mor) Constructor that reuse exiting web service connection Use this contructor when you can re-use existing web service connection.

Method Summary

protected ManagedObjectReference[]	convertMors(ManagedObject[] mos)
protected Object	getCurrentProperty(String propertyName)
protected Datastore[]	getDatastores(String propName)
protected PropertyFilter[]	getFilter(String propName)
protected HostSystem[]	getHosts(String propName)
protected ManagedObject	getManagedObject(String propName)
protected ManagedObject[]	getManagedObjects(String propName)
protected ManagedObject[]	getManagedObjects(String propName, boolean mixedType)
ManagedObjectReference	getMOR() get the ManagedObjectReference object pointing to the managed object
protected Network[]	getNetworks(String propName)
Hashtable	getPropertiesByPaths(String[] propPaths) Get multiple properties by their paths
Object	getPropertyByPath(String propPath)
protected ResourcePool[]	getResourcePools(String propName)
protected ScheduledTask[]	getScheduledTasks(String propName)
ServerConnection	getServerConnection()
protected Task[]	getTasks(String propName)
protected View[]	getViews(String propName)
protected VimPortType	getVimService() Get the web service
protected VirtualMachine[]	getVms(String propName)
protected ObjectContent	retrieveObjectProperties(String[] properties)
protected void	setMOR(ManagedObjectReference mor) Set the ManagedObjectReference object pointing to the managed object
protected void	setServerConnection(ServerConnection sc) Set up the ServerConnection, only when it hasn't been set yet.
String	toString()
protected Object[]	waitForValues(String[] filterProps, String[] endWaitProps, Object[][] expectedVals) Handle Updates for a single object.

Methods inherited from class java.lang.Object

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

Constructor Detail

ManagedObject

protected ManagedObject()

ManagedObject

public ManagedObject(ServerConnection serverConnection,
                     ManagedObjectReference mor)

Constructor that reuse exiting web service connection Use this contructor when you can re-use existing web service connection.

Parameters:

serverConnection -

mor -

Method Detail

setMOR

protected void setMOR(ManagedObjectReference mor)

Set the ManagedObjectReference object pointing to the managed object

getMOR

public ManagedObjectReference getMOR()

get the ManagedObjectReference object pointing to the managed object

Returns:

getVimService

protected VimPortType getVimService()

Get the web service

Returns:

getServerConnection

public ServerConnection getServerConnection()

setServerConnection

protected void setServerConnection(ServerConnection sc)

Set up the ServerConnection, only when it hasn't been set yet.

Parameters:

sc -

retrieveObjectProperties

protected ObjectContent retrieveObjectProperties(String[] properties)

getCurrentProperty

protected Object getCurrentProperty(String propertyName)

Parameters:

propertyName - The property name of current managed object

Returns:

it will return either an array of related data objects, or an data object itself. ManagedObjectReference objects are data objects!!!

Throws:

RemoteException

RuntimeFault

InvalidProperty

getPropertyByPath

public Object getPropertyByPath(String propPath)

getPropertiesByPaths

public Hashtable getPropertiesByPaths(String[] propPaths)
                               throws InvalidProperty,
                                      RuntimeFault,
                                      RemoteException

Get multiple properties by their paths

Parameters:

propPaths - an array of strings for property path

Returns:

a Hashtable holding with the property path as key, and the value.

Throws:

InvalidProperty

RuntimeFault

RemoteException

getManagedObjects

protected ManagedObject[] getManagedObjects(String propName,
                                            boolean mixedType)

getManagedObjects

protected ManagedObject[] getManagedObjects(String propName)

getDatastores

protected Datastore[] getDatastores(String propName)

getNetworks

protected Network[] getNetworks(String propName)

getVms

protected VirtualMachine[] getVms(String propName)

getFilter

protected PropertyFilter[] getFilter(String propName)

getResourcePools

protected ResourcePool[] getResourcePools(String propName)

getTasks

protected Task[] getTasks(String propName)

getScheduledTasks

protected ScheduledTask[] getScheduledTasks(String propName)

getViews

protected View[] getViews(String propName)

getHosts

protected HostSystem[] getHosts(String propName)

getManagedObject

protected ManagedObject getManagedObject(String propName)

waitForValues

protected Object[] waitForValues(String[] filterProps,
                                 String[] endWaitProps,
                                 Object[][] expectedVals)
                          throws InvalidProperty,
                                 RuntimeFault,
                                 RemoteException

Handle Updates for a single object. waits till expected values of properties to check are reached Destroys the ObjectFilter when done.

Parameters:

filterProps - Properties list to filter

endWaitProps - Properties list to check for expected values these be properties of a property in the filter properties list

expectedVals - values for properties to end the wait

Returns:

true indicating expected values were met, and false otherwise

Throws:

RemoteException

RuntimeFault

InvalidProperty

toString

public String toString()

Overrides:

toString in class Object

convertMors

protected ManagedObjectReference[] convertMors(ManagedObject[] mos)