Connection (core 2.10.1 API)

Summary:
Property
Constructor
Method

| Detail:
Property
Constructor
Method

org.hidetake.groovy.ssh.connection.Connection

A connected SSH connection.
Authors:
Hidetake Iwata

Properties Summary

Properties
Type	Name and description
`Remote`	`remote`
`com.jcraft.jsch.Session`	`session`

Constructor Summary

Constructors
Constructor and description
`Connection (Remote remote1, com.jcraft.jsch.Session session1)` Constructor

Methods Summary

Methods
Type Params	Return Type	Name and description
	`void`	`close()` Cleanup the connection and all channels.
	`com.jcraft.jsch.ChannelExec`	`createExecutionChannel()` Create an execution channel.
	`com.jcraft.jsch.ChannelSftp`	`createSftpChannel()` Create a SFTP channel.
	`com.jcraft.jsch.ChannelShell`	`createShellChannel()` Create a shell channel.
	`int`	`forwardLocalPort(LocalPortForwardSettings settings)` Set up local port forwarding.
	`void`	`forwardRemotePort(RemotePortForwardSettings settings)` Set up remote port forwarding.
	`java.lang.String`	`toString()`

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class java.lang.Object`	`java.lang.Object#wait(long), java.lang.Object#wait(long, int), java.lang.Object#wait(), java.lang.Object#equals(java.lang.Object), java.lang.Object#toString(), java.lang.Object#hashCode(), java.lang.Object#getClass(), java.lang.Object#notify(), java.lang.Object#notifyAll()`

- Property Detail
  - final Remote remote
  - final com.jcraft.jsch.Session session
- Constructor Detail
  - Connection(Remote remote1, com.jcraft.jsch.Session session1)
    
    Constructor
    Parameters:
    remote1
    session1 - connected session
    Returns:
    an instance
- Method Detail
  - void close()
    
    Cleanup the connection and all channels.
  - com.jcraft.jsch.ChannelExec createExecutionChannel()
    
    Create an execution channel.
    Returns:
    a channel
  - com.jcraft.jsch.ChannelSftp createSftpChannel()
    
    Create a SFTP channel.
    Returns:
    a channel
  - com.jcraft.jsch.ChannelShell createShellChannel()
    
    Create a shell channel.
    Parameters:
    operationSettings
    Returns:
    a channel
  - int forwardLocalPort(LocalPortForwardSettings settings)
    
    Set up local port forwarding.
    Parameters:
    settings
    Returns:
    local port
  - void forwardRemotePort(RemotePortForwardSettings settings)
    
    Set up remote port forwarding.
    Parameters:
    settings
  - @java.lang.Override java.lang.String toString()

Summary:
Property
Constructor
Method

| Detail:
Property
Constructor
Method

Groovy Documentation