Top Description Fields Constructors Methods
org.apache.sshd.client.config.keys

public Class LazyClientKeyIdentityProvider

extends Object
implements KeyIdentityProvider, ClientIdentityLoaderHolder, FilePasswordProviderHolder
Class Inheritance
All Implemented Interfaces
org.apache.sshd.common.config.keys.FilePasswordProviderHolder, org.apache.sshd.client.config.keys.ClientIdentityLoaderHolder, org.apache.sshd.common.keyprovider.KeyIdentityProvider
Imports
java.io.FileNotFoundException, .IOException, java.security.GeneralSecurityException, .KeyPair, java.util.Collection, .Collections, .Iterator, .NoSuchElementException, .Objects, org.apache.sshd.common.NamedResource, org.apache.sshd.common.config.keys.FilePasswordProvider, .FilePasswordProviderHolder, org.apache.sshd.common.keyprovider.KeyIdentityProvider, org.apache.sshd.common.session.SessionContext, org.apache.sshd.common.util.GenericUtils
TODO Add javadoc
Author
Apache MINA SSHD Project

Field Summary

Modifier and TypeField and Description
private final ClientIdentityLoader
clientIdentityLoader

private final boolean
ignoreNonExisting

private final Collection<? extends NamedResource>
locations

private final FilePasswordProvider
passwordProvider

Constructor Summary

AccessConstructor and Description
public
LazyClientKeyIdentityProvider(ClientIdentityLoader loader, Collection<? extends NamedResource> locations, FilePasswordProvider passwordProvider, boolean ignoreNonExisting)

Method Summary

Modifier and TypeMethod and Description
public ClientIdentityLoader
getClientIdentityLoader()

Implements org.apache.sshd.client.config.keys.ClientIdentityLoaderHolder.getClientIdentityLoader.

public FilePasswordProvider
getFilePasswordProvider()

Implements org.apache.sshd.common.config.keys.FilePasswordProviderHolder.getFilePasswordProvider.

public Collection<? extends NamedResource>
getLocations()

public boolean
isIgnoreNonExisting()

protected Iterable<KeyPair>
loadClientIdentities(SessionContext session, NamedResource location)

public Iterable<KeyPair>
loadKeys(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)

Implements org.apache.sshd.common.keyprovider.KeyIdentityProvider.loadKeys.

Load available keys.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

clientIdentityLoaderback to summary
private final ClientIdentityLoader clientIdentityLoader
ignoreNonExistingback to summary
private final boolean ignoreNonExisting
locationsback to summary
private final Collection<? extends NamedResource> locations
passwordProviderback to summary
private final FilePasswordProvider passwordProvider

Constructor Detail

LazyClientKeyIdentityProviderback to summary
public LazyClientKeyIdentityProvider(ClientIdentityLoader loader, Collection<? extends NamedResource> locations, FilePasswordProvider passwordProvider, boolean ignoreNonExisting)

Method Detail

getClientIdentityLoaderback to summary
public ClientIdentityLoader getClientIdentityLoader()

Implements org.apache.sshd.client.config.keys.ClientIdentityLoaderHolder.getClientIdentityLoader.

Returns:ClientIdentityLoader

Doc from org.apache.sshd.client.config.keys.ClientIdentityLoaderHolder.getClientIdentityLoader.

The ClientIdentityLoader to use in order to load client key pair identities - never null

Annotations
@Override
getFilePasswordProviderback to summary
public FilePasswordProvider getFilePasswordProvider()

Implements org.apache.sshd.common.config.keys.FilePasswordProviderHolder.getFilePasswordProvider.

Returns:FilePasswordProvider

Doc from org.apache.sshd.common.config.keys.FilePasswordProviderHolder.getFilePasswordProvider.

The FilePasswordProvider to use if need to load encrypted identities keys - never null

Annotations
@Override
getLocationsback to summary
public Collection<? extends NamedResource> getLocations()
isIgnoreNonExistingback to summary
public boolean isIgnoreNonExisting()
loadClientIdentitiesback to summary
protected Iterable<KeyPair> loadClientIdentities(SessionContext session, NamedResource location) throws IOException, GeneralSecurityException
loadKeysback to summary
public Iterable<KeyPair> loadKeys(SessionContext session) throws IOException, GeneralSecurityException

Implements org.apache.sshd.common.keyprovider.KeyIdentityProvider.loadKeys.

Doc from org.apache.sshd.common.keyprovider.KeyIdentityProvider.loadKeys.

Load available keys.

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).

Returns:Iterable<KeyPair>

an Iterable instance of available keys - ignored if null

Annotations
@Override
@SuppressWarnings:checkstyle:anoninnerlength
Exceptions
IOException:
If failed to read/parse the keys data
GeneralSecurityException:
If failed to generate the keys