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