com.cloudbees.jenkins.plugins.sshagent.jna

Class JNRRemoteAgent

java.lang.Object

com.cloudbees.jenkins.plugins.sshagent.jna.JNRRemoteAgent

All Implemented Interfaces:

RemoteAgent

public class JNRRemoteAgent
extends Object
implements RemoteAgent

An implementation that uses Apache SSH to provide the Agent over JNR's UnixSocket implementation.

Constructor Summary

Constructors

Constructor and Description
JNRRemoteAgent(hudson.model.TaskListener listener, File temp) Constructor.

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Detail

JNRRemoteAgent

public JNRRemoteAgent(hudson.model.TaskListener listener,
                      @CheckForNull
                      File temp)
               throws Exception

Constructor.

Parameters:

listener - the listener.

Throws:

Exception - if the agent could not start.

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)
                 throws IOException

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.

Throws:

IOException - if something went wrong.

stop

public void stop()

Stops the agent.

Specified by:

stop in interface RemoteAgent