com.vmware.vim25.mo.ServiceInstance 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
/*================================================================================
Copyright (c) 2008 VMware, Inc. All Rights Reserved.

Redistribution and use in source and binary forms, with or without modification, 
are permitted provided that the following conditions are met:

* Redistributions of source code must retain the above copyright notice, 
this list of conditions and the following disclaimer.

* Redistributions in binary form must reproduce the above copyright notice, 
this list of conditions and the following disclaimer in the documentation 
and/or other materials provided with the distribution.

* Neither the name of VMware, Inc. nor the names of its contributors may be used
to endorse or promote products derived from this software without specific prior 
written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND 
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED 
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 
IN NO EVENT SHALL VMWARE, INC. OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, 
INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR 
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, 
WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 
ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 
POSSIBILITY OF SUCH DAMAGE.
================================================================================*/

package com.vmware.vim25.mo;

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

import javax.net.ssl.TrustManager;
import java.net.MalformedURLException;
import java.net.URL;
import java.rmi.RemoteException;
import java.util.Calendar;

/**
 * The managed object class corresponding to the one defined in VI SDK API reference.
 *
 * @author Steve JIN (http://www.doublecloud.org)
 */

public class ServiceInstance extends ManagedObject {
    private ServiceContent serviceContent = null;
    private static Logger log = Logger.getLogger(ServiceInstance.class);
    final static ManagedObjectReference SERVICE_INSTANCE_MOR;
    public final static String VIM25_NAMESPACE = " xmlns=\"urn:vim25\">";
    public final static String VIM20_NAMESPACE = " xmlns=\"urn:vim2\">";

    static {
        SERVICE_INSTANCE_MOR = new ManagedObjectReference();
        SERVICE_INSTANCE_MOR.set_value("ServiceInstance");
        SERVICE_INSTANCE_MOR.setType("ServiceInstance");
    }

    public ServiceInstance(URL url, String username, String password)
        throws RemoteException, MalformedURLException {
        this(url, username, password, false);
    }

    public ServiceInstance(URL url, String username, String password, boolean ignoreCert)
        throws RemoteException, MalformedURLException {
        this(url, username, password, ignoreCert, VIM25_NAMESPACE);
    }

    public ServiceInstance(URL url, String username, String password, TrustManager trustManager)
            throws RemoteException, MalformedURLException {
       this(url, username, password, trustManager, VIM25_NAMESPACE);
    }

    public ServiceInstance(URL url, String username, String password, boolean ignoreCert, String namespace)
        throws RemoteException, MalformedURLException {
        constructServiceInstance(url, username, password, ignoreCert, namespace, 0, 0, null);
    }

    public ServiceInstance(URL url, String username, String password, TrustManager trustManager, String namespace)
            throws RemoteException, MalformedURLException {
        constructServiceInstance(url, username, password, false, namespace, 0, 0, trustManager);
    }

    public ServiceInstance(URL url, String username, String password, int connectTimeout, int readTimeout)
        throws RemoteException, MalformedURLException {
        this(url, username, password, false, connectTimeout, readTimeout);
    }

    public ServiceInstance(URL url, String username, String password, boolean ignoreCert, int connectTimeout, int readTimeout)
            throws RemoteException, MalformedURLException {
        this(url, username, password, ignoreCert, VIM25_NAMESPACE, connectTimeout, readTimeout);
    }

    public ServiceInstance(URL url, String username, String password, TrustManager trustManager, int connectTimeout, int readTimeout)
            throws RemoteException, MalformedURLException {
        this(url, username, password, trustManager, VIM25_NAMESPACE, connectTimeout, readTimeout);
    }

    public ServiceInstance(URL url, String username, String password, boolean ignoreCert, String namespace, int connectTimeout, int readTimeout)
        throws RemoteException, MalformedURLException {
        constructServiceInstance(url, username, password, ignoreCert, namespace, connectTimeout, readTimeout, null);
    }

    public ServiceInstance(URL url, String username, String password, TrustManager trustManager, String namespace, int connectTimeout, int readTimeout)
            throws RemoteException, MalformedURLException {
        constructServiceInstance(url, username, password, false, namespace, connectTimeout, readTimeout, trustManager);
    }

    protected void constructServiceInstance(URL url, String username, String password, boolean ignoreCert, String namespace, int connectTimeout, int readTimeout, TrustManager trustManager)
        throws RemoteException, MalformedURLException {
        if (url == null || username == null) {
            throw new NullPointerException("None of url, username can be null.");
        }

        setMOR(SERVICE_INSTANCE_MOR);

        VimPortType vimService = new VimPortType(url.toString(), ignoreCert);
        vimService.getWsc().setVimNameSpace(namespace);

        vimService.getWsc().setConnectTimeout(connectTimeout);
        vimService.getWsc().setReadTimeout(readTimeout);
        vimService.getWsc().setTrustManager(trustManager);

        serviceContent = retrieveServiceContent(vimService, SERVICE_INSTANCE_MOR);
        vimService.getWsc().setSoapActionOnApiVersion(getApiVersion(serviceContent));
        serviceContent = retrieveServiceContent(vimService, SERVICE_INSTANCE_MOR); //with new SOAP_ACTION
        setServerConnection(new ServerConnection(url, vimService, this));

        UserSession userSession = login(getSessionManager(), username, password, null);
        getServerConnection().setUserSession(userSession);
    }

    public ServiceInstance(URL url, String sessionStr, boolean ignoreCert)
        throws RemoteException, MalformedURLException {
        this(url, sessionStr, ignoreCert, VIM25_NAMESPACE);
    }

    public ServiceInstance(URL url, String sessionStr, TrustManager trustManager)
            throws RemoteException, MalformedURLException {
        this(url, sessionStr, trustManager, VIM25_NAMESPACE);
    }

    // sessionStr format: "vmware_soap_session=\"B3240D15-34DF-4BB8-B902-A844FDF42E85\""
    public ServiceInstance(URL url, String sessionStr, boolean ignoreCert, String namespace)
        throws RemoteException, MalformedURLException {
        constructServiceInstance(url, sessionStr, ignoreCert, namespace, 0, 0, null);
    }

    public ServiceInstance(URL url, String sessionStr, TrustManager trustManager, String namespace)
            throws RemoteException, MalformedURLException {
        constructServiceInstance(url, sessionStr, false, namespace, 0, 0, trustManager);
    }

    public ServiceInstance(URL url, String sessionStr, boolean ignoreCert, int connectTimeout, int readTimeout)
        throws RemoteException, MalformedURLException {
        this(url, sessionStr, ignoreCert, VIM25_NAMESPACE, connectTimeout, readTimeout);
    }

    public ServiceInstance(URL url, String sessionStr, TrustManager trustManager, int connectTimeout, int readTimeout)
            throws RemoteException, MalformedURLException {
        this(url, sessionStr, trustManager, VIM25_NAMESPACE, connectTimeout, readTimeout);
    }

    // sessionStr format: "vmware_soap_session=\"B3240D15-34DF-4BB8-B902-A844FDF42E85\""
    public ServiceInstance(URL url, String sessionStr, boolean ignoreCert, String namespace, int connectTimeout, int readTimeout)
        throws RemoteException, MalformedURLException {
        constructServiceInstance(url, sessionStr, ignoreCert, namespace, connectTimeout, readTimeout, null);
    }

    public ServiceInstance(URL url, String sessionStr, TrustManager trustManager, String namespace, int connectTimeout, int readTimeout)
            throws RemoteException, MalformedURLException {
        constructServiceInstance(url, sessionStr, false, namespace, connectTimeout, readTimeout, trustManager);
    }

    protected void constructServiceInstance(URL url, String sessionStr, boolean ignoreCert, String namespace, int connectTimeout, int readTimeout, TrustManager trustManager)
        throws RemoteException, MalformedURLException {
        if (url == null || sessionStr == null) {
            throw new NullPointerException("None of url, session string can be null.");
        }

        setMOR(SERVICE_INSTANCE_MOR);

        VimPortType vimService = new VimPortType(url.toString(), ignoreCert);
        Client wsc = vimService.getWsc();
        wsc.setCookie(sessionStr);
        wsc.setVimNameSpace(namespace);

        vimService.getWsc().setConnectTimeout(connectTimeout);
        vimService.getWsc().setReadTimeout(readTimeout);
        vimService.getWsc().setTrustManager(trustManager);

        serviceContent = retrieveServiceContent(vimService, SERVICE_INSTANCE_MOR);
        wsc.setSoapActionOnApiVersion(getApiVersion(serviceContent));
        setServerConnection(new ServerConnection(url, vimService, this));
        serviceContent = retrieveServiceContent(vimService, SERVICE_INSTANCE_MOR); //with new SOAP_ACTION
        UserSession userSession = getCurrentUserSession();
        getServerConnection().setUserSession(userSession);
    }

    public ServiceInstance(ServerConnection sc) {
        super(sc, SERVICE_INSTANCE_MOR);
    }

    public Calendar getServerClock() {
        return (Calendar) getCurrentProperty("serverClock");
    }

    public Capability getCapability() {
        return (Capability) getCurrentProperty("capability");
    }

    public ClusterProfileManager getClusterProfileManager() {
        return (ClusterProfileManager) createMO(getServiceContent().getClusterProfileManager());
    }

    public Calendar currentTime() throws RuntimeFault, RemoteException {
        return getVimService().currentTime(getMOR());
    }


    public Folder getRootFolder() {
        return new Folder(this.getServerConnection(), this.getServiceContent().getRootFolder());
    }

    public HostVMotionCompatibility[] queryVMotionCompatibility(VirtualMachine vm, HostSystem[] hosts, String[] compatibility) throws RuntimeFault, RemoteException {
        if (vm == null || hosts == null) {
            throw new IllegalArgumentException("Neither vm or hosts can be null.");
        }
        return getVimService().queryVMotionCompatibility(getMOR(), vm.getMOR(), MorUtil.createMORs(hosts), compatibility);
    }

    public ProductComponentInfo[] retrieveProductComponents() throws RuntimeFault, RemoteException {
        return getVimService().retrieveProductComponents(getMOR());
    }

    protected UserSession login(SessionManager sessionManager, String userName, String password, String locale) throws RemoteException {
        return sessionManager.login(userName, password, locale);
    }

    protected UserSession getCurrentUserSession() {
        return (UserSession) getSessionManager().getCurrentProperty("currentSession");
    }

    protected ServiceContent retrieveServiceContent(VimPortType vimService, ManagedObjectReference mor) throws RemoteException {
        return vimService.retrieveServiceContent(mor);
    }

    protected ServiceContent retrieveServiceContent() throws RuntimeFault, RemoteException {
        return getVimService().retrieveServiceContent(getMOR());
    }

    public Event[] validateMigration(VirtualMachine[] vms, VirtualMachinePowerState state, String[] testType
        , ResourcePool pool, HostSystem host) throws InvalidState, RuntimeFault, RemoteException {
        if (vms == null) {
            throw new IllegalArgumentException("vms must not be null.");
        }

        return getVimService().validateMigration(getMOR(), MorUtil.createMORs(vms), state, testType,
            pool == null ? null : pool.getMOR(), host == null ? null : host.getMOR());
    }

    public ServiceContent getServiceContent() {
        if (serviceContent == null) {
            try {
                serviceContent = retrieveServiceContent();
            }
            catch (Exception e) {
                log.debug("Exception caught trying to retrieveServiceContent.", e);
            }
        }
        return serviceContent;
    }

    public int getConnectTimeout() {
        return getServerConnection().getVimService().getWsc().getConnectTimeout();
    }

    public int getReadTimeout() {
        return getServerConnection().getVimService().getWsc().getReadTimeout();
    }

    public TrustManager getTrustManager() {
        return getServerConnection().getVimService().getWsc().getTrustManager();
    }

    protected String getApiVersion(ServiceContent serviceContent) {
        return serviceContent.getAbout().getApiVersion();
    }

    public AboutInfo getAboutInfo() {
        return getServiceContent().getAbout();
    }

    public AlarmManager getAlarmManager() {
        return (AlarmManager) createMO(getServiceContent().getAlarmManager());
    }

    public AuthorizationManager getAuthorizationManager() {
        return (AuthorizationManager) createMO(getServiceContent().getAuthorizationManager());
    }

    public CustomFieldsManager getCustomFieldsManager() {
        return (CustomFieldsManager) createMO(getServiceContent().getCustomFieldsManager());
    }

    public CustomizationSpecManager getCustomizationSpecManager() {
        return (CustomizationSpecManager) createMO(getServiceContent().getCustomizationSpecManager());
    }

    public EventManager getEventManager() {
        return (EventManager) createMO(getServiceContent().getEventManager());
    }

    public DiagnosticManager getDiagnosticManager() {
        return (DiagnosticManager) createMO(getServiceContent().getDiagnosticManager());
    }

    public DistributedVirtualSwitchManager getDistributedVirtualSwitchManager() {
        return (DistributedVirtualSwitchManager) createMO(getServiceContent().getDvSwitchManager());
    }

    public ExtensionManager getExtensionManager() {
        return (ExtensionManager) createMO(getServiceContent().getExtensionManager());
    }

    public FileManager getFileManager() {
        return (FileManager) createMO(getServiceContent().getFileManager());
    }

    public GuestOperationsManager getGuestOperationsManager() {
        return (GuestOperationsManager) createMO(getServiceContent().getGuestOperationsManager());
    }

    public HostLocalAccountManager getAccountManager() {
        return (HostLocalAccountManager) createMO(getServiceContent().getAccountManager());
    }

    public LicenseManager getLicenseManager() {
        return (LicenseManager) createMO(getServiceContent().getLicenseManager());
    }

    public LocalizationManager getLocalizationManager() {
        return (LocalizationManager) createMO(getServiceContent().getLocalizationManager());
    }

    public PerformanceManager getPerformanceManager() {
        return (PerformanceManager) createMO(getServiceContent().getPerfManager());
    }

    public ProfileComplianceManager getProfileComplianceManager() {
        return (ProfileComplianceManager) createMO(getServiceContent().getComplianceManager());
    }

    public PropertyCollector getPropertyCollector() {
        return (PropertyCollector) createMO(getServiceContent().getPropertyCollector());
    }

    public ScheduledTaskManager getScheduledTaskManager() {
        return (ScheduledTaskManager) createMO(getServiceContent().getScheduledTaskManager());
    }

    public SearchIndex getSearchIndex() {
        return (SearchIndex) createMO(getServiceContent().getSearchIndex());
    }

    public SessionManager getSessionManager() {
        return (SessionManager) createMO(getServiceContent().getSessionManager());
    }

    public HostSnmpSystem getHostSnmpSystem() {
        return (HostSnmpSystem) createMO(getServiceContent().getSnmpSystem());
    }

    public HostProfileManager getHostProfileManager() {
        return (HostProfileManager) createMO(getServiceContent().getHostProfileManager());
    }

    public IpPoolManager getIpPoolManager() {
        return (IpPoolManager) createMO(getServiceContent().getIpPoolManager());
    }

    public VirtualMachineProvisioningChecker getVirtualMachineProvisioningChecker() {
        return (VirtualMachineProvisioningChecker) createMO(getServiceContent().getVmProvisioningChecker());
    }

    public VirtualMachineCompatibilityChecker getVirtualMachineCompatibilityChecker() {
        return (VirtualMachineCompatibilityChecker) createMO(getServiceContent().getVmCompatibilityChecker());
    }

    public TaskManager getTaskManager() {
        return (TaskManager) createMO(getServiceContent().getTaskManager());
    }

    public UserDirectory getUserDirectory() {
        return (UserDirectory) createMO(getServiceContent().getUserDirectory());
    }

    public ViewManager getViewManager() {
        return (ViewManager) createMO(getServiceContent().getViewManager());
    }

    public VirtualDiskManager getVirtualDiskManager() {
        return (VirtualDiskManager) createMO(getServiceContent().getVirtualDiskManager());
    }

    public OptionManager getOptionManager() {
        return (OptionManager) createMO(getServiceContent().getSetting());
    }

    public OvfManager getOvfManager() {
        return (OvfManager) createMO(getServiceContent().getOvfManager());
    }

    public IoFilterManager getIoFilterManager() {
        return (IoFilterManager) createMO(getServiceContent().getIoFilterManager());
    }

    private ManagedObject createMO(ManagedObjectReference mor) {
        return MorUtil.createExactManagedObject(getServerConnection(), mor);
    }

    // TODO vim.VirtualizationManager is defined in servicecontent but no documentation there. Filed a bug already

}