org.jenkins.plugins.lockableresources

Class LockableResource

java.lang.Object

hudson.model.AbstractDescribableImpl<LockableResource>

org.jenkins.plugins.lockableresources.LockableResource

All Implemented Interfaces:

hudson.model.Describable<LockableResource>, Serializable

@ExportedBean(defaultVisibility=999)
public class LockableResource
extends hudson.model.AbstractDescribableImpl<LockableResource>
implements Serializable

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	LockableResource.DescriptorImpl

Field Summary

Fields

Modifier and Type	Field and Description
static String	GROOVY_LABEL_MARKER
static int	NOT_QUEUED

Constructor Summary

Constructors

Constructor and Description
LockableResource(String name)
LockableResource(String name, String description, String labels, String reservedBy) Deprecated.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
hudson.model.Run<?,?>	getBuild()
String	getBuildName()
Integer	getContextsInQueue()
String	getDescription()
String	getLabels()
String	getLockCause() Resolve the lock cause for this resource.
String	getName()
long	getQueueItemId()
String	getQueueItemProject()
String	getReservedBy()
String	getReservedByEmail()
hudson.model.Queue.Task	getTask()
int	hashCode()
boolean	isLocked()
boolean	isQueued()
boolean	isQueued(long taskId)
boolean	isQueuedByTask(long taskId)
boolean	isReserved()
boolean	isValidLabel(String candidate, Map<String,Object> params)
void	queueAdd(org.jenkinsci.plugins.workflow.steps.StepContext context)
void	reset()
void	setBuild(hudson.model.Run<?,?> lockedBy)
void	setDescription(String description)
void	setLabels(String labels)
void	setQueued(long queueItemId)
void	setQueued(long queueItemId, String queueProjectName)
void	setReservedBy(String userName)
String	toString()
void	unqueue()
void	unReserve()

Methods inherited from class hudson.model.AbstractDescribableImpl

getDescriptor

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

NOT_QUEUED

public static final int NOT_QUEUED

See Also:

Constant Field Values

GROOVY_LABEL_MARKER

public static final String GROOVY_LABEL_MARKER

See Also:

Constant Field Values

Constructor Detail

LockableResource

@Deprecated
public LockableResource(String name,
                                    String description,
                                    String labels,
                                    String reservedBy)

Deprecated.

LockableResource

@DataBoundConstructor
public LockableResource(String name)

Method Detail

setDescription

@DataBoundSetter
public void setDescription(String description)

setLabels

@DataBoundSetter
public void setLabels(String labels)

getName

@Exported
public String getName()

getDescription

@Exported
public String getDescription()

getLabels

@Exported
public String getLabels()

getContextsInQueue

public Integer getContextsInQueue()

isValidLabel

public boolean isValidLabel(String candidate,
                            Map<String,Object> params)

getReservedBy

@Exported
public String getReservedBy()

isReserved

@Exported
public boolean isReserved()

getReservedByEmail

@Exported
public String getReservedByEmail()

isQueued

public boolean isQueued()

isQueued

public boolean isQueued(long taskId)

isQueuedByTask

public boolean isQueuedByTask(long taskId)

unqueue

public void unqueue()

isLocked

@Exported
public boolean isLocked()

getLockCause

@CheckForNull
public String getLockCause()

Resolve the lock cause for this resource. It can be reserved or locked.

Returns:

the lock cause or null if not locked

getBuild

@WithBridgeMethods(value=hudson.model.AbstractBuild.class,
                   adapterMethod="getAbstractBuild")
public hudson.model.Run<?,?> getBuild()

getBuildName

@Exported
public String getBuildName()

setBuild

public void setBuild(hudson.model.Run<?,?> lockedBy)

getTask

public hudson.model.Queue.Task getTask()

getQueueItemId

public long getQueueItemId()

getQueueItemProject

public String getQueueItemProject()

setQueued

public void setQueued(long queueItemId)

setQueued

public void setQueued(long queueItemId,
                      String queueProjectName)

queueAdd

public void queueAdd(org.jenkinsci.plugins.workflow.steps.StepContext context)

setReservedBy

@DataBoundSetter
public void setReservedBy(String userName)

unReserve

public void unReserve()

reset

public void reset()

toString

public String toString()

Overrides:

toString in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object