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.UserCredentialsProperty Need a user property to hold the user's personal credentials.

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

hudson.ExtensionPoint.LegacyInstancesAreScopedToHudson

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
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.

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

allCredentialsDescriptors, getCredentials, lookupCredentials, lookupCredentials, lookupCredentials, lookupCredentials, lookupCredentials, lookupCredentials, lookupScopes

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.