Package com.cloudbees.plugins.credentials

Class UserCredentialsProvider

java.lang.Object

hudson.model.Descriptor<CredentialsProvider>

com.cloudbees.plugins.credentials.CredentialsProvider

com.cloudbees.plugins.credentials.UserCredentialsProvider

All Implemented Interfaces:

ExtensionPoint, Describable<CredentialsProvider>, Saveable, OnMaster, IconSpec

@Extension
public class UserCredentialsProvider
extends CredentialsProvider

A store of credentials tied to a specific User.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	UserCredentialsProvider.StoreImpl	Our implementation
static class	UserCredentialsProvider.UserCredentialsProperty	Need a user property to hold the user's personal credentials.
static class	UserCredentialsProvider.UserFacingAction

Nested classes/interfaces inherited from class hudson.model.Descriptor

Descriptor.FormException, Descriptor.PropertyType, Descriptor.Self

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields inherited from class com.cloudbees.plugins.credentials.CredentialsProvider

CREATE, DELETE, GROUP, MANAGE_DOMAINS, NONE, UPDATE, USE_ITEM, USE_OWN, VIEW

Fields inherited from class hudson.model.Descriptor

clazz

Fields inherited from interface hudson.model.Saveable

NOOP

Constructor Summary

Constructors

Constructor	Description
UserCredentialsProvider()

Method Summary

Modifier and Type	Method	Description
<C extends Credentials> List<C>	getCredentials(Class<C> type, ItemGroup itemGroup, Authentication authentication)	Returns the credentials provided by this provider which are available to the specified Authentication for items in the specified ItemGroup
<C extends Credentials> List<C>	getCredentials(Class<C> type, ItemGroup itemGroup, Authentication authentication, List<DomainRequirement> domainRequirements)	Returns the credentials provided by this provider which are available to the specified Authentication for items in the specified ItemGroup and are appropriate for the specified .plugins.credentials.domains.DomainRequirements.
String	getIconClassName()
Set<CredentialsScope>	getScopes(ModelObject object)	Returns the scopes allowed for credentials stored within the specified object or null if the object is not relevant for scopes and the object's container should be considered instead.
CredentialsStore	getStore(ModelObject object)	Returns the CredentialsStore that this CredentialsProvider maintains specifically for this ModelObject or null if either the object is not a credentials container or this CredentialsProvider does not maintain a store specifically bound to this ModelObject.

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

_isApplicable, all, allCredentialsDescriptors, enabled, enabled, findCredentialById, findCredentialById, getCredentialIds, getCredentialIds, getCredentials, getCredentials, getCredentialsDescriptors, getDescriptor, getDisplayName, getFingerprintOf, getOrCreateFingerprintOf, hasCredentialsDescriptors, hasStores, isApplicable, isApplicable, isEnabled, isEnabled, listCredentials, listCredentials, lookupCredentials, lookupCredentials, lookupCredentials, lookupCredentials, lookupCredentials, lookupCredentials, lookupCredentials, lookupCredentials, lookupCredentials, lookupCredentials, lookupScopes, lookupStores, saveAll, snapshot, snapshot, track, track, track, trackAll, trackAll, trackAll, trackAll, trackAll, trackAll

Methods inherited from class hudson.model.Descriptor

addHelpFileRedirect, bindJSON, calcAutoCompleteSettings, calcFillSettings, configure, configure, doHelp, find, find, findByDescribableClassName, findById, getCategory, getCheckMethod, getCheckUrl, getConfigFile, getConfigPage, getCurrentDescriptorByNameUrl, getDescriptorFullUrl, getDescriptorUrl, getGlobalConfigPage, getGlobalPropertyType, getHelpFile, getHelpFile, getHelpFile, getId, getJsonSafeClassName, getKlass, getPlugin, getPossibleViewNames, getPropertyType, getPropertyType, getPropertyTypeOrDie, getRequiredGlobalConfigPagePermission, getT, getViewPage, isInstance, isSubTypeOf, load, newInstance, newInstance, newInstancesFromHeteroList, newInstancesFromHeteroList, save, self, toArray, toList, toMap

Methods inherited from class java.lang.Object

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

Constructor Detail

UserCredentialsProvider

public UserCredentialsProvider()

Method Detail

getScopes

public Set<CredentialsScope> getScopes(ModelObject object)

Returns the scopes allowed for credentials stored within the specified object or null if the object is not relevant for scopes and the object's container should be considered instead.

Overrides:

getScopes in class CredentialsProvider

Parameters:

object - the object.

Returns:

the set of scopes that are relevant for the object or null if the object is not a credentials container.

getStore

public CredentialsStore getStore(@CheckForNull
                                 ModelObject object)

Returns the CredentialsStore that this CredentialsProvider maintains specifically for this ModelObject or null if either the object is not a credentials container or this CredentialsProvider does not maintain a store specifically bound to this ModelObject.

Overrides:

getStore in class CredentialsProvider

Parameters:

object - the Item or ItemGroup or User that the store is being requested of.

Returns:

either null or a scoped CredentialsStore where CredentialsStore.getContext() == object.

getCredentials

@NonNull
public <C extends Credentials> List<C> getCredentials(@NonNull
                                                      Class<C> type,
                                                      @Nullable
                                                      ItemGroup itemGroup,
                                                      @Nullable
                                                      Authentication authentication)

Returns the credentials provided by this provider which are available to the specified Authentication for items in the specified ItemGroup

Specified by:

getCredentials in class CredentialsProvider

Type Parameters:

C - the credentials type.

Parameters:

type - the type of credentials to return.

itemGroup - the item group (if null assume Jenkins.get().

authentication - the authentication (if null assume ACL.SYSTEM.

Returns:

the list of credentials.

getCredentials

@NonNull
public <C extends Credentials> List<C> getCredentials(@NonNull
                                                      Class<C> type,
                                                      @Nullable
                                                      ItemGroup itemGroup,
                                                      @Nullable
                                                      Authentication authentication,
                                                      @NonNull
                                                      List<DomainRequirement> domainRequirements)

Returns the credentials provided by this provider which are available to the specified Authentication for items in the specified ItemGroup and are appropriate for the specified .plugins.credentials.domains.DomainRequirements.

Overrides:

getCredentials in class CredentialsProvider

Type Parameters:

C - the credentials type.

Parameters:

type - the type of credentials to return.

itemGroup - the item group (if null assume Jenkins.get().

authentication - the authentication (if null assume ACL.SYSTEM.

domainRequirements - the credential domains to match (if the CredentialsProvider does not support DomainRequirements then it should assume the match is true).

Returns:

the list of credentials.

getIconClassName

public String getIconClassName()

Specified by:

getIconClassName in interface IconSpec

Overrides:

getIconClassName in class CredentialsProvider