org.jenkins.plugins.lockableresources

Class LockableResourcesManager

java.lang.Object

hudson.model.Descriptor<jenkins.model.GlobalConfiguration>

jenkins.model.GlobalConfiguration

org.jenkins.plugins.lockableresources.LockableResourcesManager

All Implemented Interfaces:

hudson.ExtensionPoint, hudson.model.Describable<jenkins.model.GlobalConfiguration>, hudson.model.Saveable

@Extension
public class LockableResourcesManager
extends jenkins.model.GlobalConfiguration

Nested Class Summary

Nested classes/interfaces inherited from class hudson.model.Descriptor

hudson.model.Descriptor.FormException, hudson.model.Descriptor.PropertyType, hudson.model.Descriptor.Self

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

hudson.ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields inherited from class hudson.model.Descriptor

clazz

Fields inherited from interface hudson.model.Saveable

NOOP

Constructor Summary

Constructors

Constructor and Description
LockableResourcesManager()

Method Summary

Modifier and Type	Method and Description
boolean	cleanWaitingContext(LockableResource resource, org.jenkinsci.plugins.workflow.steps.StepContext context)
boolean	configure(org.kohsuke.stapler.StaplerRequest req, net.sf.json.JSONObject json)
boolean	createResource(String name) Creates the resource if it does not exist.
LockableResource	fromName(String resourceName)
static LockableResourcesManager	get()
Set<String>	getAllLabels()
String	getDisplayName()
int	getFreeResourceAmount(String label)
String	getLockCause(String r)
List<LockableResource>	getResources()
List<LockableResource>	getResourcesFromBuild(hudson.model.AbstractBuild<?,?> build)
List<LockableResource>	getResourcesFromProject(String fullName)
List<LockableResource>	getResourcesWithLabel(String label, Map<String,Object> params)
Boolean	isValidLabel(String label)
boolean	lock(List<LockableResource> resources, hudson.model.Run<?,?> build, org.jenkinsci.plugins.workflow.steps.StepContext context)
boolean	lock(List<LockableResource> resources, hudson.model.Run<?,?> build, org.jenkinsci.plugins.workflow.steps.StepContext context, boolean inversePrecedence) Try to lock the resource and return true if locked.
boolean	queue(List<LockableResource> resources, long queueItemId)
List<LockableResource>	queue(LockableResourcesStruct requiredResources, long queueItemId, String queueItemProject, int number, Map<String,Object> params, Logger log)
boolean	reserve(List<LockableResource> resources, String userName)
void	reset(List<LockableResource> resources)
void	unlock(List<LockableResource> resourcesToUnLock, hudson.model.Run<?,?> build, org.jenkinsci.plugins.workflow.steps.StepContext context)
void	unlock(List<LockableResource> resourcesToUnLock, hudson.model.Run<?,?> build, org.jenkinsci.plugins.workflow.steps.StepContext context, boolean inversePrecedence)
void	unreserve(List<LockableResource> resources)

Methods inherited from class jenkins.model.GlobalConfiguration

all, getCategory, getDescriptor, getGlobalConfigPage

Methods inherited from class hudson.model.Descriptor

addHelpFileRedirect, calcAutoCompleteSettings, calcFillSettings, configure, doHelp, find, find, findByDescribableClassName, findById, getCheckMethod, getCheckUrl, getConfigFile, getConfigPage, getCurrentDescriptorByNameUrl, getDescriptorFullUrl, getDescriptorUrl, getGlobalPropertyType, getHelpFile, getHelpFile, getHelpFile, getId, getJsonSafeClassName, getKlass, getPlugin, getPossibleViewNames, getPropertyType, getPropertyType, getPropertyTypeOrDie, getT, getViewPage, isInstance, isSubTypeOf, load, newInstance, newInstance, newInstancesFromHeteroList, newInstancesFromHeteroList, save, self, toArray, toList, toMap

Methods inherited from class java.lang.Object

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

Constructor Detail

LockableResourcesManager

public LockableResourcesManager()

Method Detail

getResources

public List<LockableResource> getResources()

getResourcesFromProject

public List<LockableResource> getResourcesFromProject(String fullName)

getResourcesFromBuild

public List<LockableResource> getResourcesFromBuild(hudson.model.AbstractBuild<?,?> build)

isValidLabel

public Boolean isValidLabel(String label)

getAllLabels

public Set<String> getAllLabels()

getFreeResourceAmount

public int getFreeResourceAmount(String label)

getResourcesWithLabel

public List<LockableResource> getResourcesWithLabel(String label,
                                                    Map<String,Object> params)

fromName

public LockableResource fromName(String resourceName)

queue

public boolean queue(List<LockableResource> resources,
                     long queueItemId)

queue

public List<LockableResource> queue(LockableResourcesStruct requiredResources,
                                    long queueItemId,
                                    String queueItemProject,
                                    int number,
                                    Map<String,Object> params,
                                    Logger log)

lock

public boolean lock(List<LockableResource> resources,
                    hudson.model.Run<?,?> build,
                    @Nullable
                    org.jenkinsci.plugins.workflow.steps.StepContext context)

lock

public boolean lock(List<LockableResource> resources,
                    hudson.model.Run<?,?> build,
                    @Nullable
                    org.jenkinsci.plugins.workflow.steps.StepContext context,
                    boolean inversePrecedence)

Try to lock the resource and return true if locked.

unlock

public void unlock(List<LockableResource> resourcesToUnLock,
                   hudson.model.Run<?,?> build,
                   @Nullable
                   org.jenkinsci.plugins.workflow.steps.StepContext context)

unlock

public void unlock(List<LockableResource> resourcesToUnLock,
                   hudson.model.Run<?,?> build,
                   @Nullable
                   org.jenkinsci.plugins.workflow.steps.StepContext context,
                   boolean inversePrecedence)

getLockCause

public String getLockCause(String r)

createResource

public boolean createResource(String name)

Creates the resource if it does not exist.

cleanWaitingContext

public boolean cleanWaitingContext(LockableResource resource,
                                   org.jenkinsci.plugins.workflow.steps.StepContext context)

reserve

public boolean reserve(List<LockableResource> resources,
                       String userName)

unreserve

public void unreserve(List<LockableResource> resources)

getDisplayName

public String getDisplayName()

Overrides:

getDisplayName in class jenkins.model.GlobalConfiguration

reset

public void reset(List<LockableResource> resources)

configure

public boolean configure(org.kohsuke.stapler.StaplerRequest req,
                         net.sf.json.JSONObject json)
                  throws hudson.model.Descriptor.FormException

Overrides:

configure in class hudson.model.Descriptor<jenkins.model.GlobalConfiguration>

Throws:

hudson.model.Descriptor.FormException

get

public static LockableResourcesManager get()