Module com.jcraft.jsch
Package com.jcraft.jsch

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 a host key if there exists mached key with host, type.
    void
    remove(String host, String type, byte[] key)
    Removes a host key if there exists a matched key with host, type and key.

  • Field Details

  • 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:

    • 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:

    • remove

      void remove(String host, String type)
      Removes a host key if there exists mached key with host, type.
      See Also:

    • remove

      void remove(String host, String type, byte[] key)
      Removes a host key if there exists a matched key with host, type and key.

    • 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

      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.