com.cloudbees.jenkins.plugins.sshagent
Class SSHAgentBuildWrapper.RemoteAgentImpl

java.lang.Object
  com.cloudbees.jenkins.plugins.sshagent.SSHAgentBuildWrapper.RemoteAgentImpl

All Implemented Interfaces:

SSHAgentBuildWrapper.RemoteAgent

Enclosing class:

SSHAgentBuildWrapper

public static class SSHAgentBuildWrapper.RemoteAgentImpl
extends java.lang.Object
implements SSHAgentBuildWrapper.RemoteAgent

An implementation that uses Apache SSH to provide the Agent. This requires Tomcat-Native.

Constructor Summary

SSHAgentBuildWrapper.RemoteAgentImpl(hudson.model.BuildListener listener)
Constructor.

Method Summary

void	addIdentity(java.lang.String privateKey, java.lang.String passphrase, java.lang.String comment) Adds the provided identity to the agent.
java.lang.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

SSHAgentBuildWrapper.RemoteAgentImpl

public SSHAgentBuildWrapper.RemoteAgentImpl(hudson.model.BuildListener listener)
                                     throws java.lang.Exception

Constructor.

Parameters:

listener - the listener.

Throws:

java.lang.Exception - if the agent could not start.

Method Detail

getSocket

public java.lang.String getSocket()

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

Specified by:

getSocket in interface SSHAgentBuildWrapper.RemoteAgent

Returns:

addIdentity

public void addIdentity(java.lang.String privateKey,
                        java.lang.String passphrase,
                        java.lang.String comment)
                 throws java.io.IOException

Adds the provided identity to the agent.

Specified by:

addIdentity in interface SSHAgentBuildWrapper.RemoteAgent

Parameters:

privateKey - the private key.

passphrase - the passphrase or null.

comment - the comment to give to the key.

Throws:

java.io.IOException - if something went wrong.

stop

public void stop()

Stops the agent.

Specified by:

stop in interface SSHAgentBuildWrapper.RemoteAgent