Class SftpStreamProxy

java.lang.Object

org.apache.commons.vfs2.provider.sftp.SftpStreamProxy

All Implemented Interfaces:

com.jcraft.jsch.Proxy

public class SftpStreamProxy
extends Object
implements com.jcraft.jsch.Proxy

Stream based proxy for JSch.

Use a command on the proxy that will forward the SSH stream to the target host and port.

Since:

2.1

Field Summary

Fields

Modifier and Type	Field	Description
static final String	BASH_TCP_COMMAND	Command format using bash built-in TCP stream.
static final String	NETCAT_COMMAND	Command format using netcat command.

Constructor Summary

Constructors

Constructor	Description
SftpStreamProxy(String commandFormat, String proxyUser, String proxyHost, int proxyPort, String proxyPassword, FileSystemOptions proxyOptions)	Creates a stream proxy.

Method Summary

Modifier and Type	Method	Description
void	close()
void	connect(com.jcraft.jsch.SocketFactory socketFactory, String targetHost, int targetPort, int timeout)
InputStream	getInputStream()
OutputStream	getOutputStream()
Socket	getSocket()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

BASH_TCP_COMMAND

public static final String BASH_TCP_COMMAND

Command format using bash built-in TCP stream.

See Also:

• Constant Field Values

NETCAT_COMMAND

public static final String NETCAT_COMMAND

Command format using netcat command.

See Also:

• Constant Field Values

Constructor Details

SftpStreamProxy

public SftpStreamProxy(String commandFormat,
 String proxyUser,
 String proxyHost,
 int proxyPort,
 String proxyPassword,
 FileSystemOptions proxyOptions)

Creates a stream proxy.

Parameters:

commandFormat - A format string that will be used to create the command to execute on the proxy host using String.format(String, Object...). Two parameters are given to the format command, the target host name (String) and port (Integer).

proxyUser - The proxy user

proxyHost - The proxy host

proxyPort - The port to connect to on the proxy

proxyPassword - The proxy password

proxyOptions - Options used when connecting to the proxy

Method Details

close

public void close()

Specified by:

close in interface com.jcraft.jsch.Proxy

connect

public void connect(com.jcraft.jsch.SocketFactory socketFactory,
 String targetHost,
 int targetPort,
 int timeout)
             throws Exception

Specified by:

connect in interface com.jcraft.jsch.Proxy

Throws:

Exception

getInputStream

public InputStream getInputStream()

Specified by:

getInputStream in interface com.jcraft.jsch.Proxy

getOutputStream

public OutputStream getOutputStream()

Specified by:

getOutputStream in interface com.jcraft.jsch.Proxy

getSocket

public Socket getSocket()

Specified by:

getSocket in interface com.jcraft.jsch.Proxy