Package com.cloudbees.plugins.credentials

Class CredentialsProviderFilter.Includes

java.lang.Object

hudson.model.AbstractDescribableImpl<CredentialsProviderFilter>

com.cloudbees.plugins.credentials.CredentialsProviderFilter

com.cloudbees.plugins.credentials.CredentialsProviderFilter.Includes

All Implemented Interfaces:

ExtensionPoint, Describable<CredentialsProviderFilter>, Serializable

Enclosing class:

CredentialsProviderFilter

public static class CredentialsProviderFilter.Includes
extends CredentialsProviderFilter

A filter that implements an allow-list policy, "if you are not on the list you can't come in".

Since:

2.0

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CredentialsProviderFilter.Includes.DescriptorImpl	Our descriptor.

Nested classes/interfaces inherited from class com.cloudbees.plugins.credentials.CredentialsProviderFilter

CredentialsProviderFilter.Excludes, CredentialsProviderFilter.Includes, CredentialsProviderFilter.None

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Constructor Summary

Constructors

Constructor	Description
Includes(List<String> classNames)	Our constructor.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
boolean	filter(CredentialsProvider provider)	Returns true if and only if the supplied CredentialsProvider is permitted to be active.
List<String>	getClassNames()	Returns the list of allowed Descriptor.getId()s.
int	hashCode()
String	toString()

Methods inherited from class com.cloudbees.plugins.credentials.CredentialsProviderFilter

getDescriptor

Methods inherited from class java.lang.Object

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

Constructor Details

Includes

@DataBoundConstructor
public Includes(@CheckForNull
 List<String> classNames)

Our constructor.

Parameters:

classNames - the list of allowed Descriptor.getId()s

Method Details

filter

public boolean filter(CredentialsProvider provider)

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

Specified by:

filter in class CredentialsProviderFilter

Parameters:

provider - the CredentialsProvider to check.

Returns:

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

getClassNames

@NonNull
public List<String> getClassNames()

Returns the list of allowed Descriptor.getId()s.

equals

public boolean equals(Object o)

Specified by:

equals in class CredentialsProviderFilter

hashCode

public int hashCode()

Specified by:

hashCode in class CredentialsProviderFilter

toString

public String toString()

Specified by:

toString in class CredentialsProviderFilter