org.apache.sshd.client.auth.password

Interface PasswordIdentityProvider

All Known Subinterfaces:

AuthenticationIdentitiesProvider

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 PasswordIdentityProvider

Author:

Apache MINA SSHD Project

Field Summary

Fields

Modifier and Type	Field and Description
static PasswordIdentityProvider	EMPTY_PASSWORDS_PROVIDER An "empty" implementation of PasswordIdentityProvider that returns and empty group of passwords
static Function<PasswordIdentityProvider,Iterable<String>>	LOADER Invokes loadPasswords() and returns the result.

Method Summary

Modifier and Type	Method and Description
static Iterable<String>	iterableOf(Collection<? extends PasswordIdentityProvider> providers) Wraps a group of PasswordIdentityProvider into an Iterable of their combined passwords
static Iterator<String>	iteratorOf(ClientSession session) Creates a "unified" Iterator of passwords out of the registered passwords and the extra available ones as a single iterator of passwords
static Iterator<String>	iteratorOf(PasswordIdentityProvider provider) Resolves a non-null iterator of the available passwords
static Iterator<String>	iteratorOf(PasswordIdentityProvider identities, PasswordIdentityProvider passwords) Creates a "unified" Iterator of passwords out of 2 possible PasswordIdentityProvider
Iterable<String>	loadPasswords()
static PasswordIdentityProvider	multiProvider(Collection<? extends PasswordIdentityProvider> providers) Wraps a group of PasswordIdentityProvider into a single one
static PasswordIdentityProvider	multiProvider(PasswordIdentityProvider... providers) Wraps a group of PasswordIdentityProvider into a single one
static PasswordIdentityProvider	resolvePasswordIdentityProvider(PasswordIdentityProvider identities, PasswordIdentityProvider passwords) Creates a "unified" PasswordIdentityProvider out of 2 possible ones as follows: If both are null then return null.
static PasswordIdentityProvider	wrap(Iterable<String> passwords) Wraps a group of passwords into a PasswordIdentityProvider
static PasswordIdentityProvider	wrap(String... passwords) Wraps a group of passwords into a PasswordIdentityProvider

Field Detail

EMPTY_PASSWORDS_PROVIDER

static final PasswordIdentityProvider EMPTY_PASSWORDS_PROVIDER

An "empty" implementation of PasswordIdentityProvider that returns and empty group of passwords

LOADER

static final Function<PasswordIdentityProvider,Iterable<String>> LOADER

Invokes loadPasswords() and returns the result. Ignores null providers (i.e., returns an empty iterable instance)

Method Detail

loadPasswords

Iterable<String> loadPasswords()

Returns:

The currently available passwords - ignored if null

iteratorOf

static Iterator<String> iteratorOf(ClientSession session)

Creates a "unified" Iterator of passwords out of the registered passwords and the extra available ones as a single iterator of passwords

Parameters:

session - The ClientSession - ignored if null (i.e., empty iterator returned)

Returns:

The wrapping iterator

See Also:

ClientAuthenticationManager.getRegisteredIdentities(), ClientAuthenticationManager.getPasswordIdentityProvider()

iteratorOf

static Iterator<String> iteratorOf(PasswordIdentityProvider identities,
                                   PasswordIdentityProvider passwords)

Creates a "unified" Iterator of passwords out of 2 possible PasswordIdentityProvider

Parameters:

identities - The registered passwords

passwords - Extra available passwords

Returns:

The wrapping iterator

See Also:

resolvePasswordIdentityProvider(PasswordIdentityProvider, PasswordIdentityProvider)

iteratorOf

static Iterator<String> iteratorOf(PasswordIdentityProvider provider)

Resolves a non-null iterator of the available passwords

Parameters:

provider - The PasswordIdentityProvider - ignored if null (i.e., return an empty iterator)

Returns:

A non-null iterator - which may be empty if no provider or no passwords

resolvePasswordIdentityProvider

static PasswordIdentityProvider resolvePasswordIdentityProvider(PasswordIdentityProvider identities,
                                                                PasswordIdentityProvider passwords)

Creates a "unified" PasswordIdentityProvider 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 passwords

passwords - The extra available passwords

Returns:

The resolved provider

See Also:

multiProvider(PasswordIdentityProvider...)

multiProvider

static PasswordIdentityProvider multiProvider(PasswordIdentityProvider... providers)

Wraps a group of PasswordIdentityProvider into a single one

Parameters:

providers - The providers - ignored if null/empty (i.e., returns EMPTY_PASSWORDS_PROVIDER

Returns:

The wrapping provider

See Also:

multiProvider(Collection)

multiProvider

static PasswordIdentityProvider multiProvider(Collection<? extends PasswordIdentityProvider> providers)

Wraps a group of PasswordIdentityProvider into a single one

Parameters:

providers - The providers - ignored if null/empty (i.e., returns EMPTY_PASSWORDS_PROVIDER

Returns:

The wrapping provider

iterableOf

static Iterable<String> iterableOf(Collection<? extends PasswordIdentityProvider> providers)

Wraps a group of PasswordIdentityProvider into an Iterable of their combined passwords

Parameters:

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

Returns:

The wrapping iterable

wrap

static PasswordIdentityProvider wrap(String... passwords)

Wraps a group of passwords into a PasswordIdentityProvider

Parameters:

passwords - The passwords - ignored if null/empty (i.e., returns EMPTY_PASSWORDS_PROVIDER)

Returns:

The provider wrapper

wrap

static PasswordIdentityProvider wrap(Iterable<String> passwords)

Wraps a group of passwords into a PasswordIdentityProvider

Parameters:

passwords - The passwords Iterable - ignored if null (i.e., returns EMPTY_PASSWORDS_PROVIDER)

Returns:

The provider wrapper