org.eclipse.jgit.internal.transport.sshd

Interface RepeatingFilePasswordProvider

All Superinterfaces:

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

All Known Implementing Classes:

PasswordProviderWrapper

public interface RepeatingFilePasswordProvider
extends org.apache.sshd.common.config.keys.FilePasswordProvider

A FilePasswordProvider augmented to support repeatedly asking for passwords.

Since:

5.2

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	RepeatingFilePasswordProvider.ResourceDecodeResult Result value of handleDecodeAttemptResult(String, String, Exception).

Field Summary

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

EMPTY

Method Summary

Modifier and Type	Method and Description
default int	getAttempts() Gets the maximum number of attempts to get a password that should be attempted for one identity resource through this provider.
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 interface org.apache.sshd.common.config.keys.FilePasswordProvider

getPassword, of

Method Detail

setAttempts

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.

Parameters:

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

getAttempts

default int getAttempts()

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

Returns:

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

handleDecodeAttemptResult

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

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)

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