Package com.cloudbees.plugins.credentials

Class GlobalCredentialsConfiguration

java.lang.Object

hudson.model.ManagementLink

com.cloudbees.plugins.credentials.GlobalCredentialsConfiguration

All Implemented Interfaces:

ExtensionPoint, Action, Describable<GlobalCredentialsConfiguration>, ModelObject

@Extension(ordinal=2.147483435E9)
public class GlobalCredentialsConfiguration
extends ManagementLink
implements Describable<GlobalCredentialsConfiguration>

ManagementLink to expose the global credentials configuration screen.

Since:

2.0

See Also:

• CredentialsProviderManager.Configuration
• GlobalCredentialsConfiguration.Category

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	GlobalCredentialsConfiguration.Category	Security related configurations.
static final class	GlobalCredentialsConfiguration.DescriptorImpl	Our Descriptor.

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields

Modifier and Type	Field	Description
static final Predicate<Descriptor>	FILTER	Our filter.

Fields inherited from class hudson.model.ManagementLink

LIST

Constructor Summary

Constructors

Constructor	Description
GlobalCredentialsConfiguration()

Method Summary

Modifier and Type	Method	Description
org.kohsuke.stapler.HttpResponse	doConfigure(org.kohsuke.stapler.StaplerRequest2 req)	Handles the form submission
String	getCategoryName()
String	getDescription()
Descriptor<GlobalCredentialsConfiguration>	getDescriptor()
String	getDisplayName()
String	getIconFileName()
Permission	getRequiredPermission()	Allow users with Jenkins.SYSTEM_READ to view (but not modify) this configuration screen, matching GlobalSecurityConfiguration's read-only behavior.
String	getUrlName()

Methods inherited from class hudson.model.ManagementLink

all, getBadge, getCategory, getRequiresConfirmation, getRequiresPOST

Methods inherited from class java.lang.Object

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

Field Details

FILTER

public static final Predicate<Descriptor> FILTER

Our filter.

Any Descriptor whose Descriptor.getCategory() is an instanceof GlobalCredentialsConfiguration.Category is rendered on this page via index.jelly, which st:includes the descriptor's full Descriptor.getGlobalConfigPage() — not just simple properties such as getId()/getDisplayName(). Since getRequiredPermission() only requires Jenkins.SYSTEM_READ, any descriptor that opts into GlobalCredentialsConfiguration.Category must ensure its global config page renders correctly in read-only mode.

Constructor Details

GlobalCredentialsConfiguration

public GlobalCredentialsConfiguration()

Method Details

getIconFileName

public String getIconFileName()

Specified by:

getIconFileName in interface Action

Specified by:

getIconFileName in class ManagementLink

getDisplayName

public String getDisplayName()

Specified by:

getDisplayName in interface Action

Specified by:

getDisplayName in interface ModelObject

getDescription

public String getDescription()

Overrides:

getDescription in class ManagementLink

getUrlName

public String getUrlName()

Specified by:

getUrlName in interface Action

Specified by:

getUrlName in class ManagementLink

getCategoryName

public String getCategoryName()

Overrides:

getCategoryName in class ManagementLink

getRequiredPermission

public Permission getRequiredPermission()

Allow users with Jenkins.SYSTEM_READ to view (but not modify) this configuration screen, matching GlobalSecurityConfiguration's read-only behavior.

Overrides:

getRequiredPermission in class ManagementLink

doConfigure

@NonNull
@Restricted(org.kohsuke.accmod.restrictions.NoExternalUse.class)
public org.kohsuke.stapler.HttpResponse doConfigure(@NonNull
 org.kohsuke.stapler.StaplerRequest2 req)
                                             throws IOException,
jakarta.servlet.ServletException,
Descriptor.FormException

Handles the form submission

Parameters:

req - the request.

Returns:

the response.

Throws:

IOException - if something goes wrong.

jakarta.servlet.ServletException - if something goes wrong.

Descriptor.FormException - if something goes wrong.

getDescriptor

public Descriptor<GlobalCredentialsConfiguration> getDescriptor()

Specified by:

getDescriptor in interface Describable<GlobalCredentialsConfiguration>