Class CredentialsProviderFilter
- java.lang.Object
-
- hudson.model.AbstractDescribableImpl<CredentialsProviderFilter>
-
- com.cloudbees.plugins.credentials.CredentialsProviderFilter
-
- All Implemented Interfaces:
ExtensionPoint
,Describable<CredentialsProviderFilter>
,Serializable
- Direct Known Subclasses:
CredentialsProviderFilter.Excludes
,CredentialsProviderFilter.Includes
,CredentialsProviderFilter.None
public abstract class CredentialsProviderFilter extends AbstractDescribableImpl<CredentialsProviderFilter> implements Serializable, ExtensionPoint
A filter ofCredentialsProvider
instances used byCredentialsProviderManager
to determine which providers are active.- Since:
- 2.0
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
CredentialsProviderFilter.Excludes
A filter that implements a denylist policy, "if you are not on the list you can come in".static class
CredentialsProviderFilter.Includes
A filter that implements an allow-list policy, "if you are not on the list you can't come in".static class
CredentialsProviderFilter.None
A filter that does not filter anything.-
Nested classes/interfaces inherited from interface hudson.ExtensionPoint
ExtensionPoint.LegacyInstancesAreScopedToHudson
-
-
Constructor Summary
Constructors Constructor Description CredentialsProviderFilter()
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description abstract boolean
equals(Object obj)
abstract boolean
filter(CredentialsProvider provider)
Returnstrue
if and only if the suppliedCredentialsProvider
is permitted to be active.CredentialsProviderFilterDescriptor
getDescriptor()
abstract int
hashCode()
abstract String
toString()
-
-
-
Method Detail
-
filter
public abstract boolean filter(CredentialsProvider provider)
Returnstrue
if and only if the suppliedCredentialsProvider
is permitted to be active.- Parameters:
provider
- theCredentialsProvider
to check.- Returns:
true
if and only if the suppliedCredentialsProvider
is permitted to be active.
-
getDescriptor
public CredentialsProviderFilterDescriptor getDescriptor()
- Specified by:
getDescriptor
in interfaceDescribable<CredentialsProviderFilter>
- Overrides:
getDescriptor
in classAbstractDescribableImpl<CredentialsProviderFilter>
-
-