com.cloudbees.jenkins.plugins.sshagent

Class RemoteAgentFactory

java.lang.Object

com.cloudbees.jenkins.plugins.sshagent.RemoteAgentFactory

All Implemented Interfaces:

hudson.ExtensionPoint

Direct Known Subclasses:

JNRRemoteAgentFactory, MinaRemoteAgentFactory

public abstract class RemoteAgentFactory
extends Object
implements hudson.ExtensionPoint

Extension point for ssh-agent providers.

Nested Class Summary

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

hudson.ExtensionPoint.LegacyInstancesAreScopedToHudson

Constructor Summary

Constructors

Constructor and Description
RemoteAgentFactory()

Method Summary

Modifier and Type	Method and Description
abstract String	getDisplayName() The display name of the factory.
abstract boolean	isSupported(hudson.Launcher launcher, hudson.model.TaskListener listener) Checks if the supplied launcher is supported by this factory.
RemoteAgent	start(hudson.Launcher launcher, hudson.model.TaskListener listener) Deprecated.
RemoteAgent	start(hudson.Launcher launcher, hudson.model.TaskListener listener, hudson.FilePath temp) Start a ssh-agent on the specified launcher.

Methods inherited from class java.lang.Object

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

Constructor Detail

RemoteAgentFactory

public RemoteAgentFactory()

Method Detail

getDisplayName

public abstract String getDisplayName()

The display name of the factory.

Returns:

The display name of the factory.

isSupported

public abstract boolean isSupported(hudson.Launcher launcher,
                                    hudson.model.TaskListener listener)

Checks if the supplied launcher is supported by this factory.

Parameters:

launcher - the launcher on which the factory would be asked to start a ssh-agent.

listener - a listener in case any user diagnostics are to be printed.

Returns:

false if the factory does not want to try and start an ssh-agent on the launcher.

start

@Deprecated
public RemoteAgent start(hudson.Launcher launcher,
                                     hudson.model.TaskListener listener)
                              throws Throwable

Deprecated.

Throws:

Throwable

start

public RemoteAgent start(hudson.Launcher launcher,
                         hudson.model.TaskListener listener,
                         @CheckForNull
                         hudson.FilePath temp)
                  throws Throwable

Start a ssh-agent on the specified launcher.

Parameters:

launcher - the launcher on which to start a ssh-agent.

listener - a listener for any diagnostics.

temp - a temporary directory to use; null if unspecified

Returns:

the agent.

Throws:

Throwable - if the agent cannot be started.