Package jp.ikedam.jenkins.plugins.updatesitesmanager

Class UpdateSitesManager

java.lang.Object

hudson.model.ManagementLink

jp.ikedam.jenkins.plugins.updatesitesmanager.UpdateSitesManager

All Implemented Interfaces:

ExtensionPoint, Action, ModelObject

@Extension(ordinal=2.147483237E9)
public class UpdateSitesManager
extends ManagementLink

Page for manage UpdateSites. Provides following page.

• Manage UpdateSites, shown in Manage Jenkins page

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	UpdateSitesManager.IdExtractor	Helps to check duplication
static class	UpdateSitesManager.IsSiteManaged	This predicate helps to filter which sites should be shown on UI as editable/not editable
static class	UpdateSitesManager.WithBlankId	Helps to check ids is blank

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

ManagementLink.Category

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields

Modifier and Type	Field	Description
static final String	URL

Fields inherited from class hudson.model.ManagementLink

LIST

Constructor Summary

Constructors

Constructor	Description
UpdateSitesManager()

Method Summary

Modifier and Type	Method	Description
void	doUpdate(org.kohsuke.stapler.StaplerRequest2 req, org.kohsuke.stapler.StaplerResponse2 rsp, List<UpdateSite> managed)	Update all registered sites with concatenation of managed and not managed
ManagementLink.Category	getCategory()
String	getDescription()	Return the description shown in Manage Jenkins page.
String	getDisplayName()	Return the name of the link shown in Manage Jenkins page.
String	getIconFileName()	Return the icon file name shown in Manage Jenkins page.
List<UpdateSite>	getManagedUpdateSiteList()	Return a list of custom UpdateSites registered in Jenkins.
List<UpdateSite>	getNotManagedUpdateSiteList()	Return a list of not custom UpdateSites registered in Jenkins.
List<DescribedUpdateSiteDescriptor>	getUpdateSiteDescriptorList()	Returns all the registered DescribedUpdateSite.
String	getUrlName()	Return the name used in url.

Methods inherited from class hudson.model.ManagementLink

all, getBadge, getCategoryName, getRequiredPermission, getRequiresConfirmation, getRequiresPOST

Methods inherited from class java.lang.Object

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

Field Details

URL

public static final String URL

See Also:

• Constant Field Values

Constructor Details

UpdateSitesManager

public UpdateSitesManager()

Method Details

getDisplayName

public String getDisplayName()

Return the name of the link shown in Manage Jenkins page.

Returns:

the name of the link.

See Also:

• Action.getDisplayName()

getIconFileName

public String getIconFileName()

Return the icon file name shown in Manage Jenkins page.

Specified by:

getIconFileName in interface Action

Specified by:

getIconFileName in class ManagementLink

Returns:

icon file name

See Also:

• ManagementLink.getIconFileName()

getCategory

@NonNull
public ManagementLink.Category getCategory()

Overrides:

getCategory in class ManagementLink

getDescription

public String getDescription()

Return the description shown in Manage Jenkins page.

Overrides:

getDescription in class ManagementLink

Returns:

the description

See Also:

• ManagementLink.getDescription()

getUrlName

public String getUrlName()

Return the name used in url.

Specified by:

getUrlName in interface Action

Specified by:

getUrlName in class ManagementLink

Returns:

the name used in url.

See Also:

• ManagementLink.getUrlName()

getManagedUpdateSiteList

public List<UpdateSite> getManagedUpdateSiteList()

Return a list of custom UpdateSites registered in Jenkins.

Returns:

a list of UpdateSites

getNotManagedUpdateSiteList

public List<UpdateSite> getNotManagedUpdateSiteList()

Return a list of not custom UpdateSites registered in Jenkins.

Returns:

a list of UpdateSites

getUpdateSiteDescriptorList

public List<DescribedUpdateSiteDescriptor> getUpdateSiteDescriptorList()

Returns all the registered DescribedUpdateSite.

Returns:

a list of Descriptor of DescribedUpdateSite.

doUpdate

public void doUpdate(org.kohsuke.stapler.StaplerRequest2 req,
 org.kohsuke.stapler.StaplerResponse2 rsp,
 @Sites
 List<UpdateSite> managed)
              throws IOException,
Descriptor.FormException,
jakarta.servlet.ServletException

Update all registered sites with concatenation of managed and not managed

Parameters:

req - the request

rsp - the response

managed - managed sites form submitted form

Throws:

jakarta.servlet.ServletException - thrown when failed to generate response

IOException - thrown when failed to generate response or to save configurations

Descriptor.FormException - thrown when inappropriate configurations