Uses of Interface
com.cloudbees.plugins.credentials.Credentials
Packages that use Credentials
Package
Description
-
Uses of Credentials in com.cloudbees.plugins.credentials
Classes in com.cloudbees.plugins.credentials with type parameters of type CredentialsModifier and TypeClassDescriptionclass
CredentialsNameProvider<C extends Credentials>
Provides names for credentials.class
CredentialsResolver<F extends Credentials,
T extends Credentials> TranslatesCredentials
from one type into another.class
CredentialsResolver<F extends Credentials,
T extends Credentials> TranslatesCredentials
from one type into another.class
CredentialsSnapshotTaker<C extends Credentials>
Some credential types can store some of the credential details in a file outside of Jenkins.Classes in com.cloudbees.plugins.credentials that implement CredentialsMethods in com.cloudbees.plugins.credentials with type parameters of type CredentialsModifier and TypeMethodDescriptionstatic <C extends Credentials>
Iterable<C>CredentialsMatchers.filter
(Iterable<C> credentials, CredentialsMatcher matcher) Filters credentials using the supplied matcher.static <C extends Credentials>
Collection<C>CredentialsMatchers.filter
(Collection<C> credentials, CredentialsMatcher matcher) Filters credentials using the supplied matcher.static <C extends Credentials>
List<C>CredentialsMatchers.filter
(List<C> credentials, CredentialsMatcher matcher) Filters credentials using the supplied matcher.static <C extends Credentials>
Set<C>CredentialsMatchers.filter
(Set<C> credentials, CredentialsMatcher matcher) Filters credentials using the supplied matcher.static <C extends Credentials,
V>
Map<C,V> CredentialsMatchers.filterKeys
(Map<C, V> credentialMap, CredentialsMatcher matcher) Filters a map keyed by credentials using the supplied matcher.static <C extends Credentials,
K>
Map<K,C> CredentialsMatchers.filterValues
(Map<K, C> credentialMap, CredentialsMatcher matcher) Filters a map based on credential values using the supplied matcher.static <C extends Credentials>
CCredentialsMatchers.firstOrDefault
(Iterable<C> credentials, CredentialsMatcher matcher, C defaultIfNone) Returns the first credential from a collection that matches the supplied matcher or if none match then the specified default.static <C extends Credentials>
CCredentialsMatchers.firstOrNull
(Iterable<C> credentials, CredentialsMatcher matcher) Returns the first credential from a collection that matches the supplied matcher ornull
if none match.<C extends Credentials>
List<C>CredentialsProvider.getCredentials
(Class<C> type, ItemGroup itemGroup, Authentication authentication) Deprecated.<C extends Credentials>
List<C>CredentialsProvider.getCredentials
(Class<C> type, ItemGroup itemGroup, Authentication authentication, List<DomainRequirement> domainRequirements) Deprecated.<C extends Credentials>
List<C>CredentialsProvider.getCredentials
(Class<C> type, Item item, Authentication authentication) Deprecated.<C extends Credentials>
List<C>CredentialsProvider.getCredentials
(Class<C> type, Item item, Authentication authentication, List<DomainRequirement> domainRequirements) Deprecated.<C extends Credentials>
List<C>UserCredentialsProvider.UserCredentialsProperty.getCredentials
(Class<C> type) Helper method.<C extends Credentials>
List<C>CredentialsProvider.getCredentialsInItem
(Class<C> type, Item item, org.springframework.security.core.Authentication authentication, List<DomainRequirement> domainRequirements) Returns the credentials provided by this provider which are available to the specifiedAuthentication
for the specifiedItem
and are appropriate for the specifiedDomainRequirement
s.<C extends Credentials>
List<C>SystemCredentialsProvider.ProviderImpl.getCredentialsInItem
(Class<C> type, Item item, org.springframework.security.core.Authentication authentication, List<DomainRequirement> domainRequirements) Returns the credentials provided by this provider which are available to the specifiedAuthentication
for the specifiedItem
and are appropriate for the specifiedDomainRequirement
s.<C extends Credentials>
List<C>CredentialsProvider.getCredentialsInItemGroup
(Class<C> type, ItemGroup itemGroup, org.springframework.security.core.Authentication authentication, List<DomainRequirement> domainRequirements) Returns the credentials provided by this provider which are available to the specifiedAuthentication
for items in the specifiedItemGroup
and are appropriate for the specified.plugins.credentials.domains.DomainRequirement
s.<C extends Credentials>
List<C>SystemCredentialsProvider.ProviderImpl.getCredentialsInItemGroup
(Class<C> type, ItemGroup itemGroup, org.springframework.security.core.Authentication authentication, List<DomainRequirement> domainRequirements) Returns the credentials provided by this provider which are available to the specifiedAuthentication
for items in the specifiedItemGroup
and are appropriate for the specified.plugins.credentials.domains.DomainRequirement
s.<C extends Credentials>
List<C>UserCredentialsProvider.getCredentialsInItemGroup
(Class<C> type, ItemGroup itemGroup, org.springframework.security.core.Authentication authentication, List<DomainRequirement> domainRequirements) Returns the credentials provided by this provider which are available to the specifiedAuthentication
for items in the specifiedItemGroup
and are appropriate for the specified.plugins.credentials.domains.DomainRequirement
s.static <C extends Credentials>
CredentialsResolver<Credentials,C> CredentialsResolver.getResolver
(Class<C> clazz) Retrieves theCredentialsResolver
for the specified type (if it exists)static <C extends Credentials>
List<C>CredentialsProvider.lookupCredentials
(Class<C> type) static <C extends Credentials>
List<C>CredentialsProvider.lookupCredentials
(Class<C> type, Item item) Deprecated.static <C extends Credentials>
List<C>CredentialsProvider.lookupCredentials
(Class<C> type, ItemGroup itemGroup) Deprecated.static <C extends Credentials>
List<C>CredentialsProvider.lookupCredentials
(Class<C> type, ItemGroup itemGroup, Authentication authentication) Deprecated.static <C extends Credentials>
List<C>CredentialsProvider.lookupCredentials
(Class<C> type, ItemGroup itemGroup, Authentication authentication, DomainRequirement... domainRequirements) static <C extends Credentials>
List<C>CredentialsProvider.lookupCredentials
(Class<C> type, ItemGroup itemGroup, Authentication authentication, List<DomainRequirement> domainRequirements) Deprecated.static <C extends Credentials>
List<C>CredentialsProvider.lookupCredentials
(Class<C> type, Item item, Authentication authentication) Deprecated.static <C extends Credentials>
List<C>CredentialsProvider.lookupCredentials
(Class<C> type, Item item, Authentication authentication, DomainRequirement... domainRequirements) static <C extends Credentials>
List<C>CredentialsProvider.lookupCredentials
(Class<C> type, Item item, Authentication authentication, List<DomainRequirement> domainRequirements) static <C extends Credentials>
List<C>CredentialsProvider.lookupCredentials
(Class<C> type, Authentication authentication) static <C extends Credentials>
List<C>CredentialsProvider.lookupCredentialsInItem
(Class<C> type, Item item, org.springframework.security.core.Authentication authentication) Returns all credentials which are available to the specifiedAuthentication
for use by the specifiedItem
.static <C extends Credentials>
List<C>CredentialsProvider.lookupCredentialsInItem
(Class<C> type, Item item, org.springframework.security.core.Authentication authentication, List<DomainRequirement> domainRequirements) Returns all credentials which are available to the specifiedAuthentication
for use by the specifiedItem
.static <C extends Credentials>
List<C>CredentialsProvider.lookupCredentialsInItemGroup
(Class<C> type, ItemGroup itemGroup, org.springframework.security.core.Authentication authentication) static <C extends Credentials>
List<C>CredentialsProvider.lookupCredentialsInItemGroup
(Class<C> type, ItemGroup itemGroup, org.springframework.security.core.Authentication authentication, List<DomainRequirement> domainRequirements) static <C extends Credentials>
CCredentialsProvider.snapshot
(C credential) Make a best effort to ensure that the supplied credential is a snapshot credential (i.e.static <C extends Credentials>
CMake a best effort to ensure that the supplied credential is a snapshot credential (i.e.static <C extends Credentials>
CTrack the usage of credentials in a specific item but not associated with a specific build, for example SCM polling.static <C extends Credentials>
CTrack the usage of credentials in a specific node.static <C extends Credentials>
CTrack the usage of credentials in a specific build.static <C extends Credentials>
List<C>Track the usage of credentials in a specific item but not associated with a specific build, for example SCM polling.static <C extends Credentials>
List<C>Track the usage of credentials in a specific item but not associated with a specific build, for example SCM polling.static <C extends Credentials>
List<C>Track the usage of credentials in a specific node.static <C extends Credentials>
List<C>Track the usage of credentials in a specific node.static <C extends Credentials>
List<C>Track the usage of credentials in a specific build.static <C extends Credentials>
List<C>Track the usage of credentials in a specific build.Methods in com.cloudbees.plugins.credentials that return CredentialsModifier and TypeMethodDescriptiondefault Credentials
Optionally produce a special value when used in the context of a particular build.CredentialsStoreAction.CredentialsWrapper.getCredentials()
Exposes the backingCredentials
.Methods in com.cloudbees.plugins.credentials that return types with arguments of type CredentialsModifier and TypeMethodDescriptionCredentialsProvider.allCredentialsDescriptors()
Returns all the registeredCredentials
descriptors.CredentialsStoreAction.CredentialsWrapper.DescriptorImpl.getCredentialDescriptors()
ExposesCredentialsProvider.allCredentialsDescriptors()
to JellyUserCredentialsProvider.UserCredentialsProperty.DescriptorImpl.getCredentialDescriptors()
Gets all the credentials descriptors.abstract List<Credentials>
CredentialsStore.getCredentials
(Domain domain) Returns an unmodifiable list of credentials for the specified domain.SystemCredentialsProvider.getCredentials()
Get all the (Domain.global()
) credentials.SystemCredentialsProvider.StoreImpl.getCredentials
(Domain domain) Returns an unmodifiable list of credentials for the specified domain.UserCredentialsProvider.StoreImpl.getCredentials
(Domain domain) Returns an unmodifiable list of credentials for the specified domain.UserCredentialsProvider.UserCredentialsProperty.getCredentials()
Gets all the user's credentials.SystemCredentialsProvider.getDomainCredentialsMap()
Get all the credentials.UserCredentialsProvider.UserCredentialsProperty.getDomainCredentialsMap()
The map of domain credentials.static <C extends Credentials>
CredentialsResolver<Credentials,C> CredentialsResolver.getResolver
(Class<C> clazz) Retrieves theCredentialsResolver
for the specified type (if it exists)Methods in com.cloudbees.plugins.credentials with parameters of type CredentialsModifier and TypeMethodDescriptionabstract boolean
CredentialsStore.addCredentials
(Domain domain, Credentials credentials) boolean
SystemCredentialsProvider.StoreImpl.addCredentials
(Domain domain, Credentials credentials) boolean
UserCredentialsProvider.StoreImpl.addCredentials
(Domain domain, Credentials credentials) final boolean
CredentialsStore.addDomain
(Domain domain, Credentials... credentials) Adds a newDomain
with seed credentials.int
CredentialsNameComparator.compare
(Credentials c1, Credentials c2) static void
CredentialsUseListener.fireUse
(Credentials c, Item item) Fires theCredentialsUseListener.onUse(com.cloudbees.plugins.credentials.Credentials, hudson.model.Run)
event to track the item that uses credentials.static void
CredentialsUseListener.fireUse
(Credentials c, Node node) Fires theCredentialsUseListener.onUse(com.cloudbees.plugins.credentials.Credentials, hudson.model.Run)
event to track the node that uses credentials.static void
CredentialsUseListener.fireUse
(Credentials c, Run run) Fires theCredentialsUseListener.onUse(com.cloudbees.plugins.credentials.Credentials, hudson.model.Run)
event to track the run that uses credentials.static Fingerprint
CredentialsProvider.getFingerprintOf
(Credentials c) Retrieves theFingerprint
for a specific credential.static Fingerprint
CredentialsProvider.getOrCreateFingerprintOf
(Credentials c) Creates a fingerprint that can be used to track the usage of a specific credential.boolean
CredentialsMatcher.matches
(Credentials item) Evaluates the matcher for the specified credentials.static String
CredentialsNameProvider.name
(Credentials credentials) Name the credential.void
CredentialsUseListener.onUse
(Credentials c, Item item) Called whenCredentials
is read by an item.void
CredentialsUseListener.onUse
(Credentials c, Node node) Called whenCredentials
is read by a node.void
CredentialsUseListener.onUse
(Credentials c, Run run) Called whenCredentials
is read by a run.abstract boolean
CredentialsStore.removeCredentials
(Domain domain, Credentials credentials) boolean
SystemCredentialsProvider.StoreImpl.removeCredentials
(Domain domain, Credentials credentials) boolean
UserCredentialsProvider.StoreImpl.removeCredentials
(Domain domain, Credentials credentials) static <C extends Credentials>
List<C>Track the usage of credentials in a specific item but not associated with a specific build, for example SCM polling.static <C extends Credentials>
List<C>Track the usage of credentials in a specific node.static <C extends Credentials>
List<C>Track the usage of credentials in a specific build.abstract boolean
CredentialsStore.updateCredentials
(Domain domain, Credentials current, Credentials replacement) Updates the specifiedCredentials
from the specifiedDomain
for thisCredentialsStore
with the supplied replacement.boolean
SystemCredentialsProvider.StoreImpl.updateCredentials
(Domain domain, Credentials current, Credentials replacement) Updates the specifiedCredentials
from the specifiedDomain
for thisCredentialsStore
with the supplied replacement.boolean
UserCredentialsProvider.StoreImpl.updateCredentials
(Domain domain, Credentials current, Credentials replacement) Updates the specifiedCredentials
from the specifiedDomain
for thisCredentialsStore
with the supplied replacement.Method parameters in com.cloudbees.plugins.credentials with type arguments of type CredentialsModifier and TypeMethodDescriptionboolean
CredentialsStore.addDomain
(Domain domain, List<Credentials> credentials) Adds a newDomain
with seed credentials.boolean
SystemCredentialsProvider.StoreImpl.addDomain
(Domain domain, List<Credentials> credentials) Adds a newDomain
with seed credentials.boolean
UserCredentialsProvider.StoreImpl.addDomain
(Domain domain, List<Credentials> credentials) Adds a newDomain
with seed credentials.final boolean
CredentialsProvider.isApplicable
(Class<? extends Credentials> clazz) Returnstrue
if thisCredentialsProvider
can provide credentials of the supplied type.void
SystemCredentialsProvider.setDomainCredentialsMap
(Map<Domain, List<Credentials>> domainCredentialsMap) Set all the credentials.void
UserCredentialsProvider.UserCredentialsProperty.setDomainCredentialsMap
(Map<Domain, List<Credentials>> domainCredentialsMap) Sets the map of domain credentials.Constructors in com.cloudbees.plugins.credentials with parameters of type CredentialsModifierConstructorDescriptionCredentialsWrapper
(CredentialsStoreAction.DomainWrapper domain, Credentials credentials, String id) Constructor.TableEntry
(CredentialsProvider provider, CredentialsStore store, Domain domain, Credentials credentials, boolean masked) Constructor.Constructor parameters in com.cloudbees.plugins.credentials with type arguments of type CredentialsModifierConstructorDescriptionprotected
CredentialsDescriptor
(Class<? extends Credentials> clazz) Constructor.UserCredentialsProperty
(List<Credentials> credentials) Deprecated. -
Uses of Credentials in com.cloudbees.plugins.credentials.cli
Methods in com.cloudbees.plugins.credentials.cli that return CredentialsModifier and TypeMethodDescriptionprotected static Credentials
BaseCredentialsCLICommand.getCredentialsById
(CredentialsStore store, Domain domain, String id) -
Uses of Credentials in com.cloudbees.plugins.credentials.common
Subinterfaces of Credentials in com.cloudbees.plugins.credentials.commonModifier and TypeInterfaceDescriptioninterface
Client Credentials stored in a KeyStore.interface
Credentials that have an unique ID that assists in retrieving the specific credential from a collection ofCredentials
.interface
Credentials that have a password component.interface
Credentials that have an ID, description, keystore and password, for example client certificates for SSL.interface
Credentials that have a description to help the user differentiate the specific credential from a collection ofCredentials
and an ID to helpJenkins
locate the specific credential from a collection ofCredentials
.interface
Credentials that have an ID, description and username.interface
The credential interface that standard username password based credentials should aim to implement.interface
Credentials that have a username.interface
Credentials that have both a username and a password component. -
Uses of Credentials in com.cloudbees.plugins.credentials.domains
Subinterfaces of Credentials in com.cloudbees.plugins.credentials.domainsModifier and TypeInterfaceDescriptioninterface
Credentials that have a built in restrictionMethods in com.cloudbees.plugins.credentials.domains with type parameters of type CredentialsModifier and TypeMethodDescriptionstatic <C extends Credentials>
List<C>DomainCredentials.getCredentials
(Map<Domain, List<Credentials>> domainCredentialsMap, Class<C> type, List<DomainRequirement> domainRequirements, CredentialsMatcher credentialsMatcher) Helper to assist retrieving credentials from the map based store.Methods in com.cloudbees.plugins.credentials.domains that return types with arguments of type CredentialsModifier and TypeMethodDescriptionstatic Map<Domain,
List<Credentials>> DomainCredentials.asMap
(Collection<DomainCredentials> collection) Converts aCollection
ofDomainCredentials
into aMap
keyed byDomain
withList
ofCredentials
as values.DomainCredentials.getCredentials()
Returns the credentials.static Map<Domain,
List<Credentials>> DomainCredentials.migrateListToMap
(Map<Domain, List<Credentials>> map, List<Credentials> list) Handle migration of standard storage method for pre-domain data into domain segmented data.static Map<Domain,
List<Credentials>> DomainCredentials.toCopyOnWriteMap
(Map<Domain, List<Credentials>> map) Converts aMap
keyed byDomain
withList
ofCredentials
as values into aList
ofDomainCredentials
into aMethod parameters in com.cloudbees.plugins.credentials.domains with type arguments of type CredentialsModifier and TypeMethodDescriptionstatic List<DomainCredentials>
DomainCredentials.asList
(Map<Domain, List<Credentials>> map) Converts aMap
keyed byDomain
withList
ofCredentials
as values into aList
ofDomainCredentials
into astatic <C extends Credentials>
List<C>DomainCredentials.getCredentials
(Map<Domain, List<Credentials>> domainCredentialsMap, Class<C> type, List<DomainRequirement> domainRequirements, CredentialsMatcher credentialsMatcher) Helper to assist retrieving credentials from the map based store.static Map<Domain,
List<Credentials>> DomainCredentials.migrateListToMap
(Map<Domain, List<Credentials>> map, List<Credentials> list) Handle migration of standard storage method for pre-domain data into domain segmented data.static Map<Domain,
List<Credentials>> DomainCredentials.migrateListToMap
(Map<Domain, List<Credentials>> map, List<Credentials> list) Handle migration of standard storage method for pre-domain data into domain segmented data.static Map<Domain,
List<Credentials>> DomainCredentials.toCopyOnWriteMap
(Map<Domain, List<Credentials>> map) Converts aMap
keyed byDomain
withList
ofCredentials
as values into aList
ofDomainCredentials
into aConstructor parameters in com.cloudbees.plugins.credentials.domains with type arguments of type CredentialsModifierConstructorDescriptionDomainCredentials
(Domain domain, List<Credentials> credentials) Stapler's constructor. -
Uses of Credentials in com.cloudbees.plugins.credentials.impl
Classes in com.cloudbees.plugins.credentials.impl that implement CredentialsModifier and TypeClassDescriptionclass
Base class forStandardCredentials
.class
class
Concrete implementation ofStandardUsernamePasswordCredentials
. -
Uses of Credentials in com.cloudbees.plugins.credentials.matchers
Methods in com.cloudbees.plugins.credentials.matchers with parameters of type CredentialsModifier and TypeMethodDescriptionboolean
AllOfMatcher.matches
(Credentials item) Evaluates the matcher for the specified credentials.boolean
AnyOfMatcher.matches
(Credentials item) Evaluates the matcher for the specified credentials.boolean
BeanPropertyMatcher.matches
(Credentials item) Evaluates the matcher for the specified credentials.boolean
ConstantMatcher.matches
(Credentials item) Evaluates the matcher for the specified credentials.boolean
IdMatcher.matches
(Credentials item) Evaluates the matcher for the specified credentials.boolean
InstanceOfMatcher.matches
(Credentials item) Evaluates the matcher for the specified credentials.boolean
NotMatcher.matches
(Credentials item) Evaluates the matcher for the specified credentials.boolean
ScopeMatcher.matches
(Credentials item) Evaluates the matcher for the specified credentials.boolean
UsernameMatcher.matches
(Credentials item) Evaluates the matcher for the specified credentials.
CredentialsProvider.getCredentialsInItemGroup(Class, ItemGroup, Authentication, List)
instead.