org.apache.sshd.client.config.keys

Interface ClientIdentityLoader

public interface ClientIdentityLoader

Author:

Apache MINA SSHD Project

Field Summary

Fields

Modifier and Type	Field and Description
static ClientIdentityLoader	DEFAULT A default implementation that assumes a file location that must exist.

Method Summary

Modifier and Type	Method and Description
static KeyIdentityProvider	asKeyIdentityProvider(ClientIdentityLoader loader, Collection<? extends NamedResource> locations, FilePasswordProvider passwordProvider, boolean ignoreNonExisting) Uses the provided ClientIdentityLoader to lazy load the keys locations
boolean	isValidLocation(NamedResource location)
Iterable<KeyPair>	loadClientIdentities(SessionContext session, NamedResource location, FilePasswordProvider provider)

Field Detail

DEFAULT

static final ClientIdentityLoader DEFAULT

A default implementation that assumes a file location that must exist.

Note: It calls SecurityUtils.loadKeyPairIdentities(SessionContext, NamedResource, InputStream, FilePasswordProvider)

Method Detail

isValidLocation

boolean isValidLocation(NamedResource location)
                 throws IOException

Parameters:

location - The identity key-pair location - the actual meaning (file, URL, etc.) depends on the implementation.

Returns:

true if it represents a valid location - the actual meaning of the validity depends on the implementation

Throws:

IOException - If failed to validate the location

loadClientIdentities

Iterable<KeyPair> loadClientIdentities(SessionContext session,
                                       NamedResource location,
                                       FilePasswordProvider provider)
                                throws IOException,
                                       GeneralSecurityException

Parameters:

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

location - The identity key-pair location - the actual meaning (file, URL, etc.) depends on the implementation.

provider - The FilePasswordProvider to consult if the location contains an encrypted identity

Returns:

The loaded KeyPair - null if location is empty and it is OK that it does not exist

Throws:

IOException - If failed to access / process the remote location

GeneralSecurityException - If failed to convert the contents into a valid identity

asKeyIdentityProvider

static KeyIdentityProvider asKeyIdentityProvider(ClientIdentityLoader loader,
                                                 Collection<? extends NamedResource> locations,
                                                 FilePasswordProvider passwordProvider,
                                                 boolean ignoreNonExisting)

Uses the provided ClientIdentityLoader to lazy load the keys locations

Parameters:

loader - The loader instance to use

locations - The locations to load - ignored if null/empty

passwordProvider - The FilePasswordProvider to use if any encrypted keys found

ignoreNonExisting - Whether to ignore non existing locations as indicated by isValidLocation(NamedResource)

Returns:

The KeyIdentityProvider wrapper