org.eclipse.jgit.internal.transport.sshd

Class PasswordProviderWrapper

java.lang.Object

org.eclipse.jgit.internal.transport.sshd.PasswordProviderWrapper

All Implemented Interfaces:

org.apache.sshd.common.config.keys.FilePasswordProvider, RepeatingFilePasswordProvider

public class PasswordProviderWrapper
extends Object
implements RepeatingFilePasswordProvider

A bridge from sshd's RepeatingFilePasswordProvider to our KeyPasswordProvider API.

Nested Class Summary

Nested classes/interfaces inherited from interface org.eclipse.jgit.internal.transport.sshd.RepeatingFilePasswordProvider

RepeatingFilePasswordProvider.ResourceDecodeResult

Field Summary

Fields inherited from interface org.apache.sshd.common.config.keys.FilePasswordProvider

EMPTY

Constructor Summary

Constructors

Constructor and Description
PasswordProviderWrapper(KeyPasswordProvider delegate)

Method Summary

Modifier and Type	Method and Description
int	getAttempts() Gets the maximum number of attempts to get a password that should be attempted for one identity resource through this provider.
String	getPassword(String resourceKey)
RepeatingFilePasswordProvider.ResourceDecodeResult	handleDecodeAttemptResult(String resourceKey, String password, Exception err) Invoked to inform the password provider about the decoding result.
void	setAttempts(int numberOfPasswordPrompts) Define the maximum number of attempts to get a password that should be attempted for one identity resource through this provider.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.sshd.common.config.keys.FilePasswordProvider

of

Constructor Detail

PasswordProviderWrapper

public PasswordProviderWrapper(@NonNull
                               KeyPasswordProvider delegate)

Parameters:

delegate -

Method Detail

setAttempts

public void setAttempts(int numberOfPasswordPrompts)

Description copied from interface: RepeatingFilePasswordProvider

Define the maximum number of attempts to get a password that should be attempted for one identity resource through this provider.

Specified by:

setAttempts in interface RepeatingFilePasswordProvider

Parameters:

numberOfPasswordPrompts - number of times to ask for a password; IllegalArgumentException may be thrown if <= 0

getAttempts

public int getAttempts()

Description copied from interface: RepeatingFilePasswordProvider

Gets the maximum number of attempts to get a password that should be attempted for one identity resource through this provider.

Specified by:

getAttempts in interface RepeatingFilePasswordProvider

Returns:

the maximum number of attempts to try, always >= 1.

getPassword

public String getPassword(String resourceKey)
                   throws IOException

Specified by:

getPassword in interface org.apache.sshd.common.config.keys.FilePasswordProvider

Throws:

IOException

handleDecodeAttemptResult

public RepeatingFilePasswordProvider.ResourceDecodeResult handleDecodeAttemptResult(String resourceKey,
                                                                                    String password,
                                                                                    Exception err)
                                                                             throws IOException,
                                                                                    GeneralSecurityException

Description copied from interface: RepeatingFilePasswordProvider

Invoked to inform the password provider about the decoding result. Note: any exception thrown from this method (including if called to inform about success) will be propagated instead of the original (if any was reported)

Specified by:

handleDecodeAttemptResult in interface RepeatingFilePasswordProvider

Parameters:

resourceKey - The resource key representing the private file

password - The password that was attempted

err - The attempt result - null for success

Returns:

How to proceed in case of error - ignored if invoked in order to report success. Note: null is same as RepeatingFilePasswordProvider.ResourceDecodeResult.TERMINATE.

Throws:

IOException

GeneralSecurityException