com.cloudbees.plugins.credentials

Interface CredentialsMatcher

All Superinterfaces:

Serializable

All Known Subinterfaces:

CredentialsMatcher.CQL

All Known Implementing Classes:

AllOfMatcher, AnyOfMatcher, BeanPropertyMatcher, ConstantMatcher, IdMatcher, InstanceOfMatcher, NotMatcher, ScopeMatcher, UsernameMatcher

public interface CredentialsMatcher
extends Serializable

Something that matches credentials. Best practice is to

• Also implement CredentialsMatcher.CQL and return a description of the matcher logic using the CQL syntax detailed in CredentialsMatchers.describe(CredentialsMatcher)
• Implement Object.toString()
• Implement Object.equals(Object) and Object.hashCode()
• Define a serialVersionUID field to ensure consistent serialization

Since:

1.5

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
boolean	matches(Credentials item) Evaluates the matcher for the specified credentials.

Method Detail

matches

boolean matches(@NonNull
                Credentials item)

Evaluates the matcher for the specified credentials.

Parameters:

item - the specified credentials.

Returns:

true if and only if the specified credentials match.