io.cloudslang.content.vmware.services.helpers.GetObjectProperties Maven / Gradle / Ivy

Go to download
/*
 * (c) Copyright 2017 EntIT Software LLC, a Micro Focus company, L.P.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Apache License v2.0 which accompany this distribution.
 *
 * The Apache License is available at
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package io.cloudslang.content.vmware.services.helpers;

import com.vmware.vim25.InvalidPropertyFaultMsg;
import com.vmware.vim25.ManagedObjectReference;
import com.vmware.vim25.ObjectContent;
import com.vmware.vim25.ObjectSpec;
import com.vmware.vim25.PropertyFilterSpec;
import com.vmware.vim25.PropertySpec;
import com.vmware.vim25.RetrieveOptions;
import com.vmware.vim25.RetrieveResult;
import com.vmware.vim25.RuntimeFaultFaultMsg;
import com.vmware.vim25.ServiceContent;
import com.vmware.vim25.VimPortType;
import io.cloudslang.content.vmware.connection.ConnectionResources;
import org.jetbrains.annotations.NotNull;

import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;

/**
 * Created by Mihai Tusa.
 * 1/15/2016.
 */
public class GetObjectProperties {

    private GetObjectProperties() {}

    /**
     * Retrieve contents for a single object based on the property collector
     * registered with the service.
     *
     * @param mor        Managed Object Reference to get contents for
     * @param properties names of properties of object to retrieve
     * @return retrieved object contents
     */
    @NotNull
    public static ObjectContent[] getObjectProperties(ConnectionResources connectionResources,
                                                      ManagedObjectReference mor,
                                                      String[] properties)
            throws RuntimeFaultFaultMsg, InvalidPropertyFaultMsg {
        if (mor == null) {
            return new ObjectContent[0];
        }

        PropertyFilterSpec spec = new PropertyFilterSpec();
        spec.getPropSet().add(new PropertySpec());

        if ((properties == null || properties.length == 0)) {
            spec.getPropSet().get(0).setAll(true);
        } else {
            spec.getPropSet().get(0).setAll(false);
        }

        spec.getPropSet().get(0).setType(mor.getType());
        spec.getPropSet().get(0).getPathSet().addAll(Arrays.asList(properties));
        spec.getObjectSet().add(new ObjectSpec());
        spec.getObjectSet().get(0).setObj(mor);
        spec.getObjectSet().get(0).setSkip(false);

        List propertyFilterSpecs = new ArrayList<>(1);
        propertyFilterSpecs.add(spec);
        List objectContentList = retrievePropertiesAllObjects(connectionResources, propertyFilterSpecs);

        return objectContentList.toArray(new ObjectContent[objectContentList.size()]);
    }

    @NotNull
    public static ObjectContent getObjectProperty(final ConnectionResources connectionResources,
                                                  final ManagedObjectReference mor,
                                                  final String property) throws Exception {
        final ObjectContent[] objectContents = getObjectProperties(connectionResources, mor, new String[]{property});
        if (objectContents.length != 0 && objectContents[0] != null) {
            return objectContents[0]; //not the best solution, but life is too short. It's not because of management! Nooooo
        } else {
            throw new Exception();
        }
    }

    /**
     * Uses the new RetrievePropertiesEx method to emulate the now deprecated
     * RetrieveProperties method
     *
     * @param propertyFilterSpecList
     * @return list of object content
     * @throws Exception
     */
    private static List retrievePropertiesAllObjects(ConnectionResources connectionResources,
                                                                   List propertyFilterSpecList)
            throws RuntimeFaultFaultMsg, InvalidPropertyFaultMsg {

        VimPortType vimPort = connectionResources.getVimPortType();
        ManagedObjectReference serviceInstance = connectionResources.getServiceInstance();
        ServiceContent serviceContent = vimPort.retrieveServiceContent(serviceInstance);
        ManagedObjectReference propertyCollectorReference = serviceContent.getPropertyCollector();
        RetrieveOptions propertyObjectRetrieveOptions = new RetrieveOptions();
        List objectContentList = new ArrayList<>();

        RetrieveResult results = vimPort.retrievePropertiesEx(propertyCollectorReference,
                propertyFilterSpecList,
                propertyObjectRetrieveOptions);

        if (results != null && results.getObjects() != null && !results.getObjects().isEmpty()) {
            objectContentList.addAll(results.getObjects());
        }

        String token = null;
        if (results != null && results.getToken() != null) {
            token = results.getToken();
        }

        while (token != null && !token.isEmpty()) {
            results = vimPort.continueRetrievePropertiesEx(propertyCollectorReference, token);
            token = null;
            if (results != null) {
                token = results.getToken();
                if (results.getObjects() != null && !results.getObjects().isEmpty()) {
                    objectContentList.addAll(results.getObjects());
                }
            }
        }

        return objectContentList;
    }
}