com.cloudbees.plugins.credentials

Class CredentialsDescriptor

java.lang.Object

hudson.model.Descriptor<Credentials>

com.cloudbees.plugins.credentials.CredentialsDescriptor

All Implemented Interfaces:

hudson.model.Saveable, org.jenkins.ui.icon.IconSpec

Direct Known Subclasses:

BaseStandardCredentials.BaseStandardCredentialsDescriptor

public abstract class CredentialsDescriptor
extends hudson.model.Descriptor<Credentials>
implements org.jenkins.ui.icon.IconSpec

Descriptor for credentials.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CredentialsDescriptor.EnhancedCheckMethod An enhanced FormValidation.CheckMethod that can add assistance for resolving the context from the request path.

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

hudson.model.Descriptor.FormException, hudson.model.Descriptor.PropertyType, hudson.model.Descriptor.Self

Field Summary

Fields inherited from class hudson.model.Descriptor

clazz

Fields inherited from interface hudson.model.Saveable

NOOP

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	CredentialsDescriptor() Infers the type of the corresponding Credentials from the outer class.
protected	CredentialsDescriptor(Class<? extends Credentials> clazz) Constructor.

Method Summary

Modifier and Type	Method and Description
void	calcAutoCompleteSettings(String field, Map<String,Object> attributes)
void	calcFillSettings(String field, Map<String,Object> attributes)
hudson.util.ListBoxModel	doFillScopeItems(hudson.model.ModelObject context) Fills in the scopes for a scope list-box.
static <T extends hudson.model.ModelObject> T	findContextInPath(Class<T> type) Attempts to resolve the credentials context from the Stapler.getCurrentRequest() (includes special handling of the HTTP Referer to enable resolution from AJAX requests).
static <T extends hudson.model.ModelObject> T	findContextInPath(org.kohsuke.stapler.StaplerRequest request, Class<T> type) Attempts to resolve the credentials context from the StaplerRequest (includes special handling of the HTTP Referer to enable resolution from AJAX requests).
hudson.util.FormValidation.CheckMethod	getCheckMethod(String fieldName)
String	getCredentialsPage() Returns the config page for the credentials.
String	getIconClassName()
boolean	isApplicable(CredentialsProvider provider) Determines if this CredentialsDescriptor is applicable to the specified CredentialsProvider.
boolean	isScopeRelevant() Checks if asking for a credentials scope is relevant.
boolean	isScopeRelevant(CredentialsSelectHelper.WrappedCredentialsStore wrapper) Similar to isScopeRelevant() but used by CredentialsSelectHelper.
boolean	isScopeRelevant(CredentialsStore store) Similar to isScopeRelevant() but operating on a specific CredentialsStore rather than trying to infer from the stapler request.
boolean	isScopeRelevant(CredentialsStoreAction.CredentialsWrapper wrapper) Similar to isScopeRelevant() but used by CredentialsStoreAction.
boolean	isScopeRelevant(CredentialsStoreAction.DomainWrapper wrapper) Similar to isScopeRelevant() but used by CredentialsStoreAction.
boolean	isScopeRelevant(hudson.model.ModelObject object) Similar to isScopeRelevant() but operating on a specific ModelObject rather than trying to infer from the stapler request.
static hudson.model.ModelObject	lookupContext(String provider, String token) Looks up the context given the provider and token.
static hudson.model.ModelObject	unwrapContext(hudson.model.ModelObject context) In some cases the nearest AncestorInPath ModelObject is one of the Credentials plugins wrapper classes.

Methods inherited from class hudson.model.Descriptor

addHelpFileRedirect, configure, configure, doHelp, find, find, findByDescribableClassName, findById, getCheckUrl, getConfigFile, getConfigPage, getCurrentDescriptorByNameUrl, getDescriptorFullUrl, getDescriptorUrl, getDisplayName, getGlobalConfigPage, getGlobalPropertyType, getHelpFile, getHelpFile, getHelpFile, getId, getJsonSafeClassName, getKlass, getPlugin, getPossibleViewNames, getPropertyType, getPropertyType, getPropertyTypeOrDie, 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

CredentialsDescriptor

protected CredentialsDescriptor(Class<? extends Credentials> clazz)

Constructor.

Parameters:

clazz - The concrete credentials class.

Since:

1.2

CredentialsDescriptor

protected CredentialsDescriptor()

Infers the type of the corresponding Credentials from the outer class. This version works when you follow the common convention, where a descriptor is written as the static nested class of the describable class.

Since:

1.3

Method Detail

doFillScopeItems

@Restricted(value=org.kohsuke.accmod.restrictions.NoExternalUse.class)
 @RestrictedSince(value="2.1.5")
public hudson.util.ListBoxModel doFillScopeItems(@ContextInPath
                                                                                                                                                         hudson.model.ModelObject context)

Fills in the scopes for a scope list-box.

Parameters:

context - list-box context

Returns:

the scopes for the nearest request object that acts as a container for credentials.

isScopeRelevant

@Restricted(value=org.kohsuke.accmod.restrictions.NoExternalUse.class)
 @RestrictedSince(value="2.1.5")
public boolean isScopeRelevant()

Checks if asking for a credentials scope is relevant. For example, when a scope will be stored in UserCredentialsProvider, there is no need to specify the scope, as it can only be CredentialsScope.USER, but where the credential will be stored in SystemCredentialsProvider, there are multiple scopes relevant for that container, so the scope field is relevant.

Returns:

true if the nearest request object that acts as a container for credentials needs a scope to be specified.

isScopeRelevant

@Restricted(value=org.kohsuke.accmod.restrictions.NoExternalUse.class)
 @RestrictedSince(value="2.1.5")
public boolean isScopeRelevant(hudson.model.ModelObject object)

Similar to isScopeRelevant() but operating on a specific ModelObject rather than trying to infer from the stapler request.

Parameters:

object - the object that is going to contain the credential.

Returns:

true if there is more than one CredentialsScope that can be used for the specified object.

isScopeRelevant

@Restricted(value=org.kohsuke.accmod.restrictions.NoExternalUse.class)
public boolean isScopeRelevant(@CheckForNull
                                                                                                      CredentialsStore store)

Similar to isScopeRelevant() but operating on a specific CredentialsStore rather than trying to infer from the stapler request.

Parameters:

store - the object that is going to contain the credential.

Returns:

true if there is more than one CredentialsScope that can be used for the specified object.

Since:

2.1.5

isScopeRelevant

@Restricted(value=org.kohsuke.accmod.restrictions.NoExternalUse.class)
 @RestrictedSince(value="2.1.5")
public boolean isScopeRelevant(CredentialsStoreAction.DomainWrapper wrapper)

Similar to isScopeRelevant() but used by CredentialsStoreAction.

Parameters:

wrapper - the wrapper for the domain that is going to contain the credential.

Returns:

true if there is more than one CredentialsScope that can be used for the specified object.

isScopeRelevant

@Restricted(value=org.kohsuke.accmod.restrictions.NoExternalUse.class)
 @RestrictedSince(value="2.1.5")
public boolean isScopeRelevant(CredentialsStoreAction.CredentialsWrapper wrapper)

Similar to isScopeRelevant() but used by CredentialsStoreAction.

Parameters:

wrapper - the wrapper for the domain that is going to contain the credential.

Returns:

true if there is more than one CredentialsScope that can be used for the specified object.

isScopeRelevant

@Restricted(value=org.kohsuke.accmod.restrictions.NoExternalUse.class)
public boolean isScopeRelevant(CredentialsSelectHelper.WrappedCredentialsStore wrapper)

Similar to isScopeRelevant() but used by CredentialsSelectHelper.

Parameters:

wrapper - the wrapper for the domain that is going to contain the credential.

Returns:

true if there is more than one CredentialsScope that can be used for the specified object.

Since:

2.1.5

getCredentialsPage

public String getCredentialsPage()

Returns the config page for the credentials.

Returns:

the config page for the credentials.

getIconClassName

public String getIconClassName()

Specified by:

getIconClassName in interface org.jenkins.ui.icon.IconSpec

Since:

1.25

isApplicable

public boolean isApplicable(CredentialsProvider provider)

Determines if this CredentialsDescriptor is applicable to the specified CredentialsProvider.

This method will be called by CredentialsProvider.isApplicable(Descriptor)

Parameters:

provider - the CredentialsProvider to check.

Returns:

true if this CredentialsDescriptor is applicable in the specified CredentialsProvider

Since:

2.0

unwrapContext

@NonNull
public static hudson.model.ModelObject unwrapContext(@NonNull
                                                              hudson.model.ModelObject context)

In some cases the nearest AncestorInPath ModelObject is one of the Credentials plugins wrapper classes. This helper method unwraps those to return the correct context.

Parameters:

context - the context (wrapped or unwrapped).

Returns:

the unwrapped context.

Since:

2.1.5

lookupContext

@CheckForNull
public static hudson.model.ModelObject lookupContext(String provider,
                                                                   String token)

Looks up the context given the provider and token.

Parameters:

provider - the provider.

token - the token.

Returns:

the context.

Since:

2.1.5

findContextInPath

@CheckForNull
public static <T extends hudson.model.ModelObject> T findContextInPath(@NonNull
                                                                                     Class<T> type)

Attempts to resolve the credentials context from the Stapler.getCurrentRequest() (includes special handling of the HTTP Referer to enable resolution from AJAX requests).

Type Parameters:

T - the type of context.

Parameters:

type - the type of context.

Returns:

the context from the request

Since:

2.1.5

findContextInPath

@CheckForNull
public static <T extends hudson.model.ModelObject> T findContextInPath(@NonNull
                                                                                     org.kohsuke.stapler.StaplerRequest request,
                                                                                     @NonNull
                                                                                     Class<T> type)

Attempts to resolve the credentials context from the StaplerRequest (includes special handling of the HTTP Referer to enable resolution from AJAX requests).

Type Parameters:

T - the type of context.

Parameters:

request - the StaplerRequest.

type - the type of context.

Returns:

the context from the request

Since:

2.1.5

getCheckMethod

public hudson.util.FormValidation.CheckMethod getCheckMethod(String fieldName)

Overrides:

getCheckMethod in class hudson.model.Descriptor<Credentials>

calcFillSettings

public void calcFillSettings(String field,
                             Map<String,Object> attributes)

Overrides:

calcFillSettings in class hudson.model.Descriptor<Credentials>

calcAutoCompleteSettings

public void calcAutoCompleteSettings(String field,
                                     Map<String,Object> attributes)

Overrides:

calcAutoCompleteSettings in class hudson.model.Descriptor<Credentials>