Package org.jenkins.plugins.lockableresources.actions

Class RemoteApiV1Action

java.lang.Object

org.jenkins.plugins.lockableresources.actions.RemoteApiV1Action

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

Serves the remote lock REST API under /lockable-resources/remote/v1/.

Endpoints:

• POST /acquire - enqueue an acquire request
• GET /acquire/{lockId} - poll acquire status
• POST /lease/{lockId}/heartbeat - renew lease
• POST /lease/{lockId}/release - release lock

All endpoints require the dedicated LockableResourcesRootAction.REMOTE permission (implied by ADMINISTER). Grant it to the machine users whose API tokens remote client controllers use as credentialsId. If Remote API is disabled (see LockableResourcesManager.isRemoteApiEnabled()) every endpoint returns 403.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	RemoteApiV1Action.AcquireRouter
static final class	RemoteApiV1Action.AcquireStatusResource	Serves GET /acquire/{lockId}.
static final class	RemoteApiV1Action.LeaseResource	Serves POST /lease/{lockId}/heartbeat and POST /lease/{lockId}/release.
static final class	RemoteApiV1Action.LeaseRouter

Constructor Summary

Constructors

Constructor	Description
RemoteApiV1Action()

Method Summary

Modifier and Type	Method	Description
Object	getDynamic(String token)

Methods inherited from class java.lang.Object

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

Constructor Details

RemoteApiV1Action

public RemoteApiV1Action()

Method Details

getDynamic

public Object getDynamic(String token)