Interface HostKeyRepository

public interface HostKeyRepository

Field Summary

Fields

Modifier and Type	Field	Description
static final int	CHANGED
static final int	NOT_INCLUDED
static final int	OK

Method Summary

Modifier and Type	Method	Description
void	add(HostKey hostkey, UserInfo ui)	Adds a host key hostkey
int	check(String host, byte[] key)	Checks if host is included with the key.
HostKey[]	getHostKey()	Retuns a list for host keys managed in this repository.
HostKey[]	getHostKey(String host, String type)	Retuns a list for host keys managed in this repository.
String	getKnownHostsRepositoryID()	Returns id of this repository.
void	remove(String host, String type)	Removes host keys matching host and type.
void	remove(String host, String type, byte[] key)	Removes host keys matching host, type and key.

Field Details

OK

static final int OK

See Also:

• Constant Field Values

NOT_INCLUDED

static final int NOT_INCLUDED

See Also:

• Constant Field Values

CHANGED

static final int CHANGED

See Also:

• Constant Field Values

Method Details

check

int check(String host,
 byte[] key)

Checks if host is included with the key.

Returns:

#NOT_INCLUDED, #OK or #CHANGED

See Also:

• NOT_INCLUDED
• OK
• CHANGED

add

void add(HostKey hostkey,
 UserInfo ui)

Adds a host key hostkey

Parameters:

hostkey - a host key to be added

ui - a user interface for showing messages or promping inputs.

See Also:

• UserInfo

remove

void remove(String host,
 String type)

Removes host keys matching host and type.

When both arguments are non-null, entries with a non-empty marker are preserved. A null host clears the repository, while a null type removes all keys matching host, including marked entries.

See Also:

• remove(String host, String type, byte[] key)

remove

void remove(String host,
 String type,
 byte[] key)

Removes host keys matching host, type and key.

When host and type are non-null and key is null, entries with a non-empty marker are preserved. A non-null matching key also removes marked entries. A null host clears the repository, while a null type removes all keys matching host, including marked entries.

getKnownHostsRepositoryID

String getKnownHostsRepositoryID()

Returns id of this repository.

Returns:

identity in String

getHostKey

HostKey[] getHostKey()

Retuns a list for host keys managed in this repository.

See Also:

• getHostKey(String host, String type)

getHostKey

HostKey[] getHostKey(String host,
 String type)

Retuns a list for host keys managed in this repository.

Parameters:

host - a hostname used in searching host keys. If null is given, every host key will be listed.

type - a key type used in searching host keys, and it should be "ssh-dss" or "ssh-rsa". If null is given, a key type type will not be ignored.