com.tailf.jnc

Class SSHConnection

java.lang.Object

com.tailf.jnc.SSHConnection

public class SSHConnection
extends java.lang.Object

A SSH NETCONF connection class. Can be used whenever NetconfSession intends to use SSH for its transport.

Example:

 SSHConnection ssh = new SSHConnection("127.0.0.1", 2023);
 ssh.authenticateWithPassword("ola", "secret");
 SSHSession tr = new SSHSession(ssh);
 NetconfSession dev1 = new NetconfSession(tr);
 

Constructor Summary

Constructors

Constructor and Description
SSHConnection(java.lang.String host) By default we connect to the IANA registered port for NETCONF which is 830
SSHConnection(java.lang.String host, int port) This method establishes an SSH connection to a host, once the connection is established it must be authenticated.
SSHConnection(java.lang.String host, int port, int connectTimeout) This method establishes an SSH connection to a host, once the connection is established it must be authenticated.
SSHConnection(java.lang.String host, int port, int connectTimeout, int kexTimeout) This method establishes an SSH connection to a host, once the connection is established it must be authenticated.

Method Summary

Modifier and Type	Method and Description
void	authenticateWithPassword(java.lang.String user, java.lang.String password) Authenticate with regular username pass.
void	authenticateWithPublicKey(java.lang.String user, char[] pemPrivateKey, java.lang.String pass) Authenticate with a private key.
void	authenticateWithPublicKeyFile(java.lang.String user, java.io.File pemFile, java.lang.String password) Authenticate with the name of a file containing the private key See ganymed docs for full explanation, use null for password if the key doesn't have a passphrase.
void	close() Closes the SSH session/connection.
Connection	getGanymedConnection() This is required if wish to have access to the ganymed connection object outside of this package.

Methods inherited from class java.lang.Object

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

Constructor Detail

SSHConnection

public SSHConnection(java.lang.String host)
              throws java.io.IOException,
                     JNCException

By default we connect to the IANA registered port for NETCONF which is 830

Parameters:

host - Host or IP address to connect to

Throws:

java.io.IOException

JNCException

SSHConnection

public SSHConnection(java.lang.String host,
                     int port)
              throws java.io.IOException,
                     JNCException

This method establishes an SSH connection to a host, once the connection is established it must be authenticated.

Parameters:

host - Host name.

port - Port number to connect to.

Throws:

java.io.IOException

JNCException

SSHConnection

public SSHConnection(java.lang.String host,
                     int port,
                     int connectTimeout)
              throws java.io.IOException,
                     JNCException

This method establishes an SSH connection to a host, once the connection is established it must be authenticated.

Parameters:

host - Host name.

port - Port number to connect to.

connectTimeout -

Throws:

java.io.IOException

JNCException

SSHConnection

public SSHConnection(java.lang.String host,
                     int port,
                     int connectTimeout,
                     int kexTimeout)
              throws java.io.IOException,
                     JNCException

This method establishes an SSH connection to a host, once the connection is established it must be authenticated.

Parameters:

host - Host name.

port - Port number to connect to.

connectTimeout - Connection timeout timer. Connect the underlying TCP socket to the server with the given timeout value (non-negative, in milliseconds). Zero means no timeout.

kexTimeout - Key exchange timeout timer. Timeout for complete connection establishment (non-negative, in milliseconds). Zero means no timeout. The timeout counts until the first key-exchange round has finished.

Throws:

java.io.IOException - In case of a timeout (either connectTimeout or kexTimeout) a SocketTimeoutException is thrown.

An exception may also be thrown if the connection was already successfully connected (no matter if the connection broke in the mean time) and you invoke connect() again without having called close() first.

JNCException

Method Detail

getGanymedConnection

public Connection getGanymedConnection()

This is required if wish to have access to the ganymed connection object outside of this package.

Returns:

the underlying Ganymed connection object

authenticateWithPassword

public void authenticateWithPassword(java.lang.String user,
                                     java.lang.String password)
                              throws java.io.IOException,
                                     JNCException

Authenticate with regular username pass.

Parameters:

user - User name.

password - Password.

Throws:

java.io.IOException

JNCException

authenticateWithPublicKeyFile

public void authenticateWithPublicKeyFile(java.lang.String user,
                                          java.io.File pemFile,
                                          java.lang.String password)
                                   throws java.io.IOException,
                                          JNCException

Authenticate with the name of a file containing the private key See ganymed docs for full explanation, use null for password if the key doesn't have a passphrase.

Parameters:

user - User name.

pemFile - Fila name.

password - Password.

Throws:

java.io.IOException

JNCException

authenticateWithPublicKey

public void authenticateWithPublicKey(java.lang.String user,
                                      char[] pemPrivateKey,
                                      java.lang.String pass)
                               throws java.io.IOException,
                                      JNCException

Authenticate with a private key. See ganymed docs for full explanation, use null for password if the key doesn't have a passphrase.

Parameters:

user - User name.

pemPrivateKey - Private key.

pass - Passphrase.

Throws:

java.io.IOException

JNCException

close

public void close()

Closes the SSH session/connection.