Package com.cloudbees.jenkins.plugins.sshagent.exec

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

Constructor Summary

Constructors

Constructor	Description
ExecRemoteAgent(Launcher launcher, TaskListener listener)

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 java.lang.Object

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

Constructor Details

ExecRemoteAgent

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

Throws:

IOException

InterruptedException

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.

Parameters:

listener - for logging.

Throws:

IOException

InterruptedException