com.cloudbees.jenkins.plugins.sshagent

Class SSHAgentBuildWrapper

java.lang.Object

hudson.model.AbstractDescribableImpl<hudson.tasks.BuildWrapper>

hudson.tasks.BuildWrapper

com.cloudbees.jenkins.plugins.sshagent.SSHAgentBuildWrapper

All Implemented Interfaces:

hudson.ExtensionPoint, hudson.model.Describable<hudson.tasks.BuildWrapper>

public class SSHAgentBuildWrapper
extends hudson.tasks.BuildWrapper

A build wrapper that provides an SSH agent using supplied credentials

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SSHAgentBuildWrapper.DescriptorImpl Our descriptor.

Nested classes/interfaces inherited from class hudson.tasks.BuildWrapper

hudson.tasks.BuildWrapper.Environment

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

hudson.ExtensionPoint.LegacyInstancesAreScopedToHudson

Constructor Summary

Constructors

Constructor and Description
SSHAgentBuildWrapper(String user) Constructs a new instance.

Method Summary

Methods

Modifier and Type	Method and Description
String	getUser() Gets the IdCredentials.getId() of the credentials to use.
void	preCheckout(hudson.model.AbstractBuild build, hudson.Launcher launcher, hudson.model.BuildListener listener)
hudson.tasks.BuildWrapper.Environment	setUp(hudson.model.AbstractBuild build, hudson.Launcher launcher, hudson.model.BuildListener listener)

Methods inherited from class hudson.tasks.BuildWrapper

all, decorateLauncher, decorateLogger, getProjectAction, getProjectActions, makeBuildVariables, makeSensitiveBuildVariables, setUp

Methods inherited from class hudson.model.AbstractDescribableImpl

getDescriptor

Methods inherited from class java.lang.Object

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

Constructor Detail

SSHAgentBuildWrapper

@DataBoundConstructor
public SSHAgentBuildWrapper(String user)

Constructs a new instance.

Parameters:

user - the IdCredentials.getId() of the credentials to use.

Method Detail

getUser

public String getUser()

Gets the IdCredentials.getId() of the credentials to use.

Returns:

the IdCredentials.getId() of the credentials to use.

preCheckout

public void preCheckout(hudson.model.AbstractBuild build,
               hudson.Launcher launcher,
               hudson.model.BuildListener listener)
                 throws IOException,
                        InterruptedException

Overrides:

preCheckout in class hudson.tasks.BuildWrapper

Throws:

IOException

InterruptedException

setUp

public hudson.tasks.BuildWrapper.Environment setUp(hudson.model.AbstractBuild build,
                                          hudson.Launcher launcher,
                                          hudson.model.BuildListener listener)
                                            throws IOException,
                                                   InterruptedException

Overrides:

setUp in class hudson.tasks.BuildWrapper

Throws:

IOException

InterruptedException