Package org.jenkinsci.plugins.vsphere

Class VSphereBuildStep

java.lang.Object

org.jenkinsci.plugins.vsphere.VSphereBuildStep

All Implemented Interfaces:

ExtensionPoint, Describable<VSphereBuildStep>

Direct Known Subclasses:

Clone, ConvertToTemplate, ConvertToVm, Delete, DeleteSnapshot, Deploy, ExposeGuestInfo, PowerOff, PowerOn, Reconfigure, Rename, RenameSnapshot, RevertToSnapshot, SuspendVm, TakeSnapshot

public abstract class VSphereBuildStep
extends Object
implements Describable<VSphereBuildStep>, ExtensionPoint

Define a base class for all vSphere build steps. All vSphere build steps should extend this class, as it contains server information required by all.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VSphereBuildStep.VSphereBuildStepDescriptor

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields

Modifier and Type	Field	Description
protected vSphereCloud	sourceCloud	The vSphereCloud this step is currently running against, set by whatever resolves vsphere for this run (currently only VSphereBuildStepContainer).
protected VSphere	vsphere

Constructor Summary

Constructors

Constructor	Description
VSphereBuildStep()

Method Summary

Modifier and Type	Method	Description
static DescriptorExtensionList<VSphereBuildStep,VSphereBuildStep.VSphereBuildStepDescriptor>	all()
static boolean	allowDelete()
VSphereBuildStep.VSphereBuildStepDescriptor	getDescriptor()
String	getIP()
vSphereCloud	getSourceCloud()
VSphere	getVsphere()
abstract boolean	perform(AbstractBuild<?,?> build, Launcher launcher, BuildListener listener)
abstract void	perform(Run<?,?> run, FilePath filePath, Launcher launcher, TaskListener listener)
void	setSourceCloud(vSphereCloud sourceCloud)
void	setVsphere(VSphere vsphere)

Methods inherited from class java.lang.Object

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

Field Details

vsphere

protected VSphere vsphere

sourceCloud

protected vSphereCloud sourceCloud

The vSphereCloud this step is currently running against, set by whatever resolves vsphere for this run (currently only VSphereBuildStepContainer). Used to fall back to cloud-level defaults (e.g. hostSelectionMode) for fields a subclass leaves unset. May be null if a caller never sets it (e.g. a build step invoked directly, bypassing the container), in which case there is simply no cloud-level default to fall back to.

Constructor Details

VSphereBuildStep

public VSphereBuildStep()

Method Details

getVsphere

public VSphere getVsphere()

setVsphere

public void setVsphere(VSphere vsphere)

getSourceCloud

public vSphereCloud getSourceCloud()

setSourceCloud

public void setSourceCloud(vSphereCloud sourceCloud)

getIP

public String getIP()

all

public static DescriptorExtensionList<VSphereBuildStep,VSphereBuildStep.VSphereBuildStepDescriptor> all()

perform

public abstract boolean perform(AbstractBuild<?,?> build,
 Launcher launcher,
 BuildListener listener)
                         throws Exception

Throws:

Exception

perform

public abstract void perform(@NonNull
 Run<?,?> run,
 @NonNull
 FilePath filePath,
 @NonNull
 Launcher launcher,
 @NonNull
 TaskListener listener)
                      throws InterruptedException,
IOException

Throws:

InterruptedException

IOException

getDescriptor

public VSphereBuildStep.VSphereBuildStepDescriptor getDescriptor()

Specified by:

getDescriptor in interface Describable<VSphereBuildStep>

allowDelete

public static boolean allowDelete()