Package org.apache.sshd.common.keyprovider

Interface KeyIdentityProvider

All Known Subinterfaces:

AuthenticationIdentitiesProvider, KeyPairProvider

All Known Implementing Classes:

AbstractGeneratorHostKeyProvider, AbstractKeyPairProvider, AbstractResourceKeyPairProvider, BouncyCastleGeneratorHostKeyProvider, BuiltinClientIdentitiesWatcher, ClassLoadableResourceKeyPairProvider, ClientIdentitiesWatcher, DefaultClientIdentitiesWatcher, FileKeyPairProvider, LazyClientKeyIdentityProvider, MappedKeyPairProvider, MultiKeyIdentityProvider, 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	Description
static KeyIdentityProvider	EMPTY_KEYS_PROVIDER	An "empty" implementation of KeyIdentityProvider that returns an empty group of key pairs

Method Summary

Modifier and Type	Method	Description
static KeyPair	exhaustCurrentIdentities(Iterator<? extends KeyPair> ids)	Attempts to find the first non-null KeyPair
static boolean	isEmpty(KeyIdentityProvider provider)
static Iterable<KeyPair>	iterableOf(SessionContext session, Collection<? extends KeyIdentityProvider> providers)	Wraps a group of KeyIdentityProvider into an Iterable of KeyPairs
Iterable<KeyPair>	loadKeys(SessionContext session)	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	resolveKeyIdentityProvider(KeyIdentityProvider identities, KeyIdentityProvider keys)	Creates a "unified" KeyIdentityProvider out of 2 possible ones as follows:
static KeyIdentityProvider	wrapKeyPairs(Iterable<KeyPair> pairs)	Wraps a group of KeyPairs into a KeyIdentityProvider
static KeyIdentityProvider	wrapKeyPairs(KeyPair... pairs)	Wraps a group of KeyPairs 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

Method Detail

loadKeys

Iterable<KeyPair> loadKeys(SessionContext session)
                    throws IOException,
                           GeneralSecurityException

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

Throws:

IOException - If failed to read/parse the keys data

GeneralSecurityException - If failed to generate the keys

isEmpty

static boolean isEmpty(KeyIdentityProvider provider)

Parameters:

provider - The KeyIdentityProvider instance to verify

Returns:

true if instance is null or the EMPTY_KEYS_PROVIDER

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/empty then use the non-null one.
• If both are the same instance then use the instance.
• 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

See Also:

MultiKeyIdentityProvider

iterableOf

static Iterable<KeyPair> iterableOf(SessionContext session,
                                    Collection<? extends KeyIdentityProvider> providers)

Wraps a group of KeyIdentityProvider into an Iterable of KeyPairs

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).

providers - The group of providers - ignored if null/empty (i.e., returns an empty iterable instance)

Returns:

The wrapping iterable

wrapKeyPairs

static KeyIdentityProvider wrapKeyPairs(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

wrapKeyPairs

static KeyIdentityProvider wrapKeyPairs(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

exhaustCurrentIdentities

static KeyPair exhaustCurrentIdentities(Iterator<? extends KeyPair> ids)

Attempts to find the first non-null KeyPair

Parameters:

ids - The Iterator - ignored if null or no next element available

Returns:

The first non-null key pair found in the iterator - null if all elements exhausted without such an entry