org.apache.sshd.common.keyprovider

Class ClassLoadableResourceKeyPairProvider

java.lang.Object

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

org.apache.sshd.common.keyprovider.AbstractKeyPairProvider

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

org.apache.sshd.common.keyprovider.ClassLoadableResourceKeyPairProvider

All Implemented Interfaces:

KeyIdentityProvider, KeyPairProvider

public class ClassLoadableResourceKeyPairProvider
extends AbstractResourceKeyPairProvider<String>

This provider loads private keys from the specified resources that are accessible via ClassLoader.getResourceAsStream(String). If no loader configured via setResourceLoader(ClassLoader), then ThreadUtils.resolveDefaultClassLoader(Class) is used

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_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

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

EMPTY_KEYS_PROVIDER

Constructor Summary

Constructors

Constructor and Description
ClassLoadableResourceKeyPairProvider()
ClassLoadableResourceKeyPairProvider(ClassLoader cl)
ClassLoadableResourceKeyPairProvider(ClassLoader cl, Collection<String> resources)
ClassLoadableResourceKeyPairProvider(ClassLoader cl, String res)
ClassLoadableResourceKeyPairProvider(Collection<String> resources)
ClassLoadableResourceKeyPairProvider(String res)

Method Summary

Modifier and Type	Method and Description
protected IoResource<?>	getIoResource(SessionContext session, String resource)
ClassLoader	getResourceLoader()
Collection<String>	getResources()
Iterable<KeyPair>	loadKeys(SessionContext session) Load available keys.
protected ClassLoader	resolveClassLoader()
void	setResourceLoader(ClassLoader classLoader)
void	setResources(Collection<String> resources)

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

doLoadKeys, 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, wrap, wrap

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

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

Constructor Detail

ClassLoadableResourceKeyPairProvider

public ClassLoadableResourceKeyPairProvider()

ClassLoadableResourceKeyPairProvider

public ClassLoadableResourceKeyPairProvider(ClassLoader cl)

ClassLoadableResourceKeyPairProvider

public ClassLoadableResourceKeyPairProvider(String res)

ClassLoadableResourceKeyPairProvider

public ClassLoadableResourceKeyPairProvider(ClassLoader cl,
                                            String res)

ClassLoadableResourceKeyPairProvider

public ClassLoadableResourceKeyPairProvider(Collection<String> resources)

ClassLoadableResourceKeyPairProvider

public ClassLoadableResourceKeyPairProvider(ClassLoader cl,
                                            Collection<String> resources)

Method Detail

getResources

public Collection<String> getResources()

setResources

public void setResources(Collection<String> resources)

getResourceLoader

public ClassLoader getResourceLoader()

setResourceLoader

public void setResourceLoader(ClassLoader classLoader)

loadKeys

public Iterable<KeyPair> loadKeys(SessionContext session)

Description copied from interface: KeyIdentityProvider

Load available keys.

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

getIoResource

protected IoResource<?> getIoResource(SessionContext session,
                                      String resource)

Overrides:

getIoResource in class AbstractResourceKeyPairProvider<String>

resolveClassLoader

protected ClassLoader resolveClassLoader()