org.apache.sshd.client.config.keys

Class LazyClientKeyIdentityProvider

java.lang.Object

org.apache.sshd.client.config.keys.LazyClientKeyIdentityProvider

All Implemented Interfaces:

ClientIdentityLoaderHolder, FilePasswordProviderHolder, KeyIdentityProvider

public class LazyClientKeyIdentityProvider
extends Object
implements KeyIdentityProvider, ClientIdentityLoaderHolder, FilePasswordProviderHolder

TODO Add javadoc

Author:

Apache MINA SSHD Project

Field Summary

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

EMPTY_KEYS_PROVIDER

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
ClientIdentityLoader	getClientIdentityLoader()
FilePasswordProvider	getFilePasswordProvider()
Collection<? extends NamedResource>	getLocations()
boolean	isIgnoreNonExisting()
protected Iterable<KeyPair>	loadClientIdentities(SessionContext session, NamedResource location)
Iterable<KeyPair>	loadKeys(SessionContext session) Load available keys.

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

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

Methods inherited from interface org.apache.sshd.client.config.keys.ClientIdentityLoaderHolder

loaderHolderOf

Methods inherited from interface org.apache.sshd.common.config.keys.FilePasswordProviderHolder

providerHolderOf

Constructor Detail

LazyClientKeyIdentityProvider

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

Method Detail

getClientIdentityLoader

public ClientIdentityLoader getClientIdentityLoader()

Specified by:

getClientIdentityLoader in interface ClientIdentityLoaderHolder

Returns:

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

getLocations

public Collection<? extends NamedResource> getLocations()

getFilePasswordProvider

public FilePasswordProvider getFilePasswordProvider()

Specified by:

getFilePasswordProvider in interface FilePasswordProviderHolder

Returns:

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

See Also:

FilePasswordProvider.EMPTY

isIgnoreNonExisting

public boolean isIgnoreNonExisting()

loadKeys

public Iterable<KeyPair> loadKeys(SessionContext session)
                           throws IOException,
                                  GeneralSecurityException

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

Throws:

IOException - If failed to read/parse the keys data

GeneralSecurityException - If failed to generate the keys

loadClientIdentities

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

Throws:

IOException

GeneralSecurityException