Package org.jenkinsci.plugins

Class vSphereCloud

java.lang.Object

hudson.model.AbstractModelObject

hudson.model.Actionable

hudson.slaves.Cloud

org.jenkinsci.plugins.vSphereCloud

All Implemented Interfaces:

ExtensionPoint, Describable<Cloud>, ModelObject, SearchableModelObject, SearchItem, AccessControlled, ModelObjectWithContextMenu

public class vSphereCloud
extends Cloud

Author:

Admin

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	vSphereCloud.DescriptorImpl

Nested classes/interfaces inherited from class hudson.slaves.Cloud

Cloud.CloudState

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Nested classes/interfaces inherited from interface jenkins.model.ModelObjectWithContextMenu

ModelObjectWithContextMenu.ContextMenu, ModelObjectWithContextMenu.ContextMenuVisibility, ModelObjectWithContextMenu.MenuItem, ModelObjectWithContextMenu.MenuItemType

Field Summary

Fields inherited from class hudson.slaves.Cloud

ALL, name, PROVISION

Constructor Summary

Constructors

Constructor	Description
vSphereCloud(String vsHost, String vsDescription, String username, String password, int maxOnlineSlaves)	Deprecated.
vSphereCloud(VSphereConnectionConfig vsConnectionConfig, String vsDescription, int maxOnlineSlaves, int instanceCap, List<? extends vSphereCloudSlaveTemplate> templates)

Method Summary

Modifier and Type	Method	Description
Boolean	canMarkVMOnline(String slaveName, String vmName)
boolean	canProvision(Label label)
static List<String>	findAllVsphereCloudNames()
static List<vSphereCloud>	findAllVsphereClouds(String jobName)
boolean	getAllowUntrustedCertificate()
vSphereCloud.DescriptorImpl	getDescriptor()
final int	getHash()
int	getInstanceCap()
String	getMaintenanceMessage()
int	getMaxOnlineSlaves()
String	getPassword()
int	getPoolHealthCheckIntervalSecs()
int	getPoolIdleTimeoutSecs()
int	getSessionMaxAgeSecs()
int	getSessionMaxUses()
List<? extends vSphereCloudSlaveTemplate>	getTemplates()
String	getUsername()
VSphereConnectionConfig	getVsConnectionConfig()
String	getVsDescription()
String	getVsHost()
boolean	isMaintenanceMode()
boolean	isUseConnectionPool()
static void	Log(Slave slave, TaskListener listener, String format, Object... args)	Logs a Level.INFO message (created with String.format(String, Object...)), prefixed by the Slave name.
static void	Log(Slave slave, TaskListener listener, Throwable ex, String format, Object... args)	Logs a Level.SEVERE message (created with String.format(String, Object...)) and a Throwable (with stacktrace), prefixed by the Slave name.
static void	Log(Slave slave, String format, Object... args)	Logs a Level.INFO message (created with String.format(String, Object...)), prefixed by the Slave name.
static void	Log(Slave slave, Throwable ex, String format, Object... args)	Logs a Level.SEVERE message (created with String.format(String, Object...)) and a Throwable (with stacktrace), prefixed by the Slave name.
static void	Log(TaskListener listener, String format, Object... args)	Logs a Level.INFO message (created with String.format(String, Object...)).
static void	Log(TaskListener listener, Throwable ex, String format, Object... args)	Logs a Level.SEVERE message (created with String.format(String, Object...)) and a Throwable (with stacktrace).
static void	Log(SlaveComputer slave, TaskListener listener, String format, Object... args)	Logs a Level.INFO message (created with String.format(String, Object...)), prefixed by the SlaveComputer name.
static void	Log(SlaveComputer slave, TaskListener listener, Throwable ex, String format, Object... args)	Logs a Level.SEVERE message (created with String.format(String, Object...)) and a Throwable (with stacktrace), prefixed by the SlaveComputer name.
static void	Log(String format, Object... args)	Logs an Level.INFO message (created with String.format(String, Object...)).
static void	Log(Throwable ex, String format, Object... args)	Logs an Level.SEVERE message (created with String.format(String, Object...)) and a Throwable with stacktrace.
void	markVMOffline(String slaveName, String vmName)
Boolean	markVMOnline(String slaveName, String vmName)
Collection<NodeProvisioner.PlannedNode>	provision(Label label, int excessWorkload)
Object	readResolve()
void	setMaintenanceMessage(String maintenanceMessage)
void	setMaintenanceMode(boolean maintenanceMode)
void	setPoolHealthCheckIntervalSecs(int poolHealthCheckIntervalSecs)
void	setPoolIdleTimeoutSecs(int poolIdleTimeoutSecs)
void	setSessionMaxAgeSecs(int sessionMaxAgeSecs)
void	setSessionMaxUses(int sessionMaxUses)
void	setUseConnectionPool(boolean useConnectionPool)
String	toString()
VSphere	vSphereInstance()
void	waitWhileInMaintenanceMode(TaskListener listener)	If this cloud (or whichever vSphereCloud instance now holds its configuration - Jenkins constructs a brand-new Cloud instance on every reconfiguration rather than mutating the existing one, see resolveCurrentInstance()) is in maintenance mode, logs the configured message to listener and blocks the calling thread, polling every MAINTENANCE_POLL_INTERVAL_MS, until maintenance mode is turned off.

Methods inherited from class hudson.slaves.Cloud

all, canProvision, doConfigSubmit, doDoDelete, getACL, getDisplayName, getIcon, getIconAltText, getIconClassName, getSearchUrl, getUrl, provision, reconfigure, reconfigure, registerPermissions

Methods inherited from class hudson.model.Actionable

addAction, addOrReplaceAction, doContextMenu, doContextMenu, getAction, getAction, getActions, getActions, getAllActions, getDynamic, getDynamic, removeAction, removeActions, replaceAction, replaceActions

Methods inherited from class hudson.model.AbstractModelObject

getSearch, getSearchIndex, getSearchName, makeSearchIndex, requirePOST, sendError, sendError, sendError, sendError, sendError, sendError, sendError, sendError

Methods inherited from class java.lang.Object

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

Methods inherited from interface hudson.security.AccessControlled

checkAnyPermission, checkPermission, hasAnyPermission, hasPermission, hasPermission, hasPermission2

Methods inherited from interface hudson.search.SearchItem

getSearchGroup, getSearchIcon

Constructor Details

vSphereCloud

@Deprecated
public vSphereCloud(String vsHost,
 String vsDescription,
 String username,
 String password,
 int maxOnlineSlaves)

Deprecated.

vSphereCloud

@DataBoundConstructor
public vSphereCloud(VSphereConnectionConfig vsConnectionConfig,
 String vsDescription,
 int maxOnlineSlaves,
 int instanceCap,
 List<? extends vSphereCloudSlaveTemplate> templates)

Method Details

Log

public static void Log(String format,
 Object... args)

Logs an Level.INFO message (created with String.format(String, Object...)).

Log

public static void Log(Throwable ex,
 String format,
 Object... args)

Logs an Level.SEVERE message (created with String.format(String, Object...)) and a Throwable with stacktrace.

Log

public static void Log(TaskListener listener,
 String format,
 Object... args)

Logs a Level.INFO message (created with String.format(String, Object...)).

Log

public static void Log(TaskListener listener,
 Throwable ex,
 String format,
 Object... args)

Logs a Level.SEVERE message (created with String.format(String, Object...)) and a Throwable (with stacktrace).

Log

public static void Log(Slave slave,
 String format,
 Object... args)

Logs a Level.INFO message (created with String.format(String, Object...)), prefixed by the Slave name.

Log

public static void Log(Slave slave,
 Throwable ex,
 String format,
 Object... args)

Logs a Level.SEVERE message (created with String.format(String, Object...)) and a Throwable (with stacktrace), prefixed by the Slave name.

Log

public static void Log(Slave slave,
 TaskListener listener,
 String format,
 Object... args)

Logs a Level.INFO message (created with String.format(String, Object...)), prefixed by the Slave name.

Log

public static void Log(Slave slave,
 TaskListener listener,
 Throwable ex,
 String format,
 Object... args)

Logs a Level.SEVERE message (created with String.format(String, Object...)) and a Throwable (with stacktrace), prefixed by the Slave name.

Log

public static void Log(SlaveComputer slave,
 TaskListener listener,
 String format,
 Object... args)

Logs a Level.INFO message (created with String.format(String, Object...)), prefixed by the SlaveComputer name.

Log

public static void Log(SlaveComputer slave,
 TaskListener listener,
 Throwable ex,
 String format,
 Object... args)

Logs a Level.SEVERE message (created with String.format(String, Object...)) and a Throwable (with stacktrace), prefixed by the SlaveComputer name.

readResolve

public Object readResolve()
                   throws IOException

Throws:

IOException

getMaxOnlineSlaves

public int getMaxOnlineSlaves()

getInstanceCap

public int getInstanceCap()

getTemplates

public List<? extends vSphereCloudSlaveTemplate> getTemplates()

isUseConnectionPool

public boolean isUseConnectionPool()

setUseConnectionPool

@DataBoundSetter
public void setUseConnectionPool(boolean useConnectionPool)

getPoolHealthCheckIntervalSecs

public int getPoolHealthCheckIntervalSecs()

setPoolHealthCheckIntervalSecs

@DataBoundSetter
public void setPoolHealthCheckIntervalSecs(int poolHealthCheckIntervalSecs)

getSessionMaxAgeSecs

public int getSessionMaxAgeSecs()

setSessionMaxAgeSecs

@DataBoundSetter
public void setSessionMaxAgeSecs(int sessionMaxAgeSecs)

getSessionMaxUses

public int getSessionMaxUses()

setSessionMaxUses

@DataBoundSetter
public void setSessionMaxUses(int sessionMaxUses)

getPoolIdleTimeoutSecs

public int getPoolIdleTimeoutSecs()

setPoolIdleTimeoutSecs

@DataBoundSetter
public void setPoolIdleTimeoutSecs(int poolIdleTimeoutSecs)

isMaintenanceMode

public boolean isMaintenanceMode()

setMaintenanceMode

@DataBoundSetter
public void setMaintenanceMode(boolean maintenanceMode)

getMaintenanceMessage

public String getMaintenanceMessage()

setMaintenanceMessage

@DataBoundSetter
public void setMaintenanceMessage(String maintenanceMessage)

getPassword

@CheckForNull
public String getPassword()

getUsername

@CheckForNull
public String getUsername()

getVsDescription

public String getVsDescription()

getVsHost

@CheckForNull
public String getVsHost()

getAllowUntrustedCertificate

public boolean getAllowUntrustedCertificate()

getVsConnectionConfig

@CheckForNull
public VSphereConnectionConfig getVsConnectionConfig()

getHash

public final int getHash()

vSphereInstance

public VSphere vSphereInstance()
                        throws VSphereException

Throws:

VSphereException

waitWhileInMaintenanceMode

public void waitWhileInMaintenanceMode(TaskListener listener)
                                throws InterruptedException

If this cloud (or whichever vSphereCloud instance now holds its configuration - Jenkins constructs a brand-new Cloud instance on every reconfiguration rather than mutating the existing one, see resolveCurrentInstance()) is in maintenance mode, logs the configured message to listener and blocks the calling thread, polling every MAINTENANCE_POLL_INTERVAL_MS, until maintenance mode is turned off. Returns immediately if the cloud is not currently in maintenance mode.

Throws:

InterruptedException

canProvision

public boolean canProvision(Label label)

Overrides:

canProvision in class Cloud

provision

public Collection<NodeProvisioner.PlannedNode> provision(Label label,
 int excessWorkload)

Overrides:

provision in class Cloud

toString

public String toString()

Overrides:

toString in class Object

canMarkVMOnline

public Boolean canMarkVMOnline(String slaveName,
 String vmName)

markVMOnline

public Boolean markVMOnline(String slaveName,
 String vmName)

markVMOffline

public void markVMOffline(String slaveName,
 String vmName)

findAllVsphereClouds

public static List<vSphereCloud> findAllVsphereClouds(String jobName)

findAllVsphereCloudNames

public static List<String> findAllVsphereCloudNames()

getDescriptor

public vSphereCloud.DescriptorImpl getDescriptor()

Specified by:

getDescriptor in interface Describable<Cloud>

Overrides:

getDescriptor in class Cloud