Package io.jenkins.plugins.swarmcloud

Class SwarmOnceRetentionStrategy

java.lang.Object

hudson.slaves.RetentionStrategy<AbstractCloudComputer<?>>

hudson.slaves.CloudSlaveRetentionStrategy<AbstractCloudComputer<?>>

io.jenkins.plugins.swarmcloud.SwarmOnceRetentionStrategy

All Implemented Interfaces:

ExtensionPoint, Describable<RetentionStrategy<?>>, ExecutorListener

public class SwarmOnceRetentionStrategy
extends CloudSlaveRetentionStrategy<AbstractCloudComputer<?>>
implements ExecutorListener

Retention strategy for ephemeral one-shot Swarm agents (#7).

After the first completed build, the agent is removed and its underlying Docker Swarm service is destroyed. Used when template.oneShot is true. Modeled after the equivalent helper in the Jenkins Kubernetes plugin — there is no OnceRetentionStrategy in Jenkins core to reuse.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SwarmOnceRetentionStrategy.DescriptorImpl

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

RetentionStrategy.Always, RetentionStrategy.Demand

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields inherited from class hudson.slaves.CloudSlaveRetentionStrategy

TIMEOUT

Fields inherited from class hudson.slaves.RetentionStrategy

INSTANCE, LIST, NOOP

Constructor Summary

Constructors

Constructor	Description
SwarmOnceRetentionStrategy(int idleMinutes)

Method Summary

Modifier and Type	Method	Description
protected long	getIdleMaxTime()	Returns the idle timeout in milliseconds for the parent CloudSlaveRetentionStrategy's check() loop.
int	getIdleMinutes()
void	taskAccepted(Executor executor, Queue.Task task)
void	taskCompleted(Executor executor, Queue.Task task, long durationMS)
void	taskCompletedWithProblems(Executor executor, Queue.Task task, long durationMS, Throwable problems)

Methods inherited from class hudson.slaves.CloudSlaveRetentionStrategy

check, checkCycle, isIdleForTooLong, kill

Methods inherited from class hudson.slaves.RetentionStrategy

all, isAcceptingTasks, isManualLaunchAllowed, start

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

Methods inherited from interface hudson.model.ExecutorListener

taskStarted

Constructor Details

SwarmOnceRetentionStrategy

@DataBoundConstructor
public SwarmOnceRetentionStrategy(int idleMinutes)

Method Details

getIdleMinutes

public int getIdleMinutes()

getIdleMaxTime

protected long getIdleMaxTime()

Returns the idle timeout in milliseconds for the parent CloudSlaveRetentionStrategy's check() loop. Without this override, the parent uses the static CloudSlaveRetentionStrategy.TIMEOUT default (10 minutes) regardless of the idleMinutes value the constructor stored.

Relevant only for the edge case "agent connected but no build was ever dispatched": in that case the parent's idle check eventually reaps the agent. The main one-shot path (build runs, done(Executor) fires from ExecutorListener) terminates the agent immediately and does not depend on this method.

Overrides:

getIdleMaxTime in class CloudSlaveRetentionStrategy<AbstractCloudComputer<?>>

taskAccepted

public void taskAccepted(Executor executor,
 Queue.Task task)

Specified by:

taskAccepted in interface ExecutorListener

taskCompleted

public void taskCompleted(Executor executor,
 Queue.Task task,
 long durationMS)

Specified by:

taskCompleted in interface ExecutorListener

taskCompletedWithProblems

public void taskCompletedWithProblems(Executor executor,
 Queue.Task task,
 long durationMS,
 Throwable problems)

Specified by:

taskCompletedWithProblems in interface ExecutorListener