Modifier and Type	Class and Description
public static interface	FilePasswordProvider.Decoder< type of the result T> Something that can produce a result given a password.
public static enum	FilePasswordProvider.ResourceDecodeResult

Modifier and Type	Field and Description
public static final FilePasswordProvider	EMPTY An "empty" provider that returns `null` - i.e., unprotected key file

Method Summary

Modifier and Type	Method and Description
public default < Result type of the decoder T> T	Returns: the decoder's result, or `null` if none decode(SessionContext `SessionContext`, may be `null` session, NamedResource `NamedResource` used for error reporting resourceKey, FilePasswordProvider.Decoder<? extends T> `Decoder` to produce the result given a password decoder) Obtains the password through `getPassword(SessionContext, NamedResource, int)`, invokes the `Decoder` and then `handleDecodeAttemptResult(SessionContext, NamedResource, int, String, Exception)` and then returns the decoded result.
public String	Returns: The password - if `null`/empty then no password is required getPassword(SessionContext The `SessionContext` for invoking this load command - may be `null` if not invoked within a session context (e.g., offline tool or session unknown). session, NamedResource The resource key representing the private file resourceKey, int The zero-based index of the invocation for the specific resource (in case invoked several times for the same resource) retryIndex)
public default FilePasswordProvider.ResourceDecodeResult	Returns: How to proceed in case of error - ignored if invoked in order to report success Note `null` is same as `ResourceDecodeResult#TERMINATE`. handleDecodeAttemptResult(SessionContext The `SessionContext` for invoking this load command - may be `null` if not invoked within a session context (e.g., offline tool or session unknown). session, NamedResource The resource key representing the private file resourceKey, int The zero-based index of the invocation for the specific resource (in case invoked several times for the same resource). If success report, it indicates the number of retries it took to succeed retryIndex, String The password that was attempted password, Exception The attempt result - `null` for success err) Invoked to inform the password provide 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)
public static FilePasswordProvider	of(String password)

Field Detail

EMPTY	back to summary
public static final FilePasswordProvider EMPTY An "empty" provider that returns `null` - i.e., unprotected key file

Method Detail

decode back to summary

decode	back to summary
public default <T> T decode(SessionContext session, NamedResource resourceKey, FilePasswordProvider.Decoder<? extends T> decoder) throws IOException, GeneralSecurityException Obtains the password through `getPassword(SessionContext, NamedResource, int)`, invokes the `Decoder` and then `handleDecodeAttemptResult(SessionContext, NamedResource, int, String, Exception)` and then returns the decoded result. If the decoder fails and the `ResourceDecodeResult` is `ResourceDecodeResult#RETRY`, the whole process is re-tried. Parameters <T> Result type of the decoder session:SessionContext `SessionContext`, may be `null` resourceKey:NamedResource `NamedResource` used for error reporting decoder:FilePasswordProvider.Decoder<? extends T> `Decoder` to produce the result given a password Returns:T the decoder's result, or `null` if none Exceptions IOException: if an I/O problem occurs GeneralSecurityException: if the decoder throws it

public default <T> T decode(SessionContext session, NamedResource resourceKey, FilePasswordProvider.Decoder<? extends T> decoder) throws IOException, GeneralSecurityException

Obtains the password through getPassword(SessionContext, NamedResource, int), invokes the Decoder and then handleDecodeAttemptResult(SessionContext, NamedResource, int, String, Exception) and then returns the decoded result. If the decoder fails and the ResourceDecodeResult is ResourceDecodeResult#RETRY, the whole process is re-tried.

Parameters

<T>: Result type of the decoder
session:SessionContext: SessionContext, may be null
resourceKey:NamedResource: NamedResource used for error reporting
decoder:FilePasswordProvider.Decoder<? extends T>: Decoder to produce the result given a password

Returns:T

the decoder's result, or null if none

Exceptions

IOException:: if an I/O problem occurs
GeneralSecurityException:: if the decoder throws it

getPassword back to summary

getPassword	back to summary
public String getPassword(SessionContext session, NamedResource resourceKey, int retryIndex) throws IOException Parameters session:SessionContext The `SessionContext` for invoking this load command - may be `null` if not invoked within a session context (e.g., offline tool or session unknown). resourceKey:NamedResource The resource key representing the private file retryIndex:int The zero-based index of the invocation for the specific resource (in case invoked several times for the same resource) Returns:String The password - if `null`/empty then no password is required Exceptions IOException: if cannot resolve password See Also `handleDecodeAttemptResult(SessionContext, NamedResource, int, String, Exception)`

public String getPassword(SessionContext session, NamedResource resourceKey, int retryIndex) throws IOException

Parameters

session:SessionContext: The SessionContext for invoking this load command - may be null if not invoked within a session context (e.g., offline tool or session unknown).
resourceKey:NamedResource: The resource key representing the private file
retryIndex:int: The zero-based index of the invocation for the specific resource (in case invoked several times for the same resource)

Returns:String

The password - if null/empty then no password is required

Exceptions

IOException:: if cannot resolve password

handleDecodeAttemptResult back to summary

handleDecodeAttemptResult	back to summary
public default FilePasswordProvider.ResourceDecodeResult handleDecodeAttemptResult(SessionContext session, NamedResource resourceKey, int retryIndex, String password, Exception err) throws IOException, GeneralSecurityException Invoked to inform the password provide 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 session:SessionContext The `SessionContext` for invoking this load command - may be `null` if not invoked within a session context (e.g., offline tool or session unknown). resourceKey:NamedResource The resource key representing the private file retryIndex:int The zero-based index of the invocation for the specific resource (in case invoked several times for the same resource). If success report, it indicates the number of retries it took to succeed password:String The password that was attempted err:Exception The attempt result - `null` for success Returns:FilePasswordProvider.ResourceDecodeResult How to proceed in case of error - ignored if invoked in order to report success Note `null` is same as `ResourceDecodeResult#TERMINATE`. Exceptions IOException: If cannot resolve a new password GeneralSecurityException: If not attempting to resolve a new password

public default FilePasswordProvider.ResourceDecodeResult handleDecodeAttemptResult(SessionContext session, NamedResource resourceKey, int retryIndex, String password, Exception err) throws IOException, GeneralSecurityException

Invoked to inform the password provide 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

session:SessionContext: The SessionContext for invoking this load command - may be null if not invoked within a session context (e.g., offline tool or session unknown).
resourceKey:NamedResource: The resource key representing the private file
retryIndex:int: The zero-based index of the invocation for the specific resource (in case invoked several times for the same resource). If success report, it indicates the number of retries it took to succeed
password:String: The password that was attempted
err:Exception: The attempt result - null for success

Returns:FilePasswordProvider.ResourceDecodeResult

How to proceed in case of error - ignored if invoked in order to report success

Note

null is same as ResourceDecodeResult#TERMINATE.

Exceptions

IOException:: If cannot resolve a new password
GeneralSecurityException:: If not attempting to resolve a new password

of	back to summary
public static FilePasswordProvider of(String password)

org.apache.sshd.common.config.keys back to summary

public Interface FilePasswordProvider.Decoder<T>

Type Parameters

<T>: type of the result

Something that can produce a result given a password.

Method Summary

Modifier and Type	Method and Description
public T	decode(String password)

Method Detail

decode	back to summary
public T decode(String password) throws IOException, GeneralSecurityException

org.apache.sshd.common.config.keys back to summary

public final Enum FilePasswordProvider.ResourceDecodeResult

Class Inheritance

extends Enum<FilePasswordProvider.ResourceDecodeResult>

java.lang.Object
java.lang.Enum
org.apache.sshd.common.config.keys.FilePasswordProvider.ResourceDecodeResult

Field Summary

Modifier and Type	Field and Description
public static final FilePasswordProvider.ResourceDecodeResult	IGNORE Skip attempt and see if can proceed without the key
public static final FilePasswordProvider.ResourceDecodeResult	RETRY Try again the decoding process - including password prompt
public static final FilePasswordProvider.ResourceDecodeResult	TERMINATE Re-throw the decoding exception
public static final Set<FilePasswordProvider.ResourceDecodeResult>	VALUES

Constructor Summary

Access	Constructor and Description
private	ResourceDecodeResult()

Method Summary

Modifier and Type	Method and Description
public static FilePasswordProvider.ResourceDecodeResult	valueOf(String name)
public static FilePasswordProvider.ResourceDecodeResult[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

IGNORE	back to summary
public static final FilePasswordProvider.ResourceDecodeResult IGNORE Skip attempt and see if can proceed without the key

RETRY	back to summary
public static final FilePasswordProvider.ResourceDecodeResult RETRY Try again the decoding process - including password prompt

TERMINATE	back to summary
public static final FilePasswordProvider.ResourceDecodeResult TERMINATE Re-throw the decoding exception

VALUES	back to summary
public static final Set<FilePasswordProvider.ResourceDecodeResult> VALUES

Constructor Detail

ResourceDecodeResult	back to summary
private ResourceDecodeResult()

Method Detail

valueOf	back to summary
public static FilePasswordProvider.ResourceDecodeResult valueOf(String name)

values	back to summary
public static FilePasswordProvider.ResourceDecodeResult[] values()

public Interface FilePasswordProvider

Nested and Inner Type Summary

Field Summary

Method Summary

Field Detail

Method Detail

public Interface FilePasswordProvider.Decoder<T>

Method Summary

Method Detail

public final Enum FilePasswordProvider.ResourceDecodeResult

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail