com.vmware.vim25.mo.InventoryNavigator Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of yavijava Show documentation
Java library for VMware vSphere
There is a newer version: 6.0.05
package com.vmware.vim25.mo;

import com.vmware.vim25.*;
import com.vmware.vim25.mo.util.MorUtil;
import com.vmware.vim25.mo.util.PropertyCollectorUtil;
import org.apache.log4j.Logger;

import java.rmi.RemoteException;

public class InventoryNavigator {
    private ManagedEntity rootEntity = null;
    private SelectionSpec[] selectionSpecs = null;

    private static Logger log = Logger.getLogger(InventoryNavigator.class);

    public InventoryNavigator(ManagedEntity rootEntity) {
        this.rootEntity = rootEntity;
    }

    /**
     * Retrieve container contents from specified parent recursively if requested.
     *
     * @param recurse retrieve contents recursively from the root down
     * @throws RemoteException
     * @throws RuntimeFault
     * @throws InvalidProperty
     */
    public ManagedEntity[] searchManagedEntities(boolean recurse) throws InvalidProperty, RuntimeFault, RemoteException {
        String[][] typeinfo = new String[][]{new String[]{"ManagedEntity",}};
        return searchManagedEntities(typeinfo, recurse);
    }

    /**
     * Get the first ManagedObjectReference from current node for the specified type
     */
    public ManagedEntity[] searchManagedEntities(String type) throws InvalidProperty, RuntimeFault, RemoteException {
        String[][] typeinfo = new String[][]{new String[]{type, "name",},};
        return searchManagedEntities(typeinfo, true);
    }

    /**
     * Retrieve content recursively with multiple properties.
     * the typeinfo array contains typename + properties to retrieve.
     *
     * @param typeinfo 2D array of properties for each typename
     * @param recurse  retrieve contents recursively from the root down
     * @return retrieved object contents
     * @throws RemoteException
     * @throws RuntimeFault
     * @throws InvalidProperty
     */
    public ManagedEntity[] searchManagedEntities(String[][] typeinfo, boolean recurse) throws InvalidProperty, RuntimeFault, RemoteException {
        ObjectContent[] ocs = retrieveObjectContents(typeinfo, recurse);
        return createManagedEntities(ocs);
    }

    private ObjectContent[] retrieveObjectContents(String[][] typeinfo, boolean recurse) throws InvalidProperty, RuntimeFault, RemoteException {
        if (typeinfo == null || typeinfo.length == 0) {
            return null;
        }

        PropertyCollector pc = rootEntity.getServerConnection().getServiceInstance().getPropertyCollector();

        if (recurse && selectionSpecs == null) {
            AboutInfo ai = rootEntity.getServerConnection().getServiceInstance().getAboutInfo();

            //The apiVersion values in all the shipped products
            //  "2.0.0"    VI 3.0
            //  "2.5.0"    VI 3.5 (and u1)
            //  "2.5u2"   VI 3.5u2 (and u3, u4)
            //  "4.0"       vSphere 4.0 (and u1)
            //  "4.1"       vSphere 4.1
            //  "5.0"       vSphere 5.0
            String[] versionArray = ai.apiVersion.split("\\.");
            int majorVersion;
            try {
                majorVersion = Integer.parseInt(versionArray[0]);
            }
            catch (NumberFormatException ignore) {
                majorVersion = 0;
            }
            if (majorVersion >= 4) {
                log.debug("API version >= 4 detected. Using buildFullTraversalV4.");
                selectionSpecs = PropertyCollectorUtil.buildFullTraversalV4();
            }
            else {
                log.debug("API version < 4 detected. Using buildFullTraversal");
                selectionSpecs = PropertyCollectorUtil.buildFullTraversal();
            }
        }

        PropertySpec[] propspecary = PropertyCollectorUtil.buildPropertySpecArray(typeinfo);

        ObjectSpec os = new ObjectSpec();
        os.setObj(rootEntity.getMOR());
        os.setSkip(Boolean.FALSE);
        os.setSelectSet(selectionSpecs);

        PropertyFilterSpec spec = new PropertyFilterSpec();
        spec.setObjectSet(new ObjectSpec[]{os});
        spec.setPropSet(propspecary);

        return pc.retrieveProperties(new PropertyFilterSpec[]{spec});
    }

    private ManagedEntity[] createManagedEntities(ObjectContent[] ocs) {
        if (ocs == null) {
            return new ManagedEntity[]{};
        }
        ManagedEntity[] mes = new ManagedEntity[ocs.length];

        for (int i = 0; i < mes.length; i++) {
            ManagedObjectReference mor = ocs[i].getObj();
            mes[i] = MorUtil.createExactManagedEntity(rootEntity.getServerConnection(), mor);
        }
        return mes;
    }

    /**
     * Get the ManagedObjectReference for an item under the
     * specified parent node that has the type and name specified.
     *
     * @param type type of the managed object
     * @param name name to match
     * @return First ManagedEntity object of the type / name pair found
     * @throws RemoteException
     * @throws RuntimeFault
     * @throws InvalidProperty
     */
    public ManagedEntity searchManagedEntity(String type, String name) throws InvalidProperty, RuntimeFault, RemoteException {
        if (name == null || name.length() == 0) {
            return null;
        }

        if (type == null) {
            type = "ManagedEntity";
        }

        String[][] typeinfo = new String[][]{new String[]{type, "name",},};

        ObjectContent[] ocs = retrieveObjectContents(typeinfo, true);

        if (ocs == null || ocs.length == 0) {
            return null;
        }

        for (int i = 0; i < ocs.length; i++) {
            DynamicProperty[] propSet = ocs[i].getPropSet();

            if (propSet.length > 0) {
                String nameInPropSet = (String) propSet[0].getVal();
                if (name.equalsIgnoreCase(nameInPropSet)) {
                    ManagedObjectReference mor = ocs[i].getObj();
                    return MorUtil.createExactManagedEntity(rootEntity.getServerConnection(), mor);
                }
            }
        }
        return null;
    }

}