Class SSHAuthenticatorFactory
- java.lang.Object
-
- com.cloudbees.jenkins.plugins.sshcredentials.SSHAuthenticatorFactory
-
- All Implemented Interfaces:
ExtensionPoint
,Serializable
- Direct Known Subclasses:
TrileadSSHPasswordAuthenticator.Factory
,TrileadSSHPublicKeyAuthenticator.Factory
public abstract class SSHAuthenticatorFactory extends Object implements ExtensionPoint, Serializable
Extension point to allow plugging inSSHAuthenticator
implementations for the many SSH client libraries available.This object can be shipped to remote to create an
SSHAuthenticator
on a remote node.
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from interface hudson.ExtensionPoint
ExtensionPoint.LegacyInstancesAreScopedToHudson
-
-
Constructor Summary
Constructors Constructor Description SSHAuthenticatorFactory()
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description protected abstract <C,U extends com.cloudbees.plugins.credentials.common.StandardUsernameCredentials>
SSHAuthenticator<C,U>newInstance(C connection, U user)
Returns an instance ofSSHAuthenticator
for the supplied connection and user, ornull
if the factory does not support the connection and user combination.protected <C,U extends com.cloudbees.plugins.credentials.common.StandardUsernameCredentials>
SSHAuthenticator<C,U>newInstance(C connection, U user, String username)
Returns an instance ofSSHAuthenticator
for the supplied connection and user, ornull
if the factory does not support the connection and user combination.protected abstract <C,U extends com.cloudbees.plugins.credentials.common.StandardUsernameCredentials>
booleansupports(Class<C> connectionClass, Class<U> userClass)
Returnstrue
if and only if the supplied connection class and user class are supported by this factory.
-
-
-
Method Detail
-
newInstance
@Nullable protected abstract <C,U extends com.cloudbees.plugins.credentials.common.StandardUsernameCredentials> SSHAuthenticator<C,U> newInstance(@NonNull C connection, @NonNull U user)
Returns an instance ofSSHAuthenticator
for the supplied connection and user, ornull
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 aSSHAuthenticator
instance bound to the supplied connection and user.
-
newInstance
@Nullable protected <C,U extends com.cloudbees.plugins.credentials.common.StandardUsernameCredentials> SSHAuthenticator<C,U> newInstance(@NonNull C connection, @NonNull U user, @CheckForNull String username)
Returns an instance ofSSHAuthenticator
for the supplied connection and user, ornull
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.username
- the username ornull
to fall back to the username in the user parameter.- Returns:
null
if the connection or user is not supported by this factory, or aSSHAuthenticator
instance bound to the supplied connection and user.- Since:
- 1.4
-
supports
protected abstract <C,U extends com.cloudbees.plugins.credentials.common.StandardUsernameCredentials> boolean supports(@NonNull Class<C> connectionClass, @NonNull Class<U> userClass)
Returnstrue
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.
-
-