org.apache.sshd.client.config.keys

Class ClientIdentitiesWatcher

java.lang.Object

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

org.apache.sshd.common.keyprovider.AbstractKeyPairProvider

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

All Implemented Interfaces:

KeyIdentityProvider, KeyPairProvider

Direct Known Subclasses:

BuiltinClientIdentitiesWatcher

public class ClientIdentitiesWatcher
extends AbstractKeyPairProvider
implements KeyPairProvider

Watches over a group of files that contains client identities

Field Summary

Fields

Modifier and Type	Field and Description
private java.util.Collection<ClientIdentityProvider>	providers

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
ClientIdentitiesWatcher(java.util.Collection<? extends java.nio.file.Path> paths, ClientIdentityLoader loader, FilePasswordProvider provider)
ClientIdentitiesWatcher(java.util.Collection<? extends java.nio.file.Path> paths, ClientIdentityLoader loader, FilePasswordProvider provider, boolean strict)
ClientIdentitiesWatcher(java.util.Collection<? extends java.nio.file.Path> paths, ClientIdentityLoaderHolder loader, FilePasswordProviderHolder provider)
ClientIdentitiesWatcher(java.util.Collection<? extends java.nio.file.Path> paths, ClientIdentityLoaderHolder loader, FilePasswordProviderHolder provider, boolean strict)
ClientIdentitiesWatcher(java.util.Collection<ClientIdentityProvider> providers)

Method Summary

Modifier and Type	Method and Description
static java.util.List<ClientIdentityProvider>	buildProviders(java.util.Collection<? extends java.nio.file.Path> paths, ClientIdentityLoader loader, FilePasswordProvider provider, boolean strict)
static java.util.List<ClientIdentityProvider>	buildProviders(java.util.Collection<? extends java.nio.file.Path> paths, ClientIdentityLoaderHolder loader, FilePasswordProviderHolder provider, boolean strict)
protected java.lang.Iterable<java.security.KeyPair>	doGetKeyPairs(SessionContext session, ClientIdentityProvider p)
java.lang.Iterable<java.security.KeyPair>	loadKeys(SessionContext session) Load available keys.
protected java.lang.Iterable<java.security.KeyPair>	loadKeys(SessionContext session, java.util.function.Predicate<? super java.security.KeyPair> filter)

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

providers

private final java.util.Collection<ClientIdentityProvider> providers

Constructor Detail

ClientIdentitiesWatcher

public ClientIdentitiesWatcher(java.util.Collection<? extends java.nio.file.Path> paths,
                               ClientIdentityLoader loader,
                               FilePasswordProvider provider)

ClientIdentitiesWatcher

public ClientIdentitiesWatcher(java.util.Collection<? extends java.nio.file.Path> paths,
                               ClientIdentityLoader loader,
                               FilePasswordProvider provider,
                               boolean strict)

ClientIdentitiesWatcher

public ClientIdentitiesWatcher(java.util.Collection<? extends java.nio.file.Path> paths,
                               ClientIdentityLoaderHolder loader,
                               FilePasswordProviderHolder provider)

ClientIdentitiesWatcher

public ClientIdentitiesWatcher(java.util.Collection<? extends java.nio.file.Path> paths,
                               ClientIdentityLoaderHolder loader,
                               FilePasswordProviderHolder provider,
                               boolean strict)

ClientIdentitiesWatcher

public ClientIdentitiesWatcher(java.util.Collection<ClientIdentityProvider> providers)

Method Detail

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

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

loadKeys

protected java.lang.Iterable<java.security.KeyPair> loadKeys(SessionContext session,
                                                             java.util.function.Predicate<? super java.security.KeyPair> filter)

doGetKeyPairs

protected java.lang.Iterable<java.security.KeyPair> doGetKeyPairs(SessionContext session,
                                                                  ClientIdentityProvider p)

buildProviders

public static java.util.List<ClientIdentityProvider> buildProviders(java.util.Collection<? extends java.nio.file.Path> paths,
                                                                    ClientIdentityLoader loader,
                                                                    FilePasswordProvider provider,
                                                                    boolean strict)

buildProviders

public static java.util.List<ClientIdentityProvider> buildProviders(java.util.Collection<? extends java.nio.file.Path> paths,
                                                                    ClientIdentityLoaderHolder loader,
                                                                    FilePasswordProviderHolder provider,
                                                                    boolean strict)