com.cloudbees.jenkins.plugins.sshcredentials
Class SSHAuthenticatorFactory

java.lang.Object
  com.cloudbees.jenkins.plugins.sshcredentials.SSHAuthenticatorFactory

All Implemented Interfaces:

hudson.ExtensionPoint

Direct Known Subclasses:

TrileadSSHPasswordAuthenticator.Factory, TrileadSSHPublicKeyAuthenticator.Factory

public abstract class SSHAuthenticatorFactory
extends java.lang.Object
implements hudson.ExtensionPoint

Extension point to allow plugging in SSHAuthenticator implementations for the many SSH client libraries available.

Nested Class Summary

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

hudson.ExtensionPoint.LegacyInstancesAreScopedToHudson

Constructor Summary

SSHAuthenticatorFactory()

Method Summary

protected abstract <C,U extends SSHUser> SSHAuthenticator<C,U>	newInstance(C connection, U user) Returns an instance of SSHAuthenticator for the supplied connection and user, or null if the factory does not support the connection and user combination.
protected abstract <C,U extends SSHUser> boolean	supports(java.lang.Class<C> connectionClass, java.lang.Class<U> userClass) Returns true if and only if the supplied connection class and user class are supported by this factory.

Methods inherited from class java.lang.Object

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

Constructor Detail

SSHAuthenticatorFactory

public SSHAuthenticatorFactory()

Method Detail

newInstance

@Nullable
protected abstract <C,U extends SSHUser> SSHAuthenticator<C,U> newInstance(@NonNull
                                                                                    C connection,
                                                                                    @NonNull
                                                                                    U user)

Returns an instance of SSHAuthenticator for the supplied connection and user, or null if the factory does not support the connection and user combination.

Type Parameters:

C - the type of connection.

U - the type of user.

Parameters:

connection - the connection.

user - the user.

Returns:

null if the connection or user is not supported by this factory, or a SSHAuthenticator instance bound to the supplied connection and user.

supports

protected abstract <C,U extends SSHUser> boolean supports(@NonNull
                                                          java.lang.Class<C> connectionClass,
                                                          @NonNull
                                                          java.lang.Class<U> userClass)

Returns true if and only if the supplied connection class and user class are supported by this factory.

Type Parameters:

C - the type of connection.

U - the type of user.

Parameters:

connectionClass - the connection class.

userClass - the user class.

Returns:

true if and only if the supplied connection class and user class are supported by this factory.