WARNING: This server provides a static reference view of the NetKernel documentation. Links to dynamic content do not work. For the best experience we recommend you install NetKernel and view the documentation in the live system .

Endpoint
Name:ethz.sshAuthenticatedConnection
Description:
Id:ethz.sshAuthenticatedConnection
Category:accessor
Identifier Syntax

ethz.sshAuthenticatedConnection is an accessor using Active URI syntax with the following base identifiers:

Base
active:sshAuthenticatedConnection

and the following arguments: (for more details on argument passing details see here)

ArgumentRulesTypingDescription
remote
Mandatory
Representation (java.lang.Object)ssh: URI of the remote server
credentials
Mandatory
Representation (java.lang.Object)The ssh credentials
Request Verbs

The following verb is supported:

Verb
SOURCE
Response

The following response representations can be returned for SOURCE requests:

SOURCE Representations
org.netkernel.client.ssh.rep.AuthenticatedSSHConnection

This accessor throws no documented exceptions.

Import Requirements

To use ethz.sshAuthenticatedConnection accessor you must import the module urn:org:netkernel:client:ssh:

<import>
  <uri>urn:org:netkernel:client:ssh</uri>
</import>

Warning: This component is for advanced use only

active:sshAuthenticatedConnection provides a means of obtaining direct API-level control of an authenticated SSH connection.

remote

The remote argument must be an ssh: URI including the hostname and path to the remote file. For example:

ssh://remote.server.com/path/path/the-file

credentials

The credentials argument are the ssh credentials required to connect to the remote host. See credentials section for details.

Response Representation

The response is an instance of org.netkernel.client.ssh.rep.AuthenticatedSSHConnection which has the following source...

public class AuthenticatedSSHConnection {
    
    Connection mConn;
    
    /** Creates a new instance of AdvancedAuthenticatedSSHConnection */
    public AuthenticatedSSHConnection(Connection aConn)
    {   mConn=aConn;
    }
    
    /*
     *Get the authenticated open ssh connection. This is an advanced resource - you are fully responsible for
     *managing the connection and ensuring it is safely closed.
     **/
    public Connection advancedGetConnection()
    {   return mConn;
    }
    
    protected void finalize()
    {   mConn.close();      
    }
}

calling advancedGetConnection() will give you direct access to the Ganymede SSH Connection object. Javadoc for the Connection is available here: http://www.cleondris.ch/opensource/ssh2/javadoc/ch/ethz/ssh2/Connection.html