Package hudson.plugins.ec2

Class EC2Computer

java.lang.Object

hudson.model.AbstractModelObject

hudson.model.Actionable

hudson.model.Computer

hudson.slaves.SlaveComputer

hudson.plugins.ec2.EC2Computer

All Implemented Interfaces:

ExtensionPoint, DescriptorByNameOwner, ExecutorListener, ModelObject, SearchableModelObject, SearchItem, AccessControlled, ModelObjectWithContextMenu, HasWidgets, org.kohsuke.stapler.StaplerProxy

public class EC2Computer
extends SlaveComputer

Author:

Kohsuke Kawaguchi

Nested Class Summary

Nested classes/interfaces inherited from class hudson.model.Computer

Computer.DisplayExecutor, Computer.TerminationRequest

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.SlaveComputer

ALLOW_UNSUPPORTED_REMOTING_VERSIONS

Fields inherited from class hudson.model.Computer

BUILD, CONFIGURE, CONNECT, CREATE, DELETE, DISCONNECT, EXTENDED_READ, EXTENDED_READ_AND_CONNECT, nodeName, offlineCause, PERMISSIONS, SKIP_PERMISSION_CHECK, statusChangeLock, threadPoolForRemoting, transientActions

Constructor Summary

Constructors

Constructor	Description
EC2Computer(EC2AbstractSlave slave)

Method Summary

Modifier and Type	Method	Description
software.amazon.awssdk.services.ec2.model.Instance	describeInstance()	Obtains the instance state description in EC2.
org.kohsuke.stapler.HttpResponse	doDoDelete()	When the agent is deleted, terminate the instance.
EC2Cloud	getCloud()
String	getConsoleOutput()	Gets the EC2 console output.
String	getDecodedConsoleOutput()	Gets the EC2 decoded console output.
String	getEc2Type()
String	getInstanceId()
Instant	getLaunchTime()	Return the Instant this instance was launched
EC2AbstractSlave	getNode()
String	getRemoteAdmin()	What username to use to run root-like commands
String	getRootCommandPrefix()
String	getSlaveCommandPrefix()
String	getSlaveCommandSuffix()
SlaveTemplate	getSlaveTemplate()
String	getSpotInstanceRequestId()
int	getSshPort()
InstanceState	getState()	Gets the current state of the instance.
long	getUptime()	Number of milli-secs since the instance was started.
String	getUptimeString()	Returns uptime in the human readable form.
void	onConnected()
software.amazon.awssdk.services.ec2.model.Instance	updateInstanceDescription()	This will flush any cached description held by describeInstance().

Methods inherited from class hudson.slaves.SlaveComputer

_connect, disconnect, doDoDisconnect, doJenkinsAgentJnlp, doLaunchSlaveAgent, doSlaveAgentJnlp, doSubmitDescription, getAbsoluteRemoteFs, getAbsoluteRemotePath, getChannel, getChannelToMaster, getClassLoadingCount, getClassLoadingPrefetchCacheCount, getClassLoadingTime, getDefaultCharset, getDelegatedLauncher, getEnvVarsFull, getIconClassName, getJnlpJars, getJnlpMac, getLauncher, getListener, getLogRecords, getOSDescription, getResourceLoadingCount, getResourceLoadingTime, getRetentionStrategy, getSlaveVersion, getSystemInfoExtensions, getTarget, grabLauncher, isAcceptingTasks, isConnecting, isJnlpAgent, isLaunchSupported, isUnix, kill, openLogFile, setAcceptingTasks, setChannel, setChannel, setChannel, setChannel, setNode, taskAccepted, taskCompleted, taskCompletedWithProblems, taskStarted, tryReconnect

Methods inherited from class hudson.model.Computer

_doScript, addAction, buildEnvironment, cliConnect, cliDisconnect, cliOffline, cliOnline, connect, countBusy, countExecutors, countIdle, currentComputer, disconnect, doChangeOfflineCause, doConfigDotXml, doConfigSubmit, doDumpExportTable, doProgressiveLog, doRssAll, doRssFailed, doRssLatest, doScript, doScriptText, doToggleOffline, getACL, getActions, getAllExecutors, getApi, getAssignedLabels, getBuilds, getCaption, getComputerPanelBoxs, getConnectTime, getDemandStartMilliseconds, getDescription, getDisplayExecutors, getDisplayName, getEnvironment, getEnvVars, getExecutors, getHeapDump, getHostName, getIcon, getIconAltText, getIdleStartMilliseconds, getLoadStatistics, getLog, getLogDir, getLogFile, getLogText, getMonitorData, getMonitoringData, getName, getNumExecutors, getOfflineCause, getOfflineCauseReason, getOneOffExecutors, getSearchUrl, getSystemProperties, getTerminatedBy, getThreadDump, getTiedJobs, getTimeline, getUrl, getWorkspaceList, interrupt, isAlive, isIdle, isManualLaunchAllowed, isOffline, isOnline, isPartiallyIdle, isTemporarilyOffline, launch, onRemoved, recordTermination, relocateOldLogs, removeExecutor, resolveForCLI, setTemporarilyOffline, setTemporarilyOffline, updateByXml, waitUntilOffline, waitUntilOnline

Methods inherited from class hudson.model.Actionable

addOrReplaceAction, doContextMenu, doContextMenu, getAction, getAction, 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, toString, wait, wait, wait

Methods inherited from interface hudson.security.AccessControlled

checkAnyPermission, checkPermission, hasAnyPermission, hasPermission, hasPermission, hasPermission2

Methods inherited from interface hudson.model.DescriptorByNameOwner

getDescriptorByName

Methods inherited from interface jenkins.widgets.HasWidgets

getWidget, getWidgets

Constructor Details

EC2Computer

public EC2Computer(EC2AbstractSlave slave)

Method Details

getNode

public EC2AbstractSlave getNode()

Overrides:

getNode in class SlaveComputer

getInstanceId

@CheckForNull
public String getInstanceId()

getEc2Type

public String getEc2Type()

getSpotInstanceRequestId

public String getSpotInstanceRequestId()

getCloud

public EC2Cloud getCloud()

getSlaveTemplate

@CheckForNull
public SlaveTemplate getSlaveTemplate()

getConsoleOutput

public String getConsoleOutput()
                        throws software.amazon.awssdk.core.exception.SdkException

Gets the EC2 console output.

Throws:

software.amazon.awssdk.core.exception.SdkException

getDecodedConsoleOutput

public String getDecodedConsoleOutput()
                               throws software.amazon.awssdk.core.exception.SdkException

Gets the EC2 decoded console output.

Throws:

software.amazon.awssdk.core.exception.SdkException

Since:

TODO

describeInstance

public software.amazon.awssdk.services.ec2.model.Instance describeInstance()
                                                                    throws software.amazon.awssdk.core.exception.SdkException,
InterruptedException

Obtains the instance state description in EC2.

This method returns a cached state, so it's not suitable to check Instance.state() from the returned instance (but all the other fields are valid as it won't change.)

The cache can be flushed using updateInstanceDescription()

Throws:

software.amazon.awssdk.core.exception.SdkException

InterruptedException

updateInstanceDescription

public software.amazon.awssdk.services.ec2.model.Instance updateInstanceDescription()
                                                                             throws software.amazon.awssdk.core.exception.SdkException,
InterruptedException

This will flush any cached description held by describeInstance().

Throws:

software.amazon.awssdk.core.exception.SdkException

InterruptedException

getState

public InstanceState getState()
                       throws software.amazon.awssdk.core.exception.SdkException,
InterruptedException

Gets the current state of the instance.

Unlike describeInstance(), this method always return the current status by calling EC2.

Throws:

software.amazon.awssdk.core.exception.SdkException

InterruptedException

getUptime

public long getUptime()
               throws software.amazon.awssdk.core.exception.SdkException,
InterruptedException

Number of milli-secs since the instance was started.

Throws:

software.amazon.awssdk.core.exception.SdkException

InterruptedException

getUptimeString

public String getUptimeString()
                       throws software.amazon.awssdk.core.exception.SdkException,
InterruptedException

Returns uptime in the human readable form.

Throws:

software.amazon.awssdk.core.exception.SdkException

InterruptedException

getLaunchTime

public Instant getLaunchTime()
                      throws InterruptedException

Return the Instant this instance was launched

Returns:

Instant this instance was launched

Throws:

InterruptedException

doDoDelete

@POST
public org.kohsuke.stapler.HttpResponse doDoDelete()
                                            throws IOException

When the agent is deleted, terminate the instance.

Overrides:

doDoDelete in class Computer

Throws:

IOException

getRemoteAdmin

@CheckForNull
public String getRemoteAdmin()

What username to use to run root-like commands

Returns:

remote admin or null if the associated Node is null

getSshPort

public int getSshPort()

getRootCommandPrefix

public String getRootCommandPrefix()

getSlaveCommandPrefix

public String getSlaveCommandPrefix()

getSlaveCommandSuffix

public String getSlaveCommandSuffix()

onConnected

public void onConnected()