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

Methods

Modifier and Type	Method and Description
List<LockableResource>	checkResourcesAvailability(LockableResourcesStruct requiredResources, PrintStream logger, List<String> lockedResourcesAboutToBeUnlocked) Checks if there are enough resources available to satisfy the requirements specified within requiredResources and returns the necessary available resources.
boolean	configure(org.kohsuke.stapler.StaplerRequest req, net.sf.json.JSONObject json)
boolean	createResource(String name) Creates the resource if it does not exist.
boolean	createResourceWithLabel(String name, String label)
LockableResource	fromName(String resourceName)
static LockableResourcesManager	get()
Set<String>	getAllLabels()
String	getDisplayName()
int	getFreeResourceAmount(String label)
List<LockableResource>	getResources()
List<LockableResource>	getResourcesFromBuild(hudson.model.Run<?,?> build)
List<LockableResource>	getResourcesFromProject(String fullName)
List<LockableResource>	getResourcesMatchingScript(org.jenkinsci.plugins.scriptsecurity.sandbox.groovy.SecureGroovyScript script, Map<String,Object> params) Get a list of resources matching the script.
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, String logmessage, 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) Deprecated. USe tryQueue(org.jenkins.plugins.lockableresources.queue.LockableResourcesStruct, long, java.lang.String, int, java.util.Map, java.util.logging.Logger)
void	queueContext(org.jenkinsci.plugins.workflow.steps.StepContext context, LockableResourcesStruct requiredResources, String resourceDescription)
boolean	reserve(List<LockableResource> resources, String userName)
void	reset(List<LockableResource> resources)
List<LockableResource>	tryQueue(LockableResourcesStruct requiredResources, long queueItemId, String queueItemProject, int number, Map<String,Object> params, Logger log) Try to acquire the resources required by the task.
void	unlock(List<LockableResource> resourcesToUnLock, hudson.model.Run<?,?> build)
void	unlock(List<LockableResource> resourcesToUnLock, hudson.model.Run<?,?> build, boolean inversePrecedence)
void	unlockNames(List<String> resourceNamesToUnLock, hudson.model.Run<?,?> build, boolean inversePrecedence)
boolean	unqueueContext(org.jenkinsci.plugins.workflow.steps.StepContext context)
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.Run<?,?> 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)

getResourcesMatchingScript

@Nonnull
public List<LockableResource> getResourcesMatchingScript(@Nonnull
                                                        org.jenkinsci.plugins.scriptsecurity.sandbox.groovy.SecureGroovyScript script,
                                                        @CheckForNull
                                                        Map<String,Object> params)
                                                  throws ExecutionException

Get a list of resources matching the script.

Parameters:

script - Script

params - Additional parameters

Returns:

List of the matching resources

Throws:

ExecutionException - Script execution failed for one of the resources. It is considered as a fatal failure since the requirement list may be incomplete

Since:

TODO

fromName

public LockableResource fromName(String resourceName)

queue

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

queue

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

Deprecated. USe tryQueue(org.jenkins.plugins.lockableresources.queue.LockableResourcesStruct, long, java.lang.String, int, java.util.Map, java.util.logging.Logger)

tryQueue

@CheckForNull
public List<LockableResource> tryQueue(LockableResourcesStruct requiredResources,
                                           long queueItemId,
                                           String queueItemProject,
                                           int number,
                                           Map<String,Object> params,
                                           Logger log)
                                throws ExecutionException

Try to acquire the resources required by the task.

Parameters:

number - Number of resources to acquire. 0 means all

Returns:

List of the locked resources if the task has been accepted. null if the item is still waiting for the resources

Throws:

ExecutionException - Cannot queue the resource due to the execution failure. Carries info in the cause

Since:

TODO

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,
           @Nullable
           String logmessage,
           boolean inversePrecedence)

Try to lock the resource and return true if locked.

unlock

public void unlock(List<LockableResource> resourcesToUnLock,
          @Nullable
          hudson.model.Run<?,?> build)

unlock

public void unlock(@Nullable
          List<LockableResource> resourcesToUnLock,
          @Nullable
          hudson.model.Run<?,?> build,
          boolean inversePrecedence)

unlockNames

public void unlockNames(@Nullable
               List<String> resourceNamesToUnLock,
               @Nullable
               hudson.model.Run<?,?> build,
               boolean inversePrecedence)

createResource

public boolean createResource(String name)

Creates the resource if it does not exist.

createResourceWithLabel

public boolean createResourceWithLabel(String name,
                              String label)

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

checkResourcesAvailability

public List<LockableResource> checkResourcesAvailability(LockableResourcesStruct requiredResources,
                                                @Nullable
                                                PrintStream logger,
                                                @Nullable
                                                List<String> lockedResourcesAboutToBeUnlocked)

Checks if there are enough resources available to satisfy the requirements specified within requiredResources and returns the necessary available resources. If not enough resources are available, returns null.

queueContext

public void queueContext(org.jenkinsci.plugins.workflow.steps.StepContext context,
                LockableResourcesStruct requiredResources,
                String resourceDescription)

unqueueContext

public boolean unqueueContext(org.jenkinsci.plugins.workflow.steps.StepContext context)

get

public static LockableResourcesManager get()