Package hudson.plugins.sauce_ondemand.credentials

Class SauceCredentials

java.lang.Object

com.cloudbees.plugins.credentials.BaseCredentials

com.cloudbees.plugins.credentials.impl.BaseStandardCredentials

hudson.plugins.sauce_ondemand.credentials.SauceCredentials

All Implemented Interfaces:

com.cloudbees.plugins.credentials.common.IdCredentials, com.cloudbees.plugins.credentials.common.PasswordCredentials, com.cloudbees.plugins.credentials.common.StandardCredentials, com.cloudbees.plugins.credentials.common.StandardUsernameCredentials, com.cloudbees.plugins.credentials.common.StandardUsernamePasswordCredentials, com.cloudbees.plugins.credentials.common.UsernameCredentials, com.cloudbees.plugins.credentials.common.UsernamePasswordCredentials, com.cloudbees.plugins.credentials.Credentials, ExtensionPoint, Describable<com.cloudbees.plugins.credentials.Credentials>, Serializable

public class SauceCredentials
extends com.cloudbees.plugins.credentials.impl.BaseStandardCredentials
implements com.cloudbees.plugins.credentials.common.StandardUsernamePasswordCredentials

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SauceCredentials.DescriptorImpl
static class	SauceCredentials.ShortLivedConfig

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

com.cloudbees.plugins.credentials.impl.BaseStandardCredentials.BaseStandardCredentialsDescriptor

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Nested classes/interfaces inherited from interface com.cloudbees.plugins.credentials.common.IdCredentials

com.cloudbees.plugins.credentials.common.IdCredentials.Helpers

Nested classes/interfaces inherited from interface com.cloudbees.plugins.credentials.common.StandardCredentials

com.cloudbees.plugins.credentials.common.StandardCredentials.NameProvider

Nested classes/interfaces inherited from interface com.cloudbees.plugins.credentials.common.StandardUsernamePasswordCredentials

com.cloudbees.plugins.credentials.common.StandardUsernamePasswordCredentials.NameProvider

Field Summary

Fields

Modifier and Type	Field	Description
protected Secret	apiKey	The Password/apikey
static com.cloudbees.plugins.credentials.domains.DomainRequirement	DOMAIN_REQUIREMENT
protected String	restEndpoint	The data center endpoint
protected SauceCredentials.ShortLivedConfig	shortLivedConfig
protected String	username	The username.

Constructor Summary

Constructors

Constructor	Description
SauceCredentials(com.cloudbees.plugins.credentials.CredentialsScope scope, String id, String username, String apiKey, String restEndpoint, String description)

Method Summary

Modifier and Type	Method	Description
static List<SauceCredentials>	all(Item context)
static List<SauceCredentials>	all(ItemGroup context)
Secret	getApiKey()
static SauceCredentials	getCredentials(AbstractBuild build)
static SauceCredentials	getCredentials(AbstractProject project)
static SauceCredentials	getCredentialsById(Item context, String id)
String	getHMAC(String jobId)	Creates a HMAC token which is used as part of the Javascript inclusion that embeds the Sauce results
Secret	getPassword()
String	getRegion()
String	getRestEndpoint()
String	getRestEndpointName()
static SauceCredentials	getSauceCredentials(AbstractBuild build, SauceOnDemandBuildWrapper wrapper)
JenkinsSauceREST	getSauceREST(ProxyConfiguration proxy)
SauceCredentials.ShortLivedConfig	getShortLivedConfig()
String	getUsername()
static String	migrateToCredentials(String username, String accessKey, String restEndpoint, String migratedFrom)
void	setShortLivedConfig(SauceCredentials.ShortLivedConfig shortLivedConfig)
String	toString()

Methods inherited from class com.cloudbees.plugins.credentials.impl.BaseStandardCredentials

equals, getDescription, getId, hashCode

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

getDescriptor, getScope

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.cloudbees.plugins.credentials.Credentials

forRun, getDescriptor, getScope

Methods inherited from interface com.cloudbees.plugins.credentials.common.IdCredentials

getId

Methods inherited from interface com.cloudbees.plugins.credentials.common.StandardCredentials

getDescription

Methods inherited from interface com.cloudbees.plugins.credentials.common.UsernameCredentials

isUsernameSecret

Field Detail

username

protected final String username

The username.

apiKey

protected final Secret apiKey

The Password/apikey

restEndpoint

protected final String restEndpoint

The data center endpoint

shortLivedConfig

protected SauceCredentials.ShortLivedConfig shortLivedConfig

DOMAIN_REQUIREMENT

public static final com.cloudbees.plugins.credentials.domains.DomainRequirement DOMAIN_REQUIREMENT

Constructor Detail

SauceCredentials

@DataBoundConstructor
public SauceCredentials(@CheckForNull
                        com.cloudbees.plugins.credentials.CredentialsScope scope,
                        @CheckForNull
                        String id,
                        @NonNull
                        String username,
                        @NonNull
                        String apiKey,
                        @NonNull
                        String restEndpoint,
                        @CheckForNull
                        String description)

Method Detail

getShortLivedConfig

public SauceCredentials.ShortLivedConfig getShortLivedConfig()

setShortLivedConfig

@DataBoundSetter
public void setShortLivedConfig(SauceCredentials.ShortLivedConfig shortLivedConfig)

getCredentials

public static SauceCredentials getCredentials(AbstractProject project)

getCredentials

public static SauceCredentials getCredentials(AbstractBuild build)

getPassword

@NonNull
public Secret getPassword()

Specified by:

getPassword in interface com.cloudbees.plugins.credentials.common.PasswordCredentials

getApiKey

@NonNull
public Secret getApiKey()

getRestEndpoint

@NonNull
public String getRestEndpoint()

getRestEndpointName

@NonNull
public String getRestEndpointName()

getRegion

@NonNull
public String getRegion()

getUsername

@NonNull
public String getUsername()

Specified by:

getUsername in interface com.cloudbees.plugins.credentials.common.UsernameCredentials

toString

public String toString()

Overrides:

toString in class Object

getSauceCredentials

public static SauceCredentials getSauceCredentials(AbstractBuild build,
                                                   SauceOnDemandBuildWrapper wrapper)

getSauceREST

public JenkinsSauceREST getSauceREST(ProxyConfiguration proxy)

migrateToCredentials

public static String migrateToCredentials(String username,
                                          String accessKey,
                                          String restEndpoint,
                                          String migratedFrom)
                                   throws InterruptedException,
                                          IOException

Throws:

InterruptedException

IOException

all

public static List<SauceCredentials> all(ItemGroup context)

all

public static List<SauceCredentials> all(Item context)

getCredentialsById

public static SauceCredentials getCredentialsById(Item context,
                                                  String id)

getHMAC

public String getHMAC(String jobId)

Creates a HMAC token which is used as part of the Javascript inclusion that embeds the Sauce results

Parameters:

jobId - the Sauce job id

Returns:

the HMAC token