Package io.jenkins.plugins.swarmcloud

Class SwarmComputerLauncher

java.lang.Object

hudson.slaves.ComputerLauncher

hudson.slaves.JNLPLauncher

io.jenkins.plugins.swarmcloud.SwarmComputerLauncher

All Implemented Interfaces:

ExtensionPoint, Describable<ComputerLauncher>

public class SwarmComputerLauncher
extends JNLPLauncher

Launcher for Docker Swarm agents. Extends JNLPLauncher to allow inbound agent connections via WebSocket or JNLP.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SwarmComputerLauncher.DescriptorImpl	Descriptor for SwarmComputerLauncher.

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields inherited from class hudson.slaves.JNLPLauncher

CUSTOM_INBOUND_URL_PROPERTY, DESCRIPTOR, tunnel, vmargs

Fields inherited from class hudson.slaves.ComputerLauncher

LIST

Constructor Summary

Constructors

Constructor	Description
SwarmComputerLauncher(String cloudName, String image)
SwarmComputerLauncher(String cloudName, String image, boolean useWebSocket, String tunnel, String workDir)
SwarmComputerLauncher(String cloudName, String image, boolean useWebSocket, String tunnel, String workDir, int connectionTimeoutSeconds)

Method Summary

Modifier and Type	Method	Description
void	afterDisconnect(SlaveComputer computer, TaskListener listener)
void	beforeDisconnect(SlaveComputer computer, TaskListener listener)
static String[]	buildAgentCommand(String jenkinsUrl, String agentName, String secret, boolean useWebSocket, String workDir)	Builds the command for the inbound agent container.
static Map<String,String>	buildAgentEnvironment(String jenkinsUrl, String agentName, String secret, boolean useWebSocket, String workDir)	Builds environment variables for the agent container.
static String	getAgentSecret(String agentName)	Gets the secret for an agent from Jenkins.
String	getCloudName()
int	getConnectionTimeoutSeconds()
String	getImage()
static String	getJnlpUrl(String jenkinsUrl, String agentName)	Gets the JNLP URL for legacy connections.
String	getWorkDir()
boolean	isUseWebSocket()
void	launch(SlaveComputer computer, TaskListener listener)

Methods inherited from class hudson.slaves.JNLPLauncher

getInboundAgentUrl, getRemotingOptionsUnix, getRemotingOptionsWindows, getTunnel, getWorkDirOptions, getWorkDirSettings, isConfigured, isLaunchSupported, isWebSocket, readResolve, setTunnel, setWebSocket, setWorkDirSettings

Methods inherited from class hudson.slaves.ComputerLauncher

afterDisconnect, beforeDisconnect, checkJavaVersion, launch

Methods inherited from class java.lang.Object

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

Methods inherited from interface hudson.model.Describable

getDescriptor

Constructor Details

SwarmComputerLauncher

public SwarmComputerLauncher(@NonNull
 String cloudName,
 @NonNull
 String image)

SwarmComputerLauncher

public SwarmComputerLauncher(@NonNull
 String cloudName,
 @NonNull
 String image,
 boolean useWebSocket,
 @CheckForNull
 String tunnel,
 @CheckForNull
 String workDir)

SwarmComputerLauncher

public SwarmComputerLauncher(@NonNull
 String cloudName,
 @NonNull
 String image,
 boolean useWebSocket,
 @CheckForNull
 String tunnel,
 @CheckForNull
 String workDir,
 int connectionTimeoutSeconds)

Method Details

launch

public void launch(SlaveComputer computer,
 TaskListener listener)

Overrides:

launch in class JNLPLauncher

afterDisconnect

public void afterDisconnect(SlaveComputer computer,
 TaskListener listener)

Overrides:

afterDisconnect in class ComputerLauncher

beforeDisconnect

public void beforeDisconnect(SlaveComputer computer,
 TaskListener listener)

Overrides:

beforeDisconnect in class ComputerLauncher

getAgentSecret

@NonNull
public static String getAgentSecret(@NonNull
 String agentName)

Gets the secret for an agent from Jenkins.

buildAgentCommand

@NonNull
public static String[] buildAgentCommand(@NonNull
 String jenkinsUrl,
 @NonNull
 String agentName,
 @NonNull
 String secret,
 boolean useWebSocket,
 @CheckForNull
 String workDir)

Builds the command for the inbound agent container.

buildAgentEnvironment

@NonNull
public static Map<String,String> buildAgentEnvironment(@NonNull
 String jenkinsUrl,
 @NonNull
 String agentName,
 @NonNull
 String secret,
 boolean useWebSocket,
 @CheckForNull
 String workDir)

Builds environment variables for the agent container.

getJnlpUrl

@NonNull
public static String getJnlpUrl(@NonNull
 String jenkinsUrl,
 @NonNull
 String agentName)

Gets the JNLP URL for legacy connections.

getCloudName

public String getCloudName()

getImage

public String getImage()

isUseWebSocket

public boolean isUseWebSocket()

getWorkDir

public String getWorkDir()

getConnectionTimeoutSeconds

public int getConnectionTimeoutSeconds()