Connection (core 2.5.1 API)

org.hidetake.groovy.ssh.connection.Connection

A SSH connection.
Authors:
Hidetake Iwata

Properties Summary

Properties
Type	Name and description
`Remote`	`remote`

Constructor Summary

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

Methods Summary

Methods
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.
`void`	`executeCallbackForClosedChannels()` Execute registered closures.
`int`	`forwardLocalPort(LocalPortForwardSettings settings)` Set up local port forwarding.
`void`	`forwardRemotePort(RemotePortForwardSettings settings)` Set up remote port forwarding.
`boolean`	`isAnyPending()` Return if any channel is pending.
`java.lang.String`	`toString()`
`void`	`whenClosed(com.jcraft.jsch.Channel channel, groovy.lang.Closure closure)` Register a closure called when the channel is closed.

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class java.lang.Object`	`java.lang.Object#wait(long, int), java.lang.Object#wait(long), 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
- Constructor Detail
  - Connection(Remote remote1, com.jcraft.jsch.Session session1)
- 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
  - void executeCallbackForClosedChannels()
    
    Execute registered closures. This method throws a BackgroundCommandException if any closure returns an exception.
    See Also:
    whenClosed(com.jcraft.jsch.Channel, groovy.lang.Closure)
  - 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
  - boolean isAnyPending()
    
    Return if any channel is pending.
    Returns:
    true if at least one is pending
  - @java.lang.Override java.lang.String toString()
  - void whenClosed(com.jcraft.jsch.Channel channel, groovy.lang.Closure closure)
    
    Register a closure called when the channel is closed.
    Parameters:
    channel - the channel
    closure - callback closure

Summary:
Property
Constructor
Method

| Detail:
Property
Constructor
Method

Groovy Documentation

[Groovy] Class Connection

Properties Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Property Detail

final Remote remote

Constructor Detail

Connection(Remote remote1, com.jcraft.jsch.Session session1)

Method Detail

void close()

com.jcraft.jsch.ChannelExec createExecutionChannel()

com.jcraft.jsch.ChannelSftp createSftpChannel()

com.jcraft.jsch.ChannelShell createShellChannel()

void executeCallbackForClosedChannels()

int forwardLocalPort(LocalPortForwardSettings settings)

void forwardRemotePort(RemotePortForwardSettings settings)

boolean isAnyPending()

@java.lang.Override java.lang.String toString()

void whenClosed(com.jcraft.jsch.Channel channel, groovy.lang.Closure closure)