Session (JSch API)

java.lang.Object
- com.jcraft.jsch.Session

All Implemented Interfaces:

Runnable
```
public class Session
extends Object
implements Runnable
```
A Session represents a connection to a SSH server. One session can contain multiple Channels of various types, created with openChannel(java.lang.String).
A session is opened with connect() and closed with disconnect().
The fact that a Session implements Runnable is an implementation detail.

Field Summary

Fields
Modifier and Type Field and Description

protected boolean daemon_thread

Fields
Modifier and Type	Field and Description
`protected boolean`	`daemon_thread`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`connect()` opens the connection, using the timeout set with `setTimeout(int)`.
`void`	`connect(int connectTimeout)` opens the connection, using the specified timeout.
`void`	`delPortForwardingL(int lport)` Cancels the local port forwarding assigned at local TCP port `lport` on loopback interface.
`void`	`delPortForwardingL(String bind_address, int lport)` Cancels the local port forwarding assigned at local TCP port `lport` on `bind_address` interface.
`void`	`delPortForwardingR(int rport)` Cancels the remote port forwarding assigned at remote TCP port `rport`.
`void`	`delPortForwardingR(String bind_address, int rport)` Cancels the remote port forwarding assigned at remote TCP port `rport` bound on the interface at `bind_address`.
`void`	`disconnect()` Closes the connection to the server.
`void`	`encode(Packet packet)` (not to be invoked from outside)
`String`	`getClientVersion()` returns the version string (to be) sent to the server.
`String`	`getConfig(String key)` Retrieves a configuration option of this session.
`String`	`getHost()` gets the host name to which we will connect (or are connected).
`HostKey`	`getHostKey()` retrieves the host key of the server.
`String`	`getHostKeyAlias()` retrieves the current server host key alias.
`HostKeyRepository`	`getHostKeyRepository()` Gets the hostkeyRepository.
`int`	`getPort()` returns the port at the remote host we will connect (or already connected) to.
`String[]`	`getPortForwardingL()` returns a snapshot of the current local port forwarding configurations.
`String[]`	`getPortForwardingR()` Lists the registered remote port forwarding.
`int`	`getServerAliveCountMax()` Returns setting for the threshold to send keep-alive messages.
`int`	`getServerAliveInterval()` Returns setting for the interval to send a keep-alive message.
`String`	`getServerVersion()` returns the version string sent by the server.
`Channel`	`getStreamForwarder(String host, int port)` Instantiates an instance of stream-forwarder to `host`:`port`.
`int`	`getTimeout()` retrieves the current timeout setting.
`UserInfo`	`getUserInfo()` returns the current value of the UserInfo object.
`String`	`getUserName()` returns the user name used for login (and set when creating the session).
`boolean`	`isConnected()` retrieves the current connection status.
`void`	`noMoreSessionChannels()`
`Channel`	`openChannel(String type)` Opens a new channel of some type over this connection.
`Buffer`	`read(Buffer buf)` reads some bytes - not to be used from outside.
`void`	`rekey()` initiates a new key exchange.
`void`	`run()` Not to be called from outside.
`void`	`sendIgnore()` sends an ignored package.
`void`	`sendKeepAliveMsg()` Sends a keep-alive message.
`void`	`setClientVersion(String cv)` changes the version string to be sent to the server.
`void`	`setConfig(Hashtable newconf)` sets several configuration options at once.
`void`	`setConfig(Properties newconf)` sets several configuration options at once.
`void`	`setConfig(String key, String value)` sets a single configuration option for this session.
`void`	`setDaemonThread(boolean enable)` Sets the deamon thread property.
`void`	`setHost(String host)` Sets the host to connect to.
`void`	`setHostKeyAlias(String hostKeyAlias)` sets the host key alias used when comparing the host key to the known hosts list.
`void`	`setHostKeyRepository(HostKeyRepository hostkeyRepository)` Sets the hostkeyRepository, which will be referred in checking host keys.
`void`	`setIdentityRepository(IdentityRepository identityRepository)` Sets the identityRepository, which will be referred in the public key authentication.
`void`	`setInputStream(InputStream in)` (I have no idea what this is for.
`void`	`setOutputStream(OutputStream out)` (I have no idea what this is for.
`void`	`setPassword(byte[] password)` sets the password to use for authentication.
`void`	`setPassword(String password)` sets the password to use for authentication.
`void`	`setPort(int port)` Sets the port on the server to connect to.
`int`	`setPortForwardingL(int lport, String host, int rport)` Registers the local port forwarding for loop-back interface.
`int`	`setPortForwardingL(String conf)` Registers the local port forwarding.
`int`	`setPortForwardingL(String bind_address, int lport, String host, int rport)` Registers the local port forwarding.
`int`	`setPortForwardingL(String bind_address, int lport, String host, int rport, ServerSocketFactory ssf)` Registers the local port forwarding.
`int`	`setPortForwardingL(String bind_address, int lport, String host, int rport, ServerSocketFactory ssf, int connectTimeout)` Registers the local port forwarding.
`void`	`setPortForwardingR(int rport, String daemon)` Registers the remote port forwarding for the loopback interface of the remote.
`void`	`setPortForwardingR(int rport, String host, int lport)` Registers the remote port forwarding for the loopback interface of the remote.
`void`	`setPortForwardingR(int rport, String host, int lport, SocketFactory sf)` Registers the remote port forwarding for the loopback interface of the remote.
`void`	`setPortForwardingR(int rport, String daemon, Object[] arg)` Registers the remote port forwarding for the loopback interface of the remote.
`int`	`setPortForwardingR(String conf)` Registers the remote port forwarding.
`void`	`setPortForwardingR(String bind_address, int rport, String host, int lport)` Registers the remote port forwarding.
`void`	`setPortForwardingR(String bind_address, int rport, String host, int lport, SocketFactory sf)` Registers the remote port forwarding.
`void`	`setPortForwardingR(String bind_address, int rport, String daemon, Object[] arg)` Registers the remote port forwarding.
`void`	`setProxy(Proxy proxy)` Sets the proxy property.
`void`	`setServerAliveCountMax(int count)` Sets the number of keep-alive messages which may be sent without receiving any messages back from the server.
`void`	`setServerAliveInterval(int interval)` sets the server alive interval property.
`void`	`setSocketFactory(SocketFactory sfactory)` sets the socket factory.
`void`	`setTimeout(int timeout)` sets the timeout setting.
`void`	`setUserInfo(UserInfo userinfo)` Sets the userInfo property.
`void`	`setX11Cookie(String cookie)` sets the X11 cookie necessary to access the local X11 server.
`void`	`setX11Host(String host)` sets the host (on the local side) where the X11 server (whose display we want to forward) can be found.
`void`	`setX11Port(int port)` sets the port (on the local side) where the X11 server (whose display we want to forward) can be found.
`void`	`write(Packet packet)` Not to be used from outside - Writes a packet.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - daemon_thread
```
protected boolean daemon_thread
```
- Method Detail
  - connect
```
public void connect()
             throws JSchException
```
    opens the connection, using the timeout set with setTimeout(int).
    
    Throws:
    
    JSchException - if this session is already connected.
    
    See Also:
    
    connect(int)
  - connect
```
public void connect(int connectTimeout)
             throws JSchException
```
    opens the connection, using the specified timeout.
    
    Throws:
    
    JSchException - if this session is already connected, or some other error occurs during connecting. (If there was some other exception, it is appended as the cause to the JSchException thrown.)
  - rekey
```
public void rekey()
           throws Exception
```
    initiates a new key exchange. This is necessary for some changes on the configuration to become active, like compression or encryption mode.
    
    Throws:
    
    Exception
  - openChannel
```
public Channel openChannel(String type)
                    throws JSchException
```
    Opens a new channel of some type over this connection.
    Parameters:
    type - a string identifying the channel type. For now, the available types are these:
    
    shell - ChannelShell
    exec - ChannelExec
    direct-tcpip - ChannelDirectTCPIP
    sftp - ChannelSftp
    subsystem - ChannelSubsystem
    This method then returns a channel object of the linked Channel subclass. Some more type names are only for internal (or "from the server side") use:
    
    forwarded-tcpip - ChannelForwardedTCPIP
    session
    x11
    auth-agent@openssh.com
    Returns:
    
    a fresh channel of the right type, already initialized, but not yet connected.
    
    Throws:
    
    JSchException
  - encode
```
public void encode(Packet packet)
            throws Exception
```
    (not to be invoked from outside)
    
    Throws:
    
    Exception
  - read
```
public Buffer read(Buffer buf)
            throws Exception
```
    reads some bytes - not to be used from outside.
    
    Throws:
    
    Exception
  - write
```
public void write(Packet packet)
           throws Exception
```
    Not to be used from outside - Writes a packet.
    
    Throws:
    
    Exception
  - run
```
public void run()
```
    Not to be called from outside. The main data receiving loop.
    
    Specified by:
    
    run in interface Runnable
  - disconnect
```
public void disconnect()
```
    Closes the connection to the server. If this session is not connected, this method is a no-op.
  - setPortForwardingL
```
public int setPortForwardingL(int lport,
                              String host,
                              int rport)
                       throws JSchException
```
    Registers the local port forwarding for loop-back interface. If lport is 0, the tcp port will be allocated.
    
    Parameters:
    
    lport - local port for local port forwarding
    
    host - host address for local port forwarding
    
    rport - remote port number for local port forwarding
    
    Returns:
    
    an allocated local TCP port number
    
    Throws:
    
    JSchException
    
    See Also:
    
    setPortForwardingL(String bind_address, int lport, String host, int rport, ServerSocketFactory ssf, int connectTimeout)
  - setPortForwardingL
```
public int setPortForwardingL(String bind_address,
                              int lport,
                              String host,
                              int rport)
                       throws JSchException
```
    Registers the local port forwarding. If bind_address is an empty string or '*', the port should be available from all interfaces. If bind_address is "localhost" or null, the listening port will be bound for local use only. If lport is 0, the tcp port will be allocated.
    
    Parameters:
    
    bind_address - bind address for local port forwarding
    
    lport - local port for local port forwarding
    
    host - host address for local port forwarding
    
    rport - remote port number for local port forwarding
    
    Returns:
    
    an allocated local TCP port number
    
    Throws:
    
    JSchException
    
    See Also:
    
    setPortForwardingL(String bind_address, int lport, String host, int rport, ServerSocketFactory ssf, int connectTimeout)
  - setPortForwardingL
```
public int setPortForwardingL(String bind_address,
                              int lport,
                              String host,
                              int rport,
                              ServerSocketFactory ssf)
                       throws JSchException
```
    Registers the local port forwarding. If bind_address is an empty string or "*", the port should be available from all interfaces. If bind_address is "localhost" or null, the listening port will be bound for local use only. If lport is 0, the tcp port will be allocated.
    
    Parameters:
    
    bind_address - bind address for local port forwarding
    
    lport - local port for local port forwarding
    
    host - host address for local port forwarding
    
    rport - remote port number for local port forwarding
    
    ssf - socket factory
    
    Returns:
    
    an allocated local TCP port number
    
    Throws:
    
    JSchException
    
    See Also:
    
    setPortForwardingL(String bind_address, int lport, String host, int rport, ServerSocketFactory ssf, int connectTimeout)
  - setPortForwardingL
```
public int setPortForwardingL(String bind_address,
                              int lport,
                              String host,
                              int rport,
                              ServerSocketFactory ssf,
                              int connectTimeout)
                       throws JSchException
```
    Registers the local port forwarding. If bind_address is an empty string or "*", the port should be available from all interfaces. If bind_address is "localhost" or null, the listening port will be bound for local use only. If lport is 0, the tcp port will be allocated.
    
    Parameters:
    
    bind_address - bind address for local port forwarding
    
    lport - local port for local port forwarding
    
    host - host address for local port forwarding
    
    rport - remote port number for local port forwarding
    
    ssf - socket factory
    
    connectTimeout - timeout for establishing port connection
    
    Returns:
    
    an allocated local TCP port number
    
    Throws:
    
    JSchException
  - delPortForwardingL
```
public void delPortForwardingL(int lport)
                        throws JSchException
```
    Cancels the local port forwarding assigned at local TCP port lport on loopback interface.
    
    Parameters:
    
    lport - local TCP port
    
    Throws:
    
    JSchException
  - delPortForwardingL
```
public void delPortForwardingL(String bind_address,
                               int lport)
                        throws JSchException
```
    Cancels the local port forwarding assigned at local TCP port lport on bind_address interface.
    
    Parameters:
    
    bind_address - bind_address of network interfaces
    
    lport - local TCP port
    
    Throws:
    
    JSchException
  - getPortForwardingL
```
public String[] getPortForwardingL()
                            throws JSchException
```
    returns a snapshot of the current local port forwarding configurations. This is mainly useful for debug purposes.
    Returns:
    an array of strings, each describing one forwarding. Each string is of the form
    localport:remotehost:remoteport
    with the numbers in decimal representation.
    Throws:
    
    JSchException
  - setPortForwardingR
```
public void setPortForwardingR(int rport,
                               String host,
                               int lport)
                        throws JSchException
```
    Registers the remote port forwarding for the loopback interface of the remote.
    
    Parameters:
    
    rport - remote port
    
    host - host address
    
    lport - local port
    
    Throws:
    
    JSchException
    
    See Also:
    
    setPortForwardingR(String bind_address, int rport, String host, int lport, SocketFactory sf)
  - setPortForwardingR
```
public void setPortForwardingR(String bind_address,
                               int rport,
                               String host,
                               int lport)
                        throws JSchException
```
    Registers the remote port forwarding. If bind_address is an empty string or "*", the port should be available from all interfaces. If bind_address is "localhost" or is not given, the listening port will be bound for local use only. Note that if GatewayPorts is "no" on the remote, "localhost" is always used as a bind_address.
    
    Parameters:
    
    bind_address - bind address
    
    rport - remote port
    
    host - host address
    
    lport - local port
    
    Throws:
    
    JSchException
    
    See Also:
    
    setPortForwardingR(String bind_address, int rport, String host, int lport, SocketFactory sf)
  - setPortForwardingR
```
public void setPortForwardingR(int rport,
                               String host,
                               int lport,
                               SocketFactory sf)
                        throws JSchException
```
    Registers the remote port forwarding for the loopback interface of the remote.
    
    Parameters:
    
    rport - remote port
    
    host - host address
    
    lport - local port
    
    sf - socket factory
    
    Throws:
    
    JSchException
    
    See Also:
    
    setPortForwardingR(String bind_address, int rport, String host, int lport, SocketFactory sf)
  - setPortForwardingR
```
public void setPortForwardingR(String bind_address,
                               int rport,
                               String host,
                               int lport,
                               SocketFactory sf)
                        throws JSchException
```
    Registers the remote port forwarding. If bind_address is an empty string or "*", the port should be available from all interfaces. If bind_address is "localhost" or is not given, the listening port will be bound for local use only. Note that if GatewayPorts is "no" on the remote, "localhost" is always used as a bind_address. If rport is 0, the TCP port will be allocated on the remote.
    
    Parameters:
    
    bind_address - bind address
    
    rport - remote port
    
    host - host address
    
    lport - local port
    
    sf - socket factory
    
    Throws:
    
    JSchException
  - setPortForwardingR
```
public void setPortForwardingR(int rport,
                               String daemon)
                        throws JSchException
```
    Registers the remote port forwarding for the loopback interface of the remote. The TCP connection to rport on the remote will be forwarded to an instance of the class daemon. The class specified by daemon must implement ForwardedTCPIPDaemon.
    
    Parameters:
    
    rport - remote port
    
    daemon - class name, which implements "ForwardedTCPIPDaemon"
    
    Throws:
    
    JSchException
    
    See Also:
    
    setPortForwardingR(String bind_address, int rport, String daemon, Object[] arg)
  - setPortForwardingR
```
public void setPortForwardingR(int rport,
                               String daemon,
                               Object[] arg)
                        throws JSchException
```
    Registers the remote port forwarding for the loopback interface of the remote. The TCP connection to rport on the remote will be forwarded to an instance of the class daemon with the argument arg. The class specified by daemon must implement ForwardedTCPIPDaemon.
    
    Parameters:
    
    rport - remote port
    
    daemon - class name, which implements "ForwardedTCPIPDaemon"
    
    arg - arguments for "daemon"
    
    Throws:
    
    JSchException
    
    See Also:
    
    setPortForwardingR(String bind_address, int rport, String daemon, Object[] arg)
  - setPortForwardingR
```
public void setPortForwardingR(String bind_address,
                               int rport,
                               String daemon,
                               Object[] arg)
                        throws JSchException
```
    Registers the remote port forwarding. If bind_address is an empty string or "*", the port should be available from all interfaces. If bind_address is "localhost" or is not given, the listening port will be bound for local use only. Note that if GatewayPorts is "no" on the remote, "localhost" is always used as a bind_address. The TCP connection to rport on the remote will be forwarded to an instance of the class daemon with the argument arg. The class specified by daemon must implement ForwardedTCPIPDaemon.
    
    Parameters:
    
    bind_address - bind address
    
    rport - remote port
    
    daemon - class name, which implements "ForwardedTCPIPDaemon"
    
    arg - arguments for "daemon"
    
    Throws:
    
    JSchException
    
    See Also:
    
    setPortForwardingR(String bind_address, int rport, String daemon, Object[] arg)
  - getPortForwardingR
```
public String[] getPortForwardingR()
                            throws JSchException
```
    Lists the registered remote port forwarding.
    
    Returns:
    
    a list of "rport:host:hostport"
    
    Throws:
    
    JSchException
  - setPortForwardingL
```
public int setPortForwardingL(String conf)
                       throws JSchException
```
    Registers the local port forwarding. The argument should be in the format like "[bind_address:]port:host:hostport". If bind_address is an empty string or "*", the port should be available from all interfaces. If bind_address is "localhost" or is not given, the listening port will be bound for local use only.
    
    Parameters:
    
    conf - configuration of local port forwarding
    
    Returns:
    
    an assigned port number
    
    Throws:
    
    JSchException
    
    See Also:
    
    setPortForwardingL(String bind_address, int lport, String host, int rport)
  - setPortForwardingR
```
public int setPortForwardingR(String conf)
                       throws JSchException
```
    Registers the remote port forwarding. The argument should be in the format like "[bind_address:]port:host:hostport". If the bind_address is not given, the default is to only bind to loopback addresses. If the bind_address is "*" or an empty string, then the forwarding is requested to listen on all interfaces. Note that if GatewayPorts is "no" on the remote, "localhost" is always used for bind_address. If the specified remote is "0", the TCP port will be allocated on the remote.
    
    Parameters:
    
    conf - configuration of remote port forwarding
    
    Returns:
    
    an allocated TCP port on the remote.
    
    Throws:
    
    JSchException
    
    See Also:
    
    setPortForwardingR(String bind_address, int rport, String host, int rport)
  - getStreamForwarder
```
public Channel getStreamForwarder(String host,
                                  int port)
                           throws JSchException
```
    Instantiates an instance of stream-forwarder to host:port. Set I/O stream to the given channel, and then invoke Channel#connect() method.
    
    Parameters:
    
    host - remote host, which the given stream will be plugged to.
    
    port - remote port, which the given stream will be plugged to.
    
    Throws:
    
    JSchException
  - delPortForwardingR
```
public void delPortForwardingR(int rport)
                        throws JSchException
```
    Cancels the remote port forwarding assigned at remote TCP port rport.
    
    Parameters:
    
    rport - remote TCP port
    
    Throws:
    
    JSchException
  - delPortForwardingR
```
public void delPortForwardingR(String bind_address,
                               int rport)
                        throws JSchException
```
    Cancels the remote port forwarding assigned at remote TCP port rport bound on the interface at bind_address.
    
    Parameters:
    
    bind_address - bind address of the interface on the remote
    
    rport - remote TCP port
    
    Throws:
    
    JSchException
  - setProxy
```
public void setProxy(Proxy proxy)
```
    Sets the proxy property. This should be done before connecting. If the proxy is not null, then we use the proxy object to create the connection to the remote host. Otherwise we use the SocketFactory or create plain TCP Sockets.
  - setHost
```
public void setHost(String host)
```
    Sets the host to connect to. This is normally called by JSch.getSession(java.lang.String), so there is no need to call it, if you don't want to change this host. This should be called before connect().
  - setPort
```
public void setPort(int port)
```
    Sets the port on the server to connect to. This is normally called by JSch.getSession(java.lang.String), so there is no need to call it, if you don't want to change the port. This should be called before connect().
  - setUserInfo
```
public void setUserInfo(UserInfo userinfo)
```
    Sets the userInfo property. If this is not null, the UserInfo object is used for feedback to the user and to query information from the user. Most important here is the password query.
  - getUserInfo
```
public UserInfo getUserInfo()
```
    returns the current value of the UserInfo object. (This is used internally.)
  - setInputStream
```
public void setInputStream(InputStream in)
```
    (I have no idea what this is for. The variable set here seems to be unused.)
  - setOutputStream
```
public void setOutputStream(OutputStream out)
```
    (I have no idea what this is for. The variable set here seems to be unused.)
  - setX11Host
```
public void setX11Host(String host)
```
    sets the host (on the local side) where the X11 server (whose display we want to forward) can be found.
    The default value is "127.0.0.1", this is localhost.
    Attention: This is effectively a static property, shared by all X11-channels, Sessions and even JSch objects. Forwarding different X11 displays at the same time (from the same Java VM) is not supported.
    
    See Also:
    
    setX11Port(int), setX11Cookie(java.lang.String)
  - setX11Port
```
public void setX11Port(int port)
```
    sets the port (on the local side) where the X11 server (whose display we want to forward) can be found.
    The default value is 6000, the default port for a X11 server on display 0.
    Attention: This is effectively a static property, shared by all X11-channels, Sessions and even JSch objects. Forwarding different X11 displays at the same time (from the same Java VM) is not supported.
    
    See Also:
    
    setX11Host(java.lang.String), setX11Cookie(java.lang.String)
  - setX11Cookie
```
public void setX11Cookie(String cookie)
```
    sets the X11 cookie necessary to access the local X11 server.
    This implementation assumes the MIT-MAGIC_COOKIE-1 authentication protocol.
    Attention: This is effectively a static property, shared by all X11-channels, Sessions and even JSch objects. Forwarding different X11 displays at the same time (from the same Java VM) is not supported.
    
    Parameters:
    
    cookie - the cookie in hexadecimal encoding, should be string of length 32.
    
    See Also:
    
    setX11Host(java.lang.String), setX11Port(int)
  - setPassword
```
public void setPassword(String password)
```
    sets the password to use for authentication.
    
    Parameters:
    
    password - the new password. (We will use the UTF-8 encoding of this string as the actual password sent to the server.)
    
    See Also:
    
    setPassword(byte[])
  - setPassword
```
public void setPassword(byte[] password)
```
    sets the password to use for authentication. This will be used for the authentication methods
    - password, if it is not null
    - keyboard-interactive if it is not null, the prompt starts with "password:" and no UserInfo is given.
    Parameters:
    
    password - the new password.
  - setConfig
```
public void setConfig(Properties newconf)
```
    sets several configuration options at once.
    
    Parameters:
    
    newconf - a properties object, which should contain only String keys and values. All the current keys/value pairs are copied to our current configuration.
    
    See Also:
    
    setConfig(String, String)
  - setConfig
```
public void setConfig(Hashtable newconf)
```
    sets several configuration options at once.
    
    Parameters:
    
    newconf - a hash table, which should contain only String keys and values. All the current keys/value pairs are copied to our current configuration.
    
    See Also:
    
    setConfig(String, String)
  - setConfig
```
public void setConfig(String key,
                      String value)
```
    sets a single configuration option for this session.
    
    Parameters:
    
    key - the configuration key
    
    value - the configuration value.
  - getConfig
```
public String getConfig(String key)
```
    Retrieves a configuration option of this session. This is also used internally. If some option is not set for the session, this method returns the default value set at JSch.setConfig(java.util.Hashtable).
    
    Parameters:
    
    key - the key for the configuration option
    
    Returns:
    
    the value corresponding to the key.
  - setSocketFactory
```
public void setSocketFactory(SocketFactory sfactory)
```
    sets the socket factory. If this is not null, this socket factory is used to create a socket to the target host, and also create the streams of this socket used by us. (If we are using a proxy, the socket factory is passed to the proxy). If the socket factory is null, we use plain TCP sockets.
  - isConnected
```
public boolean isConnected()
```
    retrieves the current connection status. (This is used internally.)
    
    Returns:
    
    true if this session is connected, else false.
  - getTimeout
```
public int getTimeout()
```
    retrieves the current timeout setting.
    
    See Also:
    
    setTimeout(int)
  - setTimeout
```
public void setTimeout(int timeout)
                throws JSchException
```
    sets the timeout setting. This value is used as the socket timeout parameter, and also as the default connection timeout.
    
    Parameters:
    
    timeout - a nonnegative integer. A value of 0 (the default value) indicates "no timeout".
    
    Throws:
    
    JSchException - if the timeout value is invalid or the existing socket timeout can't be changed.
  - getServerVersion
```
public String getServerVersion()
```
    returns the version string sent by the server.
    
    Returns:
    
    the server version string interpreted in the platform's default encoding.
  - getClientVersion
```
public String getClientVersion()
```
    returns the version string (to be) sent to the server.
    
    Returns:
    
    the client version string, interpreted in the platform's default encoding.
  - setClientVersion
```
public void setClientVersion(String cv)
```
    changes the version string to be sent to the server. The default is a value compiled in indicating compatibility to SSH 2.0 and the current JSch version.
    
    Parameters:
    
    cv - the client version string. This will be encoded in the platform's default encoding. (A version string should normally only contain ASCII characters.)
  - sendIgnore
```
public void sendIgnore()
                throws Exception
```
    sends an ignored package. This is currently nowhere used. A possible use-case is described in RFC 4251, section 9.3.1. (to avoid the Rogaway attack).
    
    Throws:
    
    Exception
  - sendKeepAliveMsg
```
public void sendKeepAliveMsg()
                      throws Exception
```
    Sends a keep-alive message. This is used internally, but can also be called by users.
    
    Throws:
    
    Exception
  - noMoreSessionChannels
```
public void noMoreSessionChannels()
                           throws Exception
```
    Throws:
    
    Exception
  - getHostKey
```
public HostKey getHostKey()
```
    retrieves the host key of the server. This should be invoked after connect().
    
    Returns:
    
    the HostKey used by the remote host, or null, if we are not yet connected.
  - getHost
```
public String getHost()
```
    gets the host name to which we will connect (or are connected).
  - getUserName
```
public String getUserName()
```
    returns the user name used for login (and set when creating the session). (This is also used internally.)
  - getPort
```
public int getPort()
```
    returns the port at the remote host we will connect (or already connected) to.
  - setHostKeyAlias
```
public void setHostKeyAlias(String hostKeyAlias)
```
    sets the host key alias used when comparing the host key to the known hosts list. This is useful when at one host are multiple SSH servers with different host keys.
  - getHostKeyAlias
```
public String getHostKeyAlias()
```
    retrieves the current server host key alias.
    
    See Also:
    
    setHostKeyAlias(java.lang.String)
  - setServerAliveInterval
```
public void setServerAliveInterval(int interval)
                            throws JSchException
```
    sets the server alive interval property. This is also as the timeout value (and nowhere else). If zero is specified, no keep-alive message must be sent. The default interval is zero.
    
    Parameters:
    
    interval - the timeout interval in milliseconds before sending a server alive message, if no message is received from the server.
    
    Throws:
    
    JSchException
    
    See Also:
    
    getServerAliveInterval()
  - getServerAliveInterval
```
public int getServerAliveInterval()
```
    Returns setting for the interval to send a keep-alive message.
    
    See Also:
    
    setServerAliveInterval(int)
  - setServerAliveCountMax
```
public void setServerAliveCountMax(int count)
```
    Sets the number of keep-alive messages which may be sent without receiving any messages back from the server. If this threshold is reached while keep-alive messages are being sent, the connection will be disconnected. The default value is one.
    
    Parameters:
    
    count - the specified count
    
    See Also:
    
    getServerAliveCountMax()
  - getServerAliveCountMax
```
public int getServerAliveCountMax()
```
    Returns setting for the threshold to send keep-alive messages.
    
    See Also:
    
    setServerAliveCountMax(int)
  - setDaemonThread
```
public void setDaemonThread(boolean enable)
```
    Sets the deamon thread property. This only affects threads started after the setting, so this property should be set before connect(). The default value is false.
    
    Parameters:
    
    enable - the new value of the property. If true, all threads will be deamon threads, i.e. their running does not avoid a shutdown of the VM. If false, normal non-deamon threads will be used (and the VM can only shutdown after disconnect() (or with System.exit(int)).
  - setIdentityRepository
```
public void setIdentityRepository(IdentityRepository identityRepository)
```
    Sets the identityRepository, which will be referred in the public key authentication. The default value is null.
    
    Parameters:
    
    identityRepository -
    
    See Also:
    
    getIdentityRepository()
  - setHostKeyRepository
```
public void setHostKeyRepository(HostKeyRepository hostkeyRepository)
```
    Sets the hostkeyRepository, which will be referred in checking host keys.
    
    Parameters:
    
    hostkeyRepository -
    
    See Also:
    
    getHostKeyRepository()
  - getHostKeyRepository
```
public HostKeyRepository getHostKeyRepository()
```
    Gets the hostkeyRepository. If this.hostkeyRepository is null, JSch#getHostKeyRepository() will be invoked.
    
    See Also:
    
    JSch.getHostKeyRepository()

This is an inofficial Javadoc created by Paŭlo Ebermann. Have a look at the official homepage.

Class Session

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

daemon_thread

Method Detail

connect

connect

rekey

openChannel

encode

read

write

run

disconnect

setPortForwardingL

setPortForwardingL

setPortForwardingL

setPortForwardingL

delPortForwardingL

delPortForwardingL

getPortForwardingL

setPortForwardingR

setPortForwardingR

setPortForwardingR

setPortForwardingR

setPortForwardingR

setPortForwardingR

setPortForwardingR

getPortForwardingR

setPortForwardingL

setPortForwardingR

getStreamForwarder

delPortForwardingR

delPortForwardingR

setProxy

setHost

setPort

setUserInfo

getUserInfo

setInputStream

setOutputStream

setX11Host

setX11Port

setX11Cookie

setPassword

setPassword

setConfig

setConfig

setConfig

getConfig

setSocketFactory

isConnected

getTimeout

setTimeout

getServerVersion

getClientVersion

setClientVersion

sendIgnore

sendKeepAliveMsg

noMoreSessionChannels

getHostKey

getHost

getUserName

getPort

setHostKeyAlias

getHostKeyAlias

setServerAliveInterval

getServerAliveInterval

setServerAliveCountMax

getServerAliveCountMax

setDaemonThread

setIdentityRepository

setHostKeyRepository

getHostKeyRepository