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 loadedKeyPair
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.KeyIdentityProvider
EMPTY_KEYS_PROVIDER
-
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_DSS_CERT, SSH_ECDSA_SHA2_NISTP256_CERT, SSH_ECDSA_SHA2_NISTP384_CERT, SSH_ECDSA_SHA2_NISTP521_CERT, SSH_ED25519, SSH_ED25519_CERT, SSH_RSA, SSH_RSA_CERT
-
-
Constructor Summary
Constructors Constructor Description FileKeyPairProvider()
FileKeyPairProvider(Path path)
FileKeyPairProvider(Path... files)
FileKeyPairProvider(Collection<? extends Path> files)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected Iterable<KeyPair>
doLoadKeys(SessionContext session, Path resource)
protected IoResource<Path>
getIoResource(SessionContext session, Path resource)
Collection<? extends Path>
getPaths()
Iterable<KeyPair>
loadKeys(SessionContext session)
Load available keys.void
setPaths(Collection<? extends Path> paths)
-
Methods inherited from class org.apache.sshd.common.keyprovider.AbstractResourceKeyPairProvider
doLoadKeys, doLoadKeys, getPasswordFinder, loadKeys, openKeyPairResource, resetCacheMap, setPasswordFinder
-
Methods inherited from class org.apache.sshd.common.util.logging.AbstractLoggingBean
debug, debug, debug, debug, debug, error, error, error, error, error, getSimplifiedLogger, info, info, warn, warn, warn, warn, warn, warn, warn, warn
-
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
-
-
-
-
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()
-
setPaths
public void setPaths(Collection<? extends Path> paths)
-
loadKeys
public Iterable<KeyPair> loadKeys(SessionContext session)
Description copied from interface:KeyIdentityProvider
Load available keys.- Parameters:
session
- TheSessionContext
for invoking this load command - may benull
if not invoked within a session context (e.g., offline tool or session unknown).- Returns:
- an
Iterable
instance of available keys - ignored ifnull
-
getIoResource
protected IoResource<Path> getIoResource(SessionContext session, Path resource)
- Overrides:
getIoResource
in classAbstractResourceKeyPairProvider<Path>
-
doLoadKeys
protected Iterable<KeyPair> doLoadKeys(SessionContext session, Path resource) throws IOException, GeneralSecurityException
- Overrides:
doLoadKeys
in classAbstractResourceKeyPairProvider<Path>
- Throws:
IOException
GeneralSecurityException
-
-