Package org.jenkins.plugins.lockableresources

Class LockStepExecution

java.lang.Object

org.jenkinsci.plugins.workflow.steps.StepExecution

org.jenkinsci.plugins.workflow.steps.AbstractStepExecutionImpl

org.jenkins.plugins.lockableresources.LockStepExecution

All Implemented Interfaces:

Serializable, RemoteLockSession.Host

public class LockStepExecution
extends org.jenkinsci.plugins.workflow.steps.AbstractStepExecutionImpl
implements RemoteLockSession.Host

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
LockStepExecution(LockStep step, org.jenkinsci.plugins.workflow.steps.StepContext context)

Method Summary

Modifier and Type	Method	Description
static Map<String,String>	buildLockEnvVars(String variable, LinkedHashMap<String,List<LockableResourceProperty>> lockedResources)	Builds the lockEnvVars map injected for the duration of a lock() block, following local semantics exactly: variable="X" with locked resources r1, r2 yields X="r1,r2", X0="r1", X0_<prop>=<value>, X1="r2", ...
org.jenkinsci.plugins.workflow.steps.StepContext	context()	The workflow step context (for Run/FlowNode/TaskListener, onSuccess/onFailure).
void	onResume()
static void	proceed(LinkedHashMap<String,List<LockableResourceProperty>> lockedResources, org.jenkinsci.plugins.workflow.steps.StepContext context, String resourceDescription, String variable)
void	runBody(String displayTarget, Map<String,String> lockEnvVars, String lockId)	Runs the lock body; on completion the framework releases the remote lock via RemoteLockSession.onBodyFinished(Host).
boolean	start()
LockStep	step()	The originating lock() step.
void	stop(Throwable cause)

Methods inherited from class org.jenkinsci.plugins.workflow.steps.AbstractStepExecutionImpl

inject

Methods inherited from class org.jenkinsci.plugins.workflow.steps.StepExecution

acceptAll, acceptAll, applyAll, applyAll, blocksRestart, getContext, getStatus, getStatusBounded

Methods inherited from class java.lang.Object

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

Constructor Details

LockStepExecution

public LockStepExecution(LockStep step,
 org.jenkinsci.plugins.workflow.steps.StepContext context)

Method Details

start

public boolean start()
              throws Exception

Specified by:

start in class org.jenkinsci.plugins.workflow.steps.StepExecution

Throws:

Exception

context

public org.jenkinsci.plugins.workflow.steps.StepContext context()

Description copied from interface: RemoteLockSession.Host

The workflow step context (for Run/FlowNode/TaskListener, onSuccess/onFailure).

Specified by:

context in interface RemoteLockSession.Host

step

public LockStep step()

Description copied from interface: RemoteLockSession.Host

The originating lock() step.

Specified by:

step in interface RemoteLockSession.Host

runBody

public void runBody(String displayTarget,
 @CheckForNull
 Map<String,String> lockEnvVars,
 String lockId)

Description copied from interface: RemoteLockSession.Host

Runs the lock body; on completion the framework releases the remote lock via RemoteLockSession.onBodyFinished(Host).

Specified by:

runBody in interface RemoteLockSession.Host

proceed

public static void proceed(LinkedHashMap<String,List<LockableResourceProperty>> lockedResources,
 org.jenkinsci.plugins.workflow.steps.StepContext context,
 String resourceDescription,
 String variable)

buildLockEnvVars

@CheckForNull
public static Map<String,String> buildLockEnvVars(@CheckForNull
 String variable,
 @NonNull
 LinkedHashMap<String,List<LockableResourceProperty>> lockedResources)

Builds the lockEnvVars map injected for the duration of a lock() block, following local semantics exactly: variable="X" with locked resources r1, r2 yields X="r1,r2", X0="r1", X0_<prop>=<value>, X1="r2", ... Property env vars are included. Returns null when variable is null/empty.

Shared by the local flow (proceed(java.util.LinkedHashMap<java.lang.String, java.util.List<org.jenkins.plugins.lockableresources.LockableResourceProperty>>, org.jenkinsci.plugins.workflow.steps.StepContext, java.lang.String, java.lang.String)) and the remote bridge so the two never drift. All inputs (resource names and property name/value strings) are serializable, so the remote server can generate the same map and bridge it to the client.

stop

public void stop(@NonNull
 Throwable cause)

Overrides:

stop in class org.jenkinsci.plugins.workflow.steps.StepExecution

onResume

public void onResume()

Overrides:

onResume in class org.jenkinsci.plugins.workflow.steps.AbstractStepExecutionImpl