org.apache.sshd.client.config.keys

Class BuiltinClientIdentitiesWatcher

java.lang.Object

org.apache.sshd.common.util.logging.AbstractLoggingBean

org.apache.sshd.common.keyprovider.AbstractKeyPairProvider

org.apache.sshd.client.config.keys.ClientIdentitiesWatcher

org.apache.sshd.client.config.keys.BuiltinClientIdentitiesWatcher

All Implemented Interfaces:

KeyIdentityProvider, KeyPairProvider

Direct Known Subclasses:

DefaultClientIdentitiesWatcher

public class BuiltinClientIdentitiesWatcher
extends ClientIdentitiesWatcher

Field Summary

Fields

Modifier and Type	Field and Description
private boolean	supportedOnly

Fields inherited from class org.apache.sshd.common.util.logging.AbstractLoggingBean

log

Fields inherited from interface org.apache.sshd.common.keyprovider.KeyPairProvider

ECDSA_SHA2_NISTP256, ECDSA_SHA2_NISTP384, ECDSA_SHA2_NISTP521, EMPTY_KEYPAIR_PROVIDER, SSH_DSS, SSH_ED25519, SSH_RSA

Fields inherited from interface org.apache.sshd.common.keyprovider.KeyIdentityProvider

EMPTY_KEYS_PROVIDER

Constructor Summary

Constructors

Constructor and Description
BuiltinClientIdentitiesWatcher(java.nio.file.Path keysFolder, boolean supportedOnly, ClientIdentityLoader loader, FilePasswordProvider provider, boolean strict)
BuiltinClientIdentitiesWatcher(java.nio.file.Path keysFolder, boolean supportedOnly, ClientIdentityLoaderHolder loader, FilePasswordProviderHolder provider, boolean strict)
BuiltinClientIdentitiesWatcher(java.nio.file.Path keysFolder, java.util.Collection<java.lang.String> ids, boolean supportedOnly, ClientIdentityLoader loader, FilePasswordProvider provider, boolean strict)
BuiltinClientIdentitiesWatcher(java.nio.file.Path keysFolder, java.util.Collection<java.lang.String> ids, boolean supportedOnly, ClientIdentityLoaderHolder loader, FilePasswordProviderHolder provider, boolean strict)

Method Summary

Modifier and Type	Method and Description
static java.util.List<java.nio.file.Path>	getBuiltinIdentitiesPaths(java.nio.file.Path keysFolder, java.util.Collection<java.lang.String> ids)
static java.util.List<java.nio.file.Path>	getDefaultBuiltinIdentitiesPaths(java.nio.file.Path keysFolder)
protected boolean	isSupported(SessionContext session, java.security.KeyPair kp)
boolean	isSupportedOnly()
java.lang.Iterable<java.security.KeyPair>	loadKeys(SessionContext session) Load available keys.

Methods inherited from class org.apache.sshd.client.config.keys.ClientIdentitiesWatcher

buildProviders, buildProviders, doGetKeyPairs, loadKeys

Methods inherited from class org.apache.sshd.common.util.logging.AbstractLoggingBean

getSimplifiedLogger

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.keyprovider.KeyPairProvider

getKeyTypes, loadKey, wrap, wrap

Methods inherited from interface org.apache.sshd.common.keyprovider.KeyIdentityProvider

exhaustCurrentIdentities, isEmpty, iterableOf, multiProvider, multiProvider, resolveKeyIdentityProvider, wrapKeyPairs, wrapKeyPairs

Field Detail

supportedOnly

private final boolean supportedOnly

Constructor Detail

BuiltinClientIdentitiesWatcher

public BuiltinClientIdentitiesWatcher(java.nio.file.Path keysFolder,
                                      boolean supportedOnly,
                                      ClientIdentityLoader loader,
                                      FilePasswordProvider provider,
                                      boolean strict)

BuiltinClientIdentitiesWatcher

public BuiltinClientIdentitiesWatcher(java.nio.file.Path keysFolder,
                                      java.util.Collection<java.lang.String> ids,
                                      boolean supportedOnly,
                                      ClientIdentityLoader loader,
                                      FilePasswordProvider provider,
                                      boolean strict)

BuiltinClientIdentitiesWatcher

public BuiltinClientIdentitiesWatcher(java.nio.file.Path keysFolder,
                                      boolean supportedOnly,
                                      ClientIdentityLoaderHolder loader,
                                      FilePasswordProviderHolder provider,
                                      boolean strict)

BuiltinClientIdentitiesWatcher

public BuiltinClientIdentitiesWatcher(java.nio.file.Path keysFolder,
                                      java.util.Collection<java.lang.String> ids,
                                      boolean supportedOnly,
                                      ClientIdentityLoaderHolder loader,
                                      FilePasswordProviderHolder provider,
                                      boolean strict)

Method Detail

isSupportedOnly

public final boolean isSupportedOnly()

loadKeys

public java.lang.Iterable<java.security.KeyPair> loadKeys(SessionContext session)

Description copied from interface: KeyIdentityProvider

Load available keys.

Specified by:

loadKeys in interface KeyIdentityProvider

Overrides:

loadKeys in class ClientIdentitiesWatcher

Parameters:

session - The SessionContext for invoking this load command - may be null if not invoked within a session context (e.g., offline tool or session unknown).

Returns:

an Iterable instance of available keys - ignored if null

isSupported

protected boolean isSupported(SessionContext session,
                              java.security.KeyPair kp)

getDefaultBuiltinIdentitiesPaths

public static java.util.List<java.nio.file.Path> getDefaultBuiltinIdentitiesPaths(java.nio.file.Path keysFolder)

getBuiltinIdentitiesPaths

public static java.util.List<java.nio.file.Path> getBuiltinIdentitiesPaths(java.nio.file.Path keysFolder,
                                                                           java.util.Collection<java.lang.String> ids)