com.palantir.giraffe.ssh

Class SshHostAccessor

java.lang.Object

com.palantir.giraffe.ssh.SshHostAccessor

All Implemented Interfaces:

com.palantir.giraffe.host.AuthenticatedHostAccessor<SshCredential>, com.palantir.giraffe.host.HostAccessor

public final class SshHostAccessor
extends Object
implements com.palantir.giraffe.host.AuthenticatedHostAccessor<SshCredential>

Provides access to a file system and execution system on a host using SSH.

Method Summary

Modifier and Type	Method and Description
static SshHostAccessor	forCredential(com.palantir.giraffe.host.Host host, int port, SshCredential credential) Returns a new SshHostAccessor that authenticates using the given SshCredential on the given port.
static SshHostAccessor	forCredential(com.palantir.giraffe.host.Host host, SshCredential credential) Returns a new SshHostAccessor that authenticates using the given SshCredential.
static SshHostAccessor	forKerberos(String hostname, String username) Returns a new SshHostAccessor that authenticates as the given user using the system Kerberos configuration.
static SshHostAccessor	forKey(String hostname, String username, Path keyFile) Returns a new SshHostAccessor that authenticates using the given private key.
static SshHostAccessor	forKey(String hostname, String username, String privateKey) Returns a new SshHostAccessor that authenticates using the given private key.
static SshHostAccessor	forPassword(String hostname, String username, char[] password) Returns a new SshHostAccessor that authenticates using the given password.
static SshHostAccessor	forPassword(String hostname, String username, String password) Returns a new SshHostAccessor that authenticates using the given password.
com.palantir.giraffe.host.Host	getHost()
com.palantir.giraffe.host.HostControlSystem	open()
SshSystemRequest	request()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

forPassword

public static SshHostAccessor forPassword(String hostname,
                                          String username,
                                          String password)

Returns a new SshHostAccessor that authenticates using the given password.

Parameters:

hostname - the name of the host to access

username - the user to authenticate as

password - the user's password

forPassword

public static SshHostAccessor forPassword(String hostname,
                                          String username,
                                          char[] password)

Returns a new SshHostAccessor that authenticates using the given password.

Parameters:

hostname - the name of the host to access

username - the user to authenticate as

password - the user's password

forKey

public static SshHostAccessor forKey(String hostname,
                                     String username,
                                     Path keyFile)
                              throws IOException

Returns a new SshHostAccessor that authenticates using the given private key.

Parameters:

hostname - the name of the host to access

username - the user to authenticate as

keyFile - the private key file; the matching public key must be present on the server

Throws:

IOException

forKey

public static SshHostAccessor forKey(String hostname,
                                     String username,
                                     String privateKey)

Returns a new SshHostAccessor that authenticates using the given private key.

Parameters:

hostname - the name of the host to access

username - the user to authenticate as

privateKey - the private key; the matching public key must be present on the server

forKerberos

public static SshHostAccessor forKerberos(String hostname,
                                          String username)

Returns a new SshHostAccessor that authenticates as the given user using the system Kerberos configuration.

Parameters:

hostname - the name of the host to access

username - the user to authenticate as

forCredential

public static SshHostAccessor forCredential(com.palantir.giraffe.host.Host host,
                                            SshCredential credential)

Returns a new SshHostAccessor that authenticates using the given SshCredential.

Parameters:

host - the host to access

credential - the credential to use for authentication

forCredential

public static SshHostAccessor forCredential(com.palantir.giraffe.host.Host host,
                                            int port,
                                            SshCredential credential)

Returns a new SshHostAccessor that authenticates using the given SshCredential on the given port.

Parameters:

host - the host to access

port - the port that SSH is listening on

credential - the credential to use for authentication

getHost

public com.palantir.giraffe.host.Host getHost()

Specified by:

getHost in interface com.palantir.giraffe.host.HostAccessor

request

public SshSystemRequest request()

Specified by:

request in interface com.palantir.giraffe.host.AuthenticatedHostAccessor<SshCredential>

Specified by:

request in interface com.palantir.giraffe.host.HostAccessor

open

public com.palantir.giraffe.host.HostControlSystem open()
                                                 throws IOException

Specified by:

open in interface com.palantir.giraffe.host.HostAccessor

Throws:

IOException