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

static class	SSHAgentBuildWrapper.DescriptorImpl Our descriptor.
static interface	SSHAgentBuildWrapper.RemoteAgent Need an interface in order to export the object from the channel.
static class	SSHAgentBuildWrapper.RemoteAgentImpl An implementation that uses Apache SSH to provide the Agent.
static class	SSHAgentBuildWrapper.RemoteAgentStarter Callable to start the remote agent.

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

SSHAgentBuildWrapper(java.lang.String user)
Constructs a new instance.

Method Summary

java.lang.String	getUser() Gets the SSHUser.getId() of the credentials to use.
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(java.lang.String user)

Constructs a new instance.

Parameters:

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

Method Detail

getUser

public java.lang.String getUser()

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

Returns:

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

setUp

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

Overrides:

setUp in class hudson.tasks.BuildWrapper

Throws:

java.io.IOException

java.lang.InterruptedException