org.apache.sshd.common.config.keys.loader

Interface KeyPairResourceLoader

All Known Subinterfaces:

KeyPairPEMResourceParser, KeyPairResourceParser

All Known Implementing Classes:

AbstractKeyPairResourceParser, AbstractPEMResourceKeyPairParser, BouncyCastleKeyPairResourceParser, DSSPEMResourceKeyPairParser, ECDSAPEMResourceKeyPairParser, OpenSSHKeyPairResourceParser, PKCS8PEMResourceKeyPairParser, RSAPEMResourceKeyPairParser

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@FunctionalInterface
public interface KeyPairResourceLoader

Loads KeyPairs from text resources

Author:

Apache MINA SSHD Project

Field Summary

Fields

Modifier and Type	Field and Description
static KeyPairResourceLoader	EMPTY An empty loader that never fails but always returns an empty list

Method Summary

Modifier and Type	Method and Description
default Collection<KeyPair>	loadKeyPairs(Path path, FilePasswordProvider passwordProvider, Charset cs, OpenOption... options)
default Collection<KeyPair>	loadKeyPairs(Path path, FilePasswordProvider passwordProvider, OpenOption... options)
default Collection<KeyPair>	loadKeyPairs(String resourceKey, FilePasswordProvider passwordProvider, BufferedReader r)
default Collection<KeyPair>	loadKeyPairs(String resourceKey, FilePasswordProvider passwordProvider, InputStream stream)
default Collection<KeyPair>	loadKeyPairs(String resourceKey, FilePasswordProvider passwordProvider, InputStream stream, Charset cs)
Collection<KeyPair>	loadKeyPairs(String resourceKey, FilePasswordProvider passwordProvider, List<String> lines) Loads key pairs from the given resource text lines
default Collection<KeyPair>	loadKeyPairs(String resourceKey, FilePasswordProvider passwordProvider, Reader r)
default Collection<KeyPair>	loadKeyPairs(String resourceKey, FilePasswordProvider passwordProvider, String data)
default Collection<KeyPair>	loadKeyPairs(URL url, FilePasswordProvider passwordProvider)
default Collection<KeyPair>	loadKeyPairs(URL url, FilePasswordProvider passwordProvider, Charset cs)

Field Detail

EMPTY

static final KeyPairResourceLoader EMPTY

An empty loader that never fails but always returns an empty list

Method Detail

loadKeyPairs

default Collection<KeyPair> loadKeyPairs(Path path,
                                         FilePasswordProvider passwordProvider,
                                         OpenOption... options)
                                  throws IOException,
                                         GeneralSecurityException

Throws:

IOException

GeneralSecurityException

loadKeyPairs

default Collection<KeyPair> loadKeyPairs(Path path,
                                         FilePasswordProvider passwordProvider,
                                         Charset cs,
                                         OpenOption... options)
                                  throws IOException,
                                         GeneralSecurityException

Throws:

IOException

GeneralSecurityException

loadKeyPairs

default Collection<KeyPair> loadKeyPairs(URL url,
                                         FilePasswordProvider passwordProvider)
                                  throws IOException,
                                         GeneralSecurityException

Throws:

IOException

GeneralSecurityException

loadKeyPairs

default Collection<KeyPair> loadKeyPairs(URL url,
                                         FilePasswordProvider passwordProvider,
                                         Charset cs)
                                  throws IOException,
                                         GeneralSecurityException

Throws:

IOException

GeneralSecurityException

loadKeyPairs

default Collection<KeyPair> loadKeyPairs(String resourceKey,
                                         FilePasswordProvider passwordProvider,
                                         String data)
                                  throws IOException,
                                         GeneralSecurityException

Throws:

IOException

GeneralSecurityException

loadKeyPairs

default Collection<KeyPair> loadKeyPairs(String resourceKey,
                                         FilePasswordProvider passwordProvider,
                                         InputStream stream)
                                  throws IOException,
                                         GeneralSecurityException

Throws:

IOException

GeneralSecurityException

loadKeyPairs

default Collection<KeyPair> loadKeyPairs(String resourceKey,
                                         FilePasswordProvider passwordProvider,
                                         InputStream stream,
                                         Charset cs)
                                  throws IOException,
                                         GeneralSecurityException

Throws:

IOException

GeneralSecurityException

loadKeyPairs

default Collection<KeyPair> loadKeyPairs(String resourceKey,
                                         FilePasswordProvider passwordProvider,
                                         Reader r)
                                  throws IOException,
                                         GeneralSecurityException

Throws:

IOException

GeneralSecurityException

loadKeyPairs

default Collection<KeyPair> loadKeyPairs(String resourceKey,
                                         FilePasswordProvider passwordProvider,
                                         BufferedReader r)
                                  throws IOException,
                                         GeneralSecurityException

Throws:

IOException

GeneralSecurityException

loadKeyPairs

Collection<KeyPair> loadKeyPairs(String resourceKey,
                                 FilePasswordProvider passwordProvider,
                                 List<String> lines)
                          throws IOException,
                                 GeneralSecurityException

Loads key pairs from the given resource text lines

Parameters:

resourceKey - A hint as to the origin of the text lines

passwordProvider - The FilePasswordProvider to use in case the data is encrypted - may be null if no encrypted data is expected

lines - The List of lines as read from the resource

Returns:

The extracted KeyPairs - may be null/empty if none. Note: the resource loader may decide to skip unknown lines if more than one key pair type is encoded in it

Throws:

IOException - If failed to process the lines

GeneralSecurityException - If failed to generate the keys from the parsed data