Class CredentialsProviderTypeRestrictionDescriptor
- java.lang.Object
-
- hudson.model.Descriptor<CredentialsProviderTypeRestriction>
-
- com.cloudbees.plugins.credentials.CredentialsProviderTypeRestrictionDescriptor
-
- Direct Known Subclasses:
CredentialsProviderTypeRestriction.Excludes.DescriptorImpl
,CredentialsProviderTypeRestriction.Includes.DescriptorImpl
public abstract class CredentialsProviderTypeRestrictionDescriptor extends Descriptor<CredentialsProviderTypeRestriction>
TheDescriptor
base class forCredentialsProviderTypeRestriction
implementations.- Since:
- 2.0
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class hudson.model.Descriptor
Descriptor.FormException, Descriptor.PropertyType, Descriptor.Self
-
-
Field Summary
-
Fields inherited from class hudson.model.Descriptor
clazz
-
-
Constructor Summary
Constructors Constructor Description CredentialsProviderTypeRestrictionDescriptor()
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description abstract boolean
filter(List<CredentialsProviderTypeRestriction> restrictions, CredentialsProvider provider, CredentialsDescriptor type)
Computes the effectiveCredentialsProviderTypeRestriction.filter(CredentialsProvider, CredentialsDescriptor)
result from the sublist of allCredentialsProviderTypeRestriction
instances that use thisinstance
.-
Methods inherited from class hudson.model.Descriptor
addHelpFileRedirect, bindJSON, calcAutoCompleteSettings, calcFillSettings, configure, configure, doHelp, find, find, findByDescribableClassName, findById, getCategory, getCheckMethod, getCheckUrl, getConfigFile, getConfigPage, getCurrentDescriptorByNameUrl, getDescriptorFullUrl, getDescriptorUrl, getDisplayName, getGlobalConfigPage, getGlobalPropertyType, getHelpFile, getHelpFile, getHelpFile, getId, getJsonSafeClassName, getKlass, getPlugin, getPossibleViewNames, getPropertyType, getPropertyType, getPropertyTypeOrDie, getRequiredGlobalConfigPagePermission, getT, getViewPage, isInstance, isSubTypeOf, load, newInstance, newInstance, newInstancesFromHeteroList, newInstancesFromHeteroList, save, self, toArray, toList, toMap
-
-
-
-
Method Detail
-
filter
public abstract boolean filter(List<CredentialsProviderTypeRestriction> restrictions, CredentialsProvider provider, CredentialsDescriptor type)
Computes the effectiveCredentialsProviderTypeRestriction.filter(CredentialsProvider, CredentialsDescriptor)
result from the sublist of allCredentialsProviderTypeRestriction
instances that use thisinstance
. Each implementation can determine the policy to follow, typically implementations will from two styles:- Require at least one
CredentialsProviderTypeRestriction.filter(CredentialsProvider, CredentialsDescriptor)
returningtrue
- Require no
CredentialsProviderTypeRestriction.filter(CredentialsProvider, CredentialsDescriptor)
returningfalse
- Parameters:
restrictions
- the sublist ofCredentialsProviderManager.getRestrictions()
that returnthis
fromCredentialsProviderTypeRestriction.getDescriptor()
provider
- theCredentialsProvider
to check.type
- theCredentialsDescriptor
to check.- Returns:
true
if and only if the suppliedCredentialsDescriptor
is permitted in the scope of the suppliedCredentialsProvider
- Require at least one
-
-