A B C D E G H I J L M N O P R S T V W

A

AbstractSessionFactoryBuilder - Class in com.helger.jsch.session

AbstractSessionFactoryBuilder(JSch, String, String, int, Proxy, ICommonsMap<String, String>, UserInfo) - Constructor for class com.helger.jsch.session.AbstractSessionFactoryBuilder

B

build() - Method in class com.helger.jsch.session.AbstractSessionFactoryBuilder

Builds and returns a the new SessionFactory instance.

C

ChannelExecWrapper(Session, String, InputStream, OutputStream, OutputStream) - Constructor for class com.helger.jsch.command.CommandRunner.ChannelExecWrapper

close() - Method in class com.helger.jsch.command.CommandRunner.ChannelExecWrapper

Safely closes all stream, waits for the underlying connection to close, then returns the exit code from the command execution.

close() - Method in class com.helger.jsch.command.CommandRunner

Closes the underlying SessionManager.

close() - Method in class com.helger.jsch.proxy.SshProxy

close() - Method in class com.helger.jsch.scp.ScpConnection

close() - Method in class com.helger.jsch.scp.ScpFileInputStream

close() - Method in class com.helger.jsch.scp.ScpFileOutputStream

close() - Method in class com.helger.jsch.scp.ScpInputStream

close() - Method in class com.helger.jsch.scp.ScpOutputStream

close() - Method in class com.helger.jsch.session.SessionManager

close() - Method in class com.helger.jsch.sftp.SftpRunner

Closes the underlying SessionManager.

close() - Method in class com.helger.jsch.tunnel.TunnelConnection

Closes the underlying ssh session causing all tunnels to be closed.

close() - Method in class com.helger.jsch.tunnel.TunnelConnectionManager

Closes all sessions and their associated tunnels.

closeEntry() - Method in class com.helger.jsch.scp.ScpConnection

closeEntry() - Method in class com.helger.jsch.scp.ScpInputStream

closeEntry() - Method in class com.helger.jsch.scp.ScpOutputStream

com.helger.jsch - package com.helger.jsch

com.helger.jsch.command - package com.helger.jsch.command

com.helger.jsch.config - package com.helger.jsch.config

com.helger.jsch.proxy - package com.helger.jsch.proxy

com.helger.jsch.scp - package com.helger.jsch.scp

com.helger.jsch.session - package com.helger.jsch.session

com.helger.jsch.sftp - package com.helger.jsch.sftp

com.helger.jsch.tunnel - package com.helger.jsch.tunnel

CommandRunner - Class in com.helger.jsch.command

Provides a convenience wrapper around an exec channel.

CommandRunner(ISessionFactory) - Constructor for class com.helger.jsch.command.CommandRunner

Creates a new CommandRunner that will use a SessionManager that wraps the supplied sessionFactory.

CommandRunner.ChannelExecWrapper - Class in com.helger.jsch.command

Wraps the execution of a command to handle the opening and closing of all the data streams for you.

CommandRunner.ExecuteResult - Class in com.helger.jsch.command

A simple container for the results of a command execution.

connect(SocketFactory, String, int, int) - Method in class com.helger.jsch.proxy.SshProxy

copyFrom(File) - Method in class com.helger.jsch.scp.ScpFile

copyFrom(File, String) - Method in class com.helger.jsch.scp.ScpFile

copyTo(File) - Method in class com.helger.jsch.scp.ScpFile

copyTo(ScpFile) - Method in class com.helger.jsch.scp.ScpFile

D

DefaultSessionFactory - Class in com.helger.jsch.session

The default implementation of SessionFactory.

DefaultSessionFactory() - Constructor for class com.helger.jsch.session.DefaultSessionFactory

Creates a default DefaultSessionFactory.

DefaultSessionFactory(String, String, int) - Constructor for class com.helger.jsch.session.DefaultSessionFactory

Constructs a DefaultSessionFactory with the supplied properties.

E

ECopyMode - Enum in com.helger.jsch.scp

EDestinationOS - Enum in com.helger.jsch.scp

ensureOpen() - Method in class com.helger.jsch.tunnel.TunnelConnectionManager

Will re-open any connections that are not still open.

equals(Object) - Method in class com.helger.jsch.tunnel.Tunnel

EScpMode - Enum in com.helger.jsch.scp

execute(String) - Method in class com.helger.jsch.command.CommandRunner

Executes command and returns the result.

execute(ISftp) - Method in class com.helger.jsch.sftp.SftpRunner

Executes the sftp callback providing it an open ChannelSftp.

ExecuteResult(int, String, String) - Constructor for class com.helger.jsch.command.CommandRunner.ExecuteResult

G

getAllThirdPartyModules() - Method in class com.helger.jsch.config.ThirdPartyModuleProvider_ph_jsch

getAssignedLocalPort() - Method in class com.helger.jsch.tunnel.Tunnel

Returns the local port currently bound to.

getAsString() - Method in class com.helger.jsch.scp.ScpEntry

getAsString() - Method in interface com.helger.jsch.session.ISessionFactory

getAsString() - Method in class com.helger.jsch.session.SessionManager

getAsString() - Method in class com.helger.jsch.tunnel.Tunnel

getAsString() - Method in class com.helger.jsch.tunnel.TunnelConnection

getClone() - Method in class com.helger.jsch.command.CommandRunner

Returns a new CommandRunner with the same SessionFactory, but will create a separate session.

getCurrentInputStream() - Method in class com.helger.jsch.scp.ScpConnection

getCurrentOuputStream() - Method in class com.helger.jsch.scp.ScpConnection

getDestinationHostname() - Method in class com.helger.jsch.tunnel.Tunnel

Returns the hostname of the destination.

getDestinationPort() - Method in class com.helger.jsch.tunnel.Tunnel

Returns the port of the destination.

getErrStream() - Method in class com.helger.jsch.command.CommandRunner.ChannelExecWrapper

Returns the STDERR stream for you to read from.

getExitCode() - Method in class com.helger.jsch.command.CommandRunner.ExecuteResult

Returns the exit code of the command execution.

getHostname() - Method in class com.helger.jsch.session.DefaultSessionFactory

getHostname() - Method in interface com.helger.jsch.session.ISessionFactory

getInputStream() - Method in class com.helger.jsch.command.CommandRunner.ChannelExecWrapper

Returns the STDOUT stream for you to read from.

getInputStream() - Method in class com.helger.jsch.proxy.SshProxy

getInputStream() - Method in class com.helger.jsch.scp.ScpFile

getLocalAlias() - Method in class com.helger.jsch.tunnel.Tunnel

Returns the local alias bound to.

getLocalPort() - Method in class com.helger.jsch.tunnel.Tunnel

Returns the port this tunnel was configured with.

getLogger() - Method in class com.helger.jsch.JSchLoggerSLF4J

getMode() - Method in class com.helger.jsch.scp.ScpEntry

getMode() - Method in class com.helger.jsch.scp.ScpFileInputStream

getName() - Method in class com.helger.jsch.scp.ScpEntry

getName() - Method in class com.helger.jsch.scp.ScpFileInputStream

getNextEntry() - Method in class com.helger.jsch.scp.ScpConnection

getNextEntry() - Method in class com.helger.jsch.scp.ScpInputStream

getOutputStream() - Method in class com.helger.jsch.command.CommandRunner.ChannelExecWrapper

Returns the STDIN stream for you to write to.

getOutputStream() - Method in class com.helger.jsch.proxy.SshProxy

getOutputStream(long) - Method in class com.helger.jsch.scp.ScpFile

getOutputStream(long, String) - Method in class com.helger.jsch.scp.ScpFile

getPort() - Method in class com.helger.jsch.session.DefaultSessionFactory

getPort() - Method in interface com.helger.jsch.session.ISessionFactory

getProxy() - Method in class com.helger.jsch.session.DefaultSessionFactory

getProxy() - Method in interface com.helger.jsch.session.ISessionFactory

getSession() - Method in class com.helger.jsch.session.SessionManager

Returns a connected session.

getSessionFactory() - Method in class com.helger.jsch.session.SessionManager

getSize() - Method in class com.helger.jsch.scp.ScpEntry

getSize() - Method in class com.helger.jsch.scp.ScpFileInputStream

getSocket() - Method in class com.helger.jsch.proxy.SshProxy

getSpec() - Method in class com.helger.jsch.tunnel.Tunnel

Returns the spec string (either calculated or specified) for this tunnel.

getStderr() - Method in class com.helger.jsch.command.CommandRunner.ExecuteResult

Returns the text written to STDERR.

getStdout() - Method in class com.helger.jsch.command.CommandRunner.ExecuteResult

Returns the text written to STDOUT.

getTunnel(String, int) - Method in class com.helger.jsch.tunnel.TunnelConnection

Returns the tunnel matching the supplied values, or null if there isn't one that matches.

getTunnel(String, int) - Method in class com.helger.jsch.tunnel.TunnelConnectionManager

Returns the tunnel matching the supplied values, or null if there isn't one that matches.

getUserInfo() - Method in class com.helger.jsch.session.DefaultSessionFactory

getUserInfo() - Method in interface com.helger.jsch.session.ISessionFactory

getUsername() - Method in class com.helger.jsch.session.DefaultSessionFactory

getUsername() - Method in interface com.helger.jsch.session.ISessionFactory

H

hashCode() - Method in class com.helger.jsch.tunnel.Tunnel

I

init() - Static method in class com.helger.jsch.JSchInit

isDirectory() - Method in class com.helger.jsch.scp.ScpEntry

isEnabled(int) - Method in class com.helger.jsch.JSchLoggerSLF4J

isEndOfDirectory() - Method in class com.helger.jsch.scp.ScpEntry

ISessionFactory - Interface in com.helger.jsch.session

An interface for creating Session objects from a common configuration.

isFile() - Method in class com.helger.jsch.scp.ScpEntry

ISftp - Interface in com.helger.jsch.sftp

A simple callback interface for working with managed sftp channels.

isOpen() - Method in class com.helger.jsch.tunnel.TunnelConnection

Returns true if the underlying ssh session is open.

J

joinPath(String[]) - Method in enum com.helger.jsch.scp.EDestinationOS

joinPath(String[], int, int) - Method in enum com.helger.jsch.scp.EDestinationOS

JSCH - Static variable in class com.helger.jsch.config.ThirdPartyModuleProvider_ph_jsch

JSchInit - Class in com.helger.jsch

Initialize JSch with some suggested settings.

JSchLoggerSLF4J - Class in com.helger.jsch

JSch logger implementation on top of SLF4J.

JSchLoggerSLF4J(Class<?>) - Constructor for class com.helger.jsch.JSchLoggerSLF4J

JSchLoggerSLF4J(String) - Constructor for class com.helger.jsch.JSchLoggerSLF4J

L

log(int, String) - Method in class com.helger.jsch.JSchLoggerSLF4J

M

m_aConfig - Variable in class com.helger.jsch.session.AbstractSessionFactoryBuilder

m_aJsch - Variable in class com.helger.jsch.session.AbstractSessionFactoryBuilder

m_aProxy - Variable in class com.helger.jsch.session.AbstractSessionFactoryBuilder

m_aSessionManager - Variable in class com.helger.jsch.command.CommandRunner

m_aUserInfo - Variable in class com.helger.jsch.session.AbstractSessionFactoryBuilder

m_nPort - Variable in class com.helger.jsch.session.AbstractSessionFactoryBuilder

m_sHostname - Variable in class com.helger.jsch.session.AbstractSessionFactoryBuilder

m_sUsername - Variable in class com.helger.jsch.session.AbstractSessionFactoryBuilder

N

newDirectory(String) - Static method in class com.helger.jsch.scp.ScpEntry

newDirectory(String, String) - Static method in class com.helger.jsch.scp.ScpEntry

newEndOfDirectory() - Static method in class com.helger.jsch.scp.ScpEntry

newFile(String, long) - Static method in class com.helger.jsch.scp.ScpEntry

newFile(String, long, String) - Static method in class com.helger.jsch.scp.ScpEntry

newSession() - Method in class com.helger.jsch.session.DefaultSessionFactory

newSession() - Method in interface com.helger.jsch.session.ISessionFactory

newSessionFactoryBuilder() - Method in class com.helger.jsch.session.DefaultSessionFactory

newSessionFactoryBuilder() - Method in interface com.helger.jsch.session.ISessionFactory

Returns a builder for another session factory pre-initialized with the configuration for this session factory.

O

open(String) - Method in class com.helger.jsch.command.CommandRunner

Executes command and returns an execution wrapper that provides safe access to and management of the underlying streams of data.

open() - Method in class com.helger.jsch.tunnel.TunnelConnection

Opens a session and connects all of the tunnels.

open() - Method in class com.helger.jsch.tunnel.TunnelConnectionManager

Opens all the necessary sessions and connects all of the tunnels.

P

PROPERTY_JSCH_DOT_SSH - Static variable in class com.helger.jsch.session.DefaultSessionFactory

PROPERTY_JSCH_KNOWN_HOSTS_FILE - Static variable in class com.helger.jsch.session.DefaultSessionFactory

PROPERTY_JSCH_PRIVATE_KEY_FILES - Static variable in class com.helger.jsch.session.DefaultSessionFactory

putNextEntry(String) - Method in class com.helger.jsch.scp.ScpConnection

putNextEntry(String, long) - Method in class com.helger.jsch.scp.ScpConnection

putNextEntry(ScpEntry) - Method in class com.helger.jsch.scp.ScpConnection

putNextEntry(String) - Method in class com.helger.jsch.scp.ScpOutputStream

putNextEntry(String, long) - Method in class com.helger.jsch.scp.ScpOutputStream

putNextEntry(ScpEntry) - Method in class com.helger.jsch.scp.ScpOutputStream

R

read() - Method in class com.helger.jsch.scp.ScpFileInputStream

read(byte[], int, int) - Method in class com.helger.jsch.scp.ScpFileInputStream

read() - Method in class com.helger.jsch.scp.ScpInputStream

read(byte[], int, int) - Method in class com.helger.jsch.scp.ScpInputStream

reopen() - Method in class com.helger.jsch.tunnel.TunnelConnection

Closes, and re-opens the session and all its tunnels.

run(ChannelSftp) - Method in interface com.helger.jsch.sftp.ISftp

S

ScpConnection - Class in com.helger.jsch.scp

Based on protocol information found here

ScpConnection(ISessionFactory, String, EScpMode, ECopyMode) - Constructor for class com.helger.jsch.scp.ScpConnection

ScpEntry - Class in com.helger.jsch.scp

ScpEntry.EType - Enum in com.helger.jsch.scp

ScpFile - Class in com.helger.jsch.scp

ScpFile(ISessionFactory, String...) - Constructor for class com.helger.jsch.scp.ScpFile

ScpFile(ISessionFactory, EDestinationOS, String...) - Constructor for class com.helger.jsch.scp.ScpFile

ScpFileInputStream - Class in com.helger.jsch.scp

ScpFileOutputStream - Class in com.helger.jsch.scp

ScpInputStream - Class in com.helger.jsch.scp

ScpInputStream(ISessionFactory, String, ECopyMode) - Constructor for class com.helger.jsch.scp.ScpInputStream

ScpOutputStream - Class in com.helger.jsch.scp

Based upon information found here.

ScpOutputStream(ISessionFactory, String, ECopyMode) - Constructor for class com.helger.jsch.scp.ScpOutputStream

SessionManager - Class in com.helger.jsch.session

Provides a convenience wrapper to sessions that maintains the session connection for you.

SessionManager(ISessionFactory) - Constructor for class com.helger.jsch.session.SessionManager

Creates a SessionManager for the supplied sessionFactory.

setConfig(ICommonsMap<String, String>) - Method in class com.helger.jsch.session.AbstractSessionFactoryBuilder

Replaces the current config with config

setConfig(ICommonsMap<String, String>) - Method in class com.helger.jsch.session.DefaultSessionFactory

Sets the configuration options for the sessions created by this factory.

setConfig(String, String) - Method in class com.helger.jsch.session.DefaultSessionFactory

Adds a single configuration options for the sessions created by this factory.

setHostname(String) - Method in class com.helger.jsch.session.AbstractSessionFactoryBuilder

Replaces the current hostname with hostname

setHostname(String) - Method in class com.helger.jsch.session.DefaultSessionFactory

Sets the hostname.

setIdentitiesFromPrivateKeys(List<String>) - Method in class com.helger.jsch.session.DefaultSessionFactory

Configures this factory to use a list of identities authenticated by the supplied private keys.

setIdentityFromPrivateKey(String) - Method in class com.helger.jsch.session.DefaultSessionFactory

Configures this factory to use a single identity authenticated by the supplied private key.

setIdentityFromPrivateKey(String, String) - Method in class com.helger.jsch.session.DefaultSessionFactory

Configures this factory to use a single identity authenticated by the supplied private key and pass phrase.

setIdentityRepository(IdentityRepository) - Method in class com.helger.jsch.session.DefaultSessionFactory

Sets the IdentityRepository for this factory.

setKnownHosts(InputStream) - Method in class com.helger.jsch.session.DefaultSessionFactory

Sets the known hosts from the stream.

setKnownHosts(String) - Method in class com.helger.jsch.session.DefaultSessionFactory

Sets the known hosts from a file at path knownHosts.

setPassword(String) - Method in class com.helger.jsch.session.DefaultSessionFactory

Sets the password used to authenticate username.

setPort(int) - Method in class com.helger.jsch.session.AbstractSessionFactoryBuilder

Replaces the current port with port

setPort(int) - Method in class com.helger.jsch.session.DefaultSessionFactory

Sets the port.

setProxy(Proxy) - Method in class com.helger.jsch.session.AbstractSessionFactoryBuilder

Replaces the current proxy with proxy

setProxy(Proxy) - Method in class com.helger.jsch.session.DefaultSessionFactory

Sets the proxy through which all connections will be piped.

setTunnelConnections(Iterable<String>) - Method in class com.helger.jsch.tunnel.TunnelConnectionManager

Creates a set of tunnel connections based upon the pathAndTunnels.

setTunnelConnectionsFromFile(File, Charset) - Method in class com.helger.jsch.tunnel.TunnelConnectionManager

Creates a set of tunnel connections based upon the contents of tunnelsConfig.

setUserInfo(UserInfo) - Method in class com.helger.jsch.session.AbstractSessionFactoryBuilder

Replaces the current userInfo with userInfo

setUserInfo(UserInfo) - Method in class com.helger.jsch.session.DefaultSessionFactory

Sets the UserInfo for use with keyboard-interactive authentication.

setUsername(String) - Method in class com.helger.jsch.session.AbstractSessionFactoryBuilder

Replaces the current username with username

setUsername(String) - Method in class com.helger.jsch.session.DefaultSessionFactory

Sets the username.

SftpRunner - Class in com.helger.jsch.sftp

Provides a convenience wrapper around an sftp channel.

SftpRunner(ISessionFactory) - Constructor for class com.helger.jsch.sftp.SftpRunner

Creates a new SftpRunner that will use a SessionManager that wraps the supplied sessionFactory.

shutdown() - Static method in class com.helger.jsch.JSchInit

SSH_PORT - Static variable in interface com.helger.jsch.session.ISessionFactory

SshProxy - Class in com.helger.jsch.proxy

SshProxy(ISessionFactory) - Constructor for class com.helger.jsch.proxy.SshProxy

T

ThirdPartyModuleProvider_ph_jsch - Class in com.helger.jsch.config

Implement this SPI interface if your JAR file contains external third party modules.

ThirdPartyModuleProvider_ph_jsch() - Constructor for class com.helger.jsch.config.ThirdPartyModuleProvider_ph_jsch

toString() - Method in class com.helger.jsch.JSchLoggerSLF4J

toString() - Method in class com.helger.jsch.proxy.SshProxy

toString() - Method in class com.helger.jsch.session.SessionManager

toString() - Method in class com.helger.jsch.tunnel.Tunnel

Tunnel - Class in com.helger.jsch.tunnel

Tunnel stores all the information needed to define an ssh port-forwarding tunnel.

Tunnel(String) - Constructor for class com.helger.jsch.tunnel.Tunnel

Creates a Tunnel from a spec string.

Tunnel(String, int) - Constructor for class com.helger.jsch.tunnel.Tunnel

Creates a Tunnel to destinationPort on destinationHostname from a dynamically assigned port on localhost.

Tunnel(int, String, int) - Constructor for class com.helger.jsch.tunnel.Tunnel

Creates a Tunnel to destinationPort on destinationHostname from localPort on localhost.

Tunnel(String, int, String, int) - Constructor for class com.helger.jsch.tunnel.Tunnel

Creates a Tunnel to destinationPort on destinationHostname from localPort on localAlias.

TunnelConnection - Class in com.helger.jsch.tunnel

A TunnelConnection represents an ssh connection that opens one or more Tunnel's.

TunnelConnection(ISessionFactory, int, String, int) - Constructor for class com.helger.jsch.tunnel.TunnelConnection

Creates a TunnelConnection using the the sessionFactory to obtain its ssh connection with a single tunnel defined by Tunnel(localPort, destinationHostname, destinationPort).

TunnelConnection(ISessionFactory, Tunnel...) - Constructor for class com.helger.jsch.tunnel.TunnelConnection

Creates a TunnelConnection using the the sessionFactory to obtain its ssh connection with a list of Tunnel's.

TunnelConnection(ISessionFactory, List<Tunnel>) - Constructor for class com.helger.jsch.tunnel.TunnelConnection

Creates a TunnelConnection using the the sessionFactory to obtain its ssh connection with a list of Tunnel's.

TunnelConnectionManager - Class in com.helger.jsch.tunnel

Manages a collection of tunnels.

TunnelConnectionManager(ISessionFactory) - Constructor for class com.helger.jsch.tunnel.TunnelConnectionManager

Creates a TunnelConnectionManager that will use the baseSessionFactory to obtain its session connections.

TunnelConnectionManager(ISessionFactory, String...) - Constructor for class com.helger.jsch.tunnel.TunnelConnectionManager

Creates a TunnelConnectionManager that will use the baseSessionFactory to obtain its session connections and provide the tunnels specified.

TunnelConnectionManager(ISessionFactory, Iterable<String>) - Constructor for class com.helger.jsch.tunnel.TunnelConnectionManager

Creates a TunnelConnectionManager that will use the baseSessionFactory to obtain its session connections and provide the tunnels specified.

V

valueOf(String) - Static method in enum com.helger.jsch.scp.ECopyMode

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum com.helger.jsch.scp.EDestinationOS

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum com.helger.jsch.scp.EScpMode

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum com.helger.jsch.scp.ScpEntry.EType

Returns the enum constant of this type with the specified name.

values() - Static method in enum com.helger.jsch.scp.ECopyMode

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum com.helger.jsch.scp.EDestinationOS

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum com.helger.jsch.scp.EScpMode

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum com.helger.jsch.scp.ScpEntry.EType

Returns an array containing the constants of this enum type, in the order they are declared.

W

write(int) - Method in class com.helger.jsch.scp.ScpFileOutputStream

write(byte[], int, int) - Method in class com.helger.jsch.scp.ScpFileOutputStream

write(int) - Method in class com.helger.jsch.scp.ScpOutputStream

write(byte[], int, int) - Method in class com.helger.jsch.scp.ScpOutputStream

A B C D E G H I J L M N O P R S T V W