Package org.jenkins.plugins.lockableresources.actions

Class LockableResourcesRootAction

java.lang.Object

org.jenkins.plugins.lockableresources.actions.LockableResourcesRootAction

All Implemented Interfaces:

ExtensionPoint, Action, ModelObject, RootAction

@Extension
@ExportedBean
public class LockableResourcesRootAction
extends Object
implements RootAction

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	LockableResourcesRootAction.LockableResourcesLabel
static class	LockableResourcesRootAction.Queue
static final class	LockableResourcesRootAction.Summary

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields

Modifier and Type	Field	Description
static final Permission	CONFIGURE
static final String	ICON
static final PermissionGroup	PERMISSIONS_GROUP
static final Permission	QUEUE
static final Permission	RESERVE
static final Permission	STEAL
static final Permission	UNLOCK
static final Permission	VIEW

Constructor Summary

Constructors

Constructor	Description
LockableResourcesRootAction()

Method Summary

Modifier and Type	Method	Description
void	doChangeQueueOrder(org.kohsuke.stapler.StaplerRequest2 req, org.kohsuke.stapler.StaplerResponse2 rsp)	Change queue order (item position)
void	doCreateResource(org.kohsuke.stapler.StaplerRequest2 req, org.kohsuke.stapler.StaplerResponse2 rsp)	Create a new lockable resource from the management page.
void	doDeleteResource(org.kohsuke.stapler.StaplerRequest2 req, org.kohsuke.stapler.StaplerResponse2 rsp)	Delete a lockable resource from the management page.
void	doEditResource(org.kohsuke.stapler.StaplerRequest2 req, org.kohsuke.stapler.StaplerResponse2 rsp)	Edit an existing lockable resource from the management page.
void	doGetQueuePage(org.kohsuke.stapler.StaplerRequest2 req, org.kohsuke.stapler.StaplerResponse2 rsp)	Returns a page of queue items as JSON for server-side pagination.
void	doReassign(org.kohsuke.stapler.StaplerRequest2 req, org.kohsuke.stapler.StaplerResponse2 rsp)
void	doRecycleDeadLocks(org.kohsuke.stapler.StaplerRequest2 req, org.kohsuke.stapler.StaplerResponse2 rsp)
void	doReserve(org.kohsuke.stapler.StaplerRequest2 req, org.kohsuke.stapler.StaplerResponse2 rsp)
void	doReset(org.kohsuke.stapler.StaplerRequest2 req, org.kohsuke.stapler.StaplerResponse2 rsp)
void	doSaveNote(org.kohsuke.stapler.StaplerRequest2 req, org.kohsuke.stapler.StaplerResponse2 rsp)
void	doSteal(org.kohsuke.stapler.StaplerRequest2 req, org.kohsuke.stapler.StaplerResponse2 rsp)
void	doUnlock(org.kohsuke.stapler.StaplerRequest2 req, org.kohsuke.stapler.StaplerResponse2 rsp)
void	doUnreserve(org.kohsuke.stapler.StaplerRequest2 req, org.kohsuke.stapler.StaplerResponse2 rsp)
Set<String>	getAllLabels()	Deprecated.
Api	getApi()
int	getAssignedResourceAmount(String labelString)	Deprecated.
List<QueuedContextStruct>	getCurrentQueuedContext()	Deprecated.
String	getDisplayName()
int	getFreeResourceAmount(String labelString)	Deprecated.
int	getFreeResourcePercentage(String labelString)	Deprecated.
String	getIconFileName()
LinkedHashMap<String,LockableResourcesRootAction.LockableResourcesLabel>	getLabelsList()	Get a list of all labels
LockableResourcesManagementLink	getManagementLink()	Returns the ManagementLink instance for use by the Jelly view when rendering within the Manage Jenkins layout.
int	getNumberOfAllLabels()	Deprecated.
LockableResourcesStruct	getOldestQueue()	Deprecated.
LockableResourcesRootAction.Queue	getQueue()
LockableResource	getResource(String resourceName)
List<LockableResource>	getResources()	Get a list of resources
LockableResourcesRootAction.Summary	getSummary()	Returns a summary of resource states for the overview tab.
String	getUrlName()
String	getUserName()

Methods inherited from class java.lang.Object

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

Methods inherited from interface hudson.model.RootAction

getBadge, isPrimaryAction

Field Details

PERMISSIONS_GROUP

public static final PermissionGroup PERMISSIONS_GROUP

UNLOCK

public static final Permission UNLOCK

RESERVE

public static final Permission RESERVE

STEAL

public static final Permission STEAL

VIEW

public static final Permission VIEW

QUEUE

public static final Permission QUEUE

CONFIGURE

public static final Permission CONFIGURE

ICON

public static final String ICON

See Also:

• Constant Field Values

Constructor Details

LockableResourcesRootAction

public LockableResourcesRootAction()

Method Details

getIconFileName

@CheckForNull
public String getIconFileName()

Specified by:

getIconFileName in interface Action

getManagementLink

@Restricted(org.kohsuke.accmod.restrictions.NoExternalUse.class)
public LockableResourcesManagementLink getManagementLink()

Returns the ManagementLink instance for use by the Jelly view when rendering within the Manage Jenkins layout. Used by index.jelly.

getApi

public Api getApi()

getUserName

@CheckForNull
public String getUserName()

getDisplayName

@CheckForNull
public String getDisplayName()

Specified by:

getDisplayName in interface Action

Specified by:

getDisplayName in interface ModelObject

getUrlName

public String getUrlName()

Specified by:

getUrlName in interface Action

getSummary

@Restricted(org.kohsuke.accmod.restrictions.NoExternalUse.class)
public LockableResourcesRootAction.Summary getSummary()

Returns a summary of resource states for the overview tab.

getResources

@Exported
@Restricted(org.kohsuke.accmod.restrictions.NoExternalUse.class)
public List<LockableResource> getResources()

Get a list of resources

Returns:

All resources.

getLabelsList

@Restricted(org.kohsuke.accmod.restrictions.NoExternalUse.class)
public LinkedHashMap<String,LockableResourcesRootAction.LockableResourcesLabel> getLabelsList()

Get a list of all labels

Returns:

All possible labels.

getResource

@Restricted(org.kohsuke.accmod.restrictions.NoExternalUse.class)
public LockableResource getResource(String resourceName)

getFreeResourceAmount

@Restricted(org.kohsuke.accmod.restrictions.NoExternalUse.class)
@Deprecated
public int getFreeResourceAmount(String labelString)

Deprecated.

Get amount of free resources assigned to given *labelString*

Parameters:

labelString - Label to search.

Returns:

Amount of free labels.

getFreeResourcePercentage

@Restricted(org.kohsuke.accmod.restrictions.NoExternalUse.class)
@Deprecated
public int getFreeResourcePercentage(String labelString)

Deprecated.

Get percentage (0-100) usage of resources assigned to given *labelString*

Used by actions/LockableResourcesRootAction/index.jelly

Parameters:

labelString - Label to search.

Returns:

Percentage usages of *labelString* around all resources

Since:

2.19

getAllLabels

@Restricted(org.kohsuke.accmod.restrictions.NoExternalUse.class)
@Deprecated
public Set<String> getAllLabels()

Deprecated.

Get all existing labels as list.

Returns:

All possible labels.

getNumberOfAllLabels

@Restricted(org.kohsuke.accmod.restrictions.NoExternalUse.class)
@Deprecated
public int getNumberOfAllLabels()

Deprecated.

Get amount of all labels.

Returns:

Amount of all labels.

getAssignedResourceAmount

@Restricted(org.kohsuke.accmod.restrictions.NoExternalUse.class)
@Deprecated
public int getAssignedResourceAmount(String labelString)

Deprecated.

Get amount of resources assigned to given *labelString*

Used by actions/LockableResourcesRootAction/index.jelly

Parameters:

labelString - Label to search.

Returns:

Amount of assigned resources.

getQueue

@Restricted(org.kohsuke.accmod.restrictions.NoExternalUse.class)
public LockableResourcesRootAction.Queue getQueue()
                                           throws Descriptor.FormException

Throws:

Descriptor.FormException

getCurrentQueuedContext

@Restricted(org.kohsuke.accmod.restrictions.NoExternalUse.class)
@Deprecated
public List<QueuedContextStruct> getCurrentQueuedContext()

Deprecated.

Returns current queue

getOldestQueue

@Restricted(org.kohsuke.accmod.restrictions.NoExternalUse.class)
@CheckForNull
@Deprecated
public LockableResourcesStruct getOldestQueue()

Deprecated.

Returns current queue

doUnlock

public void doUnlock(org.kohsuke.stapler.StaplerRequest2 req,
 org.kohsuke.stapler.StaplerResponse2 rsp)
              throws IOException,
jakarta.servlet.ServletException

Throws:

IOException

jakarta.servlet.ServletException

doReserve

public void doReserve(org.kohsuke.stapler.StaplerRequest2 req,
 org.kohsuke.stapler.StaplerResponse2 rsp)
               throws IOException,
jakarta.servlet.ServletException

Throws:

IOException

jakarta.servlet.ServletException

doSteal

public void doSteal(org.kohsuke.stapler.StaplerRequest2 req,
 org.kohsuke.stapler.StaplerResponse2 rsp)
             throws IOException,
jakarta.servlet.ServletException

Throws:

IOException

jakarta.servlet.ServletException

doReassign

public void doReassign(org.kohsuke.stapler.StaplerRequest2 req,
 org.kohsuke.stapler.StaplerResponse2 rsp)
                throws IOException,
jakarta.servlet.ServletException

Throws:

IOException

jakarta.servlet.ServletException

doUnreserve

public void doUnreserve(org.kohsuke.stapler.StaplerRequest2 req,
 org.kohsuke.stapler.StaplerResponse2 rsp)
                 throws IOException,
jakarta.servlet.ServletException

Throws:

IOException

jakarta.servlet.ServletException

doReset

public void doReset(org.kohsuke.stapler.StaplerRequest2 req,
 org.kohsuke.stapler.StaplerResponse2 rsp)
             throws IOException,
jakarta.servlet.ServletException

Throws:

IOException

jakarta.servlet.ServletException

doRecycleDeadLocks

public void doRecycleDeadLocks(org.kohsuke.stapler.StaplerRequest2 req,
 org.kohsuke.stapler.StaplerResponse2 rsp)
                        throws IOException,
jakarta.servlet.ServletException

Throws:

IOException

jakarta.servlet.ServletException

doSaveNote

public void doSaveNote(org.kohsuke.stapler.StaplerRequest2 req,
 org.kohsuke.stapler.StaplerResponse2 rsp)
                throws IOException,
jakarta.servlet.ServletException

Throws:

IOException

jakarta.servlet.ServletException

doChangeQueueOrder

@Restricted(org.kohsuke.accmod.restrictions.NoExternalUse.class)
public void doChangeQueueOrder(org.kohsuke.stapler.StaplerRequest2 req,
 org.kohsuke.stapler.StaplerResponse2 rsp)
                        throws IOException,
jakarta.servlet.ServletException

Change queue order (item position)

Throws:

IOException

jakarta.servlet.ServletException

doGetQueuePage

@Restricted(org.kohsuke.accmod.restrictions.NoExternalUse.class)
public void doGetQueuePage(org.kohsuke.stapler.StaplerRequest2 req,
 org.kohsuke.stapler.StaplerResponse2 rsp)
                    throws IOException,
jakarta.servlet.ServletException

Returns a page of queue items as JSON for server-side pagination.

Throws:

IOException

jakarta.servlet.ServletException

doCreateResource

@Restricted(org.kohsuke.accmod.restrictions.NoExternalUse.class)
public void doCreateResource(org.kohsuke.stapler.StaplerRequest2 req,
 org.kohsuke.stapler.StaplerResponse2 rsp)
                      throws IOException,
jakarta.servlet.ServletException

Create a new lockable resource from the management page.

Throws:

IOException

jakarta.servlet.ServletException

doEditResource

@Restricted(org.kohsuke.accmod.restrictions.NoExternalUse.class)
public void doEditResource(org.kohsuke.stapler.StaplerRequest2 req,
 org.kohsuke.stapler.StaplerResponse2 rsp)
                    throws IOException,
jakarta.servlet.ServletException

Edit an existing lockable resource from the management page.

Throws:

IOException

jakarta.servlet.ServletException

doDeleteResource

@Restricted(org.kohsuke.accmod.restrictions.NoExternalUse.class)
public void doDeleteResource(org.kohsuke.stapler.StaplerRequest2 req,
 org.kohsuke.stapler.StaplerResponse2 rsp)
                      throws IOException,
jakarta.servlet.ServletException

Delete a lockable resource from the management page.

Throws:

IOException

jakarta.servlet.ServletException