org.apache.sshd.client.auth

Interface AuthenticationIdentitiesProvider

All Superinterfaces:

KeyIdentityProvider, PasswordIdentityProvider

public interface AuthenticationIdentitiesProvider
extends KeyIdentityProvider, PasswordIdentityProvider

Field Summary

Fields

Modifier and Type	Field and Description
static java.util.Comparator<java.lang.Object>	KEYPAIR_IDENTITY_COMPARATOR Compares 2 KeyPair identities - returns zero ONLY if both compared objects are KeyPairs and equal to each other
static java.util.Comparator<java.lang.Object>	PASSWORD_IDENTITY_COMPARATOR Compares 2 password identities - returns zero ONLY if both compared objects are Strings and equal to each other

Fields inherited from interface org.apache.sshd.common.keyprovider.KeyIdentityProvider

EMPTY_KEYS_PROVIDER

Fields inherited from interface org.apache.sshd.client.auth.password.PasswordIdentityProvider

EMPTY_PASSWORDS_PROVIDER

Method Summary

Modifier and Type	Method and Description
static int	findIdentityIndex(java.util.List<?> identities, java.util.Comparator<? super java.lang.Object> comp, java.lang.Object target)
java.lang.Iterable<?>	loadIdentities(SessionContext session)
static AuthenticationIdentitiesProvider	wrapIdentities(java.lang.Iterable<?> identities)

Methods inherited from interface org.apache.sshd.common.keyprovider.KeyIdentityProvider

exhaustCurrentIdentities, isEmpty, iterableOf, loadKeys, multiProvider, multiProvider, resolveKeyIdentityProvider, wrapKeyPairs, wrapKeyPairs

Methods inherited from interface org.apache.sshd.client.auth.password.PasswordIdentityProvider

iterableOf, iteratorOf, iteratorOf, loadPasswords, multiProvider, multiProvider, resolvePasswordIdentityProvider, wrapPasswords, wrapPasswords

Field Detail

PASSWORD_IDENTITY_COMPARATOR

static final java.util.Comparator<java.lang.Object> PASSWORD_IDENTITY_COMPARATOR

Compares 2 password identities - returns zero ONLY if both compared objects are Strings and equal to each other

KEYPAIR_IDENTITY_COMPARATOR

static final java.util.Comparator<java.lang.Object> KEYPAIR_IDENTITY_COMPARATOR

Compares 2 KeyPair identities - returns zero ONLY if both compared objects are KeyPairs and equal to each other

Method Detail

loadIdentities

java.lang.Iterable<?> loadIdentities(SessionContext session)
                              throws java.io.IOException,
                                     java.security.GeneralSecurityException

Parameters:

session - The SessionContext for invoking this load command - may be null if not invoked within a session context (e.g., offline tool).

Returns:

All the currently available identities - passwords, keys, etc...

Throws:

java.io.IOException - If failed to load the identities

java.security.GeneralSecurityException - If some security issue with the identities (e.g., keys)

findIdentityIndex

static int findIdentityIndex(java.util.List<?> identities,
                             java.util.Comparator<? super java.lang.Object> comp,
                             java.lang.Object target)

wrapIdentities

static AuthenticationIdentitiesProvider wrapIdentities(java.lang.Iterable<?> identities)

Parameters:

identities - The Iterable identities - OK if null/empty

Returns:

An AuthenticationIdentitiesProvider wrapping the identities