co.cask.cdap.runtime.spi.ssh

Interface SSHContext

public interface SSHContext

This context provides ssh keys and access to SSHSession for interacting with remote hosts.

Method Summary

Modifier and Type	Method and Description
default SSHSession	createSSHSession(SSHKeyPair keyPair, String host) Creates a SSHSession to the given host.
default SSHSession	createSSHSession(String host) Creates a SSHSession to the given host.
SSHSession	createSSHSession(String user, java.util.function.Supplier<byte[]> privateKeySupplier, String host, int port, Map<String,String> configs) Creates a SSHSession to the given host, on a specific port, and with extra sets of ssh configurations.
default SSHKeyPair	generate(String user) Generates a 2048 bits RSA secure key pair for SSH operations.
SSHKeyPair	generate(String user, int bits) Generates a RSA secure key pair for SSH operations.
Optional<SSHKeyPair>	getSSHKeyPair() Returns the SSHKeyPair that were set earlier via the setSSHKeyPair(SSHKeyPair) method during the Provisioner.createCluster(ProvisionerContext) time.
void	setSSHKeyPair(SSHKeyPair sshKeyPair) Sets the SSH key pair for the platform to communicate with the cluster in future.

Method Detail

generate

default SSHKeyPair generate(String user)
                     throws KeyException

Generates a 2048 bits RSA secure key pair for SSH operations.

Parameters:

user - the user name used for SSH.

Returns:

a SSHKeyPair

Throws:

KeyException - if failed to generate the key pair

generate

SSHKeyPair generate(String user,
                    int bits)
             throws KeyException

Generates a RSA secure key pair for SSH operations.

Parameters:

user - the user name used for SSH.

bits - number of bits in the RSA key. The longer it is, the more secure.

Returns:

a SSHKeyPair

Throws:

KeyException - if failed to generate the key pair

setSSHKeyPair

void setSSHKeyPair(SSHKeyPair sshKeyPair)

Sets the SSH key pair for the platform to communicate with the cluster in future. This method can only be called during the Provisioner.createCluster(ProvisionerContext) call.

Parameters:

sshKeyPair - the SSHKeyPair to use

getSSHKeyPair

Optional<SSHKeyPair> getSSHKeyPair()

Returns the SSHKeyPair that were set earlier via the setSSHKeyPair(SSHKeyPair) method during the Provisioner.createCluster(ProvisionerContext) time.

Returns:

an Optional of SSHKeyPair

createSSHSession

default SSHSession createSSHSession(String host)
                             throws IOException

Creates a SSHSession to the given host. It uses the SSHKeyPair set via the setSSHKeyPair(SSHKeyPair) method.

Parameters:

host - hostname to ssh to

Returns:

a new SSHSession

Throws:

IOException - if failed to create a new session to the host

createSSHSession

default SSHSession createSSHSession(SSHKeyPair keyPair,
                                    String host)
                             throws IOException

Creates a SSHSession to the given host.

Parameters:

host - hostname to ssh to

Returns:

a new SSHSession

Throws:

IOException - if failed to create a new session to the host

createSSHSession

SSHSession createSSHSession(String user,
                            java.util.function.Supplier<byte[]> privateKeySupplier,
                            String host,
                            int port,
                            Map<String,String> configs)
                     throws IOException

Creates a SSHSession to the given host, on a specific port, and with extra sets of ssh configurations.

Parameters:

user - user name for ssh

privateKeySupplier - a Supplier to private key used for ssh

host - hostname to ssh to

port - the port to connect to

configs - set of extra configurations

Returns:

a new SSHSession

Throws:

IOException - if failed to create a new session to the host