Uses of Interface
com.cloudbees.plugins.credentials.Credentials

Packages that use Credentials

Package	Description
com.cloudbees.plugins.credentials
com.cloudbees.plugins.credentials.cli
com.cloudbees.plugins.credentials.common
com.cloudbees.plugins.credentials.domains
com.cloudbees.plugins.credentials.impl
com.cloudbees.plugins.credentials.matchers

Uses of Credentials in com.cloudbees.plugins.credentials

Classes in com.cloudbees.plugins.credentials with type parameters of type Credentials

Modifier and Type	Class	Description
class	CredentialsNameProvider<C extends Credentials>	Provides names for credentials.
class	CredentialsResolver<F extends Credentials,T extends Credentials>	Translates Credentials from one type into another.
class	CredentialsResolver<F extends Credentials,T extends Credentials>	Translates Credentials 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 Credentials

Modifier and Type	Class	Description
class	BaseCredentials	Base class for Credentials.

Methods in com.cloudbees.plugins.credentials with type parameters of type Credentials

Modifier and Type	Method	Description
static <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> C	CredentialsMatchers.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> C	CredentialsMatchers.firstOrNull(Iterable<C> credentials, CredentialsMatcher matcher)	Returns the first credential from a collection that matches the supplied matcher or null if none match.
abstract <C extends Credentials> List<C>	CredentialsProvider.getCredentials(Class<C> type, ItemGroup itemGroup, Authentication authentication)	Returns the credentials provided by this provider which are available to the specified Authentication for items in the specified ItemGroup
<C extends Credentials> List<C>	CredentialsProvider.getCredentials(Class<C> type, ItemGroup itemGroup, Authentication authentication, List<DomainRequirement> domainRequirements)	Returns the credentials provided by this provider which are available to the specified Authentication for items in the specified ItemGroup and are appropriate for the specified .plugins.credentials.domains.DomainRequirements.
<C extends Credentials> List<C>	CredentialsProvider.getCredentials(Class<C> type, Item item, Authentication authentication)	Returns the credentials provided by this provider which are available to the specified Authentication for the specified Item
<C extends Credentials> List<C>	CredentialsProvider.getCredentials(Class<C> type, Item item, Authentication authentication, List<DomainRequirement> domainRequirements)	Returns the credentials provided by this provider which are available to the specified Authentication for the specified Item and are appropriate for the specified DomainRequirements.
<C extends Credentials> List<C>	SystemCredentialsProvider.ProviderImpl.getCredentials(Class<C> type, ItemGroup itemGroup, Authentication authentication)	Returns the credentials provided by this provider which are available to the specified Authentication for items in the specified ItemGroup
<C extends Credentials> List<C>	SystemCredentialsProvider.ProviderImpl.getCredentials(Class<C> type, ItemGroup itemGroup, Authentication authentication, List<DomainRequirement> domainRequirements)	Returns the credentials provided by this provider which are available to the specified Authentication for items in the specified ItemGroup and are appropriate for the specified .plugins.credentials.domains.DomainRequirements.
<C extends Credentials> List<C>	SystemCredentialsProvider.ProviderImpl.getCredentials(Class<C> type, Item item, Authentication authentication)	Returns the credentials provided by this provider which are available to the specified Authentication for the specified Item
<C extends Credentials> List<C>	SystemCredentialsProvider.ProviderImpl.getCredentials(Class<C> type, Item item, Authentication authentication, List<DomainRequirement> domainRequirements)	Returns the credentials provided by this provider which are available to the specified Authentication for the specified Item and are appropriate for the specified DomainRequirements.
<C extends Credentials> List<C>	UserCredentialsProvider.getCredentials(Class<C> type, ItemGroup itemGroup, Authentication authentication)	Returns the credentials provided by this provider which are available to the specified Authentication for items in the specified ItemGroup
<C extends Credentials> List<C>	UserCredentialsProvider.getCredentials(Class<C> type, ItemGroup itemGroup, Authentication authentication, List<DomainRequirement> domainRequirements)	Returns the credentials provided by this provider which are available to the specified Authentication for items in the specified ItemGroup and are appropriate for the specified .plugins.credentials.domains.DomainRequirements.
<C extends Credentials> List<C>	UserCredentialsProvider.UserCredentialsProperty.getCredentials(Class<C> type)	Helper method.
static <C extends Credentials> CredentialsResolver<Credentials,C>	CredentialsResolver.getResolver(Class<C> clazz)	Retrieves the CredentialsResolver for the specified type (if it exists)
static <C extends Credentials> List<C>	CredentialsProvider.lookupCredentials(Class<C> type)	Deprecated. use CredentialsProvider.lookupCredentials(Class, Item, Authentication, List), CredentialsProvider.lookupCredentials(Class, Item, Authentication, DomainRequirement...), CredentialsProvider.lookupCredentials(Class, ItemGroup, Authentication, List) or CredentialsProvider.lookupCredentials(Class, ItemGroup, Authentication, DomainRequirement...)
static <C extends Credentials> List<C>	CredentialsProvider.lookupCredentials(Class<C> type, Item item)	Deprecated. use CredentialsProvider.lookupCredentials(Class, Item, Authentication, List) or CredentialsProvider.lookupCredentials(Class, Item, Authentication, DomainRequirement...)
static <C extends Credentials> List<C>	CredentialsProvider.lookupCredentials(Class<C> type, ItemGroup itemGroup)	Deprecated. use CredentialsProvider.lookupCredentials(Class, ItemGroup, Authentication, List) or CredentialsProvider.lookupCredentials(Class, ItemGroup, Authentication, DomainRequirement...)
static <C extends Credentials> List<C>	CredentialsProvider.lookupCredentials(Class<C> type, ItemGroup itemGroup, Authentication authentication)	Deprecated. use CredentialsProvider.lookupCredentials(Class, ItemGroup, Authentication, List) or CredentialsProvider.lookupCredentials(Class, ItemGroup, Authentication, DomainRequirement...)
static <C extends Credentials> List<C>	CredentialsProvider.lookupCredentials(Class<C> type, ItemGroup itemGroup, Authentication authentication, DomainRequirement... domainRequirements)	Returns all credentials which are available to the specified Authentication for use by the Items in the specified ItemGroup.
static <C extends Credentials> List<C>	CredentialsProvider.lookupCredentials(Class<C> type, ItemGroup itemGroup, Authentication authentication, List<DomainRequirement> domainRequirements)	Returns all credentials which are available to the specified Authentication for use by the Items in the specified ItemGroup.
static <C extends Credentials> List<C>	CredentialsProvider.lookupCredentials(Class<C> type, Item item, Authentication authentication)	Deprecated. use CredentialsProvider.lookupCredentials(Class, Item, Authentication, List) or CredentialsProvider.lookupCredentials(Class, Item, Authentication, DomainRequirement...)
static <C extends Credentials> List<C>	CredentialsProvider.lookupCredentials(Class<C> type, Item item, Authentication authentication, DomainRequirement... domainRequirements)	Returns all credentials which are available to the specified Authentication for use by the specified Item.
static <C extends Credentials> List<C>	CredentialsProvider.lookupCredentials(Class<C> type, Item item, Authentication authentication, List<DomainRequirement> domainRequirements)	Returns all credentials which are available to the specified Authentication for use by the specified Item.
static <C extends Credentials> List<C>	CredentialsProvider.lookupCredentials(Class<C> type, Authentication authentication)	Deprecated. use CredentialsProvider.lookupCredentials(Class, Item, Authentication, List), CredentialsProvider.lookupCredentials(Class, Item, Authentication, DomainRequirement...), CredentialsProvider.lookupCredentials(Class, ItemGroup, Authentication, List) or CredentialsProvider.lookupCredentials(Class, ItemGroup, Authentication, DomainRequirement...)
static <C extends Credentials> C	CredentialsProvider.snapshot(C credential)	Make a best effort to ensure that the supplied credential is a snapshot credential (i.e.
static <C extends Credentials> C	CredentialsProvider.snapshot(Class<C> clazz, C credential)	Make a best effort to ensure that the supplied credential is a snapshot credential (i.e.
static <C extends Credentials> C	CredentialsProvider.track(Item item, C credentials)	Track the usage of credentials in a specific item but not associated with a specific build, for example SCM polling.
static <C extends Credentials> C	CredentialsProvider.track(Node node, C credentials)	Track the usage of credentials in a specific node.
static <C extends Credentials> C	CredentialsProvider.track(Run build, C credentials)	Track the usage of credentials in a specific build.
static <C extends Credentials> List<C>	CredentialsProvider.trackAll(Item item, C... credentials)	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>	CredentialsProvider.trackAll(Item item, List<C> credentials)	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>	CredentialsProvider.trackAll(Node node, C... credentials)	Track the usage of credentials in a specific node.
static <C extends Credentials> List<C>	CredentialsProvider.trackAll(Node node, List<C> credentials)	Track the usage of credentials in a specific node.
static <C extends Credentials> List<C>	CredentialsProvider.trackAll(Run build, C... credentials)	Track the usage of credentials in a specific build.
static <C extends Credentials> List<C>	CredentialsProvider.trackAll(Run build, List<C> credentials)	Track the usage of credentials in a specific build.

Methods in com.cloudbees.plugins.credentials that return Credentials

Modifier and Type	Method	Description
default Credentials	Credentials.forRun(Run<?,?> context)	Optionally produce a special value when used in the context of a particular build.
Credentials	CredentialsStoreAction.CredentialsWrapper.getCredentials()	Exposes the backing Credentials.

Methods in com.cloudbees.plugins.credentials that return types with arguments of type Credentials

Modifier and Type	Method	Description
static DescriptorExtensionList<Credentials,CredentialsDescriptor>	CredentialsProvider.allCredentialsDescriptors()	Returns all the registered Credentials descriptors.
DescriptorExtensionList<Credentials,CredentialsDescriptor>	CredentialsStoreAction.CredentialsWrapper.DescriptorImpl.getCredentialDescriptors()	Exposes CredentialsProvider.allCredentialsDescriptors() to Jelly
DescriptorExtensionList<Credentials,CredentialsDescriptor>	UserCredentialsProvider.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.
List<Credentials>	SystemCredentialsProvider.getCredentials()	Get all the (Domain.global()) credentials.
List<Credentials>	SystemCredentialsProvider.StoreImpl.getCredentials(Domain domain)	Returns an unmodifiable list of credentials for the specified domain.
List<Credentials>	UserCredentialsProvider.StoreImpl.getCredentials(Domain domain)	Returns an unmodifiable list of credentials for the specified domain.
List<Credentials>	UserCredentialsProvider.UserCredentialsProperty.getCredentials()	Gets all the user's credentials.
Map<Domain,List<Credentials>>	SystemCredentialsProvider.getDomainCredentialsMap()	Get all the credentials.
Map<Domain,List<Credentials>>	UserCredentialsProvider.UserCredentialsProperty.getDomainCredentialsMap()	The map of domain credentials.
static <C extends Credentials> CredentialsResolver<Credentials,C>	CredentialsResolver.getResolver(Class<C> clazz)	Retrieves the CredentialsResolver for the specified type (if it exists)
Class<? extends CredentialsNameProvider<? extends Credentials>>	value()	The naming class to use.

Methods in com.cloudbees.plugins.credentials with parameters of type Credentials

Modifier and Type	Method	Description
abstract boolean	CredentialsStore.addCredentials(Domain domain, Credentials credentials)	Adds the specified Credentials within the specified Domain for this CredentialsStore.
boolean	SystemCredentialsProvider.StoreImpl.addCredentials(Domain domain, Credentials credentials)	Adds the specified Credentials within the specified Domain for this CredentialsStore.
boolean	UserCredentialsProvider.StoreImpl.addCredentials(Domain domain, Credentials credentials)	Adds the specified Credentials within the specified Domain for this CredentialsStore.
boolean	CredentialsStore.addDomain(Domain domain, Credentials... credentials)	Adds a new Domain with seed credentials.
int	CredentialsNameComparator.compare(Credentials c1, Credentials c2)
static void	CredentialsUseListener.fireUse(Credentials c, Item item)	Fires the CredentialsUseListener.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 the CredentialsUseListener.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 the CredentialsUseListener.onUse(com.cloudbees.plugins.credentials.Credentials, hudson.model.Run) event to track the run that uses credentials.
static Fingerprint	CredentialsProvider.getFingerprintOf(Credentials c)	Retrieves the Fingerprint 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 when Credentials is read by an item.
void	CredentialsUseListener.onUse(Credentials c, Node node)	Called when Credentials is read by a node.
void	CredentialsUseListener.onUse(Credentials c, Run run)	Called when Credentials is read by a run.
abstract boolean	CredentialsStore.removeCredentials(Domain domain, Credentials credentials)	Removes the specified Credentials from the specified Domain for this CredentialsStore.
boolean	SystemCredentialsProvider.StoreImpl.removeCredentials(Domain domain, Credentials credentials)	Removes the specified Credentials from the specified Domain for this CredentialsStore.
boolean	UserCredentialsProvider.StoreImpl.removeCredentials(Domain domain, Credentials credentials)	Removes the specified Credentials from the specified Domain for this CredentialsStore.
static <C extends Credentials> List<C>	CredentialsProvider.trackAll(Item item, C... credentials)	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>	CredentialsProvider.trackAll(Node node, C... credentials)	Track the usage of credentials in a specific node.
static <C extends Credentials> List<C>	CredentialsProvider.trackAll(Run build, C... credentials)	Track the usage of credentials in a specific build.
abstract boolean	CredentialsStore.updateCredentials(Domain domain, Credentials current, Credentials replacement)	Updates the specified Credentials from the specified Domain for this CredentialsStore with the supplied replacement.
boolean	SystemCredentialsProvider.StoreImpl.updateCredentials(Domain domain, Credentials current, Credentials replacement)	Updates the specified Credentials from the specified Domain for this CredentialsStore with the supplied replacement.
boolean	UserCredentialsProvider.StoreImpl.updateCredentials(Domain domain, Credentials current, Credentials replacement)	Updates the specified Credentials from the specified Domain for this CredentialsStore with the supplied replacement.

Method parameters in com.cloudbees.plugins.credentials with type arguments of type Credentials

Modifier and Type	Method	Description
boolean	CredentialsStore.addDomain(Domain domain, List<Credentials> credentials)	Adds a new Domain with seed credentials.
boolean	SystemCredentialsProvider.StoreImpl.addDomain(Domain domain, List<Credentials> credentials)	Adds a new Domain with seed credentials.
boolean	UserCredentialsProvider.StoreImpl.addDomain(Domain domain, List<Credentials> credentials)	Adds a new Domain with seed credentials.
boolean	CredentialsProvider.isApplicable(Class<? extends Credentials> clazz)	Returns true if this CredentialsProvider 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 Credentials

Constructor	Description
CredentialsWrapper(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 Credentials

Constructor	Description
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 Credentials

Modifier and Type	Method	Description
protected 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.common

Modifier and Type	Interface	Description
interface	CertificateCredentials	Client Credentials stored in a KeyStore.
interface	IdCredentials	Credentials that have an unique ID that assists in retrieving the specific credential from a collection of Credentials.
interface	PasswordCredentials	Credentials that have a password component.
interface	StandardCertificateCredentials	Credentials that have an ID, description, keystore and password, for example client certificates for SSL.
interface	StandardCredentials	Credentials that have a description to help the user differentiate the specific credential from a collection of Credentials and an ID to help Jenkins locate the specific credential from a collection of Credentials.
interface	StandardUsernameCredentials	Credentials that have an ID, description and username.
interface	StandardUsernamePasswordCredentials	The credential interface that standard username password based credentials should aim to implement.
interface	UsernameCredentials	Credentials that have a username.
interface	UsernamePasswordCredentials	Credentials that have both a username and a password component.

Methods in com.cloudbees.plugins.credentials.common that return types with arguments of type Credentials

Modifier and Type	Method	Description
Class<? extends Credentials>[]	preferred()

Uses of Credentials in com.cloudbees.plugins.credentials.domains

Subinterfaces of Credentials in com.cloudbees.plugins.credentials.domains

Modifier and Type	Interface	Description
interface	DomainRestrictedCredentials	Credentials that have a built in restriction

Methods in com.cloudbees.plugins.credentials.domains with type parameters of type Credentials

Modifier and Type	Method	Description
static <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 Credentials

Modifier and Type	Method	Description
static Map<Domain,List<Credentials>>	DomainCredentials.asMap(Collection<DomainCredentials> collection)	Converts a Collection of DomainCredentials into a Map keyed by Domain with List of Credentials as values.
List<Credentials>	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 a Map keyed by Domain with List of Credentials as values into a List of DomainCredentials into a

Method parameters in com.cloudbees.plugins.credentials.domains with type arguments of type Credentials

Modifier and Type	Method	Description
static List<DomainCredentials>	DomainCredentials.asList(Map<Domain,List<Credentials>> map)	Converts a Map keyed by Domain with List of Credentials as values into a List of DomainCredentials into a
static <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 a Map keyed by Domain with List of Credentials as values into a List of DomainCredentials into a

Constructor parameters in com.cloudbees.plugins.credentials.domains with type arguments of type Credentials

Constructor	Description
DomainCredentials(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 Credentials

Modifier and Type	Class	Description
class	BaseStandardCredentials	Base class for StandardCredentials.
class	CertificateCredentialsImpl
class	UsernamePasswordCredentialsImpl	Concrete implementation of StandardUsernamePasswordCredentials.

Uses of Credentials in com.cloudbees.plugins.credentials.matchers

Methods in com.cloudbees.plugins.credentials.matchers with parameters of type Credentials

Modifier and Type	Method	Description
boolean	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.