Package com.cloudbees.jenkins.plugins.sshagent

Interface RemoteAgent

All Known Implementing Classes:

ExecRemoteAgent

public interface RemoteAgent

Need an interface in order to export the object from the channel.

Method Summary

Modifier and Type	Method	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.

Method Detail

getSocket

String getSocket()

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

Returns:

addIdentity

void addIdentity(String privateKey,
                 String passphrase,
                 String comment,
                 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 - if something went wrong.

InterruptedException

stop

void stop(TaskListener listener)
   throws IOException,
          InterruptedException

Stops the agent.

Parameters:

listener - for logging.

Throws:

IOException

InterruptedException