org.apache.sshd.common.keyprovider

Class FileKeyPairProvider

java.lang.Object

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

org.apache.sshd.common.keyprovider.AbstractKeyPairProvider

org.apache.sshd.common.keyprovider.AbstractResourceKeyPairProvider<Path>

org.apache.sshd.common.keyprovider.FileKeyPairProvider

All Implemented Interfaces:

KeyIdentityProvider, KeyPairProvider

public class FileKeyPairProvider
extends AbstractResourceKeyPairProvider<Path>

This host key provider loads private keys from the specified files. The loading is lazy - i.e., a file is not loaded until it is actually required. Once required though, its loaded KeyPair result is cached and not re-loaded.

Author:

Apache MINA SSHD Project

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.sshd.common.keyprovider.AbstractResourceKeyPairProvider

AbstractResourceKeyPairProvider.KeyPairIterator

Field Summary

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, LOADER

Constructor Summary

Constructors

Constructor and Description
FileKeyPairProvider()
FileKeyPairProvider(Collection<? extends Path> files)
FileKeyPairProvider(Path... files)
FileKeyPairProvider(Path path)

Method Summary

Modifier and Type	Method and Description
protected KeyPair	doLoadKey(Path resource)
Collection<? extends Path>	getPaths()
Iterable<KeyPair>	loadKeys() Load available keys.
protected InputStream	openKeyPairResource(String resourceKey, Path resource)
void	setFiles(Collection<File> files)
void	setPaths(Collection<? extends Path> paths)

Methods inherited from class org.apache.sshd.common.keyprovider.AbstractResourceKeyPairProvider

doLoadKey, doLoadKey, getPasswordFinder, loadKeys, resetCacheMap, setPasswordFinder

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

iterableOf, iteratorOf, iteratorOf, iteratorOf, multiProvider, multiProvider, providerOf, resolveKeyIdentityProvider

Constructor Detail

FileKeyPairProvider

public FileKeyPairProvider()

FileKeyPairProvider

public FileKeyPairProvider(Path path)

FileKeyPairProvider

public FileKeyPairProvider(Path... files)

FileKeyPairProvider

public FileKeyPairProvider(Collection<? extends Path> files)

Method Detail

getPaths

public Collection<? extends Path> getPaths()

setFiles

public void setFiles(Collection<File> files)

setPaths

public void setPaths(Collection<? extends Path> paths)

loadKeys

public Iterable<KeyPair> loadKeys()

Description copied from interface: KeyIdentityProvider

Load available keys.

Returns:

an Iterable instance of available keys - ignored if null

doLoadKey

protected KeyPair doLoadKey(Path resource)
                     throws IOException,
                            GeneralSecurityException

Overrides:

doLoadKey in class AbstractResourceKeyPairProvider<Path>

Throws:

IOException

GeneralSecurityException

openKeyPairResource

protected InputStream openKeyPairResource(String resourceKey,
                                          Path resource)
                                   throws IOException

Specified by:

openKeyPairResource in class AbstractResourceKeyPairProvider<Path>

Throws:

IOException