com.cloudbees.plugins.credentials

Class UserCredentialsProvider

java.lang.Object

com.cloudbees.plugins.credentials.CredentialsProvider

com.cloudbees.plugins.credentials.UserCredentialsProvider

All Implemented Interfaces:

hudson.ExtensionPoint

@Extension
public class UserCredentialsProvider
extends CredentialsProvider

A store of credentials tied to a specific User.

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

hudson.ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

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

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

Constructor Summary

Constructors

Constructor and Description
UserCredentialsProvider()

Method Summary

Methods

Modifier and Type	Method and Description
<C extends Credentials> List<C>	getCredentials(Class<C> type, hudson.model.ItemGroup itemGroup, org.acegisecurity.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, hudson.model.ItemGroup itemGroup, org.acegisecurity.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.
Set<CredentialsScope>	getScopes(hudson.model.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(hudson.model.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

allCredentialsDescriptors, findCredentialById, findCredentialById, getCredentials, getCredentials, lookupCredentials, lookupCredentials, lookupCredentials, lookupCredentials, lookupCredentials, lookupCredentials, lookupCredentials, lookupCredentials, lookupCredentials, lookupCredentials, lookupScopes, lookupStores, snapshot, snapshot

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(hudson.model.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.

getCredentials

@NonNull
public <C extends Credentials> List<C> getCredentials(@NonNull
                                                     Class<C> type,
                                                     @Nullable
                                                     hudson.model.ItemGroup itemGroup,
                                                     @Nullable
                                                     org.acegisecurity.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

Parameters:

type - the type of credentials to return.

itemGroup - the item group (if null assume Hudson.getInstance().

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
                                                     hudson.model.ItemGroup itemGroup,
                                                     @Nullable
                                                     org.acegisecurity.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

Parameters:

type - the type of credentials to return.

itemGroup - the item group (if null assume Hudson.getInstance().

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.

getStore

public CredentialsStore getStore(@CheckForNull
                        hudson.model.ModelObject object)

Description copied from class: CredentialsProvider

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 that the store is being requested of.

Returns:

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