Class SSHCredential

  • All Implemented Interfaces:
    Cloneable, Credential

    public class SSHCredential
    extends Object
    implements Credential
    A credential holding the location, key identity and passphrase (instance of Credential) of a Private key in an external file and/or the name of the file containing the known hosts
    Author:
    Ashley Abdel-Sayed
    • Field Detail

      • DEFAULT_SSH_DIRECTORY

        public static File DEFAULT_SSH_DIRECTORY
      • DEFAULT_PRIVATE_KEYS

        public static String[] DEFAULT_PRIVATE_KEYS
      • DEFAULT_KNOWN_HOSTS

        public static String DEFAULT_KNOWN_HOSTS
      • sshDirectory

        private final File sshDirectory
      • privateKeyIdentities

        private final String[] privateKeyIdentities
      • knownHostsFile

        private final String knownHostsFile
    • Constructor Detail

      • SSHCredential

        private SSHCredential​(File sshDirectory,
                              String[] privateKeyIdentities,
                              Credential passphrase,
                              String knownHostsFile)
        Parameters:
        sshDirectory - the ssh directory
        privateKeyIdentities - an array containing the name of the file(s) containing the private key
        passphrase - the passphrase used to decrypt the private key (if applicable)
        knownHostsFile - the name of the file containing the known hosts
    • Method Detail

      • getSshDirectory

        public File getSshDirectory()
        Get the SSH directory containing the private key file and known hosts file
        Returns:
        the SSH directory
      • getPrivateKeyIdentities

        public String[] getPrivateKeyIdentities()
        Get the list of private key file names
        Returns:
        the private key identities
      • getPassphrase

        public Credential getPassphrase()
        Get the passphrase used to decrypt the private key
        Returns:
        the passphrase
      • getKnownHostsFile

        public String getKnownHostsFile()
        Get the file containing the known SSH hosts
        Returns:
        the known hosts file name
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object