Class ExecRemoteAgent

java.lang.Object

com.cloudbees.jenkins.plugins.sshagent.exec.ExecRemoteAgent

All Implemented Interfaces:

Serializable

public final class ExecRemoteAgent
extends Object
implements Serializable

Runs a native SSH agent installed on a system.

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final int	DEFAULT_TIMEOUT_MINUTES	Default timeout, in minutes, applied to the agent commands when none is configured.

Constructor Summary

Constructors

Constructor	Description
ExecRemoteAgent(Launcher launcher, TaskListener listener, int timeoutMinutes)	Launches a native ssh-agent.

Method Summary

Modifier and Type	Method	Description
void	addIdentity(String privateKey, String passphrase, String comment, FilePath ws, Launcher launcher, TaskListener listener)	Adds the provided identity to the agent.
Map<String,String>	getEnv()
void	stop(Launcher launcher, TaskListener listener)	Stops the agent.

Methods inherited from class Object

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

Field Details

DEFAULT_TIMEOUT_MINUTES

public static final int DEFAULT_TIMEOUT_MINUTES

Default timeout, in minutes, applied to the agent commands when none is configured.

See Also:

• Constant Field Values

Constructor Details

ExecRemoteAgent

public ExecRemoteAgent(Launcher launcher,
 TaskListener listener,
 int timeoutMinutes)
                throws IOException,
InterruptedException

Launches a native ssh-agent.

Parameters:

launcher - launches the agent process.

listener - for logging.

timeoutMinutes - how long, in minutes, to wait for each of the ssh-agent, ssh-add and ssh-agent -k commands before giving up.

Throws:

IOException

InterruptedException

Since:

405

Method Details

addIdentity

public void addIdentity(String privateKey,
 String passphrase,
 String comment,
 FilePath ws,
 Launcher launcher,
 TaskListener listener)
                 throws IOException,
InterruptedException

Adds the provided identity to the agent.

Parameters:

privateKey - the private key.

passphrase - the passphrase or null.

comment - the comment to give to the key.

listener - for logging.

Throws:

IOException

InterruptedException

getEnv

public Map<String,String> getEnv()

stop

public void stop(Launcher launcher,
 TaskListener listener)
          throws IOException,
InterruptedException

Stops the agent.

Stopping is best-effort cleanup: if the ssh-agent process is already gone (for example killed during a long build), a failed ssh-agent -k is logged rather than thrown, so that it does not fail an otherwise successful build.

Parameters:

listener - for logging.

Throws:

IOException

InterruptedException