hudson.plugins.sauce_ondemand

Class PluginImpl

java.lang.Object

hudson.Plugin

hudson.plugins.sauce_ondemand.PluginImpl

All Implemented Interfaces:

hudson.model.Describable<PluginImpl>, hudson.model.Saveable

@Extension
public class PluginImpl
extends hudson.Plugin
implements hudson.model.Describable<PluginImpl>

Persists the access credentials and common options for the Sauce plugin.

Author:

Kohsuke Kawaguchi, Ross Rowe

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PluginImpl.DescriptorImpl

Nested classes/interfaces inherited from class hudson.Plugin

hudson.Plugin.DummyImpl

Field Summary

Fields inherited from interface hudson.model.Saveable

NOOP

Constructor Summary

Constructors

Constructor and Description
PluginImpl()

Method Summary

Modifier and Type	Method and Description
String	applyUpdates()
String	calcHMAC(String id)
static String	calcHMAC(String username, String accessKey, String jobId) Creates a HMAC token which is used as part of the Javascript inclusion that embeds the Sauce results
String	checkForUpdates()
void	configure(org.kohsuke.stapler.StaplerRequest req, net.sf.json.JSONObject formData)
static PluginImpl	get()
hudson.util.Secret	getApiKey()
PluginImpl.DescriptorImpl	getDescriptor()
String	getEnvironmentVariablePrefix()
String	getSauceConnectDirectory()
String	getSauceConnectOptions()
String	getUsername()
boolean	isDisableStatusColumn()
boolean	isSendUsageData()
void	setCredential(String username, String apiKey)
void	setDisableStatusColumn(boolean disableStatusColumn)
void	setEnvironmentVariablePrefix(String environmentVariablePrefix)
void	setSauceConnectDirectory(String sauceConnectDirectory)
void	setSauceConnectOptions(String sauceConnectOptions)
void	setSendUsageData(boolean sendUsageData)
void	start()

Methods inherited from class hudson.Plugin

configure, doDynamic, getConfigXml, getWrapper, load, postInitialize, save, setServletContext, stop

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PluginImpl

public PluginImpl()

Method Detail

getUsername

public String getUsername()

getApiKey

public hudson.util.Secret getApiKey()

calcHMAC

public String calcHMAC(String id)
                throws NoSuchAlgorithmException,
                       InvalidKeyException,
                       UnsupportedEncodingException

Throws:

NoSuchAlgorithmException

InvalidKeyException

UnsupportedEncodingException

calcHMAC

public static String calcHMAC(String username,
                              String accessKey,
                              String jobId)
                       throws NoSuchAlgorithmException,
                              InvalidKeyException,
                              UnsupportedEncodingException

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

Parameters:

username - the Sauce user id

accessKey - the Sauce access key

jobId - the Sauce job id

Returns:

the HMAC token

Throws:

NoSuchAlgorithmException - FIXME

InvalidKeyException - FIXME

UnsupportedEncodingException - FIXME

start

public void start()
           throws Exception

Overrides:

start in class hudson.Plugin

Throws:

Exception

setCredential

public void setCredential(String username,
                          String apiKey)
                   throws IOException

Throws:

IOException

configure

public void configure(org.kohsuke.stapler.StaplerRequest req,
                      net.sf.json.JSONObject formData)
               throws IOException,
                      javax.servlet.ServletException,
                      hudson.model.Descriptor.FormException

Overrides:

configure in class hudson.Plugin

Throws:

IOException

javax.servlet.ServletException

hudson.model.Descriptor.FormException

getDescriptor

public PluginImpl.DescriptorImpl getDescriptor()

Specified by:

getDescriptor in interface hudson.model.Describable<PluginImpl>

get

public static PluginImpl get()

getSauceConnectDirectory

public String getSauceConnectDirectory()

setSauceConnectDirectory

public void setSauceConnectDirectory(String sauceConnectDirectory)

getEnvironmentVariablePrefix

public String getEnvironmentVariablePrefix()

setEnvironmentVariablePrefix

public void setEnvironmentVariablePrefix(String environmentVariablePrefix)

checkForUpdates

@JavaScriptMethod
public String checkForUpdates()

Returns:

String to show to the user on screen

applyUpdates

@JavaScriptMethod
public String applyUpdates()

Returns:

Results of applying update

isDisableStatusColumn

public boolean isDisableStatusColumn()

setDisableStatusColumn

public void setDisableStatusColumn(boolean disableStatusColumn)

getSauceConnectOptions

public String getSauceConnectOptions()

setSauceConnectOptions

public void setSauceConnectOptions(String sauceConnectOptions)

setSendUsageData

public void setSendUsageData(boolean sendUsageData)

isSendUsageData

public boolean isSendUsageData()