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

Packages that use CredentialsMatcher

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

Uses of CredentialsMatcher in com.cloudbees.plugins.credentials

Subinterfaces of CredentialsMatcher in com.cloudbees.plugins.credentials

Modifier and Type	Interface	Description
static interface	CredentialsMatcher.CQL	A mix-in interface to allow describing a credentials matcher.

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

Modifier and Type	Method	Description
static CredentialsMatcher	CredentialsMatchers.allOf(CredentialsMatcher... matchers)	Creates a matcher that matches when all of the supplied matchers match.
static CredentialsMatcher	CredentialsMatchers.always()	Creates a matcher that always matches.
static CredentialsMatcher	CredentialsMatchers.anyOf(CredentialsMatcher... matchers)	Creates a matcher that matches when any of the supplied matchers match.
static CredentialsMatcher	CredentialsMatchers.both(CredentialsMatcher matcher1, CredentialsMatcher matcher2)	Creates a matcher that matches when both of the supplied matchers match.
static CredentialsMatcher	CredentialsMatchers.either(CredentialsMatcher matcher1, CredentialsMatcher matcher2)	Creates a matcher that matches when either of the supplied matchers match.
static CredentialsMatcher	CredentialsMatchers.instanceOf(Class clazz)	Creates a matcher that matches credentials of the specified type.
static CredentialsMatcher	CredentialsMatchers.never()	Creates a matcher that never matches.
static CredentialsMatcher	CredentialsMatchers.noneOf(CredentialsMatcher... matchers)	Creates a matcher that matches when none of the supplied matchers match.
static CredentialsMatcher	CredentialsMatchers.not(CredentialsMatcher matcher)	Creates a matcher that inverts the supplied matcher.
static CredentialsMatcher	CredentialsMatchers.parse(String cql)	Attempts to parse a Credentials Query Language expression and construct the corresponding matcher.
static CredentialsMatcher	CredentialsMatchers.withId(String id)	Creates a matcher that matches IdCredentials with the supplied IdCredentials.getId()
static <T extends Serializable> CredentialsMatcher	CredentialsMatchers.withProperty(String name, T expected)	Creates a matcher that matches a named Java Bean property against the supplied expected value.
static CredentialsMatcher	CredentialsMatchers.withScope(CredentialsScope scope)	Creates a matcher that matches Credentials with the supplied CredentialsScope.
static CredentialsMatcher	CredentialsMatchers.withScopes(CredentialsScope... scopes)	Creates a matcher that matches Credentials with the supplied CredentialsScope.
static CredentialsMatcher	CredentialsMatchers.withScopes(Collection<CredentialsScope> scopes)	Creates a matcher that matches Credentials with the supplied CredentialsScope.
static CredentialsMatcher	CredentialsMatchers.withUsername(String username)	Creates a matcher that matches UsernameCredentials with the supplied UsernameCredentials.getUsername()

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

Modifier and Type	Method	Description
static CredentialsMatcher	CredentialsMatchers.allOf(CredentialsMatcher... matchers)	Creates a matcher that matches when all of the supplied matchers match.
static CredentialsMatcher	CredentialsMatchers.anyOf(CredentialsMatcher... matchers)	Creates a matcher that matches when any of the supplied matchers match.
static CredentialsMatcher	CredentialsMatchers.both(CredentialsMatcher matcher1, CredentialsMatcher matcher2)	Creates a matcher that matches when both of the supplied matchers match.
static String	CredentialsMatchers.describe(CredentialsMatcher matcher)	Attempts to describe the supplied CredentialsMatcher in terms of a Credentials Query Language.
static CredentialsMatcher	CredentialsMatchers.either(CredentialsMatcher matcher1, CredentialsMatcher matcher2)	Creates a matcher that matches when either of the supplied matchers match.
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.
<C extends IdCredentials> ListBoxModel	CredentialsProvider.getCredentialIds(Class<C> type, ItemGroup itemGroup, Authentication authentication, List<DomainRequirement> domainRequirements, CredentialsMatcher matcher)	Deprecated. Use CredentialsProvider.getCredentialIdsInItemGroup(Class, ItemGroup, Authentication, List, CredentialsMatcher) instead.
<C extends IdCredentials> ListBoxModel	CredentialsProvider.getCredentialIds(Class<C> type, Item item, Authentication authentication, List<DomainRequirement> domainRequirements, CredentialsMatcher matcher)	Deprecated. Use CredentialsProvider.getCredentialIdsInItem(Class, Item, Authentication, List, CredentialsMatcher) instead.
<C extends IdCredentials> ListBoxModel	CredentialsProvider.getCredentialIdsInItem(Class<C> type, Item item, org.springframework.security.core.Authentication authentication, List<DomainRequirement> domainRequirements, CredentialsMatcher matcher)	Returns a ListBoxModel of 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 IdCredentials> ListBoxModel	CredentialsProvider.getCredentialIdsInItemGroup(Class<C> type, ItemGroup itemGroup, org.springframework.security.core.Authentication authentication, List<DomainRequirement> domainRequirements, CredentialsMatcher matcher)	Returns a ListBoxModel of 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 DomainRequirements.
static <C extends IdCredentials> ListBoxModel	CredentialsProvider.listCredentials(Class<C> type, ItemGroup itemGroup, Authentication authentication, List<DomainRequirement> domainRequirements, CredentialsMatcher matcher)	Deprecated. Use CredentialsProvider.listCredentialsInItemGroup(Class, ItemGroup, Authentication, List, CredentialsMatcher) instead.
static <C extends IdCredentials> ListBoxModel	CredentialsProvider.listCredentials(Class<C> type, Item item, Authentication authentication, List<DomainRequirement> domainRequirements, CredentialsMatcher matcher)	Deprecated. Use CredentialsProvider.listCredentialsInItem(Class, Item, Authentication, List, CredentialsMatcher) instead.
static <C extends IdCredentials> ListBoxModel	CredentialsProvider.listCredentialsInItem(Class<C> type, Item item, org.springframework.security.core.Authentication authentication, List<DomainRequirement> domainRequirements, CredentialsMatcher matcher)	Returns a ListBoxModel of all credentials which are available to the specified Authentication for use by the specified Item.
static <C extends IdCredentials> ListBoxModel	CredentialsProvider.listCredentialsInItemGroup(Class<C> type, ItemGroup itemGroup, org.springframework.security.core.Authentication authentication, List<DomainRequirement> domainRequirements, CredentialsMatcher matcher)	Returns a ListBoxModel of all credentials which are available to the specified Authentication for use by the Items in the specified ItemGroup.
static CredentialsMatcher	CredentialsMatchers.noneOf(CredentialsMatcher... matchers)	Creates a matcher that matches when none of the supplied matchers match.
static CredentialsMatcher	CredentialsMatchers.not(CredentialsMatcher matcher)	Creates a matcher that inverts the supplied matcher.

Uses of CredentialsMatcher in com.cloudbees.plugins.credentials.common

Methods in com.cloudbees.plugins.credentials.common with parameters of type CredentialsMatcher

Modifier and Type	Method	Description
AbstractIdCredentialsListBoxModel<T,C>	AbstractIdCredentialsListBoxModel.includeMatching(ItemGroup context, Class<? extends C> type, List<DomainRequirement> domainRequirements, CredentialsMatcher matcher)	Adds the ids of the specified credential type that are available to the specified context as the current authentication with the specified domain requirements and match the specified filter.
AbstractIdCredentialsListBoxModel<T,C>	AbstractIdCredentialsListBoxModel.includeMatching(Item context, Class<? extends C> type, List<DomainRequirement> domainRequirements, CredentialsMatcher matcher)	Adds the ids of the specified credential type that are available to the specified context as the current authentication with the specified domain requirements and match the specified filter.
AbstractIdCredentialsListBoxModel<T,C>	AbstractIdCredentialsListBoxModel.includeMatchingAs(Authentication authentication, ItemGroup context, Class<? extends C> type, List<DomainRequirement> domainRequirements, CredentialsMatcher matcher)	Deprecated. Use AbstractIdCredentialsListBoxModel.includeMatchingAs(Authentication, ItemGroup, Class, List, CredentialsMatcher) instead.
AbstractIdCredentialsListBoxModel<T,C>	AbstractIdCredentialsListBoxModel.includeMatchingAs(Authentication authentication, Item context, Class<? extends C> type, List<DomainRequirement> domainRequirements, CredentialsMatcher matcher)	Deprecated. Use AbstractIdCredentialsListBoxModel.includeMatchingAs(Authentication, Item, Class, List, CredentialsMatcher) instead.
AbstractIdCredentialsListBoxModel<T,C>	AbstractIdCredentialsListBoxModel.includeMatchingAs(org.springframework.security.core.Authentication authentication, ItemGroup context, Class<? extends C> type, List<DomainRequirement> domainRequirements, CredentialsMatcher matcher)	Adds the ids of the specified credential type that are available to the specified context as the specified authentication with the specified domain requirements and match the specified filter.
AbstractIdCredentialsListBoxModel<T,C>	AbstractIdCredentialsListBoxModel.includeMatchingAs(org.springframework.security.core.Authentication authentication, Item context, Class<? extends C> type, List<DomainRequirement> domainRequirements, CredentialsMatcher matcher)	Adds the ids of the specified credential type that are available to the specified context as the specified authentication with the specified domain requirements and match the specified filter.
AbstractIdCredentialsListBoxModel<T,C>	AbstractIdCredentialsListBoxModel.withMatching(CredentialsMatcher matcher, C... credentials)	Deprecated. prefer using the AbstractIdCredentialsListBoxModel.includeMatching(Item, Class, List, CredentialsMatcher) or AbstractIdCredentialsListBoxModel.includeMatchingAs(Authentication, Item, Class, List, CredentialsMatcher) methods to build the list box contents in order to allow credentials providers to not have to instantiate a full credential instance where those credential providers store the secrets external from Jenkins.
AbstractIdCredentialsListBoxModel<T,C>	AbstractIdCredentialsListBoxModel.withMatching(CredentialsMatcher matcher, Iterable<? extends C> credentials)	Deprecated. prefer using the AbstractIdCredentialsListBoxModel.includeMatching(Item, Class, List, CredentialsMatcher) or AbstractIdCredentialsListBoxModel.includeMatchingAs(Authentication, Item, Class, List, CredentialsMatcher) methods to build the list box contents in order to allow credentials providers to not have to instantiate a full credential instance where those credential providers store the secrets external from Jenkins.
AbstractIdCredentialsListBoxModel<T,C>	AbstractIdCredentialsListBoxModel.withMatching(CredentialsMatcher matcher, Iterator<? extends C> credentials)	Deprecated. prefer using the AbstractIdCredentialsListBoxModel.includeMatching(Item, Class, List, CredentialsMatcher) or AbstractIdCredentialsListBoxModel.includeMatchingAs(Authentication, Item, Class, List, CredentialsMatcher) methods to build the list box contents in order to allow credentials providers to not have to instantiate a full credential instance where those credential providers store the secrets external from Jenkins.

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

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

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.

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

Classes in com.cloudbees.plugins.credentials.matchers that implement CredentialsMatcher

Modifier and Type	Class	Description
class	AllOfMatcher	Matches all of the supplied matchers.
class	AnyOfMatcher	Matches any of the supplied matchers.
class	BeanPropertyMatcher<T extends Serializable>	Matches credentials that have a Java Bean property with an expected value.
class	ConstantMatcher	Matches credentials based on a constant result.
class	IdMatcher	Matches credentials that are IdCredentials and have the specified IdCredentials.getId().
class	InstanceOfMatcher	Matches credentials that implement a specific type.
class	NotMatcher	Inverts a matcher.
class	ScopeMatcher	Matches credentials that are IdCredentials and have the specified CredentialsScope(s).
class	UsernameMatcher	Matches credentials that are UsernameCredentials and have the specified UsernameCredentials.getUsername()

Constructors in com.cloudbees.plugins.credentials.matchers with parameters of type CredentialsMatcher

Modifier	Constructor	Description
	NotMatcher(CredentialsMatcher matcher)	Creates a new instance.

Constructor parameters in com.cloudbees.plugins.credentials.matchers with type arguments of type CredentialsMatcher

Modifier	Constructor	Description
	AllOfMatcher(List<CredentialsMatcher> matchers)	Creates a new instance.
	AnyOfMatcher(List<CredentialsMatcher> matchers)	Creates a new instance.