Interface SshConfigStore

All Known Implementing Classes:

OpenSshConfigFile

public interface SshConfigStore

An abstraction for a SSH config storage, like the OpenSSH ~/.ssh/config file.

Since:

5.8

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	SshConfigStore.HostConfig	A host entry from the ssh config.

Field Summary

Fields

Modifier and Type	Field	Description
static final SshConfigStore.HostConfig	EMPTY_CONFIG	An empty SshConfigStore.HostConfig.

Method Summary

Modifier and Type	Method	Description
SshConfigStore.HostConfig	lookup(String hostName, int port, String userName)	Locate the configuration for a specific host request.

Field Details

EMPTY_CONFIG

static final SshConfigStore.HostConfig EMPTY_CONFIG

An empty SshConfigStore.HostConfig.

Method Details

lookup

@NonNull
SshConfigStore.HostConfig lookup(@NonNull
 String hostName,
 int port,
 String userName)

Locate the configuration for a specific host request.

Parameters:

hostName - to look up

port - the user supplied; invalid input: '<'= 0 if none

userName - the user supplied, may be null or empty if none given

Returns:

the configuration for the requested name.