Package org.jenkins.plugins.lockableresources.remote

Class RemoteQueueEntry

java.lang.Object

org.jenkins.plugins.lockableresources.remote.RemoteQueueEntry

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

Remote-lock counterpart to QueuedContextStruct.

Holds a pending remote acquire request in the LRM queue so that remote locks participate in the same priority-sorted queue as local pipeline lock() steps. The request's requirements are carried as the same LockableResourcesStruct list local lock() uses, so queue promotion resolves through the canonical getAvailableResources path.

All access must be under LockableResourcesManager.syncResources.

Constructor Summary

Constructors

Constructor	Description
RemoteQueueEntry(RemoteLockRecord record, List<LockableResourcesStruct> structs, int priority, long timeoutForAllocateResource, String timeoutUnit)

Method Summary

Modifier and Type	Method	Description
String	getLockId()
RemoteLockRequest	getLockRequest()
int	getPriority()
RemoteLockRecord	getRecord()
List<LockableResource>	getResolved()
List<LockableResourcesStruct>	getStructs()
long	getTimeoutDeadlineMillis()
boolean	isTimedOut()
boolean	isValid()
void	onAcquired(List<LockableResource> resources)	Called when resources have been allocated.
void	onTimeout()	Called when the queue timeout expires.
void	setResolved(List<LockableResource> resolved)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

RemoteQueueEntry

public RemoteQueueEntry(@NonNull
 RemoteLockRecord record,
 @NonNull
 List<LockableResourcesStruct> structs,
 int priority,
 long timeoutForAllocateResource,
 @NonNull
 String timeoutUnit)

Method Details

getRecord

@NonNull
public RemoteLockRecord getRecord()

getStructs

@NonNull
public List<LockableResourcesStruct> getStructs()

getLockId

@NonNull
public String getLockId()

getPriority

public int getPriority()

getTimeoutDeadlineMillis

public long getTimeoutDeadlineMillis()

getResolved

@CheckForNull
public List<LockableResource> getResolved()

setResolved

public void setResolved(@NonNull
 List<LockableResource> resolved)

isValid

public boolean isValid()

isTimedOut

public boolean isTimedOut()

onAcquired

public void onAcquired(@NonNull
 List<LockableResource> resources)

Called when resources have been allocated. Transitions the record to ACQUIRED and builds lockEnvVars (including resource-property env vars) via RemoteResolver.remoteLockEnvVars(java.lang.String, java.util.List<org.jenkins.plugins.lockableresources.LockableResource>) - the same helper the immediate-acquire path uses, so both paths produce identical env vars (shared with local lock() through LockStepExecution.buildLockEnvVars).

onTimeout

public void onTimeout()

Called when the queue timeout expires. Transitions the record to FAILED.

getLockRequest

@NonNull
public RemoteLockRequest getLockRequest()

toString

public String toString()

Overrides:

toString in class Object