Package com.cloudbees.plugins.credentials

Class CredentialsProviderManager

java.lang.Object

hudson.model.DescriptorVisibilityFilter

com.cloudbees.plugins.credentials.CredentialsProviderManager

All Implemented Interfaces:

ExtensionPoint, Saveable, Serializable

@Extension
public class CredentialsProviderManager
extends DescriptorVisibilityFilter
implements Serializable, Saveable

Manages the various CredentialsProvider implementations in a Jenkins

Since:

2.0

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CredentialsProviderManager.Configuration	Our global configuration.

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields inherited from interface hudson.model.Saveable

NOOP

Constructor Summary

Constructors

Constructor	Description
CredentialsProviderManager()	Our constructor.

Method Summary

Modifier and Type	Method	Description
boolean	filter(Object context, Descriptor descriptor)
static XmlFile	getConfigFile()	Gets the configuration file that CredentialsProviderManager uses to store its credentials.
static CredentialsProviderManager	getInstance()	Returns our CredentialsProviderManager singleton.
static CredentialsProviderManager	getInstanceOrDie()	Returns our CredentialsProviderManager singleton.
CredentialsProviderFilter	getProviderFilter()	Gets the current CredentialsProviderFilter.
List<CredentialsProviderTypeRestriction>	getRestrictions()	Gets the current list of CredentialsProviderTypeRestriction instances.
CredentialsTypeFilter	getTypeFilter()	Gets the current CredentialsTypeFilter.
static boolean	isEnabled(CredentialsProvider provider)	Returns true if and only if the specified CredentialsProvider is enabled.
void	save()
void	setProviderFilter(CredentialsProviderFilter providerFilter)	Sets the CredentialsProviderFilter.
void	setRestrictions(List<CredentialsProviderTypeRestriction> restrictions)	Sets the list of CredentialsProviderTypeRestriction instances.
void	setTypeFilter(CredentialsTypeFilter typeFilter)	Sets the CredentialsTypeFilter.

Methods inherited from class hudson.model.DescriptorVisibilityFilter

all, apply, applyType, filterType

Methods inherited from class java.lang.Object

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

Constructor Details

CredentialsProviderManager

public CredentialsProviderManager()

Our constructor.

Method Details

isEnabled

public static boolean isEnabled(CredentialsProvider provider)

Returns true if and only if the specified CredentialsProvider is enabled.

Parameters:

provider - the specified CredentialsProvider to check.

Returns:

true if and only if the specified CredentialsProvider is enabled.

getInstance

@Nullable
public static CredentialsProviderManager getInstance()

Returns our CredentialsProviderManager singleton.

Returns:

CredentialsProviderManager singleton or null

getInstanceOrDie

@NonNull
public static CredentialsProviderManager getInstanceOrDie()

Returns our CredentialsProviderManager singleton.

Returns:

CredentialsProviderManager singleton

filter

public boolean filter(Object context,
 @NonNull
 Descriptor descriptor)

Specified by:

filter in class DescriptorVisibilityFilter

getConfigFile

public static XmlFile getConfigFile()

Gets the configuration file that CredentialsProviderManager uses to store its credentials.

Returns:

the configuration file that CredentialsProviderManager uses to store its credentials.

save

public void save()
          throws IOException

Specified by:

save in interface Saveable

Throws:

IOException

getProviderFilter

@NonNull
public CredentialsProviderFilter getProviderFilter()

Gets the current CredentialsProviderFilter.

Returns:

the current CredentialsProviderFilter.

setProviderFilter

public void setProviderFilter(@CheckForNull
 CredentialsProviderFilter providerFilter)

Sets the CredentialsProviderFilter.

Parameters:

providerFilter - the new CredentialsProviderFilter.

getTypeFilter

@NonNull
public CredentialsTypeFilter getTypeFilter()

Gets the current CredentialsTypeFilter.

Returns:

the current CredentialsTypeFilter.

setTypeFilter

public void setTypeFilter(@CheckForNull
 CredentialsTypeFilter typeFilter)

Sets the CredentialsTypeFilter.

Parameters:

typeFilter - the new CredentialsTypeFilter.

getRestrictions

@NonNull
public List<CredentialsProviderTypeRestriction> getRestrictions()

Gets the current list of CredentialsProviderTypeRestriction instances.

Returns:

the current list of CredentialsProviderTypeRestriction instances.

setRestrictions

public void setRestrictions(List<CredentialsProviderTypeRestriction> restrictions)

Sets the list of CredentialsProviderTypeRestriction instances.

Parameters:

restrictions - the new list of CredentialsProviderTypeRestriction instances.