com.vmware.connection

Class ConnectedVimServiceBase

java.lang.Object

com.vmware.connection.ConnectedVimServiceBase

Direct Known Subclasses:

AcquireSessionInfo, AddVirtualNic, AddVirtualSwitch, AddVirtualSwitchPortGroup, Basics, CIMReader, Connect, Create, CreateStorageDRS, CreateTemporaryFile, Delete, DeleteOneTimeScheduledTask, DownloadGuestFile, DVSCreate, ESXHostSampleBase, EventFormat, EventHistoryCollectorMonitor, FcdAttachToVM, FcdCreate, FcdDelete, FcdDetachFromVM, FcdRegisterLegacyDisk, GetCurrentTime, GetUpdates, GetVMFiles, History, HostProfileManager, Info, LicenseManager, Move, NIOCForDVS, OneTimeScheduledTask, OVFManagerExportVAPP, OVFManagerExportVMDK, OVFManagerImportLocalVApp, OVFManagerImportVAppFromUrl, PrintCounters, PropertyCollector, PutVMFiles, RealTime, RemoveManagedObject, RemoveVirtualNic, RemoveVirtualSwitch, RemoveVirtualSwitchPortGroup, Rename, RunProgram, SCSILunName, SDRSRecommendation, SDRSRules, SearchIndex, SimpleClient, TaskList, UploadGuestFile, VCenterSampleBase, VITop, VIUsage, VMClone, VMCreate, VMDeltaDisk, VMDiskCreate, VMEventHistoryCollectorMonitor, VMLinkedClone, VMManageCD, VMManageFloppy, VMotion, VMPowerOps, VMPowerStateAlarm, VMPromoteDisks, VMReconfig, VMRelocate, VMSnapshot, WeeklyRecurrenceScheduledTask, XVCvMotion, XVMotion

public abstract class ConnectedVimServiceBase
extends java.lang.Object

An abstract base class, extend this class if your common needs to open a connection to the virtual center server before it can do anything useful.

Example: The simplest possible extension class merely forms a connection and specifies it's own common action.

     @Sample(name = "connect")
     public class Connect extends ConnectedVimServiceBase {
          @Action
          public void action() {
               System.out.println("currently connected: " + this.isConnected());
          }
     }
 

This is provided as an alternative to extending the Connection class directly.

For a very simple connected sample:

See Also:

GetCurrentTime

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	ConnectedVimServiceBase.ConnectionException

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	PROP_ME_NAME
static java.lang.String	SVC_INST_NAME

Constructor Summary

Constructors

Constructor and Description
ConnectedVimServiceBase()

Method Summary

Methods

Modifier and Type	Method and Description
BasicConnection	basicConnectionFromConnection(Connection original)
Connection	connect() connects this object, returns itself to allow for method chaining
Connection	disconnect() disconnects this object and returns a reference to itself for method chaining
com.vmware.vim25.ManagedObjectReference	getServiceInstanceReference() Use this method to get a reference to the service instance itself.
void	setConnection(Connection connect) A method for dependency injection of the connection object.
void	setHostConnection(java.lang.Boolean value)

Methods inherited from class java.lang.Object

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

Field Detail

PROP_ME_NAME

public static final java.lang.String PROP_ME_NAME

See Also:

Constant Field Values

SVC_INST_NAME

public static final java.lang.String SVC_INST_NAME

See Also:

Constant Field Values

Constructor Detail

ConnectedVimServiceBase

public ConnectedVimServiceBase()

Method Detail

setHostConnection

@Option(name="basic-connection",
        required=false,
        description="Turn off the use of SSO for connections. Useful for connecting to ESX or ESXi hosts.",
        parameter=false)
public void setHostConnection(java.lang.Boolean value)

getServiceInstanceReference

public com.vmware.vim25.ManagedObjectReference getServiceInstanceReference()

Use this method to get a reference to the service instance itself.

Returns:

a managed object reference referring to the service instance itself.

setConnection

@Option(name="connection",
        type=Connection.class)
public void setConnection(Connection connect)

A method for dependency injection of the connection object.

Parameters:

connect - the connection object to use for this POJO

See Also:

Connection

connect

@Before
public Connection connect()

connects this object, returns itself to allow for method chaining

Returns:

a connected reference to itself.

basicConnectionFromConnection

public BasicConnection basicConnectionFromConnection(Connection original)

disconnect

@After
public Connection disconnect()

disconnects this object and returns a reference to itself for method chaining

Returns:

a disconnected reference to itself