Package org.jenkins.plugins.lockableresources.remote

Class RemoteResolver

java.lang.Object

org.jenkins.plugins.lockableresources.remote.RemoteResolver

@Restricted(org.kohsuke.accmod.restrictions.NoExternalUse.class)
public final class RemoteResolver
extends Object

Server-side resolution for remote lock requests: the admission check (existence/exposure) and resolution through the canonical LockableResourcesManager.getAvailableResources(java.util.List<org.jenkins.plugins.lockableresources.queue.LockableResourcesStruct>) path - the same one local lock() uses, with the configured exposeLabel set as the candidate filter. The server never re-implements lock() semantics; this class only decides which resources a remote request may see and resolves them, then hands off to the manager.

A pure, stateless collaborator over the manager's public API. Every call must be made while holding LockableResourcesManager.syncResources - the caller acquires it; this class never takes the lock itself.

Constructor Summary

Constructors

Constructor	Description
RemoteResolver(LockableResourcesManager lrm)

Method Summary

Modifier and Type	Method	Description
List<LockableResource>	availableForRemote(List<LockableResourcesStruct> structs, RemoteLockRequest req)	Resolves a remote request (given its canonical structs, from toRemoteStructs(org.jenkins.plugins.lockableresources.remote.RemoteLockRequest)) through the canonical LockableResourcesManager.getAvailableResources(java.util.List<org.jenkins.plugins.lockableresources.queue.LockableResourcesStruct>) path, applying the configured exposeLabel set as the candidate-visibility filter (a resource is visible iff it carries any exposeLabel - OR).
static Map<String,String>	remoteLockEnvVars(String variable, List<LockableResource> resources)	Builds lockEnvVars for an acquired remote lock from the resolved resources, via the shared LockStepExecution.buildLockEnvVars(java.lang.String, java.util.LinkedHashMap<java.lang.String, java.util.List<org.jenkins.plugins.lockableresources.LockableResourceProperty>>) - identical to local, including resource-property env vars.
List<LockableResourcesStruct>	toRemoteStructs(RemoteLockRequest req)	Builds the canonical LockableResourcesStruct list for a remote request, mirroring LockStep.getResources() (main selector + each extra entry).
String	validateRemoteSelectors(RemoteLockRequest req)	Admission check for a remote request: every selector (the main one and each extra entry) must reference something this remote client could actually lock - a resource that exists and is exposed, or a label with at least one exposed candidate.

Methods inherited from class java.lang.Object

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

Constructor Details

RemoteResolver

public RemoteResolver(@NonNull
 LockableResourcesManager lrm)

Method Details

validateRemoteSelectors

@CheckForNull
public String validateRemoteSelectors(@NonNull
 RemoteLockRequest req)

Admission check for a remote request: every selector (the main one and each extra entry) must reference something this remote client could actually lock - a resource that exists and is exposed, or a label with at least one exposed candidate. Exposure means "carries any configured exposeLabel" (see LockableResourcesManager.getExposeLabels()). This is the only remote-specific gate; the actual resolution still goes through the canonical LockableResourcesManager.getAvailableResources(java.util.List<org.jenkins.plugins.lockableresources.queue.LockableResourcesStruct>) path. Must be called under LockableResourcesManager.syncResources.

Returns:

an error code ("UNKNOWN_RESOURCE" / "UNKNOWN_LABEL") or null when all selectors are admissible. The caller maps the code to HTTP 404.

toRemoteStructs

@NonNull
public List<LockableResourcesStruct> toRemoteStructs(@NonNull
 RemoteLockRequest req)

Builds the canonical LockableResourcesStruct list for a remote request, mirroring LockStep.getResources() (main selector + each extra entry). Resources are resolved by name only (no ephemeral creation): admission (validateRemoteSelectors(org.jenkins.plugins.lockableresources.remote.RemoteLockRequest)) has already confirmed every named selector exists and is exposed, so a remote request never materialises new resources on the server. Must be called under LockableResourcesManager.syncResources.

availableForRemote

@CheckForNull
public List<LockableResource> availableForRemote(@NonNull
 List<LockableResourcesStruct> structs,
 @NonNull
 RemoteLockRequest req)

Resolves a remote request (given its canonical structs, from toRemoteStructs(org.jenkins.plugins.lockableresources.remote.RemoteLockRequest)) through the canonical LockableResourcesManager.getAvailableResources(java.util.List<org.jenkins.plugins.lockableresources.queue.LockableResourcesStruct>) path, applying the configured exposeLabel set as the candidate-visibility filter (a resource is visible iff it carries any exposeLabel - OR). The filter is a plain Predicate so the canonical resolver never learns about exposeLabel; the "requested-label AND exposeLabel" intersection is expressed entirely here, leaving local lock()'s single-label matching untouched. Returns the resources to lock (atomically) or null if not all currently satisfiable (-> QUEUED, like local). Shared by the immediate acquire and queue-promotion paths. Must be called under LockableResourcesManager.syncResources.

remoteLockEnvVars

@CheckForNull
public static Map<String,String> remoteLockEnvVars(@CheckForNull
 String variable,
 @NonNull
 List<LockableResource> resources)

Builds lockEnvVars for an acquired remote lock from the resolved resources, via the shared LockStepExecution.buildLockEnvVars(java.lang.String, java.util.LinkedHashMap<java.lang.String, java.util.List<org.jenkins.plugins.lockableresources.LockableResourceProperty>>) - identical to local, including resource-property env vars. Returns null when no variable was requested.