Package 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 java.lang.Object
implements KeyIdentityProvider, ClientIdentityLoaderHolder, FilePasswordProviderHolder

TODO Add javadoc

Field Summary

Fields

Modifier and Type	Field	Description
private ClientIdentityLoader	clientIdentityLoader
private boolean	ignoreNonExisting
private java.util.Collection<? extends NamedResource>	locations
private FilePasswordProvider	passwordProvider

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

EMPTY_KEYS_PROVIDER

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
ClientIdentityLoader	getClientIdentityLoader()
FilePasswordProvider	getFilePasswordProvider()
java.util.Collection<? extends NamedResource>	getLocations()
boolean	isIgnoreNonExisting()
protected java.lang.Iterable<java.security.KeyPair>	loadClientIdentities(SessionContext session, NamedResource location)
java.lang.Iterable<java.security.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

Field Detail

clientIdentityLoader

private final ClientIdentityLoader clientIdentityLoader

locations

private final java.util.Collection<? extends NamedResource> locations

passwordProvider

private final FilePasswordProvider passwordProvider

ignoreNonExisting

private final boolean ignoreNonExisting

Constructor Detail

LazyClientKeyIdentityProvider

public LazyClientKeyIdentityProvider(ClientIdentityLoader loader,
                                     java.util.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 java.util.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 java.lang.Iterable<java.security.KeyPair> loadKeys(SessionContext session)
                                                   throws java.io.IOException,
                                                          java.security.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:

java.io.IOException - If failed to read/parse the keys data

java.security.GeneralSecurityException - If failed to generate the keys

loadClientIdentities

protected java.lang.Iterable<java.security.KeyPair> loadClientIdentities(SessionContext session,
                                                                         NamedResource location)
                                                                  throws java.io.IOException,
                                                                         java.security.GeneralSecurityException

Throws:

java.io.IOException

java.security.GeneralSecurityException