com.jcraft.jsch

Class ProxySOCKS5

java.lang.Object

com.jcraft.jsch.ProxySOCKS5

All Implemented Interfaces:

Proxy

public class ProxySOCKS5
extends Object
implements Proxy

A Proxy implementation using a SOCKS V5 proxy. This first authenticates to the proxy and then sends an CONNECT request to connect to the desired server.

See Also:

RFC 1928: SOCKS Protocol Version 5, RFC 1929: Username/Password Authentication for SOCKS V5

Constructor Summary

Constructors

Constructor and Description
ProxySOCKS5(String proxy_host) Creates a new ProxySOCKS5 object.
ProxySOCKS5(String proxy_host, int proxy_port) Creates a new ProxyHTTP object.

Method Summary

Modifier and Type	Method and Description
void	close() Closes the connection.
void	connect(SocketFactory socket_factory, String host, int port, int timeout) Opens a connection to the target server.
static int	getDefaultPort() returns the default proxy port - this is 1080 as defined for SOCKS.
InputStream	getInputStream() Returns an InputStream to read data from the remote server.
OutputStream	getOutputStream() Returns an OutputStream to write data to the remote server.
Socket	getSocket() Returns the socket used for the connection.
void	setUserPasswd(String user, String passwd) Sets the user name and password needed for authentication to the proxy.

Methods inherited from class java.lang.Object

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

Constructor Detail

ProxySOCKS5

public ProxySOCKS5(String proxy_host)

Creates a new ProxySOCKS5 object.

Parameters:

proxy_host - the proxie's host name, maybe including the port number separated by :. (The default port is 1080.)

ProxySOCKS5

public ProxySOCKS5(String proxy_host,
                   int proxy_port)

Creates a new ProxyHTTP object.

Parameters:

proxy_host - the proxie's host name.

proxy_port - the port number of the proxy.

Method Detail

setUserPasswd

public void setUserPasswd(String user,
                          String passwd)

Sets the user name and password needed for authentication to the proxy. This has no relation to any authentication on the target server.

If the proxy needs authentication, this method should be called before calling connect(com.jcraft.jsch.SocketFactory, java.lang.String, int, int) (i.e. before passing the Proxy object to the JSch library). This class supports the "No Authentication Required" method as well as the "UserName/Password" method.

Parameters:

user - the user name

passwd - the password.

connect

public void connect(SocketFactory socket_factory,
                    String host,
                    int port,
                    int timeout)
             throws JSchException

Description copied from interface: Proxy

Opens a connection to the target server. After successful invocation of this method the other methods can be called to retrieve the results.

Specified by:

connect in interface Proxy

Parameters:

socket_factory - a factory for sockets. Might be null, then the implementation will use plain sockets.

host - the SSH server host we want to connect to.

port - the port at the SSH server.

timeout - how long to wait maximally for a connection, in milliseconds. If 0, wait as long as needed.

Throws:

JSchException

getInputStream

public InputStream getInputStream()

Description copied from interface: Proxy

Returns an InputStream to read data from the remote server. If the SSH protocol is tunneled through another protocol for proxying purposes, this InputStream has to do the unwrapping.

Specified by:

getInputStream in interface Proxy

getOutputStream

public OutputStream getOutputStream()

Description copied from interface: Proxy

Returns an OutputStream to write data to the remote server. If the SSH protocol is tunneled through another protocol for proxying purposes, this OutputStream has to do the wrapping.

Specified by:

getOutputStream in interface Proxy

getSocket

public Socket getSocket()

Description copied from interface: Proxy

Returns the socket used for the connection. This will only be used for timeout-configurations.

Specified by:

getSocket in interface Proxy

close

public void close()

Description copied from interface: Proxy

Closes the connection. This should close the underlying socket as well.

Specified by:

close in interface Proxy

getDefaultPort

public static int getDefaultPort()

returns the default proxy port - this is 1080 as defined for SOCKS.