Interface RemoteLockSession.Host

All Superinterfaces:
Serializable
All Known Implementing Classes:
LockStepExecution
Enclosing class:
RemoteLockSession

public static interface RemoteLockSession.Host extends Serializable
Step-side integration the session calls back into. Implemented by LockStepExecution; kept minimal so the bulk of the remote flow lives here rather than in the core step class.
  • Method Summary

    Modifier and Type
    Method
    Description
    org.jenkinsci.plugins.workflow.steps.StepContext
    The workflow step context (for Run/FlowNode/TaskListener, onSuccess/onFailure).
    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).
    The originating lock() step.
  • Method Details

    • context

      org.jenkinsci.plugins.workflow.steps.StepContext context()
      The workflow step context (for Run/FlowNode/TaskListener, onSuccess/onFailure).
    • step

      LockStep step()
      The originating lock() step.
    • runBody

      void runBody(String displayTarget, @CheckForNull Map<String,String> lockEnvVars, String lockId)
      Runs the lock body; on completion the framework releases the remote lock via RemoteLockSession.onBodyFinished(Host).