Package hudson.plugins.sauce_ondemand.credentials

Class SauceCredentials.DescriptorImpl

java.lang.Object

hudson.model.Descriptor<com.cloudbees.plugins.credentials.Credentials>

com.cloudbees.plugins.credentials.CredentialsDescriptor

hudson.plugins.sauce_ondemand.credentials.SauceCredentials.DescriptorImpl

All Implemented Interfaces:

Saveable, Loadable, OnMaster, IconSpec

Enclosing class:

SauceCredentials

@Extension
public static class SauceCredentials.DescriptorImpl
extends com.cloudbees.plugins.credentials.CredentialsDescriptor

Nested Class Summary

Nested classes/interfaces inherited from class com.cloudbees.plugins.credentials.CredentialsDescriptor

com.cloudbees.plugins.credentials.CredentialsDescriptor.EnhancedCheckMethod

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

Descriptor.FormException, Descriptor.PropertyType, Descriptor.Self

Field Summary

Fields inherited from class hudson.model.Descriptor

clazz

Fields inherited from interface hudson.model.Saveable

NOOP

Constructor Summary

Constructors

Constructor	Description
DescriptorImpl()

Method Summary

Modifier and Type	Method	Description
FormValidation	doCheckApiKey(Item item, String value, String username, String dataCenter)	Validates a Sauce Labs username / access key pair against the Sauce Labs accounts API.
String	getDisplayName()
String	getIconClassName()

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

calcAutoCompleteSettings, calcFillSettings, doFillScopeItems, findContextInPath, findContextInPath, getCheckMethod, getCredentialsPage, isApplicable, isScopeRelevant, isScopeRelevant, isScopeRelevant, isScopeRelevant, isScopeRelevant, isScopeRelevant, lookupContext, unwrapContext

Methods inherited from class hudson.model.Descriptor

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

DescriptorImpl

public DescriptorImpl()

Method Details

getDisplayName

public String getDisplayName()

Overrides:

getDisplayName in class Descriptor<com.cloudbees.plugins.credentials.Credentials>

doCheckApiKey

@POST
public FormValidation doCheckApiKey(@AncestorInPath
 Item item,
 @QueryParameter
 String value,
 @QueryParameter
 String username,
 @QueryParameter
 String dataCenter)

Validates a Sauce Labs username / access key pair against the Sauce Labs accounts API.

Only administrators (system credentials store) or users allowed to configure the ancestor item (folder store, or the inline "Add credentials" dialog of a job) may trigger the outbound request. Everybody else silently gets FormValidation.ok(), so the endpoint cannot be used as a credentials oracle. Restricted to POST so it cannot be triggered by following a link (SECURITY-3770).

Parameters:

item - the ancestor item, or null for the system / user credentials stores

value - the access key to validate

username - the Sauce Labs username

dataCenter - the Sauce Labs data center name, defaults to US_WEST

Returns:

the validation result

getIconClassName

public String getIconClassName()

Specified by:

getIconClassName in interface IconSpec

Overrides:

getIconClassName in class com.cloudbees.plugins.credentials.CredentialsDescriptor