com.cloudbees.jenkins.plugins.sshagent.exec

Class ExecRemoteAgent

java.lang.Object

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

All Implemented Interfaces:

RemoteAgent

public class ExecRemoteAgent
extends Object
implements RemoteAgent

An implementation that uses native SSH agent installed on a system.

Method Summary

Modifier and Type	Method and Description
void	addIdentity(String privateKey, String passphrase, String comment, TaskListener listener) Adds the provided identity to the agent.
String	getSocket() Returns the value that the environment variable should be set to.
void	stop(TaskListener listener) Stops the agent.

Methods inherited from class java.lang.Object

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

Method Detail

getSocket

public String getSocket()

Returns the value that the environment variable should be set to.

Specified by:

getSocket in interface RemoteAgent

Returns:

addIdentity

public void addIdentity(String privateKey,
                        String passphrase,
                        String comment,
                        TaskListener listener)
                 throws IOException,
                        InterruptedException

Adds the provided identity to the agent.

Specified by:

addIdentity in interface RemoteAgent

Parameters:

privateKey - the private key.

passphrase - the passphrase or null.

comment - the comment to give to the key.

listener - for logging.

Throws:

IOException - if something went wrong.

InterruptedException

stop

public void stop(TaskListener listener)
          throws IOException,
                 InterruptedException

Stops the agent.

Specified by:

stop in interface RemoteAgent

Parameters:

listener - for logging.

Throws:

IOException

InterruptedException