Package com.cloudbees.plugins.credentials

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 of CredentialsDescriptor types scoped to specific CredentialsProvider instances used by CredentialsProviderManager 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

Modifier and Type	Method	Description
abstract boolean	equals(Object obj)
abstract boolean	filter(CredentialsProvider provider, CredentialsDescriptor type)	Returns true if the supplied CredentialsDescriptor is permitted to be active for the supplied CredentialsProvider.
CredentialsProviderTypeRestrictionDescriptor	getDescriptor()
abstract int	hashCode()
abstract String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

CredentialsProviderTypeRestriction

public CredentialsProviderTypeRestriction()

Method Details

filter

public abstract boolean filter(CredentialsProvider provider,
 CredentialsDescriptor type)

Returns true if the supplied CredentialsDescriptor is permitted to be active for the supplied CredentialsProvider.

Parameters:

provider - the CredentialsProvider to check.

type - the CredentialsDescriptor to check.

Returns:

true if and only if the supplied CredentialsProvider is permitted to be active.

See Also:

• for how multiple instances are combined.

getDescriptor

public CredentialsProviderTypeRestrictionDescriptor getDescriptor()

Specified by:

getDescriptor in interface Describable<CredentialsProviderTypeRestriction>

Overrides:

getDescriptor in class AbstractDescribableImpl<CredentialsProviderTypeRestriction>

hashCode

public abstract int hashCode()

Overrides:

hashCode in class Object

equals

public abstract boolean equals(Object obj)

Overrides:

equals in class Object

toString

public abstract String toString()

Overrides:

toString in class Object