Class CredentialsProviderTypeRestriction
- java.lang.Object
-
- hudson.model.AbstractDescribableImpl<CredentialsProviderTypeRestriction>
-
- com.cloudbees.plugins.credentials.CredentialsProviderTypeRestriction
-
- All Implemented Interfaces:
ExtensionPoint
,Describable<CredentialsProviderTypeRestriction>
,Serializable
- Direct Known Subclasses:
CredentialsProviderTypeRestriction.Excludes
,CredentialsProviderTypeRestriction.Includes
public abstract class CredentialsProviderTypeRestriction extends AbstractDescribableImpl<CredentialsProviderTypeRestriction> implements Serializable, ExtensionPoint
A filter ofCredentialsDescriptor
types scoped to specificCredentialsProvider
instances used byCredentialsProviderManager
to determine which types are applicable to each provider.- Since:
- 2.0
- See Also:
CredentialsProviderFilter
,CredentialsTypeFilter
, Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
CredentialsProviderTypeRestriction.Excludes
A list of excluded types for each provider.static class
CredentialsProviderTypeRestriction.Includes
A list of included types for each provider.-
Nested classes/interfaces inherited from interface hudson.ExtensionPoint
ExtensionPoint.LegacyInstancesAreScopedToHudson
-
-
Constructor Summary
Constructors Constructor Description CredentialsProviderTypeRestriction()
-
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, CredentialsDescriptor type)
Returnstrue
if the suppliedCredentialsDescriptor
is permitted to be active for the suppliedCredentialsProvider
.CredentialsProviderTypeRestrictionDescriptor
getDescriptor()
abstract int
hashCode()
abstract String
toString()
-
-
-
Method Detail
-
filter
public abstract boolean filter(CredentialsProvider provider, CredentialsDescriptor type)
Returnstrue
if the suppliedCredentialsDescriptor
is permitted to be active for the suppliedCredentialsProvider
.- Parameters:
provider
- theCredentialsProvider
to check.type
- theCredentialsDescriptor
to check.- Returns:
true
if and only if the suppliedCredentialsProvider
is permitted to be active.- See Also:
for how multiple instances are combined.
-
getDescriptor
public CredentialsProviderTypeRestrictionDescriptor getDescriptor()
- Specified by:
getDescriptor
in interfaceDescribable<CredentialsProviderTypeRestriction>
- Overrides:
getDescriptor
in classAbstractDescribableImpl<CredentialsProviderTypeRestriction>
-
-