com.cloudbees.plugins.credentials

Class CredentialsProviderTypeRestrictionDescriptor

java.lang.Object

hudson.model.Descriptor<CredentialsProviderTypeRestriction>

com.cloudbees.plugins.credentials.CredentialsProviderTypeRestrictionDescriptor

All Implemented Interfaces:

hudson.model.Saveable

Direct Known Subclasses:

CredentialsProviderTypeRestriction.Excludes.DescriptorImpl, CredentialsProviderTypeRestriction.Includes.DescriptorImpl

public abstract class CredentialsProviderTypeRestrictionDescriptor
extends hudson.model.Descriptor<CredentialsProviderTypeRestriction>

The Descriptor base class for CredentialsProviderTypeRestriction implementations.

Since:

2.0

Nested Class Summary

Nested classes/interfaces inherited from class hudson.model.Descriptor

hudson.model.Descriptor.FormException, hudson.model.Descriptor.PropertyType, hudson.model.Descriptor.Self

Field Summary

Fields inherited from class hudson.model.Descriptor

clazz

Fields inherited from interface hudson.model.Saveable

NOOP

Constructor Summary

Constructors

Constructor and Description
CredentialsProviderTypeRestrictionDescriptor()

Method Summary

Modifier and Type	Method and Description
abstract boolean	filter(List<CredentialsProviderTypeRestriction> restrictions, CredentialsProvider provider, CredentialsDescriptor type) Computes the effective CredentialsProviderTypeRestriction.filter(CredentialsProvider, CredentialsDescriptor) result from the sublist of all CredentialsProviderTypeRestriction instances that use this instance.

Methods inherited from class hudson.model.Descriptor

addHelpFileRedirect, calcAutoCompleteSettings, calcFillSettings, configure, configure, doHelp, find, find, findByDescribableClassName, findById, getCheckMethod, getCheckUrl, getConfigFile, getConfigPage, getCurrentDescriptorByNameUrl, getDescriptorFullUrl, getDescriptorUrl, getDisplayName, getGlobalConfigPage, getGlobalPropertyType, getHelpFile, getHelpFile, getHelpFile, getId, getJsonSafeClassName, getKlass, getPlugin, getPossibleViewNames, getPropertyType, getPropertyType, getPropertyTypeOrDie, getT, getViewPage, isInstance, isSubTypeOf, load, newInstance, newInstance, newInstancesFromHeteroList, newInstancesFromHeteroList, save, self, toArray, toList, toMap

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CredentialsProviderTypeRestrictionDescriptor

public CredentialsProviderTypeRestrictionDescriptor()

Method Detail

filter

public abstract boolean filter(List<CredentialsProviderTypeRestriction> restrictions,
                               CredentialsProvider provider,
                               CredentialsDescriptor type)

Computes the effective CredentialsProviderTypeRestriction.filter(CredentialsProvider, CredentialsDescriptor) result from the sublist of all CredentialsProviderTypeRestriction instances that use this instance. Each implementation can determine the policy to follow, typically implementations will from two styles:

• Require at least one CredentialsProviderTypeRestriction.filter(CredentialsProvider, CredentialsDescriptor) returning true
• Require no CredentialsProviderTypeRestriction.filter(CredentialsProvider, CredentialsDescriptor) returning false

But whether to check against the whole list or only a subset is a choice of the implementation.

Parameters:

restrictions - the sublist of CredentialsProviderManager.getRestrictions() that return this from CredentialsProviderTypeRestriction.getDescriptor()

provider - the CredentialsProvider to check.

type - the CredentialsDescriptor to check.

Returns:

true if and only if the supplied CredentialsDescriptor is permitted in the scope of the supplied CredentialsProvider