Package com.cloudbees.plugins.credentials

Interface Summary

Interface	Description
Credentials	A generic type of credentials.
CredentialsMatcher	Something that matches credentials.
CredentialsMatcher.CQL	A mix-in interface to allow describing a credentials matcher.
CredentialsUseListener	A Listener to track Credentials usage.

Class Summary

Class	Description
BaseCredentials	Base class for Credentials.
ContextInPath.HandlerImpl
ContextMenuIconUtils	Some utility methods to help working with Icon, IconSet and ModelObjectWithContextMenu.ContextMenu.
CredentialsConfidentialKey	ConfidentialKey that stores a SecretKey for shared-secret cryptography (AES).
CredentialsDescriptor	Descriptor for credentials.
CredentialsDescriptor.EnhancedCheckMethod	An enhanced FormValidation.CheckMethod that can add assistance for resolving the context from the request path.
CredentialsMatchers	Some standard matchers and filtering utility methods.
CredentialsNameComparator	Comparator to alphabetically sort credentials drop down list in ascending order by Credential Name.
CredentialsNameProvider<C extends Credentials>	Provides names for credentials.
CredentialsParameterDefinition	A ParameterDefinition for a parameter that supplies a Credentials.
CredentialsParameterDefinition.DescriptorImpl	Our descriptor.
CredentialsParameterValue	A ParameterValue produced from a CredentialsParameterDefinition.
CredentialsProvider	An extension point for providing Credentials.
CredentialsProviderFilter	A filter of CredentialsProvider instances used by CredentialsProviderManager to determine which providers are active.
CredentialsProviderFilter.Excludes	A filter that implements a denylist policy, "if you are not on the list you can come in".
CredentialsProviderFilter.Excludes.DescriptorImpl	Our descriptor.
CredentialsProviderFilter.Includes	A filter that implements an allow-list policy, "if you are not on the list you can't come in".
CredentialsProviderFilter.Includes.DescriptorImpl	Our descriptor.
CredentialsProviderFilter.None	A filter that does not filter anything.
CredentialsProviderFilter.None.DescriptorImpl	Our descriptor.
CredentialsProviderFilterDescriptor	The base Descriptor class for all CredentialsProviderFilter instances.
CredentialsProviderManager	Manages the various CredentialsProvider implementations in a Jenkins
CredentialsProviderManager.Configuration	Our global configuration.
CredentialsProviderTypeRestriction	A filter of CredentialsDescriptor types scoped to specific CredentialsProvider instances used by CredentialsProviderManager to determine which types are applicable to each provider.
CredentialsProviderTypeRestriction.Excludes	A list of excluded types for each provider.
CredentialsProviderTypeRestriction.Excludes.DescriptorImpl	Our descriptor
CredentialsProviderTypeRestriction.Includes	A list of included types for each provider.
CredentialsProviderTypeRestriction.Includes.DescriptorImpl	Our descriptor
CredentialsProviderTypeRestrictionDescriptor	The Descriptor base class for CredentialsProviderTypeRestriction implementations.
CredentialsResolver<F extends Credentials,T extends Credentials>	Translates Credentials from one type into another.
CredentialsSelectHelper	A descriptor used to assist the c:select tag with allowing in-place addition of credentials.
CredentialsSelectHelper.ContextResolver	An extension point to allow plugging in additional resolution of ModelObject instances.
CredentialsSelectHelper.ItemContextResolver	A CredentialsSelectHelper.ContextResolver for Item instances resolvable by Jenkins.getItemByFullName(String).
CredentialsSelectHelper.StoreItem	Value class to hold the details of a CredentialsStore.
CredentialsSelectHelper.SystemContextResolver	A CredentialsSelectHelper.ContextResolver for Jenkins.
CredentialsSelectHelper.UserContextResolver	A CredentialsSelectHelper.ContextResolver for User instances.
CredentialsSelectHelper.WrappedContextResolver	Stapler binding for CredentialsSelectHelper.ContextResolver.
CredentialsSelectHelper.WrappedContextResolverCredentialsProvider	Stapler binding for a CredentialsSelectHelper.ContextResolver and CredentialsProvider.
CredentialsSelectHelper.WrappedCredentialsStore	Stapler binding for a CredentialsStore.
CredentialsSnapshotTaker<C extends Credentials>	Some credential types can store some of the credential details in a file outside of Jenkins.
CredentialsStore	A store of Credentials.
CredentialsStoreAction	An action for a CredentialsStore
CredentialsStoreAction.CredentialsWrapper	A wrapper object to bind and expose Credentials instances into the web UI.
CredentialsStoreAction.CredentialsWrapper.DescriptorImpl	Our Descriptor.
CredentialsStoreAction.DomainWrapper	A wrapper object to bind and expose Domain instances into the web UI.
CredentialsStoreAction.DomainWrapper.DescriptorImpl	Our Descriptor.
CredentialsTypeFilter	A filter of CredentialsDescriptor types used by CredentialsProviderManager to determine which types are active.
CredentialsTypeFilter.Excludes	A filter that implements a denylist policy, "if you are not on the list you can come in".
CredentialsTypeFilter.Excludes.DescriptorImpl	Our descriptor.
CredentialsTypeFilter.Includes	A filter that implements a allowlist policy, "if you are not on the list you can't come in".
CredentialsTypeFilter.Includes.DescriptorImpl	Our descriptor.
CredentialsTypeFilter.None	A filter that does not filter anything.
CredentialsTypeFilter.None.DescriptorImpl	Our descriptor.
CredentialsTypeFilterDescriptor	The base Descriptor class for all CredentialsTypeFilter instances.
GlobalCredentialsConfiguration	ManagementLink to expose the global credentials configuration screen.
GlobalCredentialsConfiguration.Category	Security related configurations.
GlobalCredentialsConfiguration.DescriptorImpl	Our Descriptor.
ManageCredentialsConfiguration	ManagementLink to expose a link to the manage credentials configuration screen.
Messages	Generated localization support class.
PluginImpl	Jenkins Plugin impl.
SecretBytes	An analogue of Secret to be used for efficient storage of byte[].
SecretBytes.ConverterImpl	Our XStream converter.
SecretBytes.StaplerConverterImpl
SystemCredentialsProvider	The root store of credentials.
SystemCredentialsProvider.DescriptorImpl	Our management link descriptor.
SystemCredentialsProvider.ProviderImpl
SystemCredentialsProvider.StoreImpl	Our CredentialsStore.
SystemCredentialsProvider.UserFacingAction	Expose the store.
UserCredentialsProvider	A store of credentials tied to a specific User.
UserCredentialsProvider.StoreImpl	Our implementation
UserCredentialsProvider.UserCredentialsProperty	Need a user property to hold the user's personal credentials.
UserCredentialsProvider.UserCredentialsProperty.DescriptorImpl	Our user property descriptor.
UserCredentialsProvider.UserFacingAction
ViewCredentialsAction	An Action that lets you view the available credentials for any ModelObject.
ViewCredentialsAction.RootActionImpl	Add the ViewCredentialsAction to the Jenkins root.
ViewCredentialsAction.TableEntry	Value class to simplify creating the table.
ViewCredentialsAction.TransientTopLevelItemActionFactoryImpl	Add the ViewCredentialsAction to all TopLevelItem instances.
ViewCredentialsAction.TransientUserActionFactoryImpl	Add the ViewCredentialsAction to all User instances.

Enum Summary

Enum	Description
CredentialsScope	The scope of credentials.

Exception Summary

Exception	Description
CredentialsUnavailableException	This exception can be thrown by any get method in a Credentials subclass to indicate that the requested property is unavailable.

Annotation Types Summary

Annotation Type	Description
ContextInPath	Indicates that this parameter is injected by evaluating StaplerRequest.getAncestors() and searching for a credentials context with the parameter type.
NameWith	Often there is a requirement to get the names of different credentials in order to allow the user to select from multiple equivalent credentials.
ResolveWith	As credentials evolve we need to be able to map legacy credential types to newer common interfaces and implementations.