Package com.cloudbees.plugins.credentials

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 of CredentialsDescriptor types used by CredentialsProviderManager 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

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

Methods inherited from class java.lang.Object

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

Constructor Details

CredentialsTypeFilter

public CredentialsTypeFilter()

Method Details

filter

public abstract boolean filter(CredentialsDescriptor type)

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

Parameters:

type - the CredentialsDescriptor to check.

Returns:

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

getDescriptor

public CredentialsTypeFilterDescriptor getDescriptor()

Specified by:

getDescriptor in interface Describable<CredentialsTypeFilter>

Overrides:

getDescriptor in class AbstractDescribableImpl<CredentialsTypeFilter>

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