KeyIdentityProvider (Apache Mina SSHD

All Known Subinterfaces:

AuthenticationIdentitiesProvider, KeyPairProvider

All Known Implementing Classes:

AbstractGeneratorHostKeyProvider, AbstractKeyPairProvider, AbstractResourceKeyPairProvider, BouncyCastleGeneratorHostKeyProvider, BuiltinClientIdentitiesWatcher, ClassLoadableResourceKeyPairProvider, ClientIdentitiesWatcher, DefaultClientIdentitiesWatcher, FileKeyPairProvider, MappedKeyPairProvider, SimpleGeneratorHostKeyProvider

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 KeyIdentityProvider
```
Author:

Apache MINA SSHD Project

Field Summary

Fields
Modifier and Type	Field and Description
`static KeyIdentityProvider`	`EMPTY_KEYS_PROVIDER` An "empty" implementation of `KeyIdentityProvider` that returns an empty group of key pairs
`static Function<KeyIdentityProvider,Iterable<KeyPair>>`	`LOADER` Invokes `loadKeys()` and returns the result - ignores `null` providers (i.e., returns an empty iterable instance)

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`static Iterable<KeyPair>`	`iterableOf(Collection<? extends KeyIdentityProvider> providers)` Wraps a group of `KeyIdentityProvider` into an `Iterable` of `KeyPair`s
`static Iterator<KeyPair>`	`iteratorOf(ClientSession session)` Creates a "unified" `Iterator` of key pairs out of the registered `KeyPair` identities and the extra available ones as a single iterator of key pairs
`static Iterator<KeyPair>`	`iteratorOf(KeyIdentityProvider provider)` Resolves a non-`null` iterator of the available keys
`static Iterator<KeyPair>`	`iteratorOf(KeyIdentityProvider identities, KeyIdentityProvider keys)` Creates a "unified" `Iterator` of `KeyPair`s out of 2 possible `KeyIdentityProvider`
`Iterable<KeyPair>`	`loadKeys()` Load available keys.
`static KeyIdentityProvider`	`multiProvider(Collection<? extends KeyIdentityProvider> providers)` Wraps a group of `KeyIdentityProvider` into a single one
`static KeyIdentityProvider`	`multiProvider(KeyIdentityProvider... providers)` Wraps a group of `KeyIdentityProvider` into a single one
`static KeyIdentityProvider`	`providerOf(ClientSession session)` Creates a "unified" `KeyIdentityProvider` of key pairs out of the registered `KeyPair` identities and the extra available ones as a single iterator of key pairs
`static KeyIdentityProvider`	`resolveKeyIdentityProvider(KeyIdentityProvider identities, KeyIdentityProvider keys)` Creates a "unified" `KeyIdentityProvider` out of 2 possible ones as follows: If both are `null` then return `null`.
`static KeyIdentityProvider`	`wrap(Iterable<KeyPair> pairs)` Wraps a group of `KeyPair`s into a `KeyIdentityProvider`
`static KeyIdentityProvider`	`wrap(KeyPair... pairs)` Wraps a group of `KeyPair`s into a `KeyIdentityProvider`

- Field Detail
  - EMPTY_KEYS_PROVIDER
```
static final KeyIdentityProvider EMPTY_KEYS_PROVIDER
```
    An "empty" implementation of KeyIdentityProvider that returns an empty group of key pairs
  - LOADER
```
static final Function<KeyIdentityProvider,Iterable<KeyPair>> LOADER
```
    Invokes loadKeys() and returns the result - ignores null providers (i.e., returns an empty iterable instance)
- Method Detail
  - loadKeys
```
Iterable<KeyPair> loadKeys()
```
    Load available keys.
    
    Returns:
    
    an Iterable instance of available keys - ignored if null
  - providerOf
```
static KeyIdentityProvider providerOf(ClientSession session)
```
    Creates a "unified" KeyIdentityProvider of key pairs out of the registered KeyPair identities and the extra available ones as a single iterator of key pairs
    
    Parameters:
    
    session - The ClientSession - ignored if null (i.e., empty iterator returned)
    
    Returns:
    
    The wrapping KeyIdentityProvider
    
    See Also:
    
    ClientAuthenticationManager.getRegisteredIdentities(), KeyPairProviderHolder.getKeyPairProvider()
  - iteratorOf
```
static Iterator<KeyPair> iteratorOf(ClientSession session)
```
    Creates a "unified" Iterator of key pairs out of the registered KeyPair identities and the extra available ones as a single iterator of key pairs
    
    Parameters:
    
    session - The ClientSession - ignored if null (i.e., empty iterator returned)
    
    Returns:
    
    The wrapping iterator
    
    See Also:
    
    ClientAuthenticationManager.getRegisteredIdentities(), KeyPairProviderHolder.getKeyPairProvider()
  - iteratorOf
```
static Iterator<KeyPair> iteratorOf(KeyIdentityProvider identities,
                                    KeyIdentityProvider keys)
```
    Creates a "unified" Iterator of KeyPairs out of 2 possible KeyIdentityProvider
    
    Parameters:
    
    identities - The registered keys identities
    
    keys - Extra available key pairs
    
    Returns:
    
    The wrapping iterator
    
    See Also:
    
    resolveKeyIdentityProvider(KeyIdentityProvider, KeyIdentityProvider)
  - iteratorOf
```
static Iterator<KeyPair> iteratorOf(KeyIdentityProvider provider)
```
    Resolves a non-null iterator of the available keys
    
    Parameters:
    
    provider - The KeyIdentityProvider - ignored if null
    
    Returns:
    
    A non-null iterator - which may be empty if no provider or no keys
  - resolveKeyIdentityProvider
```
static KeyIdentityProvider resolveKeyIdentityProvider(KeyIdentityProvider identities,
                                                      KeyIdentityProvider keys)
```
    Creates a "unified" KeyIdentityProvider out of 2 possible ones as follows:
    - If both are null then return null.
    - If either one is null then use the non-null one.
    - If both are the same instance then use it.
    - Otherwise, returns a wrapper that groups both providers.
    Parameters:
    
    identities - The registered key pair identities
    
    keys - The extra available key pairs
    
    Returns:
    
    The resolved provider
    
    See Also:
    
    multiProvider(KeyIdentityProvider...)
  - multiProvider
```
static KeyIdentityProvider multiProvider(KeyIdentityProvider... providers)
```
    Wraps a group of KeyIdentityProvider into a single one
    
    Parameters:
    
    providers - The providers - ignored if null/empty (i.e., returns EMPTY_KEYS_PROVIDER)
    
    Returns:
    
    The wrapping provider
    
    See Also:
    
    multiProvider(Collection)
  - multiProvider
```
static KeyIdentityProvider multiProvider(Collection<? extends KeyIdentityProvider> providers)
```
    Wraps a group of KeyIdentityProvider into a single one
    
    Parameters:
    
    providers - The providers - ignored if null/empty (i.e., returns EMPTY_KEYS_PROVIDER)
    
    Returns:
    
    The wrapping provider
  - iterableOf
```
static Iterable<KeyPair> iterableOf(Collection<? extends KeyIdentityProvider> providers)
```
    Wraps a group of KeyIdentityProvider into an Iterable of KeyPairs
    
    Parameters:
    
    providers - The group of providers - ignored if null/empty (i.e., returns an empty iterable instance)
    
    Returns:
    
    The wrapping iterable
  - wrap
```
static KeyIdentityProvider wrap(KeyPair... pairs)
```
    Wraps a group of KeyPairs into a KeyIdentityProvider
    
    Parameters:
    
    pairs - The key pairs - ignored if null/empty (i.e., returns EMPTY_KEYS_PROVIDER).
    
    Returns:
    
    The provider wrapper
  - wrap
```
static KeyIdentityProvider wrap(Iterable<KeyPair> pairs)
```
    Wraps a group of KeyPairs into a KeyIdentityProvider
    
    Parameters:
    
    pairs - The key pairs Iterable - ignored if null (i.e., returns EMPTY_KEYS_PROVIDER).
    
    Returns:
    
    The provider wrapper

Interface KeyIdentityProvider

Field Summary

Method Summary

Field Detail

EMPTY_KEYS_PROVIDER

LOADER

Method Detail

loadKeys

providerOf

iteratorOf

iteratorOf

iteratorOf

resolveKeyIdentityProvider

multiProvider

multiProvider

iterableOf

wrap

wrap