Package com.vmware.vim25.mo

Class InventoryNavigator

java.lang.Object

com.vmware.vim25.mo.InventoryNavigator

public class InventoryNavigator
extends Object

Locate ManagedEntity objects under a root folder. Supports two modes:

• Find-only (searchManagedEntities(String) and friends) — returns entities whose subsequent property reads round-trip to the server.
• Find-and-fetch (searchManagedEntitiesWithProperties(String[][], boolean)) — single round-trip that returns entities with the requested properties pre-cached; subsequent reads of those properties via typed getters are served from the cache.

Constructor Summary

Constructors

Constructor	Description
InventoryNavigator(ManagedEntity rootEntity)

Method Summary

Modifier and Type	Method	Description
ManagedEntity[]	searchManagedEntities(boolean recurse)	Retrieve container contents from specified parent recursively if requested.
ManagedEntity[]	searchManagedEntities(String type)	Get the first ManagedObjectReference from current node for the specified type
ManagedEntity[]	searchManagedEntities(String[][] typeinfo, boolean recurse)	Retrieve content recursively with multiple properties.
ManagedEntity[]	searchManagedEntitiesWithProperties(String[][] typeinfo, boolean recurse)	Like searchManagedEntities(String[][], boolean) but pre-populates each returned entity's property cache with the requested values.
ManagedEntity	searchManagedEntity(String type, String name)	Get the ManagedObjectReference for an item under the specified parent node that has the type and name specified.

Methods inherited from class java.lang.Object

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

Constructor Details

InventoryNavigator

public InventoryNavigator(ManagedEntity rootEntity)

Method Details

searchManagedEntities

public ManagedEntity[] searchManagedEntities(boolean recurse)
                                      throws InvalidProperty,
RuntimeFault,
RemoteException

Retrieve container contents from specified parent recursively if requested.

Parameters:

recurse - retrieve contents recursively from the root down

Throws:

RemoteException

RuntimeFault

InvalidProperty

searchManagedEntities

public ManagedEntity[] searchManagedEntities(String type)
                                      throws InvalidProperty,
RuntimeFault,
RemoteException

Get the first ManagedObjectReference from current node for the specified type

Throws:

InvalidProperty

RuntimeFault

RemoteException

searchManagedEntities

public ManagedEntity[] searchManagedEntities(String[][] typeinfo,
 boolean recurse)
                                      throws InvalidProperty,
RuntimeFault,
RemoteException

Retrieve content recursively with multiple properties. The typeinfo array contains {typename, prop1, prop2, ...} per type.

Note: the requested property values are fetched from the server but discarded — only the entities are returned, and subsequent calls to entity getters round-trip to the server again. To keep the property values, use searchManagedEntitiesWithProperties(String[][], boolean) instead.

Parameters:

typeinfo - 2D array of properties for each typename

recurse - retrieve contents recursively from the root down

Returns:

matching entities (without cached properties)

Throws:

InvalidProperty

RuntimeFault

RemoteException

searchManagedEntitiesWithProperties

public ManagedEntity[] searchManagedEntitiesWithProperties(String[][] typeinfo,
 boolean recurse)
                                                    throws InvalidProperty,
RuntimeFault,
RemoteException

Like searchManagedEntities(String[][], boolean) but pre-populates each returned entity's property cache with the requested values. Reading a cached property via the entity's typed getter (e.g. vm.getName()) returns the cached value without contacting the server. Reads of properties that weren't requested fall through to the server as usual.

Cached values do not refresh — long-lived entities will return stale data if the underlying property changes on the server. For polling use cases, re-run the search.

Single round-trip equivalent of:

 ManagedEntity[] mes = nav.searchManagedEntities(typename);
 Hashtable<String, Object>[] props = PropertyCollectorUtil.retrieveProperties(mes, typename, propNames);
 

Parameters:

typeinfo - 2D array of {typename, prop1, prop2, ...} per type

recurse - retrieve contents recursively from the root down

Throws:

InvalidProperty

RuntimeFault

RemoteException

searchManagedEntity

public ManagedEntity searchManagedEntity(String type,
 String name)
                                  throws InvalidProperty,
RuntimeFault,
RemoteException

Get the ManagedObjectReference for an item under the specified parent node that has the type and name specified.

Parameters:

type - type of the managed object

name - name to match

Returns:

First ManagedEntity object of the type / name pair found

Throws:

RemoteException

RuntimeFault

InvalidProperty