Package com.cloudbees.plugins.credentials

Class CredentialsTypeFilter.Includes

java.lang.Object

hudson.model.AbstractDescribableImpl<CredentialsTypeFilter>

com.cloudbees.plugins.credentials.CredentialsTypeFilter

com.cloudbees.plugins.credentials.CredentialsTypeFilter.Includes

All Implemented Interfaces:

ExtensionPoint, Describable<CredentialsTypeFilter>, Serializable

Enclosing class:

CredentialsTypeFilter

public static class CredentialsTypeFilter.Includes
extends CredentialsTypeFilter

A filter that implements a allowlist 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	CredentialsTypeFilter.Includes.DescriptorImpl	Our descriptor.

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

CredentialsTypeFilter.Excludes, CredentialsTypeFilter.Includes, CredentialsTypeFilter.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(CredentialsDescriptor type)	Returns true if and only if the supplied CredentialsDescriptor 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.CredentialsTypeFilter

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 included Descriptor.getId()s.

Method Details

filter

public boolean filter(CredentialsDescriptor type)

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

Specified by:

filter in class CredentialsTypeFilter

Parameters:

type - the CredentialsDescriptor to check.

Returns:

true if and only if the supplied CredentialsDescriptor 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 CredentialsTypeFilter

hashCode

public int hashCode()

Specified by:

hashCode in class CredentialsTypeFilter

toString

public String toString()

Specified by:

toString in class CredentialsTypeFilter