Package 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<java.lang.String>

org.apache.sshd.common.keyprovider.ClassLoadableResourceKeyPairProvider

All Implemented Interfaces:

KeyIdentityProvider, KeyPairProvider

public class ClassLoadableResourceKeyPairProvider
extends AbstractResourceKeyPairProvider<java.lang.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

Nested Class Summary

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

AbstractResourceKeyPairProvider.KeyPairIterator

Field Summary

Fields

Modifier and Type	Field	Description
private java.lang.ClassLoader	classLoader
private java.util.Collection<java.lang.String>	resources

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
ClassLoadableResourceKeyPairProvider()
ClassLoadableResourceKeyPairProvider(java.lang.ClassLoader cl)
ClassLoadableResourceKeyPairProvider(java.lang.ClassLoader cl, java.lang.String res)
ClassLoadableResourceKeyPairProvider(java.lang.ClassLoader cl, java.util.Collection<java.lang.String> resources)
ClassLoadableResourceKeyPairProvider(java.lang.String res)
ClassLoadableResourceKeyPairProvider(java.util.Collection<java.lang.String> resources)

Method Summary

Modifier and Type	Method	Description
protected IoResource<?>	getIoResource(SessionContext session, java.lang.String resource)
java.lang.ClassLoader	getResourceLoader()
java.util.Collection<java.lang.String>	getResources()
java.lang.Iterable<java.security.KeyPair>	loadKeys(SessionContext session)	Load available keys.
protected java.lang.ClassLoader	resolveClassLoader()
void	setResourceLoader(java.lang.ClassLoader classLoader)
void	setResources(java.util.Collection<java.lang.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

Field Detail

classLoader

private java.lang.ClassLoader classLoader

resources

private java.util.Collection<java.lang.String> resources

Constructor Detail

ClassLoadableResourceKeyPairProvider

public ClassLoadableResourceKeyPairProvider()

ClassLoadableResourceKeyPairProvider

public ClassLoadableResourceKeyPairProvider(java.lang.ClassLoader cl)

ClassLoadableResourceKeyPairProvider

public ClassLoadableResourceKeyPairProvider(java.lang.String res)

ClassLoadableResourceKeyPairProvider

public ClassLoadableResourceKeyPairProvider(java.lang.ClassLoader cl,
                                            java.lang.String res)

ClassLoadableResourceKeyPairProvider

public ClassLoadableResourceKeyPairProvider(java.util.Collection<java.lang.String> resources)

ClassLoadableResourceKeyPairProvider

public ClassLoadableResourceKeyPairProvider(java.lang.ClassLoader cl,
                                            java.util.Collection<java.lang.String> resources)

Method Detail

getResources

public java.util.Collection<java.lang.String> getResources()

setResources

public void setResources(java.util.Collection<java.lang.String> resources)

getResourceLoader

public java.lang.ClassLoader getResourceLoader()

setResourceLoader

public void setResourceLoader(java.lang.ClassLoader classLoader)

loadKeys

public java.lang.Iterable<java.security.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,
                                      java.lang.String resource)

Overrides:

getIoResource in class AbstractResourceKeyPairProvider<java.lang.String>

resolveClassLoader

protected java.lang.ClassLoader resolveClassLoader()